annotate doku/source/functionality.txt @ 188:43f1cbdcd597

Modified and beautified the documentation: * INSTALL.txt, doku/Makefile, doku/source/conf.py, doku/source/functionality.txt, doku/source/index.txt, doku/source/restrictions.txt, website/favicon.png, LICENCE.txt: added more details to the content of the documentation. some more configurations. * doku/source/LICENCE.txt: New. Added a licence-text (symlinking into the documentation). * doku/source/_static/favicon.png, doku/source/_static/logo_wide.png, doku/source/_templates/indexsidebar.html, doku/source/_templates/layout.html: Optic-cosmetics.
author Stephan Holl <stephan.holl@intevation.de>
date Wed, 20 Jul 2011 15:53:01 +0200
parents fe6dbfc86144
children 1e3a5019c4ed
rev   line source
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
1 .. index:: features, functionality, configuration, runtime-parameter,
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
2 commandline
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
3
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
4 -------------
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
5 Functionality
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
6 -------------
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
7
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
8 The MXD2map converter works as a commandline tool to transform maps from the
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
9 proprietary ArcGIS file format "MXD" to a MapServer configuration file.
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
10
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
11 To transform an ArcGIS mxd file to a MapServer configuration file the mxd file
183
fe6dbfc86144 Updated documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 182
diff changeset
12 must have a valid and available data source and must not fit the
fe6dbfc86144 Updated documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 182
diff changeset
13 :ref:`restriction-label` described in the appropriate section.
fe6dbfc86144 Updated documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 182
diff changeset
14
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
15 .. image:: ../funktionsweise/funktionsweise-MXD-konverter.png
183
fe6dbfc86144 Updated documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 182
diff changeset
16
fe6dbfc86144 Updated documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 182
diff changeset
17 .. _howtouse-label:
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
18
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
19 How to use
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
20 ----------
183
fe6dbfc86144 Updated documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 182
diff changeset
21
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
22 The converter is started via the commandline running the command::
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
23
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
24 $java -jar mxd2map.jar
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
25
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
26 The converter can be configured in two ways:
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
27
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
28 1. The converter.properties file (see converter.properties.sample)
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
29 2. via commandline arguments
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
30
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
31 The converter.properties.sample file::
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
32
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
33
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
34 # Java properties file for the MXD Converter Tool.
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
35 mxd = \\full\\path\\to\\mxd-file
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
36 map = \\full\\path\\to\\map-file
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
37 map-template = \\full\\path\\to\\mapfile-template
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
38
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
39 Make sure you mask backslahes with an additional backslash.
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
40
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
41 Both take a parameter for the path to the mxd file, the outputfile and a mapfile
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
42 template for initial mapfile config. Commandline parameters have a higher
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
43 priority than the properties file.
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
44
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
45 The available parameters on the commandline are::
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
46
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
47 -m or --mxd The mxd file to convert.
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
48
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
49 -a or --map The path to the output file. Should end with ".map".
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
50
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
51 -t or --template The template to use for an initial mapfile
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
52 configuration.
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
53
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
54 To have the full functionality for ArcGIS map conversion it is necessary to have
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
55 the ESRI fonts available. ArcGIS products install these fonts to the default
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
56 windows font folder ``c:\\windows\\fonts``. To make them available for the converter
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
57 there has to be a MapServer font set (see
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
58 http://mapserver.org/mapfile/fontset.html). The MXD2map converter comes with an
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
59 initial fontset containing all relevant ESRI fonts and the free font FreeSans.
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
60 The font set file named fonts.txt can be edited and further fonts can be added.
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
61 To use a font set, the file needs to be referenced in the MapServer template
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
62 otherwise the converter can not create character symbols and will show up errors
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
63 in the conversion process.
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
64
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
65 The converter uses a separate symbol file to provide symbol sets to the
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
66
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
67 template to have initial symbols available. If no symbol file is referenced a
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
68 new one is created by the converter if necessary. The resulting symbol set is
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
69 written to the same directory as the output mapfile named
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
70 [mapfile-name]-symbols.sym.
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
71
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
72
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
73 Features
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
74 --------
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
75
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
76 MXD2map currently supportes the following features:
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
77
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
78 * Datasources
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
79 * ArcSDE database connections (requires MapServer built against ArcSDE, Client-dlls needed)
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
80 * ESRI-Shapefiles
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
81
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
82 * Symbols:
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
83
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
84 * Simple marker symbols
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
85 * Character marker symbols
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
86 * Arrow marker symbols
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
87 * Symbols based on TTF-characters of special cartographic fonts
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
88 * Any combination of character marker symbols
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
89 * Linesymbols with pattern and cartographic attributes
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
90 * Polygons filled with solid color and outline
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
91 * Polygons filled with a hatch and hatched outline
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
92
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
93 * Layer types:
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
94
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
95 * Featurelayer (vectors) as POINT, LINESTRING and POLYGON
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
96 * Classifications with unique values
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
97 * Classifications with class breaks
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
98 * Grouplayers with one grouplevel (as MapServer does not support more than one nested level)
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
99
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
100 * Further map attributes:
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
101
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
102 * Projections and units based on the EPSG-table
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
103 * Min/max scale denominations at layer and label-level
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
104 * Map extents
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
105 * Simple labeling
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
106 * Filter and expressions
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
107 * ArcSDE Jointables
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
108 *
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
109
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)