Borges DMS

Self-Documentation

Edited by

Camille Bégnis

Joël Pomerleau, Christian Roy, Fabian Mandelbaum, Peter Pingus, Jerry Huynh-Tot, John Rye.

2002-04-19

Abstract


Table of Contents

Preface
1. Legal Notice
2. About this Document
1. A Revolutionary Concept
1. What is Borges
2. Do I need it?
3. Some Vocabulary
2. Quick Start Guide
1. Installation
2. First Steps
3. Begin your own Project
3. User's Reference manual
1. Documents writing
2. Output Generation
3. Output Style Customizations
4. Revision Management
4. Features for the Project Manager
5. Borges and XML Editors (Emacs Rules)
6. Borges and CVS Integration
7. Programmer's Reference manual
8. Getting Help
9. Passwords
A. Borges Commands Reminder
B. GFDL

Preface

1. Legal Notice

legal-notice

2. About this Document

about-borges-doc-sect1

This section will present this document and the Borges project very quickly

Chapter 1. A Revolutionary Concept

1. What is Borges

intro-borges-sect1

2. Do I need it?

intro-use-sect1

3. Some Vocabulary

intro-vocabulary-sect1

Explain here what we mean by project, author, author initials, document, sub-document, module, module status, atom, atom revision. Put links to relevant manual sections.

Chapter 2. Quick Start Guide

1. Installation

installation-borges-sect1

This should give links to packages, sources, website. Speak about requirements. Tell how to create a starting local repository.

2. First Steps

first-steps-borges-sect1

Give basic commands to configure, compile PDF and html outputs, generate the report; for sample document.

3. Begin your own Project

first-project-borges-sect1

Tell how to configure the system for the new manual/languages. Then begin a step-by-step example:

  1. Define your manual by writing the master.top.xml file;

  2. Define local entities for titles notably;

  3. Test master.top.html compilation;

  4. Build module templates;

  5. Populate templates;

  6. Test doc compilation.

Chapter 3. User's Reference manual

1. Documents writing

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, ...

2. Output Generation

borges-compile-features-sect1

Detail:

  1. Available output formats;

  2. How to generate a single manual;

  3. Where to customize them;

  4. How to associate a special stylesheet to a special document;

  5. How to generate a set of manuals/languages documents.

3. Output Style Customizations

borges-style-custom-sect1

Tell how to customize stylesheets, rceate new layers and use them..

4. Revision Management

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.

Chapter 4. Features for the Project Manager

borges-manager-features-sect1

Move here the mail section from previous chapter.

Chapter 5. Borges and XML Editors (Emacs Rules)

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..

Chapter 6. Borges and CVS Integration

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.

Chapter 7. Programmer's Reference manual

programmer-borges-chapter

Enter in the details of implementations, how to add a new module for other DTDs/stylesheets...

Chapter 8. Getting Help

borges-help-chapter

List all associated resources: website, ML, SF, IRC, what they are for (not only help, but bugreports, RFEs, etc.).

Chapter 9. Passwords

passwords

This is just a sample module to shom Borges possibilitiesn notably for reports.

Appendix A. Borges Commands Reminder

command-reminder-appendix

This appendix will list all available make commands under Borges, sorted by topic: compilation, revision management, reports generation, etc.

Appendix B. GFDL

gfdl-appendix