[GRASS-SVN] r32916 - grass/trunk

svn_grass at osgeo.org svn_grass at osgeo.org
Wed Aug 20 06:58:39 EDT 2008


Author: glynn
Date: 2008-08-20 06:58:38 -0400 (Wed, 20 Aug 2008)
New Revision: 32916

Modified:
   grass/trunk/SUBMITTING_DOCS
Log:
Change description.html references to <module.html>


Modified: grass/trunk/SUBMITTING_DOCS
===================================================================
--- grass/trunk/SUBMITTING_DOCS	2008-08-20 10:38:23 UTC (rev 32915)
+++ grass/trunk/SUBMITTING_DOCS	2008-08-20 10:58:38 UTC (rev 32916)
@@ -20,12 +20,15 @@
 
 
 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).
+   (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/description.html for an example.
+   module name. See raster/r.terraflow/r.terraflow.html for an example.
 
    Note that the parameter information is auto-generated upon
    compilation. This is done by running module in a virtual session



More information about the grass-commit mailing list