[MacPorts] NewHelpSystem modified

MacPorts noreply at macports.org
Tue Apr 7 18:53:26 PDT 2009


Changed page "NewHelpSystem" by raimue at macports.org from 91.11.239.21*
Page URL: <http://trac.macports.org/wiki/NewHelpSystem>
Diff URL: <http://trac.macports.org/wiki/NewHelpSystem?action=diff&version=6>
Revision 6

-------8<------8<------8<------8<------8<------8<------8<------8<--------
Index: NewHelpSystem
=========================================================================
--- NewHelpSystem (version: 5)
+++ NewHelpSystem (version: 6)
@@ -6,7 +6,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.
 
@@ -19,6 +19,11 @@
 == Changes for base developers == #developers
 
 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
 

-------8<------8<------8<------8<------8<------8<------8<------8<--------

* The IP shown here might not mean anything if the user or the server is
behind a proxy.

--
MacPorts <http://www.macports.org/>
Ports system for Mac OS

This is an automated message. Someone at http://www.macports.org/ added your email
address to be notified of changes on NewHelpSystem. If it was not you, please
report to .


More information about the macports-changes mailing list