[mapserver-commits] r8078 - in trunk/docs/references: . output
symbology
svn at osgeo.org
svn at osgeo.org
Mon Nov 24 14:12:29 EST 2008
Author: hobu
Date: 2008-11-24 14:12:29 -0500 (Mon, 24 Nov 2008)
New Revision: 8078
Modified:
trunk/docs/references/index.txt
trunk/docs/references/output/agg.txt
trunk/docs/references/output/antialias.txt
trunk/docs/references/output/dynamic_charting.txt
trunk/docs/references/output/flash.txt
trunk/docs/references/output/html_legend.txt
trunk/docs/references/output/imagemaps.txt
trunk/docs/references/output/pdf.txt
trunk/docs/references/output/svg.txt
trunk/docs/references/output/tile_mode.txt
trunk/docs/references/symbology/construction.txt
trunk/docs/references/symbology/examples.txt
trunk/docs/references/symbology/notes.txt
trunk/docs/references/symbology/syntax.txt
Log:
output section
Modified: trunk/docs/references/index.txt
===================================================================
--- trunk/docs/references/index.txt 2008-11-24 17:23:54 UTC (rev 8077)
+++ trunk/docs/references/index.txt 2008-11-24 19:12:29 UTC (rev 8078)
@@ -10,5 +10,6 @@
mapfile/index
mapscript/index
+ output/index
ogc/index
Modified: trunk/docs/references/output/agg.txt
===================================================================
--- trunk/docs/references/output/agg.txt 2008-11-24 17:23:54 UTC (rev 8077)
+++ trunk/docs/references/output/agg.txt 2008-11-24 19:12:29 UTC (rev 8078)
@@ -8,8 +8,6 @@
:Date: $Date$
:Last Updated: 2007/08/21
-.. sectnum::
-
.. contents:: Table of Contents
:depth: 2
:backlinks: top
Modified: trunk/docs/references/output/antialias.txt
===================================================================
--- trunk/docs/references/output/antialias.txt 2008-11-24 17:23:54 UTC (rev 8077)
+++ trunk/docs/references/output/antialias.txt 2008-11-24 19:12:29 UTC (rev 8078)
@@ -8,8 +8,6 @@
:Date: $Date$
:Last Updated: 2007/02/04
-.. sectnum::
-
.. contents:: Table of Contents
:depth: 2
:backlinks: top
@@ -22,53 +20,53 @@
::
-MAP
- ...
- IMAGETYPE PNG24
- ...
-END
+ MAP
+ ...
+ IMAGETYPE PNG24
+ ...
+ END
-2. Add TRANSPARENCY to the LAYER object and set value to ALPHA<br>
+2. Add TRANSPARENCY to the LAYER object and set value to ALPHA
::
-MAP
- ...
- IMAGETYPE PNG24
- ...
+ MAP
+ ...
+ IMAGETYPE PNG24
+ ...
- LAYER
- ...
- TRANSPARENCY ALPHA
- ...
- END
-END
+ LAYER
+ ...
+ TRANSPARENCY ALPHA
+ ...
+ END
+ END
3. Add ANTIALIAS keyword to the STYLE object within the CLASS object within the LAYER and set value to TRUE
::
-MAP
- ...
- IMAGETYPE PNG24
- ...
+ MAP
+ ...
+ IMAGETYPE PNG24
+ ...
- LAYER
- ...
- TRANSPARENCY ALPHA
- ...
- CLASS
- ...
- STYLE
+ LAYER
...
- ANTIALIAS TRUE
+ TRANSPARENCY ALPHA
...
- END
- \.\.\.
- END # end class
- END # end layer
-END # end map
+ CLASS
+ ...
+ STYLE
+ ...
+ ANTIALIAS TRUE
+ ...
+ END
+ \.\.\.
+ END # end class
+ END # end layer
+ END # end map
Tips: Don't use the SYMBOL or the SIZE keywords within the CLASS object,
instead use WIDTH to specify width of line or polygon outline. Don't use
@@ -79,101 +77,103 @@
::
-MAP
- NAME 'ms101'
- EXTENT -2198022.00 -2444920.25 2707932.00 1234545.25 # CONUS LAEA (US)
- SIZE 640 480
- SHAPEPATH 'data'
- SYMBOLSET 'symbols/symbols.txt'
+ MAP
+ NAME 'ms101'
+ EXTENT -2198022.00 -2444920.25 2707932.00 1234545.25 # CONUS LAEA (US)
+ SIZE 640 480
+ SHAPEPATH 'data'
+ SYMBOLSET 'symbols/symbols.txt'
- IMAGETYPE PNG24
+ IMAGETYPE PNG24
- PROJECTION
- "init=epsg:2163"
- END
+ PROJECTION
+ "init=epsg:2163"
+ END
- # The layer below will be rendered as 1-pixel wide, antialiased line
- # If you'd like to change the line thickness add the WIDTH keyword
- # in the STYLE object with a value of 3 or greater.
- LAYER # begin antialiased country boundary (line) layer
- NAME 'country_line'
- DATA 'shapefile/WorldCountryBorders'
- TYPE LINE
- STATUS ON
- TRANSPARENCY ALPHA
+ # The layer below will be rendered as 1-pixel wide, antialiased line
+ # If you'd like to change the line thickness add the WIDTH keyword
+ # in the STYLE object with a value of 3 or greater.
+ LAYER # begin antialiased country boundary (line) layer
+ NAME 'country_line'
+ DATA 'shapefile/WorldCountryBorders'
+ TYPE LINE
+ STATUS ON
+ TRANSPARENCY ALPHA
- PROJECTION
- "init=epsg:4326"
- END
+ PROJECTION
+ "init=epsg:4326"
+ END
- CLASS
- NAME 'Country Boundary'
- STYLE
- COLOR 96 96 96
- ANTIALIAS TRUE
- END
- END
- END # end country boundary layer
+ CLASS
+ NAME 'Country Boundary'
+ STYLE
+ COLOR 96 96 96
+ ANTIALIAS TRUE
+ END
+ END
+ END # end country boundary layer
- # The layer below shows one way to draw a polygon with antialiased outline
- LAYER # begin antialiased country boundary (polygon) layer
- NAME 'country_line'
- DATA 'shapefile/Countries_area'
- TYPE POLYGON
- STATUS ON
- TRANSPARENCY ALPHA
+ # The layer below shows one way to draw a polygon with antialiased outline
+ LAYER # begin antialiased country boundary (polygon) layer
+ NAME 'country_line'
+ DATA 'shapefile/Countries_area'
+ TYPE POLYGON
+ STATUS ON
+ TRANSPARENCY ALPHA
- PROJECTION
- "init=epsg:4326"
- END
+ PROJECTION
+ "init=epsg:4326"
+ END
- CLASS
- NAME 'Country Boundary'
- STYLE
- COLOR 212 212 212
- OUTLINECOLOR 96 96 96
- WIDTH 3
- ANTIALIAS TRUE
- END
- END
- END # end country boundary polygon layer
+ CLASS
+ NAME 'Country Boundary'
+ STYLE
+ COLOR 212 212 212
+ OUTLINECOLOR 96 96 96
+ WIDTH 3
+ ANTIALIAS TRUE
+ END
+ END
+ END # end country boundary polygon layer
- # The layer below shows one way to draw a polygon with antialiased outline
- LAYER # begin antialiased state boundary (line) layer
- NAME 'state_line'
- DATA 'shapefile/us_states'
- TYPE LINE
- STATUS ON
- TRANSPARENCY ALPHA
+ # The layer below shows one way to draw a polygon with antialiased outline
+ LAYER # begin antialiased state boundary (line) layer
+ NAME 'state_line'
+ DATA 'shapefile/us_states'
+ TYPE LINE
+ STATUS ON
+ TRANSPARENCY ALPHA
- PROJECTION
- "init=epsg:4326"
- END
+ PROJECTION
+ "init=epsg:4326"
+ END
- CLASS
- NAME 'State Boundary'
- STYLE
- COLOR 144 144 144
- SYMBOL 'cartoline'
- ANTIALIAS TRUE
- END
+ CLASS
+ NAME 'State Boundary'
+ STYLE
+ COLOR 144 144 144
+ SYMBOL 'cartoline'
+ ANTIALIAS TRUE
+ END
+ END
+ END # end state line layer
+ END # end of map file
+
+Here's how the 'cartoline' symbol is defined:
+
+::
+
+ SYMBOL
+ NAME 'cartoline'
+ TYPE CARTOLINE
+ LINECAP round
+ LINEJOIN round
+ LINEJOINMAXSIZE 3
END
- END # end state line layer
-END # end of map file</PRE>
-</p>
-<p>Here's how the 'cartoline' symbol is defined:<br>
-<PRE>SYMBOL
- NAME 'cartoline'
- TYPE CARTOLINE
- LINECAP round
- LINEJOIN round
- LINEJOINMAXSIZE 3
-END</PRE><br>
+.. note:: The examples provided here are for illustrative purposes
+ only--keep your map file definitions simple. Antialiasing adds computing
+ overhead on the server and could slow/degrade its performance. Don't use
+ it unless you must and certainly don't use symbols with it unless you really
+ have to.
-.. note: The examples provided here are for illustrative purposes
-only--keep your map file definitions simple. Antialiasing adds computing
-overhead on the server and could slow/degrade its performance. Don't use
-it unless you must and certainly don't use symbols with it unless you really
-have to.
-
Modified: trunk/docs/references/output/dynamic_charting.txt
===================================================================
--- trunk/docs/references/output/dynamic_charting.txt 2008-11-24 17:23:54 UTC (rev 8077)
+++ trunk/docs/references/output/dynamic_charting.txt 2008-11-24 19:12:29 UTC (rev 8078)
@@ -8,8 +8,6 @@
:Date: $Date$
:Last Updated: 2007/10/23
-.. sectnum::
-
.. contents:: Table of Contents
:depth: 2
:backlinks: top
@@ -37,8 +35,8 @@
Output from AGG and GD Renderers
-.. image:: renderer-agg.png
-.. image:: gd-renderer.png
+.. image:: ../../images/renderer-agg.png
+.. image:: ../../images/gd-renderer.png
Adding a Chart Layer to a Mapfile
@@ -52,11 +50,11 @@
::
-LAYER
-...
- TYPE CHART
+ LAYER
...
-END
+ TYPE CHART
+ ...
+ END
No other specific keywords have been added in order to keep the number of
different keywords to a minimum in the mapfile syntax, therefore all the
@@ -72,12 +70,12 @@
::
-LAYER
- TYPE CHART
- PROCESSING "CHART_SIZE=21" # specify size of the chart for pie or bar graphs
- #PROCESSING "CHART_SIZE=20 10" # specify width and height for bar graphs
- ...
-END
+ LAYER
+ TYPE CHART
+ PROCESSING "CHART_SIZE=21" # specify size of the chart for pie or bar graphs
+ #PROCESSING "CHART_SIZE=20 10" # specify width and height for bar graphs
+ ...
+ END
For those living on the bleeding edge, the diameter of a pie chart can be bound
to an attribute starting from trunk version of 2007-10-20. Details located at http://trac.osgeo.org/MapServer/ticket/2136
@@ -95,24 +93,24 @@
::
-LAYER
-...
- CLASS
- # include a NAME keyword if you want this class to be included
- # in the legend
- NAME "value 1"
- STYLE
- # specify which value from the data source will be used as the
- # value for the graph
- SIZE [attribute]
+ LAYER
+ ...
+ CLASS
+ # include a NAME keyword if you want this class to be included
+ # in the legend
+ NAME "value 1"
+ STYLE
+ # specify which value from the data source will be used as the
+ # value for the graph
+ SIZE [attribute]
+ ...
+ END
+ END
+ CLASS
...
END
+ ...
END
- CLASS
- ...
- END
-...
-END
At least 2 CLASS blocks must be specified before charting can occur (but
you already knew this if you want your charts to convey at least *some*
@@ -127,23 +125,23 @@
::
-STYLE
- SIZE [attribute]
- # specify the fill color
- COLOR r g b
+ STYLE
+ SIZE [attribute]
+ # specify the fill color
+ COLOR r g b
- # if present will draw an outline around the corresponding bar or slice
- OUTLINECOLOR r g b
+ # if present will draw an outline around the corresponding bar or slice
+ OUTLINECOLOR r g b
- #specify the width of the outline if OUTLINECOLOR is present (defaults to 1)
- WIDTH w
+ #specify the width of the outline if OUTLINECOLOR is present (defaults to 1)
+ WIDTH w
- # only for pie charts. 'a' is the number of pixels the corresponding
- # slice will be offset relative to the center of the pie. This is useful
- # for emphasizing a specific value in each chart. 'b' is required by the
- # mapfile parser but is ignored.
- OFFSET a b
-END
+ # only for pie charts. 'a' is the number of pixels the corresponding
+ # slice will be offset relative to the center of the pie. This is useful
+ # for emphasizing a specific value in each chart. 'b' is required by the
+ # mapfile parser but is ignored.
+ OFFSET a b
+ END
Pie Charts
-------------------------------------------------------------------------------
@@ -153,7 +151,7 @@
::
-PROCESSING "CHART_TYPE=PIE"
+ PROCESSING "CHART_TYPE=PIE"
For each shape in the layer's datasource, the STYLE SIZE is used to set
the relative size (value) of each pie slice, with the angles of the slices
@@ -161,37 +159,37 @@
::
-LAYER
- NAME "Ages"
- TYPE CHART
- CONNECTIONTYPE postgis
- CONNECTION "blabla"
- DATA "the_geom from demo"
- PROCESSING "CHART_TYPE=pie"
- PROCESSING "CHART_SIZE=30"
- STATUS ON
- CLASS
- NAME "Population Age 0-19"
- STYLE
- SIZE [v1006]
- COLOR 255 244 237
+ LAYER
+ NAME "Ages"
+ TYPE CHART
+ CONNECTIONTYPE postgis
+ CONNECTION "blabla"
+ DATA "the_geom from demo"
+ PROCESSING "CHART_TYPE=pie"
+ PROCESSING "CHART_SIZE=30"
+ STATUS ON
+ CLASS
+ NAME "Population Age 0-19"
+ STYLE
+ SIZE [v1006]
+ COLOR 255 244 237
+ END
END
- END
- CLASS
- NAME "Population Age 20-39"
- STYLE
- SIZE [v1007]
- COLOR 255 217 191
+ CLASS
+ NAME "Population Age 20-39"
+ STYLE
+ SIZE [v1007]
+ COLOR 255 217 191
+ END
END
- END
- CLASS
- NAME "Population Age 40-59"
- STYLE
- SIZE [v1008]
- COLOR 255 186 140
+ CLASS
+ NAME "Population Age 40-59"
+ STYLE
+ SIZE [v1008]
+ COLOR 255 186 140
+ END
END
END
-END
In the example above, if for a given shape we have v1006=1000, v1007=600 and
v1008=400 then the actual pie slices for each class will be respectively
@@ -204,7 +202,7 @@
::
-PROCESSING "CHART_TYPE=BAR"
+ PROCESSING "CHART_TYPE=BAR"
For each shape in the layer's datasource, the STYLE SIZE is used to set the
relative size (value) of each bar in the graph. By default, the vertical axis
@@ -224,12 +222,12 @@
::
-PROCESSING "CHART_BAR_MINVAL=val"
-PROCESSING "CHART_BAR_MAXVAL=val"
+ PROCESSING "CHART_BAR_MINVAL=val"
+ PROCESSING "CHART_BAR_MAXVAL=val"
Values in the datasource that are above CHART_BAR_MAXVAL or below
CHART_BAR_MINVAL will be clipped respectively to these values. If only one of
these directives is included, the other will be automatically adjusted for
each shape to include at least the origin, i.e. the graphs for all the
-shapes will be in the same scale <i>only if </i>all the values are of the
+shapes will be in the same scale *only if* all the values are of the
same sign (positive or negative).
\ No newline at end of file
Modified: trunk/docs/references/output/flash.txt
===================================================================
--- trunk/docs/references/output/flash.txt 2008-11-24 17:23:54 UTC (rev 8077)
+++ trunk/docs/references/output/flash.txt 2008-11-24 19:12:29 UTC (rev 8078)
@@ -10,8 +10,6 @@
:Date: $Date$
:Last Updated: 2008/07/15
-.. sectnum::
-
.. contents:: Table of Contents
:depth: 2
:backlinks: top
Modified: trunk/docs/references/output/html_legend.txt
===================================================================
--- trunk/docs/references/output/html_legend.txt 2008-11-24 17:23:54 UTC (rev 8077)
+++ trunk/docs/references/output/html_legend.txt 2008-11-24 19:12:29 UTC (rev 8078)
@@ -8,8 +8,6 @@
:Date: $Date$
:Last Updated: 2006/01/09
-.. sectnum::
-
.. contents::
:depth: 2
:backlinks: top
Modified: trunk/docs/references/output/imagemaps.txt
===================================================================
--- trunk/docs/references/output/imagemaps.txt 2008-11-24 17:23:54 UTC (rev 8077)
+++ trunk/docs/references/output/imagemaps.txt 2008-11-24 19:12:29 UTC (rev 8078)
@@ -8,8 +8,6 @@
:Date: $Date$
:Last Updated: 2008/10/08
-.. sectnum::
-
.. contents::
:depth: 2
:backlinks: top
@@ -18,7 +16,12 @@
Introduction
============
-The shpxy method of creating imagemaps uses MapServer query functionality to build a html imagemap. Just like a regular MapServer query, you send a query request and MapServer uses the templates to build a block of html that it sends back to the browser. The first example shows you how to build an imagemap based on a point layer. An example template for a polygon layer is also included.
+The shpxy method of creating imagemaps uses MapServer query functionality to
+build a html imagemap. Just like a regular MapServer query, you send a query
+request and MapServer uses the templates to build a block of html that it sends
+back to the browser. The first example shows you how to build an imagemap
+based on a point layer. An example template for a polygon layer is also
+included.
**Components**
@@ -69,30 +72,39 @@
END
-You can see that we have a mapfile with one point layer, and that it contains references to three query templates.
+You can see that we have a mapfile with one point layer, and that it
+contains references to three query templates.
Templates
==============================
-In MapServer, the query header and footers get processed only once. The main query template, 'bodytemplate.html' in this example, gets processed once for each record in the record set returned by the query.
+In MapServer, the query header and footers get processed only once. The
+main query template, 'bodytemplate.html' in this example, gets processed
+once for each record in the record set returned by the query.
Point Layers
-------------
-Here is the query header, 'imapheader.html'. It creates the opening tag for your html imagemap.
+Here is the query header, 'imapheader.html'. It creates the opening tag
+for your html imagemap.
::
<map id="mymap" name="mymap">
-Here is the query template, 'bodytemplate.html'. It creates the body of the html imagemap.
+Here is the query template, 'bodytemplate.html'. It creates the body of
+the html imagemap.
::
<area shape="circle" coords="[shpxy precision=0 proj=image yf=",7" xf=","]" href="http://my.url/mypage.cfm?region=[NAME]" title="[NAME]" alt="[NAME]">
- This template is used to create circular imagemap elements for a point layer. NAME is a fieldname in the data source, the value for NAME for each individual record gets substituted as the template is processed. The href specifies the URL link if the element is clicked. Title and alt will display the value when an element is moused over.
+This template is used to create circular imagemap elements for a point layer.
+NAME is a fieldname in the data source, the value for NAME for each
+individual record gets substituted as the template is processed. The
+href specifies the URL link if the element is clicked. Title and alt will
+display the value when an element is moused over.
The resulting html element looks like
@@ -108,9 +120,13 @@
coords="[shpxy precision=0 proj=image xf="," yf=",7"]"
-This is where MapServer will substitute the image coordinates for that query record. With Precision=0, the coordinates will be integers.
+This is where MapServer will substitute the image coordinates for that
+query record. With Precision=0, the coordinates will be integers.
-You also see shpxy template formatting options 'xf' and 'yf'. 'xf="," tells MapServer to place a comma after the x coordinate. 'yf=",7" after the y coordinate. This is done to specify a radius of 7 pixels for the circle. More options can be found in the `MapServer Template Reference`_ .
+You also see shpxy template formatting options 'xf' and 'yf'. 'xf=","
+tells MapServer to place a comma after the x coordinate. 'yf=",7" after
+the y coordinate. This is done to specify a radius of 7 pixels for the
+circle. More options can be found in the `MapServer Template Reference`_ .
The query footer template simply adds the closing tag for the html imagemap
@@ -132,7 +148,10 @@
Request URL
==============================
-To get the imagemap, you need to send a GET or POST request to MapServer with several URL variables defined. The below URL tells MapServer where the mapfile is located, what layer we are querying, and that we are using nquery mode to return multiple results.
+To get the imagemap, you need to send a GET or POST request to MapServer
+with several URL variables defined. The below URL tells MapServer where
+the mapfile is located, what layer we are querying, and that we are
+using nquery mode to return multiple results.
::
@@ -143,7 +162,9 @@
Additional Notes
=================
-If you use separate map files to generate your imagemap and your map image, make sure that the EXTENT and SIZE specified in both mapfiles are identical. If they are not, your features will not align properly.
+If you use separate map files to generate your imagemap and your map
+image, make sure that the EXTENT and SIZE specified in both mapfiles
+are identical. If they are not, your features will not align properly.
More Information
=================
Modified: trunk/docs/references/output/pdf.txt
===================================================================
--- trunk/docs/references/output/pdf.txt 2008-11-24 17:23:54 UTC (rev 8077)
+++ trunk/docs/references/output/pdf.txt 2008-11-24 19:12:29 UTC (rev 8078)
@@ -8,8 +8,6 @@
:Date: $Date$
:Last Updated: 2006/01/12
-.. sectnum::
-
.. contents:: Table of Contents
:depth: 2
:backlinks: top
Modified: trunk/docs/references/output/svg.txt
===================================================================
--- trunk/docs/references/output/svg.txt 2008-11-24 17:23:54 UTC (rev 8077)
+++ trunk/docs/references/output/svg.txt 2008-11-24 19:12:29 UTC (rev 8078)
@@ -8,8 +8,6 @@
:Date: $Date$
:Last Updated: 2005/12/13
-.. sectnum::
-
.. contents:: Table of Contents
:depth: 2
:backlinks: top
Modified: trunk/docs/references/output/tile_mode.txt
===================================================================
--- trunk/docs/references/output/tile_mode.txt 2008-11-24 17:23:54 UTC (rev 8077)
+++ trunk/docs/references/output/tile_mode.txt 2008-11-24 19:12:29 UTC (rev 8078)
@@ -8,8 +8,6 @@
:Date: $Date$
:Last Updated: 2008/04/30
-.. sectnum::
-
.. contents:: Table of Contents
:depth: 2
:backlinks: top
@@ -34,7 +32,7 @@
projection support by running it with the '-v' option and looking
for 'SUPPORTS=PROJ'.
-Example 1. On Unix:
+Example 1. On Unix::
$ ./mapserv -v
MapServer version 4.6.1 OUTPUT=GIF OUTPUT=PNG OUTPUT=JPEG OUTPUT=WBMP OUTPUT=PDF
@@ -42,7 +40,7 @@
SUPPORTS=WMS_CLIENT SUPPORTS=WFS_SERVER SUPPORTS=WFS_CLIENT SUPPORTS=WCS_SERVER
INPUT=JPEG INPUT=POSTGIS INPUT=OGR INPUT=GDAL INPUT=SHAPEFILE DEBUG=MSDEBUG
-Example 2. On Windows:
+Example 2. On Windows::
C:\apache\cgi-bin> mapserv -v
MapServer version 4.6.1 OUTPUT=GIF OUTPUT=PNG OUTPUT=JPEG OUTPUT=WBMP OUTPUT=PDF
Modified: trunk/docs/references/symbology/construction.txt
===================================================================
--- trunk/docs/references/symbology/construction.txt 2008-11-24 17:23:54 UTC (rev 8077)
+++ trunk/docs/references/symbology/construction.txt 2008-11-24 19:12:29 UTC (rev 8078)
@@ -1,3 +1,5 @@
+.. _sym_construction:
+
*****************************************************************************
Cartographic Symbol Construction with MapServer
*****************************************************************************
@@ -10,8 +12,6 @@
:Date: $Date$
:Last Updated: 2005/11/23
-.. sectnum::
-
.. contents:: Table of Contents
:depth: 2
:backlinks: top
@@ -38,12 +38,7 @@
.. _`Download study report`: http://www.mapmedia.de/dokumente/umn_signaturen_howto/Praktikumsarbeit.zip
-.. sectnum::
-.. contents:: Table of Contents
- :depth: 2
- :backlinks: top
-
Introduction
============
Modified: trunk/docs/references/symbology/examples.txt
===================================================================
--- trunk/docs/references/symbology/examples.txt 2008-11-24 17:23:54 UTC (rev 8077)
+++ trunk/docs/references/symbology/examples.txt 2008-11-24 19:12:29 UTC (rev 8078)
@@ -1,3 +1,17 @@
+*****************************************************************************
+ Symbology Examples
+*****************************************************************************
+
+:Author: Jeff McKenna
+:Contact: jmckenna at gatewaygeomatics.com
+:Revision: $Revision$
+:Date: $Date$
+:Last Updated: 2008/07/16
+
+.. contents:: Table of Contents
+ :depth: 2
+ :backlinks: top
+
The following example creates a dashed line with 10 pixels on, 5 off, 5 on, 10 off ...
Example 1. Dashed Line
@@ -14,7 +28,7 @@
END
The next example symbol is a star, used to represent the national capital, hence the name.
-The font name in defined in the FONTSET file. The code number "114" varies,
+The font name in defined in the :ref:`FONTSET` file. The code number "114" varies,
you can use MS Windows' character map to figure it out, or guestimate.
Example 2. TrueType font marker symbol
Modified: trunk/docs/references/symbology/notes.txt
===================================================================
--- trunk/docs/references/symbology/notes.txt 2008-11-24 17:23:54 UTC (rev 8077)
+++ trunk/docs/references/symbology/notes.txt 2008-11-24 19:12:29 UTC (rev 8078)
@@ -1,6 +1,6 @@
- Symbol definitions can be included within the main MapFile or, more
commonly, in a separate file. Symbol definitions in a separate file
- are designated using the SYMBOLSET keyword, as part of the `MAP Object`_.
+ are designated using the SYMBOLSET keyword, as part of the :ref`MAP Object <map>`.
This recommended setup is ideal for re-using symbol definitions across
multiple MapServer applications.
- There are 3 main types of symbols in MapServer: Markers,
@@ -10,13 +10,9 @@
filled polygons) symbol 0 is a solid fill, and for lines, symbol 0
is a single pixel wide line.
- Symbol definitions contain no color information, colors are set within
- `CLASS`_ objects.
+ :ref:`CLASS` objects.
- For MapServer versions < 5 there is a maximum of 64 symbols per file. This can
be changed by editing mapsymbol.h and changing the value of MS_MAXSYMBOLS at the
top of the file. As of MapServer 5.0 there is no symbol limit.
-- More information can be found in the `Construction of Cartographic Symbols`_
+- More information can be found in the :ref:`Construction of Cartographic Symbols <sym_construction>`
document.
-
-.. _`Construction of Cartographic Symbols`: http://ms.gis.umn.edu/docs/howto/cartosymbols
-.. _`Map Object`: /docs/reference/mapfile/map
-.. _`CLASS`: /docs/reference/mapfile/class
\ No newline at end of file
Modified: trunk/docs/references/symbology/syntax.txt
===================================================================
--- trunk/docs/references/symbology/syntax.txt 2008-11-24 17:23:54 UTC (rev 8077)
+++ trunk/docs/references/symbology/syntax.txt 2008-11-24 19:12:29 UTC (rev 8078)
@@ -1,3 +1,9 @@
+.. _symbol:
+
+*****************************************************************************
+ SYMBOL
+*****************************************************************************
+
ANTIALIAS [true|false]
Should TrueType fonts be antialiased.
@@ -8,13 +14,11 @@
FILLED [true|false]
Sets the symbol to be filled with a user defined color (See the
- `CLASS`_ object). For marker symbols, if OUTLINECOLOR was specified
+ :ref:`CLASS` object). For marker symbols, if OUTLINECOLOR was specified
then the symbol is outlined with it.
-.. _`CLASS`: /docs/reference/mapfile/class
-
FONT [string]
- Name of TrueType font to use as defined in the FONTSET.
+ Name of TrueType font to use as defined in the :ref:`FONTSET`.
GAP [int]
Given in pixels. This defines a distance between symbols for
@@ -29,7 +33,7 @@
Image (GIF or PNG) to use as a marker or brush for type PIXMAP symbols.
NAME [string]
- Alias for this font to be used in CLASS objects
+ Alias for this font to be used in :ref:`CLASS` objects
LINECAP [butt|round|square|triangle]
Sets the line cap type for the cartoline symbol. Default is butt. Works
@@ -58,8 +62,7 @@
defines the x and y radius of an ellipse. Circles are created when x and
y are equal.
- *Note:*
-
+.. note::
If a class using this symbol doesn't contain an explicit size, then the
default symbol size will be based on the range of "y" values in the point
coordinates. e.g. if the y coordinates of the points in the symbol range
@@ -82,7 +85,5 @@
* ellipse: radius values in the x and y directions define an ellipse.
* pixmap: a user supplied GIF image will be used as the symbol.
* truetype: TrueType font to use as defined in the FONTSET.
- * cartoline: allows for different designs of line ends (mitered, rounded, beveled). More information can be found in the `Cartographic Symbols document`_.
+ * cartoline: allows for different designs of line ends (mitered, rounded, beveled). More information can be found in the :ref:`Cartographic Symbols document <sym_construction>`.
* hatch: produces hatched lines throughout the shape.
-
-.. _`Cartographic Symbols document`: /docs/howto/cartosymbols
\ No newline at end of file
More information about the mapserver-commits
mailing list