installation-borges-sect1
This should give links to packages, sources, website. Speak about requirements. Tell how to create a starting local repository.
first-steps-borges-sect1
Give basic commands to configure, compile PDF and html outputs, generate the report; for sample document.
first-project-borges-sect1
Tell how to configure the system for the new manual/languages. Then begin a step-by-step example:
Define your manual by writing the
master.top.xml
file;
Define local entities for titles notably;
Test master.top.html compilation;
Build module templates;
Populate templates;
Test doc compilation.
borges-writing-features-sect1
At first, review the format of configuration files: in conf/ but also conf.xml. For master.top.xml detail all the required elements for the revision system to work.
Then Explain in details all functionalities, those already seen above, plus global entities, images, stylesheet driver files, sub_manuals, validation, ...
borges-compile-features-sect1
Detail:
Available output formats;
How to generate a single manual;
Where to customize them;
How to associate a special stylesheet to a special document;
How to generate a set of manuals/languages documents.
borges-style-custom-sect1
Tell how to customize stylesheets, rceate new layers and use them..
borges-revision-features-sect1
First introduce the revision system in details with its various levels.
Enter in the details from top to bottom: whole project report, manual, module, element. For each, tell the way to make it work in the sources, the make target associated, and where to check the result.
Finally, tell how to automatically publish the report on a mail server through cron jobs.
borges-manager-features-sect1
Move here the mail section from previous chapter.
borges-editors-chapter
In introduction tell that any editor should be OK provided it does not interfere with Borges requirements.
Then add a section for Emacs+PSGML which Borges fully supports..
borges-cvs-chapter
Tell that Borges is designed to work fine on a CVS. Tell what to put on CVS and what not. Warn about the problems caused by module templates automatically generated that must be added to the CVS at the same time the modified master.top.xml is updated. Same when adding new languages/manuals.
programmer-borges-chapter
Enter in the details of implementations, how to add a new module for other DTDs/stylesheets...
borges-help-chapter
List all associated resources: website, ML, SF, IRC, what they are for (not only help, but bugreports, RFEs, etc.).
passwords
This is just a sample module to shom Borges possibilitiesn notably for reports.
command-reminder-appendix
This appendix will list all available make commands under Borges, sorted by topic: compilation, revision management, reports generation, etc.