Documentation update

3 files changed, 478 insertions, 0 deletions

diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 000000000..b10f0f783
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+#
+# Ishtar documentation build configuration file, created by
+# sphinx-quickstart on Wed Oct 12 01:01:02 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 = []
+
+# 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'Ishtar'
+copyright = u'2011, Étienne Loks'
+
+# 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 = '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 = 'Ishtardoc'
+
+
+# -- 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', 'Ishtar.tex', u'Ishtar Documentation',
+   u'Étienne Loks', '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', 'ishtar', u'Ishtar Documentation',
+     [u'Étienne Loks'], 1)
+]
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 000000000..d1d5a6585
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,22 @@
+.. Ishtar documentation master file, created by
+   sphinx-quickstart on Wed Oct 12 01:01:02 2011.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Ishtar's documentation!
+==================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   installation
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
new file mode 100644
index 000000000..a19bf08c1
--- /dev/null
+++ b/docs/source/installation.rst
@@ -0,0 +1,240 @@
+.. -*- coding: utf-8 -*-
+
+===================
+Ishtar installation
+===================
+
+:Author: Étienne Loks
+:Date: 2011-10-12
+:Copyright: CC-BY 3.0
+
+This document presents the installation of Ishtar on a machine with GNU/Linux.
+Instruction are given for Debian but they are easy to adapt to other distribution.
+
+.. contents::
+
+Requirements
+------------
+
+ - `apache <http://www.apache.org/>`_ version 2.x
+
+ - `python <http://www.python.org/>`_ versions 2.6 or superior
+
+ - `django <http://www.djangoproject.com/>`_ version 1.2
+
+ - `postgresql <http://www.postgresql.org/>`_ version 8.x or 9.x
+
+ - `gettext <http://www.gnu.org/software/gettext/>`_
+
+ - `psycopg2 <http://freshmeat.net/projects/psycopg/>`_
+
+ - `python-pisa <http://pypi.python.org/pypi/pisa/>`_
+
+ - `django-registration <https://bitbucket.org/ubernostrum/django-registration/>`_
+
+ - `django-formwizard <http://django-formwizard.readthedocs.org/en/latest/>`_
+
+ - `django-simple-history <https://bitbucket.org/q/django-simple-history/src>`_ version 1.0
+
+ - `jquery <http://jquery.com/>`_
+
+ - `jquery-ui <http://jqueryui.com/>`_
+
+ - `xhtml2odt <http://xhtml2odt.org/>`_
+
+ - `python-utidylib <http://developer.berlios.de/projects/utidylib>`_
+
+ - `python-lxml <http://lxml.de/>`_
+
+ - `python-imaging <http://www.pythonware.com/products/pil/>`_
+
+Optionaly:
+
+ - curl (to fetch towns from OSM)
+
+
+The easier way to obtain most these packages is to get them from your favorite Linux distribution repositories.
+For instance the packages for Debian squeeze are get with::
+
+    $ apt-get install apache2 python python-django python-psycopg2 gettext postgresql-8.4 libjs-jquery libjs-jquery-ui
+    $ apt-get install python-pisa python-django-registration python-utidylib python-lxml python-imaging
+
+If these packages do not exist in your distribution's repository, please refer to applications websites.
+
+django-simple-history, django-formwizard and xhtml2odt are usually not packaged.
+
+To install django-simple-history (mercurial package is needed)::
+
+    $ hg clone -r 1.0 http://bitbucket.org/q/django-simple-history
+    $ cd django-simple-history
+    $ python setup.py install
+
+To install django-formwizard (git package is needed)::
+
+    $ git clone https://github.com/stephrdev/django-formwizard.git
+    $ cd django-formwizard
+    $ git checkout 0.5
+    $ python setup.py install
+
+To install django-formwizard (git package is needed)::
+
+    $ git clone git://gitorious.org/xhtml2odt/xhtml2odt.git
+
+(don't forget the path you have installed this library: you'll have to set it in your settings)
+
+If you want to take the bleeding edge version git is necessary. Install the appropriate package.
+
+Database configuration
+----------------------
+
+Now that postgres is installed, you need to create a new user for your ishtar instance::
+
+    $ su postgres
+    $ createuser --echo --adduser --createdb --encrypted --pwprompt ishtar-user
+
+Then, you have to create the database::
+
+
+    $ createdb --echo --owner ishtar-user --encoding UNICODE ishtar "My Ishtar database"
+
+Getting the sources
+-------------------
+
+Currently only the git version is available (in the directory you have decided to place sources - for instance /var/local is a good idea)::
+
+    $ cd /var/local/
+    $ git clone git://lysithea.proxience.com/git/ishtar.git
+    $ cd ishtar
+    $ git checkout prod
+
+"prod" is here the chosen version (do "git branch" to view available branches).
+
+Installing the sources
+-------------------
+
+In your Ishtar application directory create settings.py to fit to your configuration.
+A base template is provided (settings.py.example)::
+
+    $ cd /var/local/ishtar/ishtar/
+    $ ISHTAR_DIR=`pwd`
+    $ cp settings.py.example settings.py
+    $ nano settings.py
+    ####
+    ROOT_PATH = '/var/local/ishtar/ishtar/'
+
+    URL_PATH = ""
+    JQUERY_URL = "/javascript/jquery/jquery.js"
+    JQUERY_UI_URL = "/javascript/jquery-ui/"
+    XHTML2ODT_PATH = ROOT_PATH + "../xhtml2odt"
+    ODT_TEMPLATE = ROOT_PATH + "../static/template.odt"
+
+    LOGIN_REDIRECT_URL = "/" + URL_PATH
+
+    (...)
+    DATABASES = {
+    'default': {
+        'ENGINE': 'django.contrib.gis.db.backends.postgis', # Add 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'.
+        'NAME': 'ishtar',                      # Or path to database file if using sqlite3.
+        'USER': 'user',                      # Not used with sqlite3.
+        'PASSWORD': 'pass',                  # Not used with sqlite3.
+        'HOST': '',                      # Set to empty string for localhost. Not used with sqlite3.
+            'PORT': '',                      # Set to empty string for default. Not used with sqlite3.
+    }
+    }
+    (...)
+
+Compiling languages
+-------------------
+
+If your language is available in the locale directory of Ishtar, you will just need to get it compiled. Still being in the Ishtar directory, this can be done with (here, "de" stands for german. Replace it with the appropriate language code)::
+
+    $ cd $ISHTAR_DIR
+    $ django-admin compilemessages -l de
+
+If your language is not available, feel free to create the default po files and to submit it, contributions are well appreciated. Procedure is as follows.
+
+You first need to create the default po file (of course, replace "de" according to the language you chose to create)::
+
+
+    $ django-admin makemessages -l de
+
+There should now be a django.po file in locale/de/LC_MESSAGES. Complete it with your translation.
+
+Now that the translation file is completed, just compile it the same way you would have if the language file was already available.
+
+Database initialisation
+-----------------------
+
+Check if you have specific initialisation files for your country (this exemple
+for France: "fr")::
+
+    $ cd $ISHTAR_DIR
+    $ ls ../database/fr
+
+If a file "initial_data.json" exists copy it to a "fixtures" directory in the ishtar application directory.::
+
+    $ mkdir fixtures
+    $ cp ../database/fr/initial_data.json fixtures
+
+
+Create the appropriate tables (still being in ishtar application directory)::
+
+    $ ./manage.py syncdb
+
+
+You will be prompted for the creation of an administrator account (administration can be found at: http://where_is_ishtar/admin).
+Then create database views (not automatically created by the admin)::
+
+    $ cd $ISHTAR_DIR
+    $ su postgres
+    $ psql -U ishtar-user ishtar -f ../database/views.sql
+
+Then generate rights for installed form wizards.::
+
+    ./manage.py generate_rights
+
+If you have specific files for towns and departments (in the "database/$COUNTRY_CODE" directory),
+you can now insert them in the database::
+
+    $ cd $ISHTAR_DIR
+    $ ./scripts/import_from_csv.py ../database/fr/departements-insee-2010.csv department
+    $ ./scripts/import_from_csv.py ../database/fr/communes-insee-2010.csv town
+
+Of course import departments before towns.
+
+Now the database is set, congratulations!
+
+Webserver configuration
+-----------------------
+
+Apache configuration with mod_wsgi
+**********************************
+
+Install mod_wsgi for apache::
+
+    $ sudo apt-get install libapache2-mod-wsgi
+
+Create and edit a configuration for Ishtar::
+
+    $ sudo mkdir /var/local/ishtar/apache
+    $ sudo cp /var/local/ishtar/conf/django.wsgi /var/local/ishtar/apache/django.wsgi
+    $ sudo cp /var/local/ishtar/conf/apache-wsgi.conf /etc/apache2/sites-available/ishtar
+
+Adapt the files django.wsgi (with the correct sys path) and ishtar.
+
+To activate the website reload apache.::
+
+    $ sudo a2ensite ishtar
+    $ sudo /etc/init.d/apache2 reload
+
+Now that you have gone through ALL this configuration procedure (which was not that hard after all) you can configure the site.
+
+
+
+..
+    NOTES À NE PAS PRENDRE EN COMPTE
+    """
+    INSTALL_PATH = "/home/etienne/work/ishtar/xhtml2odt"
+    __init__.py
+    Import towns:
+    curl --location --globoff "http://openstreetmap.us/xapi/api/0.6/node[place=village|town|city][bbox=-5.53711,41.90228,8.96484,51.50874]" -o data.osm