[mapguide-commits] r5573 - in trunk/MgDev/Doc: . devguide devguide/source devguide/source/images

svn_mapguide at osgeo.org svn_mapguide at osgeo.org
Tue Mar 1 05:51:07 EST 2011


Author: jng
Date: 2011-03-01 02:51:07 -0800 (Tue, 01 Mar 2011)
New Revision: 5573

Added:
   trunk/MgDev/Doc/devguide/
   trunk/MgDev/Doc/devguide/Makefile
   trunk/MgDev/Doc/devguide/build_readme.txt
   trunk/MgDev/Doc/devguide/make.bat
   trunk/MgDev/Doc/devguide/source/
   trunk/MgDev/Doc/devguide/source/_static/
   trunk/MgDev/Doc/devguide/source/_templates/
   trunk/MgDev/Doc/devguide/source/analyzing_features.rst
   trunk/MgDev/Doc/devguide/source/conf.py
   trunk/MgDev/Doc/devguide/source/custom_output.rst
   trunk/MgDev/Doc/devguide/source/digitizing_and_redlining.rst
   trunk/MgDev/Doc/devguide/source/fusion.rst
   trunk/MgDev/Doc/devguide/source/images/
   trunk/MgDev/Doc/devguide/source/images/OSGeo_compass_watermark.png
   trunk/MgDev/Doc/devguide/source/images/mgos.gif
   trunk/MgDev/Doc/devguide/source/images/osgeo.png
   trunk/MgDev/Doc/devguide/source/index.rst
   trunk/MgDev/Doc/devguide/source/interacting_with_layers.rst
   trunk/MgDev/Doc/devguide/source/introduction.rst
   trunk/MgDev/Doc/devguide/source/maestroapi.rst
   trunk/MgDev/Doc/devguide/source/mapagent.rst
   trunk/MgDev/Doc/devguide/source/mapguide_advanced.rst
   trunk/MgDev/Doc/devguide/source/mapguide_ajax_viewer.rst
   trunk/MgDev/Doc/devguide/source/mapguide_cookbook.rst
   trunk/MgDev/Doc/devguide/source/modifying_maps_and_layers.rst
   trunk/MgDev/Doc/devguide/source/openlayers.rst
   trunk/MgDev/Doc/devguide/source/working_with_feature_data.rst
Log:
#1614: Add initial skeleton of updated developer's guide. This currently has the outline of the current devguide, along with some extra topics of interest such as Fusion, OpenLayers and Maestro


Property changes on: trunk/MgDev/Doc/devguide
___________________________________________________________________
Added: svn:ignore
   + build


Added: trunk/MgDev/Doc/devguide/Makefile
===================================================================
--- trunk/MgDev/Doc/devguide/Makefile	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/Makefile	2011-03-01 10:51:07 UTC (rev 5573)
@@ -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/MapGuideDevelopersGuide.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/MapGuideDevelopersGuide.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/MapGuideDevelopersGuide"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/MapGuideDevelopersGuide"
+	@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."

Added: trunk/MgDev/Doc/devguide/build_readme.txt
===================================================================
--- trunk/MgDev/Doc/devguide/build_readme.txt	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/build_readme.txt	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,5 @@
+This devguide is built using Sphinx (http://sphinx.pocoo.org)
+
+Sphinx requires Python 2.6
+
+Once sphinx is installed, run the make.bat file to build the devguide
\ No newline at end of file

Added: trunk/MgDev/Doc/devguide/make.bat
===================================================================
--- trunk/MgDev/Doc/devguide/make.bat	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/make.bat	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,170 @@
+ at ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	: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.  text       to make text files
+	echo.  man        to make manual pages
+	echo.  changes    to make an overview over 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
+	goto end
+)
+
+if "%1" == "clean" (
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+	del /q /s %BUILDDIR%\*
+	goto end
+)
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+	goto end
+)
+
+if "%1" == "singlehtml" (
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "htmlhelp" (
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+	goto end
+)
+
+if "%1" == "qthelp" (
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\MapGuideDevelopersGuide.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\MapGuideDevelopersGuide.ghc
+	goto end
+)
+
+if "%1" == "devhelp" (
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished.
+	goto end
+)
+
+if "%1" == "epub" (
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "text" (
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The text files are in %BUILDDIR%/text.
+	goto end
+)
+
+if "%1" == "man" (
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.The overview file is in %BUILDDIR%/changes.
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+	goto end
+)
+
+:end

Added: trunk/MgDev/Doc/devguide/source/analyzing_features.rst
===================================================================
--- trunk/MgDev/Doc/devguide/source/analyzing_features.rst	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/source/analyzing_features.rst	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,26 @@
+.. index::
+   single: feature; analysis
+   
+Analyzing Features
+==================
+
+Introduction
+------------
+
+Representations of Geometry
+---------------------------
+
+Coordinate Systems
+------------------
+
+Measuring Distance
+------------------
+
+Temporary Feature Sources
+-------------------------
+
+Creating a Buffer
+-----------------
+
+Example
+-------
\ No newline at end of file

Added: trunk/MgDev/Doc/devguide/source/conf.py
===================================================================
--- trunk/MgDev/Doc/devguide/source/conf.py	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/source/conf.py	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,260 @@
+# -*- coding: utf-8 -*-
+#
+# MapGuide Developer's Guide documentation build configuration file, created by
+# sphinx-quickstart on Tue Mar 01 20:12:19 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.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'MapGuide Developer\'s Guide'
+copyright = u'2011, Open Source Geospatial Foundation'
+
+# 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 = '2.0'
+# The full version, including alpha/beta/rc tags.
+release = '2.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# 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 = '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
+# 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 = 'MapGuide Developer\'s Guide'
+
+# 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 = 'images/mgos.gif'
+
+# 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 = 'MapGuideDevelopersGuide'
+
+
+# -- 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', 'MapGuideDevelopersGuide.tex', u'MapGuide Developer\'s Guide',
+   u'Open Source Geospatial Foundation', '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
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'mapguidedevelopersguide', u'MapGuide Developer\'s Guide',
+     [u'Open Source Geospatial Foundation'], 1)
+]
+
+
+# -- Options for Epub output ---------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u'MapGuide Developer\'s Guide'
+epub_author = u'Open Source Geospatial Foundation'
+epub_publisher = u'Open Source Geospatial Foundation'
+epub_copyright = u'2011, Open Source Geospatial Foundation'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+#epub_exclude_files = []
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}

Added: trunk/MgDev/Doc/devguide/source/custom_output.rst
===================================================================
--- trunk/MgDev/Doc/devguide/source/custom_output.rst	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/source/custom_output.rst	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,16 @@
+.. index::
+   
+Custom Output
+=============
+
+.. todo:
+    Talk about KML output as well
+
+Introduction
+------------
+
+Rendering Service
+-----------------
+
+Mapping Service
+---------------
\ No newline at end of file

Added: trunk/MgDev/Doc/devguide/source/digitizing_and_redlining.rst
===================================================================
--- trunk/MgDev/Doc/devguide/source/digitizing_and_redlining.rst	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/source/digitizing_and_redlining.rst	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,14 @@
+.. index::
+   single: digitizing; redlining
+   
+Digitizing and Redlining
+========================
+
+Introduction
+------------
+
+Digitizing
+----------
+
+Redlining
+---------
\ No newline at end of file

Added: trunk/MgDev/Doc/devguide/source/fusion.rst
===================================================================
--- trunk/MgDev/Doc/devguide/source/fusion.rst	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/source/fusion.rst	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,20 @@
+.. index:
+   single: fusion
+
+The Fusion Application Framework
+================================
+
+Introduction
+------------
+
+Essential Concepts
+------------------
+
+Widgets
+-------
+
+Events
+------
+
+Working With Maps
+-----------------

Added: trunk/MgDev/Doc/devguide/source/images/OSGeo_compass_watermark.png
===================================================================
(Binary files differ)


Property changes on: trunk/MgDev/Doc/devguide/source/images/OSGeo_compass_watermark.png
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Added: trunk/MgDev/Doc/devguide/source/images/mgos.gif
===================================================================
(Binary files differ)


Property changes on: trunk/MgDev/Doc/devguide/source/images/mgos.gif
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Added: trunk/MgDev/Doc/devguide/source/images/osgeo.png
===================================================================
(Binary files differ)


Property changes on: trunk/MgDev/Doc/devguide/source/images/osgeo.png
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Added: trunk/MgDev/Doc/devguide/source/index.rst
===================================================================
--- trunk/MgDev/Doc/devguide/source/index.rst	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/source/index.rst	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,36 @@
+.. MapGuide Developer's Guide documentation master file, created by
+   sphinx-quickstart on Tue Mar 01 20:12:19 2011.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+MapGuide Developer's Guide
+==========================
+
+
+Contents
+========
+
+.. toctree::
+   :maxdepth: 2
+   
+   introduction
+   mapguide_ajax_viewer
+   interacting_with_layers
+   working_with_feature_data
+   modifying_maps_and_layers
+   analyzing_features
+   digitizing_and_redlining
+   custom_output
+   openlayers
+   fusion
+   mapagent
+   maestroapi
+   mapguide_advanced
+   mapguide_cookbook
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
+

Added: trunk/MgDev/Doc/devguide/source/interacting_with_layers.rst
===================================================================
--- trunk/MgDev/Doc/devguide/source/interacting_with_layers.rst	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/source/interacting_with_layers.rst	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,14 @@
+.. index::
+   single: layers
+   
+Interacting With Layers
+=======================
+
+Overview of Layers
+------------------
+
+Enumerating Map Layers
+----------------------
+
+Manipulating Layers
+-------------------
\ No newline at end of file

Added: trunk/MgDev/Doc/devguide/source/introduction.rst
===================================================================
--- trunk/MgDev/Doc/devguide/source/introduction.rst	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/source/introduction.rst	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,29 @@
+.. index::
+   single: introduction
+   
+Introduction
+============
+
+What This Guide Covers
+----------------------
+
+Essential Concepts
+------------------
+
+Preparing to Run the Examples
+-----------------------------
+
+Application Development
+-----------------------
+
+Resources and Repositories
+--------------------------
+
+Hello, Map - Displaying a Web Layout
+------------------------------------
+
+Hello, Map 2 - Adding a Custom Command
+--------------------------------------
+
+Understanding Services
+----------------------
\ No newline at end of file

Added: trunk/MgDev/Doc/devguide/source/maestroapi.rst
===================================================================
--- trunk/MgDev/Doc/devguide/source/maestroapi.rst	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/source/maestroapi.rst	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,20 @@
+.. index:
+   single: maestro
+   
+Using the Maestro API
+=====================
+
+Introduction
+------------
+
+The Server Connection Interface
+-------------------------------
+
+The Resource Object Model
+-------------------------
+
+Resource Validation
+-------------------
+
+Using the Official MapGuide API
+-------------------------------
\ No newline at end of file

Added: trunk/MgDev/Doc/devguide/source/mapagent.rst
===================================================================
--- trunk/MgDev/Doc/devguide/source/mapagent.rst	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/source/mapagent.rst	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,5 @@
+.. index:
+   single: mapagent
+   
+The Map Agent
+=============
\ No newline at end of file

Added: trunk/MgDev/Doc/devguide/source/mapguide_advanced.rst
===================================================================
--- trunk/MgDev/Doc/devguide/source/mapguide_advanced.rst	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/source/mapguide_advanced.rst	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,25 @@
+.. index:
+
+Advanced MapGuide Topics
+========================
+
+Using Transactions
+------------------
+
+Describing a Feature Source
+---------------------------
+
+Creating a File-based Feature Source
+------------------------------------
+
+Feature Source CRUD
+-------------------
+
+Creating and Modifying Schemas
+------------------------------
+
+Quering Data with Expressions and Filters
+-----------------------------------------
+
+The Geospatial Platform and MapGuide's role in it
+-------------------------------------------------
\ No newline at end of file

Added: trunk/MgDev/Doc/devguide/source/mapguide_ajax_viewer.rst
===================================================================
--- trunk/MgDev/Doc/devguide/source/mapguide_ajax_viewer.rst	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/source/mapguide_ajax_viewer.rst	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,17 @@
+.. index::
+   single: viewer
+   
+The MapGuide AJAX Viewer
+========================
+
+Introduction
+------------
+
+Understanding Viewer Frames
+---------------------------
+
+MapGuide Viewer API
+-------------------
+
+Embedding a Viewer in Your Own Page
+------------------------------------
\ No newline at end of file

Added: trunk/MgDev/Doc/devguide/source/mapguide_cookbook.rst
===================================================================
--- trunk/MgDev/Doc/devguide/source/mapguide_cookbook.rst	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/source/mapguide_cookbook.rst	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,5 @@
+.. index:
+   single: samples
+   
+MapGuide Cookbook
+-----------------
\ No newline at end of file

Added: trunk/MgDev/Doc/devguide/source/modifying_maps_and_layers.rst
===================================================================
--- trunk/MgDev/Doc/devguide/source/modifying_maps_and_layers.rst	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/source/modifying_maps_and_layers.rst	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,23 @@
+.. index::
+   single: map; layer
+
+Modifying Maps and Layers
+=========================
+
+Introduction
+------------
+
+Adding An Existing Layer To A Map
+---------------------------------
+
+Creating Layers by Modifying XML
+--------------------------------
+
+Another Way to Create Layers
+----------------------------
+
+Adding Layers to a Map
+----------------------
+
+Making Changes Permanent
+------------------------
\ No newline at end of file

Added: trunk/MgDev/Doc/devguide/source/openlayers.rst
===================================================================
--- trunk/MgDev/Doc/devguide/source/openlayers.rst	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/source/openlayers.rst	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,5 @@
+.. index:
+   single: openlayers
+   
+Using OpenLayers with MapGuide
+==============================
\ No newline at end of file

Added: trunk/MgDev/Doc/devguide/source/working_with_feature_data.rst
===================================================================
--- trunk/MgDev/Doc/devguide/source/working_with_feature_data.rst	                        (rev 0)
+++ trunk/MgDev/Doc/devguide/source/working_with_feature_data.rst	2011-03-01 10:51:07 UTC (rev 5573)
@@ -0,0 +1,14 @@
+.. index::
+   single: feature; data
+
+Working With Feature Data
+=========================
+
+Overivew of Features
+--------------------
+
+Querying Feature Data
+---------------------
+
+Active Selections
+-----------------
\ No newline at end of file



More information about the mapguide-commits mailing list