Sophie: Borges-doc-0.7.12-1mdk noarch

Borges-doc-0.7.12-1mdk.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Borges DMS</title><meta name="generator" content="DocBook XSL Stylesheets V1.59.2" id="generator" /><meta name="description" content="" id="description" /></head><body><div class="book" lang="en" xml:lang="en"><div class="titlepage"><div><h1 class="title"><a id="Borges-doc"></a>Borges DMS</h1></div><div><h2 class="subtitle">Self-Documentation</h2></div><div><div class="authorgroup"><h4 class="editedby">Edited by</h4><h3 class="editor">Camille Bégnis</h3><div class="author"><h3 class="author">Joël Pomerleau</h3><div class="affiliation"><div class="address"><p><tt>&lt;<a href="mailto:joel@mandrakesoft.com">joel@mandrakesoft.com</a>&gt;</tt></p></div></div></div><div class="author"><h3 class="author">Christian Roy</h3><div class="affiliation"><div class="address"><p><tt>&lt;<a href="mailto:croy@mandrakesoft.com">croy@mandrakesoft.com</a>&gt;</tt></p></div></div></div><div class="author"><h3 class="author">Fabian Mandelbaum</h3><div class="affiliation"><div class="address"><p><tt>&lt;<a href="mailto:fabman@mandrakesoft.com">fabman@mandrakesoft.com</a>&gt;</tt></p></div></div></div><div class="author"><h3 class="author">Peter Pingus</h3><div class="affiliation"><div class="address"><p><tt>&lt;<a href="mailto:pp@mandrakesoft.com">pp@mandrakesoft.com</a>&gt;</tt></p></div></div></div><div class="author"><h3 class="author">Jerry Huynh-Tot</h3><div class="affiliation"><div class="address"><p><tt>&lt;<a href="mailto:jerry@mandrakesoft.com">jerry@mandrakesoft.com</a>&gt;</tt></p></div></div></div></div></div><div><p class="copyright">Copyright © 2002 MandrakeSoft SA</p></div><div><p class="pubdate">2002-04-19</p></div><div></div><div><div class="abstract"><p class="title"><b>Abstract</b></p><p></p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="#id5379279">Preface</a></dt><dd><dl><dt>1. <a href="#id5379292">Legal Notice</a></dt><dt>2. <a href="#id5379387">About this Document</a></dt></dl></dd><dt>1. <a href="#id5379312">A Revolutionary Concept</a></dt><dd><dl><dt>1. <a href="#id5379318">What is Borges</a></dt><dt>2. <a href="#id5379336">Do I need it?</a></dt><dt>3. <a href="#id5379350">Some Vocabulary</a></dt></dl></dd><dt>2. <a href="#id5379375">Quick Start Guide</a></dt><dd><dl><dt>1. <a href="#id5375338">Installation</a></dt><dt>2. <a href="#id5375361">First Steps</a></dt><dt>3. <a href="#id5375381">Begin your own Project</a></dt></dl></dd><dt>3. <a href="#id5375470">User's Reference manual</a></dt><dd><dl><dt>1. <a href="#id5375478">Documents writing</a></dt><dt>2. <a href="#id5375515">Output Generation</a></dt><dt>3. <a href="#id5375585">Output Style Customizations</a></dt><dt>4. <a href="#id5375607">Revision Management</a></dt></dl></dd><dt>4. <a href="#id5375642">Features for the Project Manager</a></dt><dt>5. <a href="#id5374656">Borges and XML Editors (Emacs Rules)</a></dt><dt>6. <a href="#id5374684">Borges and CVS Integration</a></dt><dt>7. <a href="#id5374709">Programmer's Reference manual</a></dt><dt>8. <a href="#id5374731">Getting Help</a></dt><dt>9. <a href="#id5374752">Passwords</a></dt><dt>A. <a href="#command-reminder">Borges Commands Reminder</a></dt><dt>B. <a href="#gfdl">GFDL</a></dt></dl></div><div class="preface" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title"><a id="id5379279"></a>Preface</h2></div></div><div class="toc"><dl><dt>1. <a href="#id5379292">Legal Notice</a></dt><dt>2. <a href="#id5379387">About this Document</a></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a id="id5379292"></a>1. Legal Notice</h2></div></div><p class="module">legal-notice</p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a id="id5379387"></a>2. About this Document</h2></div></div><p class="module">about-borges-doc-sect1</p><p>This section will present this document and the Borges
      project very quickly</p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title"><a id="id5379312"></a>Chapter 1. A Revolutionary Concept</h2></div></div><div class="toc"><dl><dt>1. <a href="#id5379318">What is Borges</a></dt><dt>2. <a href="#id5379336">Do I need it?</a></dt><dt>3. <a href="#id5379350">Some Vocabulary</a></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a id="id5379318"></a>1. What is Borges</h2></div></div><p class="module">intro-borges-sect1</p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a id="id5379336"></a>2. Do I need it?</h2></div></div><p class="module">intro-use-sect1</p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a id="id5379350"></a>3. Some Vocabulary</h2></div></div><p class="module">intro-vocabulary-sect1</p><p>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.</p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title"><a id="id5379375"></a>Chapter 2. Quick Start Guide</h2></div></div><div class="toc"><dl><dt>1. <a href="#id5375338">Installation</a></dt><dt>2. <a href="#id5375361">First Steps</a></dt><dt>3. <a href="#id5375381">Begin your own Project</a></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a id="id5375338"></a>1. Installation</h2></div></div><p class="module">installation-borges-sect1</p><p>This should give links to packages, sources,
      website. Speak about requirements. Tell how to create a starting
      local repository.</p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a id="id5375361"></a>2. First Steps</h2></div></div><p class="module">first-steps-borges-sect1</p><p>Give basic commands to configure, compile PDF and html
      outputs, generate the report; for sample document.</p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a id="id5375381"></a>3. Begin your own Project</h2></div></div><p class="module">first-project-borges-sect1</p><p>Tell how to configure the system for the new
      manual/languages. Then begin a step-by-step example:</p><div class="orderedlist"><ol type="1"><li><p>Define your manual by writing the
	    <tt>master.top.xml</tt> file;</p></li><li><p>Define local entities for titles notably;</p></li><li><p>Test master.top.html compilation;</p></li><li><p>Build module templates;</p></li><li><p>Populate templates;</p></li><li><p>Test doc compilation.</p></li></ol></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title"><a id="id5375470"></a>Chapter 3. User's Reference manual</h2></div></div><div class="toc"><dl><dt>1. <a href="#id5375478">Documents writing</a></dt><dt>2. <a href="#id5375515">Output Generation</a></dt><dt>3. <a href="#id5375585">Output Style Customizations</a></dt><dt>4. <a href="#id5375607">Revision Management</a></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a id="id5375478"></a>1. Documents writing</h2></div></div><p class="module">borges-writing-features-sect1</p><p>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.</p><p>Then Explain in details all functionalities, those already
      seen above, plus global entities, images, stylesheet driver
      files, sub_manuals, validation, ...</p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a id="id5375515"></a>2. Output Generation</h2></div></div><p class="module">borges-compile-features-sect1</p><p>Detail:</p><div class="orderedlist"><ol type="1"><li><p>Available output formats;</p></li><li><p>How to generate a single manual;</p></li><li><p>Where to customize them;</p></li><li><p>How to associate a special stylesheet to a special document;</p></li><li><p>How to generate a set of manuals/languages documents.</p></li></ol></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a id="id5375585"></a>3. Output Style Customizations</h2></div></div><p class="module">borges-style-custom-sect1</p><p>Tell how to customize stylesheets, rceate new layers and
      use them..</p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a id="id5375607"></a>4. Revision Management</h2></div></div><p class="module">borges-revision-features-sect1</p><p>First introduce the revision system in details with its
      various levels.</p><p>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.</p><p>Finally, tell how to automatically publish the report on a
      mail server through cron jobs.</p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title"><a id="id5375642"></a>Chapter 4. Features for the Project Manager</h2></div></div><p class="module">borges-manager-features-sect1</p><p>Move here the mail section from previous chapter.</p></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title"><a id="id5374656"></a>Chapter 5. Borges and XML Editors (Emacs Rules)</h2></div></div><p class="module">borges-editors-chapter</p><p>In introduction tell that any editor should be OK provided
    it does not interfere with Borges requirements.</p><p>Then add a section for Emacs+PSGML which Borges fully
    supports..</p></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title"><a id="id5374684"></a>Chapter 6. Borges and CVS Integration</h2></div></div><p class="module">borges-cvs-chapter</p><p>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.</p></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title"><a id="id5374709"></a>Chapter 7. Programmer's Reference manual</h2></div></div><p class="module">programmer-borges-chapter</p><p>Enter in the details of implementations, how to add a new
    module for other DTDs/stylesheets...</p></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title"><a id="id5374731"></a>Chapter 8. Getting Help</h2></div></div><p class="module">borges-help-chapter</p><p>List all associated resources: website, ML, SF, IRC, what
    they are for (not only help, but bugreports, RFEs, etc.).</p></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title"><a id="id5374752"></a>Chapter 9. Passwords</h2></div></div><p class="module">passwords</p><p>This is just a sample module to shom Borges possibilitiesn
    notably for reports.</p></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title"><a id="command-reminder"></a>Appendix A. Borges Commands Reminder</h2></div></div><p class="module">command-reminder-appendix</p><p>This appendix will list all available make commands under
    Borges, sorted by topic: compilation, revision management, reports
    generation, etc.</p></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><h2 class="title"><a id="gfdl"></a>Appendix B. GFDL</h2></div></div><p class="module">gfdl-appendix</p></div></div></body></html>