# HG changeset patch # User Raimund Renkert # Date 1310994744 -7200 # Node ID 91e2d46d796867272c409d5a02652f580f6cd6fb # Parent 0bde090506f9660a5d15b08ad281bc524f7ecc4f Added functionality, restrictions and how to build runtime enviroment to documentation. diff -r 0bde090506f9 -r 91e2d46d7968 ChangeLog --- a/ChangeLog Mon Jul 11 14:28:38 2011 +0200 +++ b/ChangeLog Mon Jul 18 15:12:24 2011 +0200 @@ -1,3 +1,15 @@ +2011-07-18 Raimund Renkert + + * doku/source/index.txt: Added functionality.txt to sphinx + documentation. + + * INSTALL.txt, doku/source/restrictions.txt: + Documentation how to create runtime enviroment and described the + restriction of the converter. + + * doku/source/functionality.txt: + New. Description how the converter works. + 2011-07-11 Raimund Renkert * src/java/de/intevation/mxd/reader/ArrowMarkerSymbolReader.java, diff -r 0bde090506f9 -r 91e2d46d7968 INSTALL.txt --- a/INSTALL.txt Mon Jul 11 14:28:38 2011 +0200 +++ b/INSTALL.txt Mon Jul 18 15:12:24 2011 +0200 @@ -30,6 +30,10 @@ ant jar +or:: + + ant jar-norevision + Install Apache Webserver ------------------------ @@ -61,14 +65,29 @@ #. Copy mapserv.exe from c:/ms_6.1-dev/bin/apps/ms to c:/ms_6.1-dev/bin/ + Create run-environment ---------------------- -writeme - +The current version of MXD2map needs a few steps to run properly. +The following steps assume the runtime folder to be c:/mxd2map/. This path can +be changed. ------ -Usage ------ +1. Copy mxd2map.jar to c:/mxd2map/. -writeme +#. Copy folder "conf" from repository to c:/mxd2map/ + +#. Create folder c:/mxd2map/lib/ + +#. Get log4j from http://logging.apache.org/log4j/1.2/download.html + +#. Get jargs http://jargs.sourceforge.net/ (Version 1.0) + +#. Build the libraries and copy the resulting jar-files to c:/mxd2map/lib/ + +#. Copy mapscript.jar and mapscript.dll to c:/mxd2map/lib/ + +#. Create a folder c:/mxd2map/logs/ + +#. Create or copy a converter.properties file to c:/mxd2map/ + diff -r 0bde090506f9 -r 91e2d46d7968 doku/source/functionality.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doku/source/functionality.txt Mon Jul 18 15:12:24 2011 +0200 @@ -0,0 +1,87 @@ +------------- +Functionality +------------- + +The MXD2map converter works as a commandline tool to transform maps from the +proprietary ArcGIS file format "MXD" to a MapServer configuration file. + +To transform an ArcGIS mxd file to a MapServer configuration file the mxd file +must have a valid and available data source and must not fit the restrictions +described in the appropriate section. + +How to use +---------- +The converter is started via the commandline running the command:: + + $java -jar mxd2map.jar + +The converter can be configured in two ways: + +1. The converter.properties file (see converter.properties.sample) +2. via commandline arguments + +Both take a parameter for the path to the mxd file, the outputfile and a mapfile +template for initial mapfile config. Commandline parameters have a higher +priority than the properties file. + +The available parameters on the commandline are:: + + -m or --mxd The mxd file to convert. + + -a or --map The path to the output file. Should end with ".map". + + -t or --template The template to use for an initial mapfile + configuration. + +To have the full functionality for ArcGIS map conversion it is necessary to have +the ESRI fonts available. ArcGIS products install these fonts to the default +windows font folder "c:\\windows\\fonts". To make them available for the converter +there has to be a MapServer font set (see +http://mapserver.org/mapfile/fontset.html). The MXD2map converter comes with an +initial fontset containing all relevant ESRI fonts and the free font FreeSans. +The font set file named fonts.txt can be edited and further fonts can be added. +To use a font set, the file needs to be referenced in the MapServer template +otherwise the converter can not create character symbols and will show up errors +in the conversion process. + +The converter uses a separate symbol file to provide symbol sets to the +MapServer configuration. A pre-build symbol file can be referenced in the +template to have initial symbols available. If no symbol file is referenced a +new one is created by the converter if necessary. The resulting symbol set is +written to the same directory as the output mapfile named +[mapfile-name]-symbols.sym. + + +Features +-------- + +Currently supported features: + + * The MXD2map converter can use ArcSDE database connections and local + shapefile datasources to create a mapfile. + + * Convertable symbols: + + * Simple marker symbols + * Character marker symbols + * Arrow marker symbols + * Any combination of character marker symbols + * Linesymbols with pattern and cartographic attributes + * Polygons filled with solid color and outline + * Polygons filled with a hatch and outline + + * Convertable layer: + + * Feature layer + * Layer containing unique values + * Layer containing class breaks + * Grouplayer with one grouplevel + + * Further map attributes: + + * Projection and units + * Min/max scale denominations + * Map extents + * Simple labeling + * Filter and expressions + diff -r 0bde090506f9 -r 91e2d46d7968 doku/source/index.txt --- a/doku/source/index.txt Mon Jul 11 14:28:38 2011 +0200 +++ b/doku/source/index.txt Mon Jul 18 15:12:24 2011 +0200 @@ -12,6 +12,7 @@ :maxdepth: 2 INSTALL.txt + functionality.txt restrictions.txt Indices and tables diff -r 0bde090506f9 -r 91e2d46d7968 doku/source/restrictions.txt --- a/doku/source/restrictions.txt Mon Jul 11 14:28:38 2011 +0200 +++ b/doku/source/restrictions.txt Mon Jul 18 15:12:24 2011 +0200 @@ -7,7 +7,38 @@ Supported datasources: * ArcSDE-passwords cannot be read since they are encrypted. The converter - exports the string "define me" which needs to be replaced later on in the - resulting mapfile + exports the string "define me" which needs to be replaced later on in the + resulting mapfile - * + * Since the MapServer cannot use a file geodatabase datasource the converter + does not support this datasource and will not transform the MXD-file at all. + + * Raster data is not supported by the converter yet. + +Symbol support: + + * Line symbols with pattern cannot be combined with marker symbols. The + converter reads all symbols and writes the corresponding styles to the + resulting mapfile but the marker symbols are rendered without any gap. + + * Workarround: + For small marker symbols it is recommended to use a line symbol in + combination with pattern (in ArcGIS called template) to create the + symbology. + The reason why marker symbols cannot be used in combination with a template + is the difficulty to interpret the read attributes like marks and gaps and + write the appropriate symbols with the appropiate gap to the mapfile. + + * The converter sets the width to 1 for line symbols that have a width + smaller than 1. Outlines with a width smaller than 1 are drawn in the fill + color of the ploygon and the width is set to 1. + + * Picture symbols are not supported by the converter. + + * In ArcGIS maps default symbols can be defined as fallback. Since MapServer + does not support such fallback symbols or styles the converter does not + read these default symbols. + + * In ArcGIS predefined symbols like bars or pie charts can be used to display + values. The converter does not support these symbols. +