[mapguide-commits] r5771 - in trunk/Tools/Maestro: . UserDoc
UserDoc/source
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Tue May 10 10:54:06 EDT 2011
Author: jng
Date: 2011-05-10 07:54:06 -0700 (Tue, 10 May 2011)
New Revision: 5771
Added:
trunk/Tools/Maestro/UserDoc/
trunk/Tools/Maestro/UserDoc/Makefile
trunk/Tools/Maestro/UserDoc/make.bat
trunk/Tools/Maestro/UserDoc/source/
trunk/Tools/Maestro/UserDoc/source/_static/
trunk/Tools/Maestro/UserDoc/source/_templates/
trunk/Tools/Maestro/UserDoc/source/conf.py
trunk/Tools/Maestro/UserDoc/source/differences.rst
trunk/Tools/Maestro/UserDoc/source/edit_xml.rst
trunk/Tools/Maestro/UserDoc/source/index.rst
trunk/Tools/Maestro/UserDoc/source/installation.rst
trunk/Tools/Maestro/UserDoc/source/introduction.rst
trunk/Tools/Maestro/UserDoc/source/localpreview.rst
trunk/Tools/Maestro/UserDoc/source/mapguide_terminology.rst
trunk/Tools/Maestro/UserDoc/source/mgcooker.rst
trunk/Tools/Maestro/UserDoc/source/other_tools.rst
trunk/Tools/Maestro/UserDoc/source/packaging.rst
trunk/Tools/Maestro/UserDoc/source/resource_validation.rst
trunk/Tools/Maestro/UserDoc/source/understanding_applications.rst
trunk/Tools/Maestro/UserDoc/source/understanding_feature_sources.rst
trunk/Tools/Maestro/UserDoc/source/understanding_layers.rst
trunk/Tools/Maestro/UserDoc/source/user_interface.rst
Log:
#1677: Add initial skeleton for the Maestro User Guide
Added: trunk/Tools/Maestro/UserDoc/Makefile
===================================================================
--- trunk/Tools/Maestro/UserDoc/Makefile (rev 0)
+++ trunk/Tools/Maestro/UserDoc/Makefile 2011-05-10 14:54:06 UTC (rev 5771)
@@ -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/MaestroUserGuide.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/MaestroUserGuide.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/MaestroUserGuide"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/MaestroUserGuide"
+ @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/Tools/Maestro/UserDoc/make.bat
===================================================================
--- trunk/Tools/Maestro/UserDoc/make.bat (rev 0)
+++ trunk/Tools/Maestro/UserDoc/make.bat 2011-05-10 14:54:06 UTC (rev 5771)
@@ -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\MaestroUserGuide.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\MaestroUserGuide.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/Tools/Maestro/UserDoc/source/conf.py
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/conf.py (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/conf.py 2011-05-10 14:54:06 UTC (rev 5771)
@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+#
+# Maestro User Guide documentation build configuration file, created by
+# sphinx-quickstart on Wed May 11 00:21:18 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.todo', 'sphinx.ext.coverage', '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'Maestro User 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 = '1.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.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 = 'Maestro User 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 = 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 = 'MaestroUserGuide'
+
+
+# -- 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', 'MaestroUserGuide.tex', u'Maestro User Guide Documentation',
+ u'Jackie Ng', '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', 'maestrouserguide', u'Maestro User Guide Documentation',
+ [u'Jackie Ng'], 1)
+]
Added: trunk/Tools/Maestro/UserDoc/source/differences.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/differences.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/differences.rst 2011-05-10 14:54:06 UTC (rev 5771)
@@ -0,0 +1,8 @@
+Differences between Maestro and MapGuide Studio
+===============================================
+
+Features unique to MapGuide Studio
+----------------------------------
+
+Features unique to MapGuide Maestro
+-----------------------------------
\ No newline at end of file
Added: trunk/Tools/Maestro/UserDoc/source/edit_xml.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/edit_xml.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/edit_xml.rst 2011-05-10 14:54:06 UTC (rev 5771)
@@ -0,0 +1,2 @@
+Editing via the XML editor
+==========================
\ No newline at end of file
Added: trunk/Tools/Maestro/UserDoc/source/index.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/index.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/index.rst 2011-05-10 14:54:06 UTC (rev 5771)
@@ -0,0 +1,38 @@
+.. Maestro User Guide documentation master file, created by
+ sphinx-quickstart on Wed May 11 00:21:18 2011.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Maestro User Guide
+==================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ introduction
+ installation
+ mapguide_terminology
+ differences
+
+ user_interface
+
+ understanding_feature_sources
+ understanding_layers
+ understanding_applications
+
+ edit_xml
+ resource_validation
+ packaging
+ mgcooker
+ localpreview
+ other_tools
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
Added: trunk/Tools/Maestro/UserDoc/source/installation.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/installation.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/installation.rst 2011-05-10 14:54:06 UTC (rev 5771)
@@ -0,0 +1,8 @@
+Installing MapGuide Maestro
+===========================
+
+Installing on Windows
+---------------------
+
+Installing on Linux/Mac OSX
+---------------------------
\ No newline at end of file
Added: trunk/Tools/Maestro/UserDoc/source/introduction.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/introduction.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/introduction.rst 2011-05-10 14:54:06 UTC (rev 5771)
@@ -0,0 +1,2 @@
+Introduction
+============
\ No newline at end of file
Added: trunk/Tools/Maestro/UserDoc/source/localpreview.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/localpreview.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/localpreview.rst 2011-05-10 14:54:06 UTC (rev 5771)
@@ -0,0 +1,2 @@
+Using Local Feature Source Preview
+==================================
\ No newline at end of file
Added: trunk/Tools/Maestro/UserDoc/source/mapguide_terminology.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/mapguide_terminology.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/mapguide_terminology.rst 2011-05-10 14:54:06 UTC (rev 5771)
@@ -0,0 +1,63 @@
+Understanding MapGuide Terminology
+==================================
+
+.. todo::
+ Currently copy/paste of existing wiki content
+
+Before you can start using MapGuide Maestro, you must understand how MapGuide divides the different parts that make up a map. To understand the MapGuide Maestro interface, you must also have a knowledgde of the names used in MapGuide.
+
+Types of Resources
+------------------
+
+...
+
+Spatial Data and Regular Data
+-----------------------------
+
+Data can come from a number of sources, such as a spread sheet or a database. Some data is spatially enabled, and this means that it has one or more columns of data that describes a geometric entry. Such data is usually called vector data. In spatially enabled data, the non-spatial data is usually called "attributes".
+
+Some data has an X and Y column (or LAT/LON), and is thus not spatially enabled. MapGuide can treat such data as if it was spatially enabled though.
+
+Another type of data is raster data, which is typically some form of aerial foto.
+
+MapGuide uses FDO to connect to data, and calls each connection a "FeatureSource", regardless of what type of data it points to.
+
+A "FeatureSource" does not have any information about how it looks, it's just lines, polygons and points.
+
+Displaying Data
+---------------
+
+In MapGuide a "LayerDefinition" is used to describe how to represent a layer visually. This distinction between data and representation, means that you can define your "FeatureSource" once, and display it in red, green and blue.
+
+In a "LayerDefinition" you define how the layer should look in different "ScaleRanges". A "ScaleRange" is defined by two numbers, and while the map is displayed at a given scale, MapGuide will show it as the first matching "ScaleRange". If you define a "ScaleRange" 0 - 1000 and one 1001 - 2000, you can display the data differently depending on how close the user is viewing the map.
+
+For each "ScaleRange" you can define a number of rules. This can be used to visually show difference in the non-spatial values, eg. land value, or a broken pipe, etc. The default rule in MapGuide is a blank rule, which will match all data.
+
+If you use rules to display eg. land values with a gradient color, ranging from low land value to high land value, it is called "Theming".
+
+An object in the map can also have a "Label", which is displayed on top of the item. This can be used to display road names.
+
+You can also set a "Tooltip" on an object, which will be displayed when the cursor hovers over the object.
+
+Finally you can set a "Link" on an object, which will open when the user double clicks on the feature (CTRL+click in some places).
+
+Combining Data
+--------------
+
+Once you have set up the visual apperance of your layers, you can combine them together in a map. In the map, the layers have a "Drawing Order", which is used to order how the layers are drawn. If you have a county and a subway layer, you might not be able to see the subways if they are below the large county layer. Usually polygons are at the bottom, then lines, then points, and finally labels on top.
+
+In MapGuide, such a collection of layers is called a "MapDefinition". In a "MapDefinition", you can also group layers, so the users can easily toggle the visibilty of a number of layers with a single click.
+
+In a "MapDefinition" you can also define what layers should be visible in the legend, and what names should be displayed in the legend.
+
+Presenting Data to the user
+---------------------------
+
+Now that you have a "MapDefinition", you can set up a frame the user can view the data in. This frame defines what tools the user has (Zoom tool, select tool, measure tool, etc.), as well as what items are visible (legend, overview map, etc.).
+
+There are currently two types of frames you can use, one called "WebLayout" and one called "Fusion Application". Autodesk has named the "Fusion Application" "Flexible Layout", so you may see that term as well.
+
+MapGuide Packages
+-----------------
+
+When you have put a lot of effort into setting up a map, you can take a backup of the entire setup. Such a backup is known as a "Package". A "Package" is a compressed file with the extension ".mgp". You can create, edit and restore such packages using either MapGuide Maestro, or the MapGuide Site Administrator.
\ No newline at end of file
Added: trunk/Tools/Maestro/UserDoc/source/mgcooker.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/mgcooker.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/mgcooker.rst 2011-05-10 14:54:06 UTC (rev 5771)
@@ -0,0 +1,2 @@
+Using MgCooker
+==============
\ No newline at end of file
Added: trunk/Tools/Maestro/UserDoc/source/other_tools.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/other_tools.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/other_tools.rst 2011-05-10 14:54:06 UTC (rev 5771)
@@ -0,0 +1,2 @@
+Other Tools
+===========
\ No newline at end of file
Added: trunk/Tools/Maestro/UserDoc/source/packaging.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/packaging.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/packaging.rst 2011-05-10 14:54:06 UTC (rev 5771)
@@ -0,0 +1,11 @@
+Packaging Data
+==============
+
+.. index::
+ single: Resources; Packaging and Loading
+
+Creating Packages
+-----------------
+
+Loading Packages
+----------------
\ No newline at end of file
Added: trunk/Tools/Maestro/UserDoc/source/resource_validation.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/resource_validation.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/resource_validation.rst 2011-05-10 14:54:06 UTC (rev 5771)
@@ -0,0 +1,5 @@
+Resource Validation
+===================
+
+.. index::
+ single: Resources; Validating
Added: trunk/Tools/Maestro/UserDoc/source/understanding_applications.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/understanding_applications.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/understanding_applications.rst 2011-05-10 14:54:06 UTC (rev 5771)
@@ -0,0 +1,8 @@
+Understanding Applications
+==========================
+
+Web Layouts
+-----------
+
+Application Definitions
+-----------------------
\ No newline at end of file
Added: trunk/Tools/Maestro/UserDoc/source/understanding_feature_sources.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/understanding_feature_sources.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/understanding_feature_sources.rst 2011-05-10 14:54:06 UTC (rev 5771)
@@ -0,0 +1,17 @@
+Understanding Feature Sources
+=============================
+
+File-based Data
+---------------
+
+Relational Data
+---------------
+
+Raster Data
+-----------
+
+The Generic Editor
+------------------
+
+Provider-specific notes
+-----------------------
\ No newline at end of file
Added: trunk/Tools/Maestro/UserDoc/source/understanding_layers.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/understanding_layers.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/understanding_layers.rst 2011-05-10 14:54:06 UTC (rev 5771)
@@ -0,0 +1,14 @@
+Understanding Layers
+====================
+
+Basic Layer Properties
+----------------------
+
+Advanced Layer Properties
+-------------------------
+
+Styling Layers
+--------------
+
+Theming Layers
+--------------
\ No newline at end of file
Added: trunk/Tools/Maestro/UserDoc/source/user_interface.rst
===================================================================
--- trunk/Tools/Maestro/UserDoc/source/user_interface.rst (rev 0)
+++ trunk/Tools/Maestro/UserDoc/source/user_interface.rst 2011-05-10 14:54:06 UTC (rev 5771)
@@ -0,0 +1,2 @@
+The Maestro User Interface
+==========================
\ No newline at end of file
More information about the mapguide-commits
mailing list