[GRASS-SVN] r36186 - grass/branches/develbranch_6

[svn_grass at osgeo.org]

Author: epatton
Date: 2009-03-03 09:52:41 -0500 (Tue, 03 Mar 2009)
New Revision: 36186

Modified:
   grass/branches/develbranch_6/SUBMITTING_DOCS
Log:
Added info on recommended html sections, merge from trunk r36185

Modified: grass/branches/develbranch_6/SUBMITTING_DOCS
===================================================================
--- grass/branches/develbranch_6/SUBMITTING_DOCS	2009-03-03 14:48:04 UTC (rev 36185)
+++ grass/branches/develbranch_6/SUBMITTING_DOCS	2009-03-03 14:52:41 UTC (rev 36186)
@@ -20,15 +20,36 @@
 
 
 2. Module manual page:
-   Place the documentation in HTML format into 'description.html'.
+   Place the documentation in HTML format into '<module>.html', where
+   <module> is the name of the module. E.g. if the module is named
+   r.example, the documentation file should be named r.example.html.
+
    The easiest way to do this is to study an existing HTML page
-   (to get the page style, e.g. vector/v.to.db/description.html).
-   With a few exceptions header and footer are NOT allowed.
-   You can add figures (PNG format), the figure name prefix should be the 
-   module name. See raster/r.terraflow/description.html for an example.
+   (to get the page style, e.g. vector/v.to.db/v.to.db.html).
+   With a few exceptions, header and footer are NOT allowed.
+   You can add figures (PNG format); the figure name prefix should be the 
+   module name. See raster/r.terraflow/r.terraflow.html for an example.
 
+   A number of major sections should be present in each help page.
+
+   * = Required
+   ! = Suggested
+   . = Optional
+
+   In recommended order
+   --------------------
+
+   * <h2>DESCRIPTION</h2>
+   ! <h2>NOTE</H2>, <h2>NOTES</h2>
+   ! <h2>EXAMPLE</h2>, <h2>EXAMPLES</h2>
+   . <h2>TODO</h2>
+   . <h2>BUGS</h2>
+   . <h2>REFERENCE</h2>, <h2>REFERENCES</h2>
+   * <h2>SEE ALSO</h2>
+   * <h2>AUTHOR</h2>, <h2>AUTHORS</h2>
+
    Note that the parameter information is auto-generated upon
-   compilation. This is done by running module in a virtual session
+   compilation. This is done by running the module in a virtual session
    after compilation (see the output of 'make'). To subsequently
    verify the final HTML page, check the resulting HTML pages which
    will be stored with the name of the module.