Changes between Version 5 and Version 6 of NewHelpSystem

Timestamp:

Apr 8, 2009, 1:53:23 AM (16 years ago)

Author:

raimue (Rainer Müller)

Comment:

--

NewHelpSystem

@@ -7 +7 @@
 == Details == #details
 
-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.
+The 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.
 
 Asciidoc is already available in MacPorts and therefore easy accessible to all developers.
@@ -20 +20 @@
 
 As 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.
+
+== AsciiDoc References ==
+
+ * [http://www.methods.co.nz/asciidoc/userguide.html Official AsciiDoc User Guide]
+ * [http://liksom.info/blog/?q=node/114 AsciiDoc cheat sheet]
 
 == Development Branch == #branch