# HG changeset patch # User Stephan Holl # Date 1311169981 -7200 # Node ID 43f1cbdcd59766399ffdd34e7361706c2d4cf4b6 # Parent ea7858d75459226f0f7e03ef7be4ab6b686a649d 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. diff -r ea7858d75459 -r 43f1cbdcd597 ChangeLog --- a/ChangeLog Wed Jul 20 14:06:07 2011 +0200 +++ b/ChangeLog Wed Jul 20 15:53:01 2011 +0200 @@ -1,3 +1,21 @@ +2011-07-20 Stephan Holl + +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. + 2011-07-20 Stephan Holl * website/img/inmenulogo.png ,website/img/logo_single.png diff -r ea7858d75459 -r 43f1cbdcd597 INSTALL.txt --- a/INSTALL.txt Wed Jul 20 14:06:07 2011 +0200 +++ b/INSTALL.txt Wed Jul 20 15:53:01 2011 +0200 @@ -1,3 +1,5 @@ +.. index:: installation, requirements, apache, UMN MapServer, compile, jar + ------------ Requirements ------------ diff -r ea7858d75459 -r 43f1cbdcd597 LICENCE.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/LICENCE.txt Wed Jul 20 15:53:01 2011 +0200 @@ -0,0 +1,171 @@ +.. index:: LGPL, licence + +Licence +======= + +GNU LESSER GENERAL PUBLIC LICENSE +--------------------------------- + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + +This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + +0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser + General Public License, and the "GNU GPL" refers to version 3 of the GNU + General Public License. + + "The Library" refers to a covered work governed by this License, + other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided + by the Library, but which is not otherwise based on the Library. + Defining a subclass of a class defined by the Library is deemed a mode + of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an + Application with the Library. The particular version of the Library + with which the Combined Work was made is also called the "Linked + Version". + + The "Minimal Corresponding Source" for a Combined Work means the + Corresponding Source for the Combined Work, excluding any source code + for portions of the Combined Work that, considered in isolation, are + based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the + object code and/or source code for the Application, including any data + and utility programs needed for reproducing the Combined Work from the + Application, but excluding the System Libraries of the Combined Work. + +1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License + without being bound by section 3 of the GNU GPL. + +2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a + facility refers to a function or data to be supplied by an Application + that uses the facility (other than as an argument passed when the + facility is invoked), then you may convey a copy of the modified + version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + +3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from + a header file that is part of the Library. You may convey such object + code under terms of your choice, provided that, if the incorporated + material is not limited to numerical parameters, data structure + layouts and accessors, or small macros, inline functions and templates + (ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + +4. Combined Works. + + You may convey a Combined Work under terms of your choice that, + taken together, effectively do not restrict modification of the + portions of the Library contained in the Combined Work and reverse + engineering for debugging such modifications, if you also do each of + the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + +5. Combined Libraries. + + You may place library facilities that are a work based on the + Library side by side in a single library together with other library + facilities that are not Applications and are not covered by this + License, and convey such a combined library under terms of your + choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + +6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions + of the GNU Lesser General Public License from time to time. Such new + versions will be similar in spirit to the present version, but may + differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the + Library as you received it specifies that a certain numbered version + of the GNU Lesser General Public License "or any later version" + applies to it, you have the option of following the terms and + conditions either of that published version or of any later version + published by the Free Software Foundation. If the Library as you + received it does not specify a version number of the GNU Lesser + General Public License, you may choose any version of the GNU Lesser + General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide + whether future versions of the GNU Lesser General Public License shall + apply, that proxy's public statement of acceptance of any version is + permanent authorization for you to choose that version for the + Library. diff -r ea7858d75459 -r 43f1cbdcd597 doku/Makefile --- a/doku/Makefile Wed Jul 20 14:06:07 2011 +0200 +++ b/doku/Makefile Wed Jul 20 15:53:01 2011 +0200 @@ -6,6 +6,7 @@ SPHINXBUILD = sphinx-build PAPER = BUILDDIR = build +MAKE = make # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 @@ -37,6 +38,7 @@ -rm -rf $(BUILDDIR)/* html: + $(MAKE) -C funktionsweise all $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." @@ -91,6 +93,7 @@ @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: + $(MAKE) -C funktionsweise all $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @@ -98,6 +101,7 @@ "(use \`make latexpdf' here to do that automatically)." latexpdf: + $(MAKE) -C funktionsweise all $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." make -C $(BUILDDIR)/latex all-pdf diff -r ea7858d75459 -r 43f1cbdcd597 doku/source/LICENCE.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doku/source/LICENCE.txt Wed Jul 20 15:53:01 2011 +0200 @@ -0,0 +1,1 @@ +../../LICENCE.txt \ No newline at end of file diff -r ea7858d75459 -r 43f1cbdcd597 doku/source/_static/favicon.png Binary file doku/source/_static/favicon.png has changed diff -r ea7858d75459 -r 43f1cbdcd597 doku/source/_static/logo_wide.png Binary file doku/source/_static/logo_wide.png has changed diff -r ea7858d75459 -r 43f1cbdcd597 doku/source/_templates/indexsidebar.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doku/source/_templates/indexsidebar.html Wed Jul 20 15:53:01 2011 +0200 @@ -0,0 +1,8 @@ +

Download

+

MXD2map-sourcecode is available at our + website.

+ +

Questions? Suggestions?

+ +

Don't hesitate to ask at the MXD2map-developer-mailinglist.

diff -r ea7858d75459 -r 43f1cbdcd597 doku/source/_templates/layout.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doku/source/_templates/layout.html Wed Jul 20 15:53:01 2011 +0200 @@ -0,0 +1,24 @@ +{% extends "!layout.html" %} + +{% block extrahead %} +{{ super() }} +{%- if not embedded %} + +{%- endif %} +{% endblock %} + +{% block header %} +
+ + MXD2map logo + +
+{% endblock %} + +{% block rootrellink %} +
  • MXD2map website | 
    • +
  • Contents
    • +{% endblock %} diff -r ea7858d75459 -r 43f1cbdcd597 doku/source/conf.py --- a/doku/source/conf.py Wed Jul 20 14:06:07 2011 +0200 +++ b/doku/source/conf.py Wed Jul 20 15:53:01 2011 +0200 @@ -41,20 +41,21 @@ # General information about the project. project = u'MXD2map' -copyright = u'2011, foo bar' +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 # built documents. # # The short X.Y version. -version = '0.0.1' +version = '0.1' # The full version, including alpha/beta/rc tags. -release = '0.0.1' +release = '0.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -language = 'de' +language = 'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -91,7 +92,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'sphinxdoc' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -115,7 +116,7 @@ # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +html_favicon = '_static/favicon.png' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -131,7 +132,7 @@ #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +html_sidebars = {'index': ['indexsidebar.html', 'searchbox.html']} # Additional templates that should be rendered to pages, maps page names to # template names. @@ -147,13 +148,13 @@ #html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the @@ -170,16 +171,16 @@ # -- Options for LaTeX output -------------------------------------------------- # The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' +latex_paper_size = 'a4' # The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' +latex_font_size = '12pt' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'MXD2map.tex', u'MXD2map Documentation', - u'foo bar', 'manual'), + u'Raimund Renkert, Stephan Holl', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -221,7 +222,7 @@ } ''', 'classoptions': ',oneside', -'babel': '\\usepackage[ngerman,german]{babel}' +'babel': '\\usepackage[english]{babel}' } @@ -231,5 +232,5 @@ # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'mxd2map', u'MXD2map Documentation', - [u'foo bar'], 1) + [u'Raimund Renkert, Stephan Holl'], 1) ] diff -r ea7858d75459 -r 43f1cbdcd597 doku/source/functionality.txt --- a/doku/source/functionality.txt Wed Jul 20 14:06:07 2011 +0200 +++ b/doku/source/functionality.txt Wed Jul 20 15:53:01 2011 +0200 @@ -1,3 +1,6 @@ +.. index:: features, functionality, configuration, runtime-parameter, +commandline + ------------- Functionality ------------- @@ -9,7 +12,7 @@ must have a valid and available data source and must not fit the :ref:`restriction-label` described in the appropriate section. -.. image:: ../funktionsweise/funktionsweise-MXD-konverter.svg +.. image:: ../funktionsweise/funktionsweise-MXD-konverter.png .. _howtouse-label: @@ -25,6 +28,16 @@ 1. The converter.properties file (see converter.properties.sample) 2. via commandline arguments +The converter.properties.sample file:: + + + # Java properties file for the MXD Converter Tool. + mxd = \\full\\path\\to\\mxd-file + map = \\full\\path\\to\\map-file + map-template = \\full\\path\\to\\mapfile-template + +Make sure you mask backslahes with an additional backslash. + 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. @@ -40,7 +53,7 @@ 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 +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. @@ -50,7 +63,7 @@ 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 @@ -60,33 +73,37 @@ Features -------- -Currently supported features: +MXD2map currently supportes the following features: - * The MXD2map converter can use ArcSDE database connections and local - shapefile datasources to create a mapfile. + * Datasources + * ArcSDE database connections (requires MapServer built against ArcSDE, Client-dlls needed) + * ESRI-Shapefiles - * Convertable symbols: + * Symbols: * Simple marker symbols * Character marker symbols * Arrow marker symbols + * Symbols based on TTF-characters of special cartographic fonts * 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: + * Polygons filled with a hatch and hatched outline - * Feature layer - * Layer containing unique values - * Layer containing class breaks - * Grouplayer with one grouplevel + * Layer types: + + * Featurelayer (vectors) as POINT, LINESTRING and POLYGON + * Classifications with unique values + * Classifications with class breaks + * Grouplayers with one grouplevel (as MapServer does not support more than one nested level) * Further map attributes: - * Projection and units - * Min/max scale denominations + * Projections and units based on the EPSG-table + * Min/max scale denominations at layer and label-level * Map extents * Simple labeling * Filter and expressions + * ArcSDE Jointables + * diff -r ea7858d75459 -r 43f1cbdcd597 doku/source/index.txt --- a/doku/source/index.txt Wed Jul 20 14:06:07 2011 +0200 +++ b/doku/source/index.txt Wed Jul 20 15:53:01 2011 +0200 @@ -3,14 +3,15 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to MXD2map's documentation! -=================================== +.. index:: contents -Contents: +MXD2map documentation! +======================= .. toctree:: :maxdepth: 2 + LICENCE.txt INSTALL.txt functionality.txt restrictions.txt @@ -19,6 +20,5 @@ ================== * :ref:`genindex` -* :ref:`modindex` * :ref:`search` diff -r ea7858d75459 -r 43f1cbdcd597 doku/source/restrictions.txt --- a/doku/source/restrictions.txt Wed Jul 20 14:06:07 2011 +0200 +++ b/doku/source/restrictions.txt Wed Jul 20 15:53:01 2011 +0200 @@ -1,4 +1,4 @@ -.. _restriction-label: +.. index:: restrictions ------------ Restrictions @@ -9,10 +9,10 @@ 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 ```` which needs to be replaced later on in the + resulting mapfile. - * Since the MapServer cannot use a file geodatabase datasource the converter + * Since MapServer cannot use a FileGeodatabase datasources (yet) the MXD2map does not support this datasource and will not transform the MXD-file at all. * Raster data is not supported by the converter yet. @@ -22,9 +22,10 @@ * 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. + The resulting mapimage may not look as intended. - * Workarround: - For small marker symbols it is recommended to use a line symbol in + * .. 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. The reason why marker symbols cannot be used in combination with a template @@ -35,18 +36,19 @@ 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: - To avoid lines and line colors (specially outlines) to be handled by the + * .. tip:: + 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. + * Picture symbols are not supported by the converter since ArcGIS embedds + the image directly into the MXDfile. - * 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 maps default symbols can be defined as fallback within classifications. + Since MapServer does not support such fallback symbols or styles + within classifications 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. + values. The converter does not support these symbols yet. Layer support: diff -r ea7858d75459 -r 43f1cbdcd597 website/favicon.png Binary file website/favicon.png has changed