Borges provides an easy procedure to start with a new documentation project. We will detail the configuration steps necessary to create a project template. Afterwards, the sample document provided with Borges will be compiled into both PDF and HTML and the progress report will be generated.
Create the project skeleton
to do so.
Initialize the System with the Provided Sample
make adddoc doc=My_Book master=/usr/share/Borges/Sample/master.top.xml
and directories will be populated with the minimum required files.
Compile My_Book to PDF and Check the Result
make -C manuals/My_Book My_Book.pdf LANG=en
if everything went well, you should see a nice PDF of the sample document. Of course, you can use Acrobat Reader instead of Xpdf to open the PDF if you prefer.
Compile My_Book to HTML and Check the Result
make -C manuals/My_Book My_Book.flat.html LANG=en
to do so, and then check the results by pointing your favorite browser to ~/My_Project/manuals/My_Book/My_Book.flat.html.
Generate and View the Report
make -C reports all LANG=en
and view the resulting report by pointing your favorite web browser to ~/My_Project/reports/index.html.