changeset 144:ad3f540fd1c3

Merged.
author vc11884admin@VC11884.win.bsh.de
date Mon, 27 Jun 2011 17:22:52 +0200
parents f98d2759e494 (diff) 6d294beb0e59 (current diff)
children b2c5a66022f1
files ChangeLog
diffstat 10 files changed, 516 insertions(+), 20 deletions(-) [+]
line wrap: on
line diff
--- a/.hgignore	Mon Jun 27 17:16:55 2011 +0200
+++ b/.hgignore	Mon Jun 27 17:22:52 2011 +0200
@@ -1,4 +1,4 @@
 syntax: regexp
 ^mapserver/logs/
 ^tmp/
-
+^doku/build/
--- a/ChangeLog	Mon Jun 27 17:16:55 2011 +0200
+++ b/ChangeLog	Mon Jun 27 17:22:52 2011 +0200
@@ -16,6 +16,26 @@
 	  Test if symbol exists. If not exists, write new symbol with new
 	  name.
 
+2011-06-24  Stephan Holl  <stephan.holl@intevation.de>
+
+	* INSTALL.txt: added a hint how to install the converter and its
+	requirements.
+	* doku/source/conf.py, doku/source/INSTALL.txt,
+	doku/source/index.txt,doku/source/restrictions.txt,
+	doku/source/index.rst,doku/source/restrictions.rst: renamed .rst to
+	.txt, linked INSTALL.txt from root into the docs.
+
+2011-06-24  Stephan Holl  <stephan.holl@intevation.de>
+
+
+	* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
+	doku/source/restrictions.rst: New. added stub for creating a
+	documentation.
+
+2011-06-24  Stephan Holl  <stephan.holl@intevation.de>
+
+	* moved README.txt to mxd/README_testbed.txt
+
 2011-06-23  Raimund Renkert  <raimund.renkert@intevation.de>
 
 	* src/java/de/intevation/mxd/utils/MapToXMLUtils.java,
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/INSTALL.txt	Mon Jun 27 17:22:52 2011 +0200
@@ -0,0 +1,74 @@
+------------
+Requirements
+------------
+
+The current version of the converter only runs on Windows. This is because
+the ArcObjects JDK API is not running properly on Linux though.
+
+To run the converter you need at least the following componentes:
+
+ * 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
+ * Optional: MapServer compiled with ArcSDE-plugin
+ * Optional: GDAL/OGR compiled with ArcSDE-support
+ * Optional: GDAL/OGR compiled with FileGeodatabase-support 
+
+
+
+------------
+Installation
+------------
+
+Compile the converter-sources
+-----------------------------
+
+To compile the sources you need to have a properly configured
+ant-environmet available. ArcGIS SDK provides an ant-installation which
+suffices::
+
+ ant jar
+
+Install Apache Webserver
+------------------------
+
+Install Apache webserver by exedcuting the .msi-file and follow the
+install-dialogs::
+
+ httpd-2.2.19-win32-x86-openssl-0.9.8r.msi
+
+Make sure that you install apache as a service so it will be available
+directly after system bootup.
+
+
+Install UMN MapServer
+---------------------
+
+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
+
+#. Configure Apache Webserver to find the cgi-bin-folder::
+
+    ScriptAlias /cgi-bin/ "C:/ms_6.1-dev/bin/"
+
+    <Location "/cgi-bin">
+        Options None
+        Order allow,deny
+        Allow from all
+    </Location>
+
+#. Copy mapserv.exe from c:/ms_6.1-dev/bin/apps/ms to c:/ms_6.1-dev/bin/
+
+Create run-environment
+----------------------
+
+writeme
+
+
+-----
+Usage
+-----
+
+writeme
--- a/README.txt	Mon Jun 27 17:16:55 2011 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,19 +0,0 @@
-===========
-MXD TESTBED
-===========
-
-For more information take a look at:
-https://bsh-intern.intevation.de/MXD/Arbeitspakete/AP2/1
-
-URLs
-====
-http://bhutan.atlas.intevation.de/cgi-bin/wms_mxd.cgi
-http://bhutan.atlas.intevation.de/cgi-bin/wms_mxd.cgi?Request=GetCapabilities&Service=WMS&Version=1.1.1
-
-
-Setting up mapserver mxd testbed under SLES 11
-==============================================
-zypper in mapserver
-ln -s /home/intevation/mxd-testbed/contrib/sh/wms_mxd.cgi /srv/www/cgi-bin
-ln -s /home/intevation/mxd-testbed/contrib/apache/mxd-testbed.conf /etc/apache2/vhosts.d/
-/etc/init.d/apache2 reload
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doku/Makefile	Mon Jun 27 17:22:52 2011 +0200
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/MXD2map.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/MXD2map.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/MXD2map"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/MXD2map"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doku/source/INSTALL.txt	Mon Jun 27 17:22:52 2011 +0200
@@ -0,0 +1,1 @@
+../../INSTALL.txt
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doku/source/conf.py	Mon Jun 27 17:22:52 2011 +0200
@@ -0,0 +1,235 @@
+# -*- coding: utf-8 -*-
+#
+# MXD2map documentation build configuration file, created by
+# sphinx-quickstart on Mon Jun 20 09:48:05 2011.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.viewcode']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.txt'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'MXD2map'
+copyright = u'2011, foo bar'
+
+# 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'
+# The full version, including alpha/beta/rc tags.
+release = '0.0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+language = 'de'
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# 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
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# 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
+
+# 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,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# 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
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'MXD2mapdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# 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'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+latex_elements = {
+'preamble': r'''\newcommand{\pyHeaderFamily}{\sffamily\bfseries}
+\fancypagestyle{normal}{ \fancyhf{}
+    \fancyfoot[LE,RO]{{\pyHeaderFamily \thepage}}
+    \fancyfoot[LO]{{\pyHeaderFamily \nouppercase{\rightmark}}}
+    \fancyfoot[RE]{{\pyHeaderFamily \nouppercase{\leftmark}}}
+    \fancyhead[LE,RO]{{\pyHeaderFamily \title,
+ \releasename\space\version}}
+    \renewcommand{\headrulewidth}{0.4pt}
+    \renewcommand{\footrulewidth}{0.4pt}
+    % changes
+    %\fancyhead[LO,RE]{{\includegraphics[height=0.5cm]{InteProxy-logo.png}}}
+
+}
+''',
+'classoptions': ',oneside',
+'babel': '\\usepackage[ngerman,german]{babel}'
+} 
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'mxd2map', u'MXD2map Documentation',
+     [u'foo bar'], 1)
+]
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doku/source/index.txt	Mon Jun 27 17:22:52 2011 +0200
@@ -0,0 +1,23 @@
+.. MXD2map documentation master file, created by
+   sphinx-quickstart on Mon Jun 20 09:48:05 2011.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to MXD2map's documentation!
+===================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   INSTALL.txt
+   restrictions.txt
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doku/source/restrictions.txt	Mon Jun 27 17:22:52 2011 +0200
@@ -0,0 +1,13 @@
+------------
+Restrictions
+------------
+
+Currently there are some restrictions in the usage of the converter:
+
+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
+
+ * 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mxd/README_mxd.txt	Mon Jun 27 17:22:52 2011 +0200
@@ -0,0 +1,19 @@
+===========
+MXD TESTBED
+===========
+
+For more information take a look at:
+https://bsh-intern.intevation.de/MXD/Arbeitspakete/AP2/1
+
+URLs
+====
+http://bhutan.atlas.intevation.de/cgi-bin/wms_mxd.cgi
+http://bhutan.atlas.intevation.de/cgi-bin/wms_mxd.cgi?Request=GetCapabilities&Service=WMS&Version=1.1.1
+
+
+Setting up mapserver mxd testbed under SLES 11
+==============================================
+zypper in mapserver
+ln -s /home/intevation/mxd-testbed/contrib/sh/wms_mxd.cgi /srv/www/cgi-bin
+ln -s /home/intevation/mxd-testbed/contrib/apache/mxd-testbed.conf /etc/apache2/vhosts.d/
+/etc/init.d/apache2 reload
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)