Mercurial > mxd2map > mxd2map

annotate doku/source/functionality.txt @ 235:00a39e8b6eed

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* INSTALL.txt: Added a paragraph to make the env-vars available in Apache * doku/source/_templates/layout.html: defining a custom footer with the version-string included * doku/source/conf.py: adopt versionstring and copyright * doku/source/functionality.txt: formating-cosmetics, correct icon
author Stephan Holl <stephan.holl@intevation.de>
date Fri, 05 Aug 2011 09:18:53 +0200
parents df533a03ad9f
children d10fd4de02aa
rev   line source
202
1e3a5019c4ed * INSTALL.txt, LICENCE.txt, doku/source/LICENCE.txt,
Stephan Holl <stephan.holl@intevation.de>
parents: 188
diff changeset
1 .. index:: features, functionality, configuration, runtime-parameter, commandline
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
2
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
3 -------------
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
4 Functionality
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
5 -------------
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 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
8 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
9
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
10 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
11 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
12 :ref:`restriction-label` described in the appropriate section.
fe6dbfc86144 Updated documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 182
diff changeset
13
235
00a39e8b6eed * INSTALL.txt: Added a paragraph to make the env-vars available in Apache
Stephan Holl <stephan.holl@intevation.de>
parents: 230
diff changeset
14 .. image:: ../funktionsweise/funktionsweise-MXD2map.png
202
1e3a5019c4ed * INSTALL.txt, LICENCE.txt, doku/source/LICENCE.txt,
Stephan Holl <stephan.holl@intevation.de>
parents: 188
diff changeset
15 :align: center
1e3a5019c4ed * INSTALL.txt, LICENCE.txt, doku/source/LICENCE.txt,
Stephan Holl <stephan.holl@intevation.de>
parents: 188
diff changeset
16 :alt: MXD2map-Schema
1e3a5019c4ed * INSTALL.txt, LICENCE.txt, doku/source/LICENCE.txt,
Stephan Holl <stephan.holl@intevation.de>
parents: 188
diff changeset
17 :width: 500px
183
fe6dbfc86144 Updated documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 182
diff changeset
18
fe6dbfc86144 Updated documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 182
diff changeset
19 .. _howtouse-label:
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
20
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
21 How to use
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
22 ----------
183
fe6dbfc86144 Updated documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 182
diff changeset
23
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
24 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
25
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
26 $java -jar mxd2map.jar
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 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
29
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
30 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
31 2. via commandline arguments
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
32
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
33 The converter.properties.sample file::
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
34
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
35
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
36 # Java properties file for the MXD Converter Tool.
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
37 mxd = \\full\\path\\to\\mxd-file
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
38 map = \\full\\path\\to\\map-file
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
39 map-template = \\full\\path\\to\\mapfile-template
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
40
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
41 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
42
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
43 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
44 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
45 priority than the properties file.
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 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
48
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
49 -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
50
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
51 -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
52
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
53 -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
54 configuration.
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
55
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
56 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
57 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
58 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
59 there has to be a MapServer font set (see
235
00a39e8b6eed * INSTALL.txt: Added a paragraph to make the env-vars available in Apache
Stephan Holl <stephan.holl@intevation.de>
parents: 230
diff changeset
60 http://mapserver.org/mapfile/fontset.html).
00a39e8b6eed * INSTALL.txt: Added a paragraph to make the env-vars available in Apache
Stephan Holl <stephan.holl@intevation.de>
parents: 230
diff changeset
61
00a39e8b6eed * INSTALL.txt: Added a paragraph to make the env-vars available in Apache
Stephan Holl <stephan.holl@intevation.de>
parents: 230
diff changeset
62 The MXD2map converter comes with an
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
63 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
64 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
65 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
66 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
67 in the conversion process.
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
68
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
69 The converter uses a separate symbol file to provide symbol sets to the
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
70 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
71 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
72 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
73 [mapfile-name]-symbols.sym.
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
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
76 Features
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
77 --------
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
78
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
79 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
80
230
df533a03ad9f completed the features and restrictions-section
Stephan Holl <stephan.holl@intevation.de>
parents: 209
diff changeset
81 * Datasources:
df533a03ad9f completed the features and restrictions-section
Stephan Holl <stephan.holl@intevation.de>
parents: 209
diff changeset
82
df533a03ad9f completed the features and restrictions-section
Stephan Holl <stephan.holl@intevation.de>
parents: 209
diff changeset
83 * ArcSDE vector database connections (requires MapServer built against ArcSDE, Client-dlls needed)
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
84 * ESRI-Shapefiles
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
85
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
86 * Symbols:
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
87
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
88 * Simple marker symbols
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
89 * Character marker symbols
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
90 * Arrow marker symbols
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
91 * 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
92 * Any combination of character marker symbols
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
93 * Linesymbols with pattern and cartographic attributes
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
94 * Polygons filled with solid color and outline
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
95 * 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
96
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
97 * Layer types:
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
98
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
99 * Featurelayer (vectors) as POINT, LINESTRING and POLYGON
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
100 * Classifications with unique values
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
101 * Classifications with class breaks
230
df533a03ad9f completed the features and restrictions-section
Stephan Holl <stephan.holl@intevation.de>
parents: 209
diff changeset
102 * Group-members are concatinated to group.layername. This ensures having discrete layernames
df533a03ad9f completed the features and restrictions-section
Stephan Holl <stephan.holl@intevation.de>
parents: 209
diff changeset
103 * ArcGIS-layergroups are represented as WMS Named layers, which are WMS-layers without a title (so not requestable throuhg GetMap)
df533a03ad9f completed the features and restrictions-section
Stephan Holl <stephan.holl@intevation.de>
parents: 209
diff changeset
104 * all definition-queries for filtering the data on Layer- and classification-level
182
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
105
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
106 * Further map attributes:
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
107
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
108 * Projections and units based on the EPSG-table
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
109 * 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
110 * Map extents
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
111 * Simple labeling
91e2d46d7968 Added functionality, restrictions and how to build runtime enviroment
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
112 * Filter and expressions
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 183
diff changeset
113 * ArcSDE Jointables
202
1e3a5019c4ed * INSTALL.txt, LICENCE.txt, doku/source/LICENCE.txt,
Stephan Holl <stephan.holl@intevation.de>
parents: 188
diff changeset
114 * Mapfile-Templating for OGC-related stuff
230
df533a03ad9f completed the features and restrictions-section
Stephan Holl <stephan.holl@intevation.de>
parents: 209
diff changeset
115 * Simple Labeling-syntax (a subset of ArcGISs VBScript-labels)
209
1d7fc059e538 * doku/source/functionality.txt: Added part about the translation
Stephan Holl <stephan.holl@intevation.de>
parents: 202
diff changeset
116
1d7fc059e538 * doku/source/functionality.txt: Added part about the translation
Stephan Holl <stephan.holl@intevation.de>
parents: 202
diff changeset
117 * Other features
1d7fc059e538 * doku/source/functionality.txt: Added part about the translation
Stephan Holl <stephan.holl@intevation.de>
parents: 202
diff changeset
118
230
df533a03ad9f completed the features and restrictions-section
Stephan Holl <stephan.holl@intevation.de>
parents: 209
diff changeset
119 * Umlauts are translated into its equivalents within LAYER-names,
235
00a39e8b6eed * INSTALL.txt: Added a paragraph to make the env-vars available in Apache
Stephan Holl <stephan.holl@intevation.de>
parents: 230
diff changeset
120 CLASS-names and also mapfile-names. Though it is good standard not to
00a39e8b6eed * INSTALL.txt: Added a paragraph to make the env-vars available in Apache
Stephan Holl <stephan.holl@intevation.de>
parents: 230
diff changeset
121 use them since they mostly cause problems when using them within
00a39e8b6eed * INSTALL.txt: Added a paragraph to make the env-vars available in Apache
Stephan Holl <stephan.holl@intevation.de>
parents: 230
diff changeset
122 OWS-related services.
00a39e8b6eed * INSTALL.txt: Added a paragraph to make the env-vars available in Apache
Stephan Holl <stephan.holl@intevation.de>
parents: 230
diff changeset
123
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)