Changeset 58319

Timestamp:

Nov 27, 2013, 12:59:34 PM (11 years ago)

Author:

neteler

Message:

g.parser manual: GUI window screenshot added to example

Location:

grass/branches/releasebranch_6_4/general/g.parser

Files:

• . (modified) (1 prop)
• Makefile (modified) (1 diff)
• description.html (modified) (6 diffs)
• g_parser_test.png (added)

grass/branches/releasebranch_6_4/general/g.parser

@@ +1 @@
+OBJ.*
 *.tmp.html
-*OBJ*

@@ +1 @@
+OBJ.*
 *.tmp.html
-*OBJ*

grass/branches/releasebranch_6_4/general/g.parser/Makefile

@@ -9 +9 @@
 
 default: cmd
+        $(INSTALL_DATA) g_parser_test.png $(HTMLDIR)/g_parser_test.png
 
-#hardcoded here, this is an exeption due to the g.parser specialities:
+#FIXME: please comment or file bug reports instead of just quietly
+#  bypassing portability problems with a ifneq(). otherwise underlying
+#  problems never get fixed. thanks
 ifneq ($(MSYSTEM),MINGW32)
+
+# hardcoded here, this is an exeption due to the g.parser specialities:
 htmlcmd:
         $(MAKE) $(HTMLDIR)/$(PGM).html HTMLSRC=
+
 endif

grass/branches/releasebranch_6_4/general/g.parser/description.html

@@ -13 +13 @@
 <em><b>g.parser</b></em>
 
+<h2>SYNOPSIS</h2>
+<b>g.parser help</b><br>
+<b>g.parser</b> [-<b>s</b>] [-<b>t</b>] <em>filename</em> [<em>argument</em>,...]
+
+<h3>Flags:</h3>
+<dl>
+<dt><b>-t</b></dt>
+<dd>Print strings for translation</dd>
+<dt><b>-s</b></dt>
+<dd>Write option values to stdout instead of reinvoking script</dd>
+</dl>
+
 <h2>DESCRIPTION</h2>
 
@@ -49 +61 @@
 <div class="code"><pre>
 #%module
-#%  description: g.parser test script   
+#% description: g.parser test script   
 #%end
 #%flag
-#%  key: f
-#%  description: A flag
-#%end
-#%option
-#%  key: raster
-#%  type: string
-#%  gisprompt: old,cell,raster
-#%  description: Raster input map
-#%  required : yes
-#%end
-</pre></div>
-
-<h2>SYNOPSIS</h2>
-<b>g.parser help</b><br>
-<b>g.parser</b> [-<b>s</b>] [-<b>t</b>] <em>filename</em> [<em>argument</em>,...]
-
-<h3>Flags:</h3>
-<dl>
-<dt><b>-t</b></DT>
-<dd>Print strings for translation</DD>
-<dt><b>-s</b></DT>
-<dd>Write option values to stdout instead of reinvoking script</DD>
-</dl>
+#% key: f
+#% description: A flag
+#%end
+#%option
+#% key: raster
+#% type: string
+#% gisprompt: old,cell,raster
+#% description: Raster input map
+#% required : yes
+#%end
+</pre></div>
 
 <h2>NOTES</h2>
@@ -177 +177 @@
 <h2>EXAMPLES</h2>
 
+All examples below autogenerate the graphical user interface when invoked
+without parameters of flags:
+
+<p>
+<img src="g_parser_test.png" alt="Autogenerated GUI window">
+
 <h3>Example code for SHELL</h3>
 
@@ -238 +244 @@
 echo "Value of GIS_OPT_VECTOR: '$GIS_OPT_VECTOR'"
 
+</pre></div>
+
+To run properly, the script needs to be copied into $GISBASE/scripts/
+with the executable flag being set. The script will provide a GUI
+(as above) and the following usage help text:
+
+<div class="code"><pre>
+test.sh --help
+
+Description:
+ g.parser test script (python)
+
+Usage:
+ test.sh [-f] raster=string vector=string [option1=string]
+   [--verbose] [--quiet]
+
+Flags:
+  -f   A flag
+ --v   Verbose module output
+ --q   Quiet module output
+
+Parameters:
+   raster   Raster input map
+   vector   Vector input map
+  option1   An option
 </pre></div>
 
@@ -309 +340 @@
 </pre></div>
 
-The <tt>test.py</tt> script will provide following help text:
+The <tt>test.py</tt> script will provide a GUI (as above) and the
+following usage help text:
 
 <div class="code"><pre>
@@ -414 +446 @@
   <a href="g.filename.html">g.filename</a>,
   <a href="g.findfile.html">g.findfile</a>,
-  <a href="g.tempfile.html">g.tempfile</a>,
+  <a href="g.tempfile.html">g.tempfile</a>
 </em>
 

@@ +1 @@
+OBJ.*
 *.tmp.html
-*OBJ*