Changes between Version 5 and Version 6 of NewHelpSystem


Ignore:
Timestamp:
Apr 8, 2009, 1:53:23 AM (15 years ago)
Author:
raimue (Rainer Müller)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • NewHelpSystem

    v5 v6  
    77== Details == #details
    88
    9 The new help system will make use of [http://asciidoc.org asciidoc] which is already used in other Open Source projects such as git and mercurial. Existing man pages of these projects can serve as reference for ours. Using asciidoc allows to generate multiple output formats out of one single source, especially interesting for us are man pages and !DocBook XML. The resulting man page can be included in the base distribution, while the !DocBook XML could help to integrate the man pages into the guide.
     9The new help system will make use of [http://www.methods.co.nz/asciidoc/ asciidoc] which is already used in other Open Source projects such as git and mercurial. Existing man pages of these projects can serve as reference for ours. Using asciidoc allows to generate multiple output formats out of one single source, especially interesting for us are man pages and !DocBook XML. The resulting man page can be included in the base distribution, while the !DocBook XML could help to integrate the man pages into the guide.
    1010
    1111Asciidoc is already available in MacPorts and therefore easy accessible to all developers.
     
    2020
    2121As asciidoc is not available on Mac OS X systems without installing MacPorts we should not add it as a new dependency for building base. Therefore, the generated man pages will be checked in into SVN in the same manner we already do for the `configure` script and other files generated by autoconf. Man pages will still reside in the `base/doc` directory.
     22
     23== AsciiDoc References ==
     24
     25 * [http://www.methods.co.nz/asciidoc/userguide.html Official AsciiDoc User Guide]
     26 * [http://liksom.info/blog/?q=node/114 AsciiDoc cheat sheet]
    2227
    2328== Development Branch == #branch