[GRASS-SVN] r31248 - grass-addons/vector/v.colors

[svn_grass at osgeo.org]

Author: hamish
Date: 2008-05-05 03:49:13 -0400 (Mon, 05 May 2008)
New Revision: 31248

Modified:
   grass-addons/vector/v.colors/description.html
Log:
clean/update

Modified: grass-addons/vector/v.colors/description.html
===================================================================
--- grass-addons/vector/v.colors/description.html	2008-05-05 04:50:10 UTC (rev 31247)
+++ grass-addons/vector/v.colors/description.html	2008-05-05 07:49:13 UTC (rev 31248)
@@ -1,27 +1,33 @@
 <H2>DESCRIPTION</H2>
 
-<EM>v.colors</EM> is like r.colors but for vector maps.
-You give it a vector map and data column, together with color rules like
-you would do for a raster. It creates a new column in the database with
-R:G:B values suitable for use with 'd.vect -a'.
+<EM>v.colors</EM> is much like <em>r.colors</em>, but may be used for vector maps.
+You give it a vector map and numeric data column, together with color rules
+like you would do for a raster. It creates a new column in the database with
+R:G:B values suitable for use with '<tt>d.vect -a</tt>'.
 
-Hopefully it helps supplement the ongoing thematic mapping efforts.
-It is mildly tested so far and pretty simple; seems to be ~75% error
-checking code.
-
+<P>
 How it works: it creates a dummy raster map with the same data range as
-the vector's column then runs r.colors on that. Then it uses
-r.what.colors for each value found by v.db.select and uploads it to the
-DB. Better would be a C module which rendered directly instead of saving
-the colors in the DB.
+the vector's column then runs <em>r.colors</em> for that temporary map.
+It then uses <em>r.what.colors</em> for each value found by <em>v.db.select</em>
+and uploads it a new column in the vector map's attribute database.
 
-<h2>EXAMPLES</h2>
+<P>
+It is planned that this script will be replaced with a C display module which
+renders thematic vector maps directly instead requiring the overhead of
+saving the colors into the DB.
 
+<P>
+If the target column name given by the <b>rgb_column</b> option does
+not exist, it will be created. The default name is "<tt>GRASSRGB</tt>".
+
+<h2>EXAMPLE</h2>
+
 Colorizing a TIN generated by <em>v.delaunay</em>:
 
 <div class="code"><pre>
 # new columns for x,y,z of centroids
-v.db.addtable tin col="east double precision, north double precision, height double precision, GRASSRGB varchar(11)"
+v.db.addtable map=tin \
+   columns="east double precision, north double precision, height double precision, GRASSRGB varchar(11)"
 
 # transfer geometry for colorizing (we need the centroid height)
 v.to.db tin opt=coor col="east,north,height"
@@ -37,9 +43,20 @@
 
 <H2>SEE ALSO</H2>
 
-<EM><A HREF="r.colors.html">colors</A></EM>
+<EM>
+<A HREF="r.colors.html">r.colors</A><BR>
+<A HREF="r.what.color.html">r.what.color</A><BR>
+<A HREF="v.db.addcol">v.db.addcol</A><BR>
+<A HREF="v.db.select.html">v.db.select</A><BR>
+<A HREF="db.execute.html">db.execute</A>
+</EM>
 
+
+
 <H2>AUTHOR</H2>
 
-Hamish Bowman
-<p><i>Last changed: $Date: 2006-09-07 11:38:05 +0200 (Thu, 07 Sep 2006) $</i>
+Hamish Bowman<BR>
+<i>Dunedin, New Zealand</i>
+
+<p>
+<i>Last changed: $Date: 2006-09-07 11:38:05 +0200 (Thu, 07 Sep 2006) $</i>