Mercurial > mxd2map
changeset 202:1e3a5019c4ed
* INSTALL.txt, LICENCE.txt, doku/source/LICENCE.txt,
doku/source/conf.py, doku/source/functionality.txt,
doku/source/index.txt, doku/source/restrictions.txt: Added some
formatting, a section about the setup of environment vars needed
for runtime, added some more features.
| author | Stephan Holl <stephan.holl@intevation.de> |
|---|---|
| date | Thu, 21 Jul 2011 09:38:44 +0200 |
| parents | 877be7484245 |
| children | 123fd9887a4f |
| files | ChangeLog INSTALL.txt LICENCE.txt doku/source/LICENCE.txt doku/source/conf.py doku/source/functionality.txt doku/source/index.txt doku/source/restrictions.txt |
| diffstat | 7 files changed, 88 insertions(+), 32 deletions(-) [+] |
line wrap: on
line diff
--- a/ChangeLog Wed Jul 20 18:30:00 2011 +0200 +++ b/ChangeLog Thu Jul 21 09:38:44 2011 +0200 @@ -1,3 +1,13 @@ +2011-07-21 Stephan Holl <stephan.holl@intevation.de> + +More documentations: + + * INSTALL.txt, LICENCE.txt, doku/source/LICENCE.txt, + doku/source/conf.py, doku/source/functionality.txt, + doku/source/index.txt, doku/source/restrictions.txt: Added some + formatting, a section about the setup of environment vars needed + for runtime, added some more features. + 2011-07-20 Raimund Renkert <raimund.renkert@intevation.de> * src/java/de/intevation/mxd/writer/MapScriptWriter.java:
--- a/INSTALL.txt Wed Jul 20 18:30:00 2011 +0200 +++ b/INSTALL.txt Thu Jul 21 09:38:44 2011 +0200 @@ -11,12 +11,12 @@ * Sun Java6 SDK to build, JRE to run * ArcGIS Desktop10.x or ArcEngine10.x with a valid licence enabled - * UMN MapServer with Java MapScript-bindings (recent development-version) - * Apache Webserver for displaying the resulting Mapfiles + * UMN MapServer with Java MapScript-bindings (>=6.0.1 or recent development-version) + * Apache2 Webserver for displaying the resulting Mapfiles * Optional: MapServer compiled with ArcSDE-plugin * Optional: GDAL/OGR compiled with ArcSDE-support * Optional: GDAL/OGR compiled with FileGeodatabase-support - + * Optional: Other GDAL/OGR-related tools. ------------ @@ -53,7 +53,7 @@ The current documentation uses the Windows binary-builds from http://www.gisinternals.com/sdk/ -1. Unzip the ZIP-file at c:/ms_6.1-dev +1. Unzip the ZIP-file at ``c:/ms_6.1-dev`` #. Configure Apache Webserver to find the cgi-bin-folder:: @@ -65,7 +65,7 @@ Allow from all </Location> -#. Copy mapserv.exe from c:/ms_6.1-dev/bin/apps/ms to c:/ms_6.1-dev/bin/ +#. Copy mapserv.exe from ``c:/ms_6.1-dev/bin/apps/ms`` to ``c:/ms_6.1-dev/bin/`` Create run-environment @@ -75,21 +75,68 @@ The following steps assume the runtime folder to be c:/mxd2map/. This path can be changed. -1. Copy mxd2map.jar to c:/mxd2map/. +1. Copy ``mxd2map.jar`` to ``c:/mxd2map/``. -#. Copy folder "conf" from repository to c:/mxd2map/ +#. Copy folder "conf" from repository to ``c:/mxd2map/`` -#. Create folder c:/mxd2map/lib/ +#. 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/ +#. Build the libraries and copy the resulting jar-files to ``c:/mxd2map/lib/`` -#. Create a folder c:/mxd2map/logs/ +#. Copy mapscript.jar and mapscript.dll to ``c:/mxd2map/lib/`` -#. Create or copy a converter.properties file to c:/mxd2map/ +#. Create a folder ``c:/mxd2map/logs/`` +#. Create or copy a converter.properties file to ``c:/mxd2map/`` + +Setup environment-variables +--------------------------- + +For running the converter it is necessary to set up some environment +variables and adjust the path accordingly. + +The following example shows the minimum env-vars needed:: + + @echo off + if "%1" == "setenv" goto setenv + + %comspec% /k SDKShell.bat setenv %1 + goto exit + + :setenv + @echo Setting environment for using the GDAL and MapServer tools. + + if "%2"=="hideoci" goto hideoci + + set ocipath=0 + set _path="%PATH:;=" "%" + for %%p in (%_path%) do if not "%%~p"=="" if exist %%~p\oci.dll set ocipath=1 + + if "%ocipath%"=="0" goto hideoci + @echo WARNING: If you encounter problems with missing oci libraries then type: + @echo SDKShell hideoci + goto setenv2 + + :hideoci + @echo Hiding the OCI plugin library. + if not exist %CD%\bin\gdal\plugins-optional mkdir %CD%\bin\gdal\plugins-optional + if exist %CD%\bin\gdal\plugins\ogr_OCI.dll move %CD%\bin\gdal\plugins\ogr_OCI.dll %CD%\bin\gdal\plugins-optional\ogr_OCI.dll + if exist %CD%\bin\gdal\plugins\gdal_GEOR.dll move %CD%\bin\gdal\plugins\gdal_GEOR.dll %CD%\bin\gdal\plugins-optional\gdal_GEOR.dll + + :setenv2 + SET PATH=C:\Program Files\ArcGIS\DeveloperKit10.0\java\jre\bin;C:\Program Files\ArcGIS\Engine10.0\bin;%CD%\bin;%CD%\bin;%CD%\bin\gdal\python\osgeo;%CD%\bin\proj\apps;%CD%\bin\gdal\apps;%CD%\bin\ms\apps;%CD%\bin\gdal\csharp;%CD%\bin\ms\csharp;%CD%\bin\curl;%CD%\bin\ms\java;C:\Program Files\Vim\vim71;C:\Program Files\TortoiseHg;%PATH% + SET GDAL_DATA=%CD%\bin\gdal-data + SET GDAL_DRIVER_PATH=%CD%\bin\gdal\plugins + SET PYTHONPATH=%CD%\bin\gdal\python\osgeo + SET PROJ_LIB=%CD%\bin\proj\SHARE + SET CURL_CA_BUNDLE=C:\ms4w\Apache\conf\ca-bundle\cacert.pem + + :exit + +The above batch-script ``SDKShell.bat`` needs to be sources before working +with MXD2map. +
--- a/LICENCE.txt Wed Jul 20 18:30:00 2011 +0200 +++ b/LICENCE.txt Thu Jul 21 09:38:44 2011 +0200 @@ -1,12 +1,10 @@ .. index:: LGPL, licence Licence -======= +------- -GNU LESSER GENERAL PUBLIC LICENSE ---------------------------------- - -Version 3, 29 June 2007 + **GNU LESSER GENERAL PUBLIC LICENSE** + Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies
--- a/doku/source/conf.py Wed Jul 20 18:30:00 2011 +0200 +++ b/doku/source/conf.py Thu Jul 21 09:38:44 2011 +0200 @@ -41,8 +41,7 @@ # General information about the project. project = u'MXD2map' -copyright = u'2011, Bundesamt fuer Seeschifffahrt und Hydrographie, -Intevation GmbH' +copyright = u'2011, Bundesamt fuer Seeschifffahrt und Hydrographie, Intevation GmbH' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -55,7 +54,7 @@ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -language = 'en' +#language = 'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -151,7 +150,7 @@ html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +html_show_sphinx = False # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. html_show_copyright = True @@ -185,7 +184,7 @@ # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +latex_logo = '_static/logo_wide.png' # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. @@ -217,7 +216,7 @@ \renewcommand{\headrulewidth}{0.4pt} \renewcommand{\footrulewidth}{0.4pt} % changes - %\fancyhead[LO,RE]{{\includegraphics[height=0.5cm]{InteProxy-logo.png}}} + %\fancyhead[LO,RE]{{\includegraphics[height=0.5cm]{_static/logo-wide.png}}} } ''',
--- a/doku/source/functionality.txt Wed Jul 20 18:30:00 2011 +0200 +++ b/doku/source/functionality.txt Thu Jul 21 09:38:44 2011 +0200 @@ -1,5 +1,4 @@ -.. index:: features, functionality, configuration, runtime-parameter, -commandline +.. index:: features, functionality, configuration, runtime-parameter, commandline ------------- Functionality @@ -13,6 +12,9 @@ :ref:`restriction-label` described in the appropriate section. .. image:: ../funktionsweise/funktionsweise-MXD-konverter.png + :align: center + :alt: MXD2map-Schema + :width: 500px .. _howtouse-label: @@ -105,5 +107,4 @@ * Simple labeling * Filter and expressions * ArcSDE Jointables - * - + * Mapfile-Templating for OGC-related stuff
--- a/doku/source/index.txt Wed Jul 20 18:30:00 2011 +0200 +++ b/doku/source/index.txt Thu Jul 21 09:38:44 2011 +0200 @@ -6,7 +6,7 @@ .. index:: contents MXD2map documentation! -======================= +====================== .. toctree:: :maxdepth: 2
--- a/doku/source/restrictions.txt Wed Jul 20 18:30:00 2011 +0200 +++ b/doku/source/restrictions.txt Thu Jul 21 09:38:44 2011 +0200 @@ -1,4 +1,5 @@ .. index:: restrictions +.. _restriction-label: ------------ Restrictions @@ -24,7 +25,7 @@ resulting mapfile but the marker symbols are rendered without any gap. The resulting mapimage may not look as intended. - * .. hint:: + .. hint:: 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. @@ -36,8 +37,8 @@ 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. - * .. tip:: - Tip: To avoid lines and line colors (specially outlines) to be handled by the + .. tip:: + To avoid lines and line colors (specially outlines) to be handled by the converter, use integer numbers for line width only. * Picture symbols are not supported by the converter since ArcGIS embedds