[mapserver-commits] r13199 - trunk/docs/en/mapfile
svn at osgeo.org
svn at osgeo.org
Sun Mar 4 15:30:24 EST 2012
Author: havatv
Date: 2012-03-04 12:30:24 -0800 (Sun, 04 Mar 2012)
New Revision: 13199
Modified:
trunk/docs/en/mapfile/outputformat.txt
Log:
Added documentation of geospatial PDF to outputformat (#4218). Also adjusted som overlong lines.
Modified: trunk/docs/en/mapfile/outputformat.txt
===================================================================
--- trunk/docs/en/mapfile/outputformat.txt 2012-03-03 11:45:58 UTC (rev 13198)
+++ trunk/docs/en/mapfile/outputformat.txt 2012-03-04 20:30:24 UTC (rev 13199)
@@ -131,6 +131,117 @@
jpeg produced (value from 0-100).
.. index::
+ triple: OUTPUTFORMAT; FORMATOPTION; GAMMA
+
+ - AGG/\*: "GAMMA=n" is used to specify the gamma correction to
+ apply to polygon rendering. Allowed values are ]0.0,1.0] ,
+ default is 0.75. This value is used to prevent artifacts from
+ appearing on the border of contiguous polygons. Set to 1.0 to
+ disable gamma correction.
+
+ .. index::
+ triple: OUTPUTFORMAT; FORMATOPTION; COMPRESSION
+
+ - AGG/PNG: "COMPRESSION=n" is used to determine the ZLIB
+ compression applied to the png creation. n is expected to be an
+ integer value from 0 to 9, with 0 meaning *no* compression (not
+ recommended), 1 meaning fastest compression, and 9 meaning best
+ compression. The compression levels come at a cost (be it in
+ terms of cpu processing or file size, chose the setting that
+ suits you most). The default is COMPRESSION=6.
+
+ - AGG/PNG supports quantizing from 24/32 bits to 8bits, in order
+ to reduce the final image size (and therefore save bandwidth)
+ (see also http://trac.osgeo.org/mapserver/ticket/2436#comment:4
+ for strategies when applying these options):
+
+ .. index::
+ triple: OUTPUTFORMAT; FORMATOPTION; QUANTIZE_FORCE
+
+ - "QUANTIZE_FORCE=on" used to reduce an RGB or RGBA image into
+ an 8bit (or less) paletted images. The colors used in the
+ palette are selected to best fit the actual colors in the RGB
+ or RGBA image.
+
+ .. index::
+ triple: OUTPUTFORMAT; FORMATOPTION; QUANTIZE_COLORS
+
+ - "QUANTIZE_COLORS=256" used to specify the number of colors to
+ be used when applying quantization. Maximum value is
+ 256. Specifying anything between 17 and 255 is probably a
+ waste of quality as each pixel is still encoded with a full
+ byte. Specifying a value under 16 will produce tiny images,
+ but severly degraded.
+
+ .. index::
+ triple: OUTPUTFORMAT; FORMATOPTION; PALETTE
+
+ - "PALETTE=/path/to/palette.txt" is used to define the absolute
+ path where palette colors can be found. This file must contain
+ 256 entries of r,g,b triplets for RGB imagemodes, or r,g,b,a
+ quadruplets for RGBA imagemodes. The expected format is one
+ triplet (or quadruplet) per line, each value separated by
+ commas, and each triplet/quadruplet on a single line. If you
+ want to use transparency with a palette, it is important to
+ have these two colors in the palette file: 0,0,0,0 and
+ 255,255,255,255.
+
+ .. NOTE::
+ 0,0,0,0 is important if you have fully transparent areas.
+ 255,255,255,255 is opaque white.
+ The important colors to have in your palette really depend
+ on your actual map, although 0,0,0,0 , 0,0,0,255 , and
+ 255,255,255,255 are very likely to show up most of the
+ time.
+
+ .. index::
+ triple: OUTPUTFORMAT; FORMATOPTION; PALETTE_FORCE
+
+ - "PALETTE_FORCE=on" is used to reduce image depth with a
+ predefined palette. This option is incompatible with the
+ previous quantization options.
+
+ .. index::
+ pair: PDF; Geospatial
+
+ - CAIRO/PDF:
+
+ .. index::
+ triple: OUTPUTFORMAT; FORMATOPTION; GEO_ENCODING
+
+ - "GEO_ENCODING=ISO32000" or "GEO_ENCODING=OGC_BP": Geospatial
+ PDF will be generated. Requires GDAL 2.0 with PDF driver.
+ See the `GDAL Geospatial PDF`_ documentation for requirements.
+
+ .. versionadded:: 6.2
+
+ .. index::
+ triple: OUTPUTFORMAT; FORMATOPTION; METADATA_ITEM
+
+ - "METADATA_ITEM:option=value": Additional PDF options can be
+ provided using the METADATA_ITEM prefix. The following
+ options are available: `AUTHOR`, `CREATOR`, `CREATION_DATE`,
+ `KEYWORDS`, `PRODUCER`, `SUBJECT`, `TITLE`.
+
+ .. versionadded:: 6.2
+
+ Example:
+
+ .. code-block:: mapfile
+
+ OUTPUTFORMAT
+ NAME pdf
+ DRIVER "CAIRO/PDF"
+ MIMETYPE "application/x-pdf"
+ IMAGEMODE RGB
+ EXTENSION "pdf"
+ FORMATOPTION "GEO_ENCODING=ISO32000"
+ FORMATOPTION "METADATA_ITEM:CREATOR=MapServer, with GDAL trunk"
+ FORMATOPTION "METADATA_ITEM:PRODUCER=MapServer, with GDAL trunk"
+ END
+
+
+ .. index::
triple: OUTPUTFORMAT; FORMATOPTION; INTERLACE
- GD/PNG: The "INTERLACE=[ON/OFF]" option may be used to turn
@@ -154,87 +265,26 @@
.. index::
triple: OUTPUTFORMAT; FORMATOPTION; COMPRESS
- - GDAL/GTiff: Supports the TILED=YES, BLOCKXSIZE=n, BLOCKYSIZE=n,
- INTERLEAVE=[PIXEL/BAND] and COMPRESS=[NONE,PACKBITS,JPEG,LZW,DEFLATE]
- format specific options.
+ - GDAL/GTiff: Supports the "TILED=YES", "BLOCKXSIZE=n",
+ "BLOCKYSIZE=n", "INTERLEAVE=[PIXEL/BAND]" and
+ "COMPRESS=[NONE,PACKBITS,JPEG,LZW,DEFLATE]" format specific
+ options.
- GDAL/\*: All FORMATOPTIONs are passed onto the GDAL create function.
Options supported by GDAL are described in the detailed documentation
- for each GDAL format
+ for each GDAL format.
.. index::
triple: OUTPUTFORMAT; FORMATOPTION; NULLVALUE
- - GDAL/\*: NULLVALUE=n is used in raw image modes (IMAGEMODE
+ - GDAL/\*: "NULLVALUE=n" is used in raw image modes (IMAGEMODE
BYTE/INT16/FLOAT) to pre-initialize the raster and an attempt is made
to record this in the resulting file as the nodata value. This is
automatically set in WCS mode if rangeset_nullvalue is set.
- - OGR/\*: See OGR Output document for details of OGR format options.
+ - OGR/\*: See the :ref:`ogr_output` document for details of OGR
+ format options.
- .. index::
- triple: OUTPUTFORMAT; FORMATOPTION; GAMMA
-
- - AGG/\*: GAMMA=n is used to specify the gamma correction to apply to polygon
- rendering. Allowed values are ]0.0,1.0] , default is 0.75. This value is
- used to prevent artifacts from appearing on the border of contiguous
- polygons. Set to 1.0 to disable gamma correction.
-
- .. index::
- triple: OUTPUTFORMAT; FORMATOPTION; COMPRESSION
-
- - AGG/PNG: COMPRESSION=n is used to determine the ZLIB compression applied to
- the png creation. n is expected to be an integer value from 0 to 9, with 0
- meaning *no* compression (not recommended), 1 meaning fastest compression,
- and 9 meaning best compression. The compression levels come at a cost (be it
- in terms of cpu processing or file size, chose the setting that suits you
- most). The default is COMPRESSION=6.
-
- - AGG/PNG supports quantizing from 24/32 bits to 8bits,
- in order to reduce the final image size (and therefore save bandwidth) (see
- also http://trac.osgeo.org/mapserver/ticket/2436#comment:4 for strategies
- when applying these options):
-
- .. index::
- triple: OUTPUTFORMAT; FORMATOPTION; QUANTIZE_FORCE
-
- - "QUANTIZE_FORCE=on" used to reduce an RGB or RGBA image into an 8bit
- (or less) paletted images. The colors used in the palette are selected
- to best fit the actual colors in the RGB or RGBA image.
-
- .. index::
- triple: OUTPUTFORMAT; FORMATOPTION; QUANTIZE_COLORS
-
- - "QUANTIZE_COLORS=256" used to specify the number of colors to be used
- when applying quantization. Maximum value is 256. Specifying anything
- between 17 and 255 is probably a waste of quality as each pixel is still
- encoded with a full byte. Specifying a value under 16 will produce tiny
- images, but severly degraded.
-
- .. index::
- triple: OUTPUTFORMAT; FORMATOPTION; PALETTE
-
- - "PALETTE=/path/to/palette.txt" is used to define the absolute path where
- palette colors can be found. This file must contain 256 entries of r,g,b
- triplets for RGB imagemodes, or r,g,b,a quadruplets for
- RGBA imagemodes. The expected format is one triplet (or quadruplet) per
- line, each value separated by commas, and each triplet/quadruplet on a
- single line. If you want to use transparency with a palette, it is
- important to have these two colors in the palette file:
- 0,0,0,0 and 255,255,255,255.
-
- .. NOTE::
- 0,0,0,0 is important if you have fully transparent areas.
- 255,255,255,255 is opaque white.
- The important colors to have in your palette really depend on your
- actual map, although 0,0,0,0 , 0,0,0,255 , and 255,255,255,255 are
- very likely to show up most of the time.
- .. index::
- triple: OUTPUTFORMAT; FORMATOPTION; PALETTE_FORCE
-
- - "PALETTE_FORCE=on" is used to reduce image depth with a predefined palette.
- This option is incompatible with the previous quantization options.
-
.. index::
pair: OUTPUTFORMAT; IMAGEMODE
@@ -316,3 +366,5 @@
components drawn in this color will also be transparent, so for map
generation with transparency it is best to use an otherwise unused color
as the background color.
+
+.. _`GDAL Geospatial PDF`: http://www.gdal.org/frmt_pdf.html
More information about the mapserver-commits
mailing list