[GRASS-SVN] r30351 - grass/branches/releasebranch_6_3

Mon Feb 25 22:00:22 EST 2008

Author: epatton
Date: 2008-02-25 22:00:22 -0500 (Mon, 25 Feb 2008)
New Revision: 30351

Modified:
   grass/branches/releasebranch_6_3/SUBMITTING_DOCS
Log:
Backported submitting guidelines for html tags from TRUNK

Modified: grass/branches/releasebranch_6_3/SUBMITTING_DOCS
===================================================================

--- grass/branches/releasebranch_6_3/SUBMITTING_DOCS	2008-02-26 02:58:34 UTC (rev 30350)
+++ grass/branches/releasebranch_6_3/SUBMITTING_DOCS	2008-02-26 03:00:22 UTC (rev 30351)
@@ -1,4 +1,4 @@
-$Id$
+$Date$
 
 NOTE: Please improve this list!
 
@@ -10,12 +10,15 @@
 [ see SUBMITTING for C hints ]
 [ see SUBMITTING_SCRIPTS for shell script hints ]
 [ see SUBMITTING_TCLTK for tcl and tk hints ]
+[ see SUBMITTING_PYTHON for Python code hints ]
 
+
 1. Editing of HTML pages
    To avoid insertion of too complicated HTML tags (see also below),
    we strongly suggest to use a plain text editor rather than a
    HTML editor for editing.
 
+
 2. Module manual page:
    Place the documentation in HTML format into 'description.html'.
    The easiest way to do this is to study an existing HTML page
@@ -39,6 +42,7 @@
    The online WWW man pages is updated every Saturday (from SVN
    repository).
 
+
 3. Usage of limited HTML tags
    Since the MAN conversion of g.html2man is limited, please use
    no other HTML tags than:
@@ -46,7 +50,27 @@
    <H2> <H3> <H4>  <HEAD> <HEADER> <HR> <I> <IMG> <LI> <OL> <P>
    <PRE> <SUP> <TABLE> <TD> <TH> <TITLE> <TR> <UL>
 
-See also:
+
+4. Suggested HTML markup protocol:
+   Module names (i.e., v.category) should be emphsized with <em>,
+   and boldface <b> for flags and parameter names. Shell commands, 
+   names, values, etc. should use <tt>. Empahsized phrases should use 
+   italics <i>. The SEE ALSO section of each page should also be 
+   alphabetized. 	  		
+
+
+5. When submitting new files to the repository set SVN properties,
+   e.g. for HTML file
+    
+       svn:mime-type : text/html
+       svn:keywords : Author Date Id
+       svn:eol-style : native
+
+   See
+   http://svnbook.red-bean.com/en/1.4/svn.advanced.props.html
+
+
+6. See also
    http://grass.gdf-hannover.de/wiki/Updating_GRASS_Documentation
 
 ...

