Browse Source

d.linegraph manual: language fixes

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@69648 15284696-431f-4ddb-bdfa-cd5b030d7da7
Markus Neteler 8 years ago
parent
commit
fb015eaca0
1 changed files with 36 additions and 33 deletions
  1. 36 33
      display/d.linegraph/d.linegraph.html

+ 36 - 33
display/d.linegraph/d.linegraph.html

@@ -1,6 +1,6 @@
 <h2>DESCRIPTION</h2>
 <h2>DESCRIPTION</h2>
 
 
-<em>d.linegraph</em> is a primitive program to draw simple x,y line graphs
+<em>d.linegraph</em> is a module to draw simple x,y line graphs
 (plots) based on numerical data contained in separate files.
 (plots) based on numerical data contained in separate files.
 
 
 
 
@@ -22,12 +22,11 @@ deceptive.
 
 
 <h3>File inputs</h3>
 <h3>File inputs</h3>
 
 
-<p>
-If <b>directory</b> option is provided, the paths to files can (and
-should) be only relative paths to the files. This is not recommended
-for scripting, but it can be advantageous when typing the paths
-manually. For example when all the files are stored in the directory
-<tt>/home/john/data</tt>, use can provide the following in the command
+If the <b>directory</b> option is provided, the paths to files can (and
+should) be only relative paths to these files. WHile this is not recommended
+for scripting, it can be advantageous when typing the paths
+manually. For example when all files are stored in the directory
+<tt>/home/john/data</tt>, the user can provide the following in the command
 line:
 line:
 
 
 <div class="code"><pre>
 <div class="code"><pre>
@@ -37,35 +36,35 @@ d.linegraph directory=/home/john/data x_file=x.txt y_file=y1.txt,y2.txt
 
 
 <h3>Managing colors</h3>
 <h3>Managing colors</h3>
 
 
-User can specify the <b>y_color</b> option, the <b>color_table</b>
+The user can specify the <b>y_color</b> option, the <b>color_table</b>
 option or just leave the defaults to influence the color of the
 option or just leave the defaults to influence the color of the
 plotted lines.
 plotted lines.
 
 
 <p>
 <p>
-Color specified by <b>y_color</b> option is used for drawing the lines
+Colors specified by <b>y_color</b> option are used for drawing the lines
 in the graph. If multiple Y data files are used, an equal number of
 in the graph. If multiple Y data files are used, an equal number of
 colors may be used to control the colors of the lines. Colors will be
 colors may be used to control the colors of the lines. Colors will be
 assigned to Y data in respect to the sequence of instantiation on the
 assigned to Y data in respect to the sequence of instantiation on the
 command line. It can be one of GRASS GIS named colors or the RGB
 command line. It can be one of GRASS GIS named colors or the RGB
-values from 0-255 separated by colon.
+values from 0-255 separated by colons (RRR:GGG:BBB).
 
 
 <p>
 <p>
-Alternatively, user can use <b>color_table</b> option to specify one
+Alternatively, the user can use the <b>color_table</b> option to specify one
 of the GRASS GIS predefined color tables.
 of the GRASS GIS predefined color tables.
 
 
 <p>
 <p>
-By default, a series of colors will be chosen by the program if none are
-provided upon invocation. Order of default colors is red, green,
-violet, blue, orange, gray, brown, magenta, white, and indigo. User is
-advised not to rely on the order of default colors and use <b>y_color</b>
-or <b>color_table</b> option to obtain predictable and reproducible
-results.
+By default, a series of colors will be chosen by the module if none are
+provided upon invocation. The order of default colors is red, green,
+violet, blue, orange, gray, brown, magenta, white, and indigo. The user is
+advised not to rely on the order of default colors but to either use the
+<b>y_color</b> or the <b>color_table</b> option to obtain predictable and
+reproducible results.
 
 
 <p>
 <p>
 The color to be used for titles, axis lines, tics, and scale numbers
 The color to be used for titles, axis lines, tics, and scale numbers
-is determined by the <b>title_color</b> option.
-User can provide one of the GRASS GIS named colors (such as gray, white, or black)
-or use the GRASS GIS colon-separated format for RGB.
+is determined by the <b>title_color</b> option. The user can provide
+one of the GRASS GIS named colors (such as gray, white, or black)
+or use the GRASS GIS colon-separated format for RGB (RRR:GGG:BBB).
 
 
 <h3>Titles, labels, and tics</h3>
 <h3>Titles, labels, and tics</h3>
 
 
@@ -90,24 +89,27 @@ placement using the <em><a href="d.text.html">d.text</a></em> or
 
 
 For historical reasons, the <em>d.linegraph</em> module accepts
 For historical reasons, the <em>d.linegraph</em> module accepts
 titles of more than one word where the underscore character ("_")
 titles of more than one word where the underscore character ("_")
-is used to represent spaces (" "). For example "Census_data_1990"
-would be printed over the graph as "Census data 1990". This is not
+is used to represent spaces (" "). For example "Census_data_1990" would be
+printed over the graph as "Census data 1990". The use of underscores is not
 necessary to use as long as the parameter is quoted in the command line.
 necessary to use as long as the parameter is quoted in the command line.
-In general, this is not recommended to use and there is no need to use
-it at all in Python or GUI.
+In general, use of underscores is not recommended and there is no need to use
+it at all in the GUI or when using <em>d.linegraph</em> in Python scripts.
 
 
 <p>
 <p>
-The way the program locates and labels tic marks is less than perfect: 1)
-although distances between Y tics is proportional to the value, they are
-not proportional on the X axis; 2) decimal values between -1 and 1 can be
-printed on the X axis, but not on Y. (With respect to the later, the input
-for Y values can all be multiplied by a factor of 10 before graphing).
+The way the program locates and labels tic marks is less than perfect:
+<br>
+1) although distances between Y tics is proportional to the value, they are
+not proportional on the X axis;
+<br>
+2) decimal values between -1 and 1 can be printed on the X axis, but not
+on Y. (With respect to the later, the input for Y values can all be
+multiplied by a factor of 10 before graphing).
 
 
 <p>
 <p>
-Depending on the user needs, it might be easier or more appropriate
+Depending on the user's needs, it might be easier or more appropriate
 to use a 3rd party tool such as xgraph, gnuplot, Matplotlib in Python,
 to use a 3rd party tool such as xgraph, gnuplot, Matplotlib in Python,
 or R instead of <em>d.linegraph</em>.
 or R instead of <em>d.linegraph</em>.
-For a more general solution for plotting in GRASS GIS, user is
+For a more general solution for plotting in GRASS GIS, the user is
 advised to use the <em><a href="d.graph.html">d.graph</a></em> module.
 advised to use the <em><a href="d.graph.html">d.graph</a></em> module.
 
 
 
 
@@ -147,8 +149,9 @@ d.mon start=cairo output=plot.png width=400 height=400 --o
 d.erase  # previous image is not cleaned
 d.erase  # previous image is not cleaned
 -->
 -->
 
 
-The series of commands creates a file <tt>plot.png</tt> in the current
-directory which is the drawing make by <em>d.linegraph</em>.
+<p>
+The next command sequence creates a file <tt>plot.png</tt> in the current
+directory which is the drawing made by <em>d.linegraph</em>.
 
 
 <div class="code"><pre>
 <div class="code"><pre>
 d.mon start=cairo output=plot.png width=400 height=400
 d.mon start=cairo output=plot.png width=400 height=400