[GRASS-SVN] r36185 - grass/trunk

[svn_grass at osgeo.org]

Author: epatton
Date: 2009-03-03 09:48:04 -0500 (Tue, 03 Mar 2009)
New Revision: 36185

Modified:
   grass/trunk/SUBMITTING_DOCS
Log:
Added info on recommended html sections

Modified: grass/trunk/SUBMITTING_DOCS
===================================================================
--- grass/trunk/SUBMITTING_DOCS	2009-03-02 23:45:37 UTC (rev 36184)
+++ grass/trunk/SUBMITTING_DOCS	2009-03-03 14:48:04 UTC (rev 36185)
@@ -26,12 +26,30 @@
 
    The easiest way to do this is to study an existing HTML page
    (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 
+   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.