Browse Source

r.example, v.example manuals: expanded to be closer to https://trac.osgeo.org/grass/wiki/Submitting/Docs

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@73675 15284696-431f-4ddb-bdfa-cd5b030d7da7
Markus Neteler 6 years ago
parent
commit
13c24bcb9d

+ 21 - 3
doc/python/script/r.example.html

@@ -1,17 +1,35 @@
 <h2>DESCRIPTION</h2>
 
 <em>r.example</em> selects values from raster above value of mean plus
-standard deviation
+standard deviation.
+See the source code for details.
+
+<h2>NOTES</h2>
+
+Some more detailed notes go here.
+
+<h2>EXAMPLE</h2>
+
+Computing the mean and standard deviation of the raster map "elevation"
+(North Carolina sample dataset):
+
+<div class="code"><pre>
+g.region raster=elevation -p
+r.example input=elevation output=elevation_mean_stddev
+r.info elevation_mean_stddev
+</pre></div>
 
 <h2>SEE ALSO</h2>
 
 <em>
 <a href="r.univar.html">r.univar</a>,
-<a href="r.mapcalc.html">r.mapcalc</a>
+<a href="r.mapcalc.html">r.mapcalc</a>,
+<a href="v.example.html">v.example</a>
 </em>
 
+<a href="http://grass.osgeo.org/programming7/">GRASS Programmer's Manual</a>
 
-<h2>AUTHOR</h2>
+<h2>AUTHORS</h2>
 
 GRASS Development Team
 

+ 21 - 3
doc/raster/r.example/r.example.html

@@ -1,19 +1,37 @@
 <h2>DESCRIPTION</h2>
 
 <em>r.example</em> does practically do nothing, except
-for illustrating GRASS raster programming. It copies
+for illustrating GRASS GIS raster programming. It copies
 over an existing raster map to a new raster map.
 See the source code for details.
 
+<h2>NOTES</h2>
+
+Some more detailed notes go here.
+
+<h2>EXAMPLE</h2>
+
+Create a copy of the raster map "elevation"
+(North Carolina sample dataset):
+
+<div class="code"><pre>
+g.region raster=elevation -p
+r.example input=elevation output=elevation2
+r.info elevation2
+</pre></div>
+
 <h2>SEE ALSO</h2>
 
 <em>
 <a href="r.stats.html">r.stats</a>,
-<a href="http://grass.osgeo.org/programming7/">GRASS Programmer's Manual</a>
+<a href="v.example.html">v.example</a>
 </em>
 
+<em>
+<a href="https://grass.osgeo.org/programming7/">GRASS Programmer's Manual</a>
+</em>
 
-<h2>AUTHOR</h2>
+<h2>AUTHORS</h2>
 
 GRASS Development Team
 

+ 17 - 3
doc/vector/v.example/v.example.html

@@ -3,20 +3,34 @@
 <em>v.example</em> is an example vector module that does something like
 labeling all vectors with value 1. A new map is written instead of updating
 the input map.
+See the source code for details.
+
+<h2>NOTES</h2>
+
+Some more detailed notes go here.
 
 <h2>EXAMPLE</h2>
 
+Label all vectors with value 1 (North Carolina sample dataset):
+
 <div class="code"><pre>
-v.example input=map output=newmap
+v.example input=zipcodes_wake output=newmap
+v.category newmap option=report
 </pre></div>
 
 <h2>SEE ALSO</h2>
 
 <em>
-<a href="http://grass.osgeo.org/programming7/">GRASS Programmer's Manual</a>
+<a href="r.example.html">r.example</a>,
+<a href="v.category.html">r.category</a>,
+<a href="v.example.html">v.example</a>
+</em>
+
+<em>
+<a href="https://grass.osgeo.org/programming7/">GRASS Programmer's Manual</a>
 </em>
 
-<h2>AUTHOR</h2>
+<h2>AUTHORS</h2>
 
 Radim Blazek, ITC-irst, Trento, Italy