Borges DMS

Self-Documentation

Edited by

Camille Bégnis

Joël Pomerleau


            <joel@mandrakesoft.com>
          

Christian Roy


            <croy@mandrakesoft.com>
          

Fabian Mandelbaum


            <fabman@mandrakesoft.com>
          

Peter Pingus


            <pp@mandrakesoft.com>
          

Jerry Huynh-Tot


            <jerry@mandrakesoft.com>
          

2002-04-19

Abstract


Table of Contents

Preface
1. Legal Notice
2. About Borges Documentation
1. A Revolutionary Concept
1. What is Borges?
1.1. Features
2. Choosing Borges
2.1. Do I need it?
2.2. Is Borges for me?
3. Some Vocabulary
2. Quick Start Guide
1. Installation
1.1. Where to get it?
1.2. How to install it?
1.3. Dependencies
2. First Steps
3. Beginning Your Own Project
3.1. Configuring Borges to Start a New Project
3.2. Step by Step Example
3.3. Final Notes
3. User's Reference manual
1. Documents Writing
1.1. Configuration Files
1.2. Document Creation Features
1.3. Document modification features
1.4. Adding new languages to the system
2. Generating Final Documents
2.1. Single Manual Generation
2.2. Generating Multiple Documents at Once
2.3. Generating a Single Module
3. Output Style Customizations
3.1. Customizing Existing Formats
3.2. Creating a New Customization Layer
4. Revision Management
4.1. Modules Life Cycle
4.2. Inter-Languages Modules Synchronization
4.3. Generating Reports
4. Features for the Project Manager
1. Sending Mails to Authors
2. Accounting Report
5. Borges and XML Editors (Emacs Rules)
6. Borges and CVS Integration
7. Programer's Reference manual
1. Makefiles
1.1. Borges source Makefile
1.2. Documentatin Projects Makefiles
1.3. Makefiles in Action
2. The Way a Manual is Generated
3. Adding/changing Manuals Rules
4. Supporting Another DTD than DocBook
8. Getting Help
1. Bug Reports, Feature Requests, Patches
2. Contact
9. Sample Module for Tests
A. Borges Commands Reminder
B. GNU Free Documentation License
1. GNU Free Documentation License
1.0. PREAMBLE
1.1. APPLICABILITY AND DEFINITIONS
1.2. VERBATIM COPYING
1.3. COPYING IN QUANTITY
1.4. MODIFICATIONS
1.5. COMBINING DOCUMENTS
1.6. COLLECTIONS OF DOCUMENTS
1.7. AGGREGATION WITH INDEPENDENT WORKS
1.8. TRANSLATION
1.9. TERMINATION
1.10. FUTURE REVISIONS OF THIS LICENSE
2. How to use this License for your documents

List of Figures

3.1. Borges' Modules Life Cycle
3.2. An extract of a super-document report
3.3. A Sample Modules' report
3.4. Changes in IDs/revisions
3.5. Side by side not synched elements
3.6. The reports generated by Borges
7.1. Distributing Makefiles
7.2. Makefiles Relatiunships
7.3. Distributing Makefiles

List of Tables

3.1. Borges Output Formats