[GRASS-SVN] r70419 - grass-addons/grass7/vector/v.profile

[svn_grass at osgeo.org]

Author: neteler
Date: 2017-01-23 09:37:24 -0800 (Mon, 23 Jan 2017)
New Revision: 70419

Modified:
   grass-addons/grass7/vector/v.profile/v.profile.html
Log:
v.profile addon manual: English fixes; reformatted according to https://trac.osgeo.org/grass/wiki/Submitting/Docs

Modified: grass-addons/grass7/vector/v.profile/v.profile.html
===================================================================
--- grass-addons/grass7/vector/v.profile/v.profile.html	2017-01-23 11:47:13 UTC (rev 70418)
+++ grass-addons/grass7/vector/v.profile/v.profile.html	2017-01-23 17:37:24 UTC (rev 70419)
@@ -1,26 +1,27 @@
 <h2>DESCRIPTION</h2>
 
-<p>This module will print out distance and attributes of points/lines
+<em>v.profile</em> prints out distance and attributes of points/lines
 along a profiling line. Distance is calculated from the first profiling line
 coordinate pair or from the beginning of vector line.<br>
-Buffer (tolerance) parameter sets how far point can be
-located from profiling line and still be included in output data set.<br>
-Output map option can be used to visually check which points are
-profiled. Buffer (tolerance) setting does not affect lines. Lines are
-sampled at their crossing point with profiling line.<br>
-By default Z values are printed if input vector is a 3D map. It can be disabled with
--z flag.<br>
-Profiling line can be provided as N,E coordinate pairs or can
-come from input vector map. As currently profiling line must be single
-line, one should use profile_where parameter to select single line from
-profile input map if it contains multiple features.</p>
+The <em>buffer</em> (tolerance) parameter sets how far point can be
+located from a profiling line and still be included in the output data set.<br>
+The <em>output</em> map option can be used to visually check which points are
+profiled. The <em>buffer</em> (tolerance) setting does not affect lines.
+Lines are sampled at their crossing point with profiling line.
+<p>
+By default Z values are printed if input vector is a 3D map. It can be
+disabled with the <b>-z</b> flag.<br>
+The profiling line can be provided as N,E coordinate pairs or from an
+input vector map. As a profiling line must be a single line, the user
+should use the <em>profile_where</em> parameter to select a single line
+from a profile input map if it contains multiple vector features.
 
-<h2>NOTE</h2>
+<h2>NOTES</h2>
 
-<p>Currently module can profile only points and lines (including 3D ones).
-Areas and other complex features are not supported. If one can provide
-reasonable examples how area sampling should work and why it is
-important, area (or any other feature type) sampling can be added.</p>
+Currently the module can profile only points and lines (including 3D ones).
+Areas and other complex features are not supported. If in future users can
+provide reasonable examples how area sampling should work and why it is
+important, area (or any other feature type) sampling can be added.
 
 <h2>EXAMPLES</h2>
 
@@ -30,12 +31,13 @@
 that are within 100m range to profiling line (Spearfish dataset).
 
 <div class="code"><pre>
+# Spearfish sample dataset
 v.profile input=archsites map_output=profiling_line buffer=100 \
           east_north=591518.55,4925722.38,592110.14,4920989.67 \
 	  output=archsites_distance.csv dp=3 separator=comma
 
 # Now let's see the output:
-$ cat archsites_distance.csv
+cat archsites_distance.csv
 Number,Distance,cat,str1
 1,446.958,24,"Hanson Ranch"
 2,1386.149,11,"No Name"
@@ -50,6 +52,7 @@
 # Take elevation samples
 r.profile input=elevation.dem at PERMANENT output=/home/user/elevation.profile \
   profile=600570.27364,4920613.41838,600348.034348,4920840.38617
+
 # Now get distance to place where river marker should be set
 v.profile input=streams at PERMANENT output=river_profile.csv \
   east_north=600570.27364,4920613.41838,600348.034348,4920840.38617
@@ -57,19 +60,21 @@
 
 <h2>BUGS</h2>
 
-<p>Strings are enclosed in double quotes ", still quotes within string are
-not escaped.</p>
+Strings are enclosed in double quotes ", still quotes within string are
+not escaped.
 <p>
 Output does not contain Vector CAT values. Only way how to get CAT value is from
-the attribute table.</p>
+the attribute table.
 <p>If sampled feature (point, line) contains multiple attribute entries
 (has multiple CAT values), only the first one is reported. If this is a
-limitation in some practical use case, open a feature request in GRASS GIS
-issue tracker.</p>
+limitation in some practical use case, a feature request in GRASS GIS
+issue tracker should be opened.
 
 <h2>SEE ALSO</h2>
 
+<em>
 <a href="r.profile.html">r.profile</a>
+</em>
 
 <h2>AUTHOR</h2>