diff options
author | Nawa <bellefeegore@follepensee.net> | 2012-11-29 02:28:05 +0100 |
---|---|---|
committer | Nawa <bellefeegore@follepensee.net> | 2012-11-29 02:28:05 +0100 |
commit | 29733981680ef96482ad7adb6fb6fc3f4cef685a (patch) | |
tree | aeb663bcc3c8561ba10008b54b8c943184688e88 | |
parent | d09de4b20d942f322608dd695c09d463fd017bc1 (diff) | |
download | Chimère-29733981680ef96482ad7adb6fb6fc3f4cef685a.tar.bz2 Chimère-29733981680ef96482ad7adb6fb6fc3f4cef685a.zip |
Documentation: new corrections
-rw-r--r-- | docs/customisation.rst | 2 | ||||
-rw-r--r-- | docs/fr/install.rst | 89 | ||||
-rw-r--r-- | docs/import_export.rst | 72 | ||||
-rw-r--r-- | docs/install.rst | 6 | ||||
-rw-r--r-- | docs/upgrade.rst | 2 |
5 files changed, 91 insertions, 80 deletions
diff --git a/docs/customisation.rst b/docs/customisation.rst index e6615db..05f1d35 100644 --- a/docs/customisation.rst +++ b/docs/customisation.rst @@ -8,7 +8,7 @@ Customisation :date: 2012-11-28 :Copyright: CC-BY 3.0 -This document presents the installation of Chimère. +This document presents the customisation of Chimère. It has been updated for version 2.0.0. diff --git a/docs/fr/install.rst b/docs/fr/install.rst index a61846d..404cf4c 100644 --- a/docs/fr/install.rst +++ b/docs/fr/install.rst @@ -9,9 +9,9 @@ Installation :Copyright: CC-BY 3.0 Ce document présente l'installation de Chimère. -Ce document a été mis à jour pour la version 2.0.0 de Chimère. +Il a été mis à jour pour la version 2.0.0 de Chimère. -Prerequis +Pré-requis ********* - `apache <http://www.apache.org/>`_ version 2.x @@ -26,13 +26,13 @@ Prerequis - `Beautiful Soup <http://www.crummy.com/software/BeautifulSoup/>`_ - python-simplejson - python-gdal - - `unidecode <http://pypi.python.org/pypi/Unidecode>_ + - `unidecode <http://pypi.python.org/pypi/Unidecode>`_ - `lxml <http://lxml.de/>`_ - `jquery <http://jquery.com/>`_ version 1.7.1 or better - `jquery-ui <http://jqueryui.com/>`_ - `Universal Feed Parser <https://code.google.com/p/feedparser/>`_ -geodjango fait parti de Django depuis la version 1.0 mas nécessite quelques +geodjango fait partie de Django depuis la version 1.0 mas nécessite quelques dépendances supplémentaires.:: - `geos <http://trac.osgeo.org/geos/>`_ 3.0.x @@ -51,25 +51,26 @@ La manière la plus simple de satisfaire à ces pré-prequis est de les installe par le biais des dépôts de votre distribution Linux préférée. Par exemple pour Debian Wheezy:: - apt-get install python python-django python-django-south \ - python-beautifulsoup tinymce apache2 libgeos-3.3.3 proj-bin gdal-bin \ - python-gdal python-lxml python-psycopg2 python-imaging gettext \ - postgresql-9.1 postgresql-9.1-postgis libjs-jquery libjs-jquery-ui \ - python-django-celery python-simplejson gpsbabel \ - python-pyexiv2 python-feedparser javascript-common + apt-get install apache2 python python-django python-django-south \ + postgresql-9.1 gettext python-psycopg2 python-imaging \ + python-pyexiv2 python-beautifulsoup python-simplejson python-gdal \ + javascript-common python-lxml libjs-jquery libjs-jquery-ui \ + python-feedparser libgeos-3.3.3 proj-bin postgresql-9.1-postgis \ + gdal-bin tinymce gpsbabel python-django-celery \ Pour Debian Squeeze (il est nécessaire d'activer les backports):: apt-get install -t squeeze-backports python-django libjs-jquery - apt-get install python python-django-south python-beautifulsoup tinymce \ - apache2 libgeos-3.2.0 proj-bin gdal-bin python-gdal python-lxml \ - python-psycopg2 python-imaging gettext postgresql-8.4 \ - postgresql-8.4-postgis libjs-jquery libjs-jquery-ui python-simplejson \ - gpsbabel python-pyexiv2 python-feedparser javascript-common + apt-get install apache2 python python-django python-django-south \ + postgresql-8.4 gettext python-psycopg2 python-imaging \ + python-pyexiv2 python-beautifulsoup python-simplejson python-gdal \ + javascript-common python-lxml libjs-jquery libjs-jquery-ui \ + python-feedparser libgeos-3.2.0 proj-bin postgresql-8.4-postgis \ + gdal-bin tinymce gpsbabel \ Si ces paquets n'ont pas d'équivalents sur les dépôts de votre distribution -Linux référez vous aux sites web de ces applications. +Linux, référez vous aux sites web de ces applications. Configuration de la base de données *********************************** @@ -114,8 +115,8 @@ Prenez garde à prendre la dernière version de la branche souhaitée wget http://www.peacefrogs.net/download/chimere/chimere-1.0.2.tar.bz2 -Téléchargez, décompressez et bougez les fichiers dans un répertoire lisible -par l'utilisateur de votre server web (www-data pour Debian).:: +Téléchargez, décompressez et déplacez les fichiers dans un répertoire lisible +par l'utilisateur de votre serveur web (www-data pour Debian).:: cd $INSTALL_PATH tar xvjf chimere-last.tar.bz2 @@ -129,15 +130,15 @@ Une autre solution est d'obtenir les sources depuis le dépôt Git:: cd $INSTALL_PATH git clone git://www.peacefrogs.net/git/chimere cd chimere - git tag -l # list tagged versions - git checkout v2.0 # checkout the desired version + git tag -l # lister les versions + git checkout v2.0 # choisir la version désirée Créez un patron pour votre projet ********************************* -Il y a un exemple de projet fourni « example_project ». Copiez le et modifiez -le (ou obtenez un autre projet basé sur Chimère):: +Il y a un exemple de projet fourni (*example_project*). Copiez-le et +modifiez-le (ou utilisez un autre projet basé sur Chimère):: cd $INSTALL_PATH/chimere cp -ra example_project mychimere_project @@ -146,15 +147,15 @@ Le nom de votre projet est utilisé pour le nom de la bibliothèque Python correspondant à votre projet. En tant que bibliothèque Python, ce nom doit suivre les règles de nommage des noms de variable Python : il doit comporter au moins une lettre et peut -comporter autant de nombres et de lettres que souhaité, le caractère « _ » est -accepté. N'utilisez pas de caractères accentués. Ne commencez pas par « _ » -car cela a une signification particulière en Python. +comporter autant de nombres et de lettres que souhaité, le caractère tiret bas +(« _ ») est accepté. N'utilisez pas de caractères accentués. Ne commencez pas +par « _ » car cela a une signification particulière en Python. Dans le répertoire de votre application Chimère créez un fichier *local_settings.py* qui correspond à votre configuration. Un fichier de base est fourni (*local_settings.py.example*) et des descriptions -courtes de fichiers les plus pertinents sont fournis en dessous (regardez les au -moins). La plupart de ces paramétrages sont initialisés dans le fichier +courtes des fichiers les plus pertinents sont données sous celui-ci (survolez-les au +minimum). La plupart de ces paramétrages sont initialisés dans le fichier *settings.py*.:: cd $INSTALL_PATH/chimere/mychimere_project @@ -163,27 +164,27 @@ moins). La plupart de ces paramétrages sont initialisés dans le fichier :Fields: - * DATABASES: paramètres relatifs à la base de données - * PROJECT_NAME: nom du projet - * SECRET_KEY: une clé secrète pour l'installation de votre application - Django. Cette clé est utilisée pour les signatures cryptographique de - l'application et doit être initialisé à une valeur unique et non - devinable. **Changez là !** - * ROOT_URLCONF: module python de configuration des urls pour votre projet. + * DATABASES : paramètres relatifs à la base de données + * PROJECT_NAME : nom du projet + * SECRET_KEY : une clé secrète pour l'installation de votre application + Django. Cette clé est utilisée pour les signatures cryptographiques de + l'application et doit être initialisée à une valeur unique et non + devinable. **Modifiez-là !** + * ROOT_URLCONF : module python de configuration des urls pour votre projet. quelque chose comme : 'mychimere_project.urls' - * EMAIL_HOST: SMTP du serveur de courriel pour envoyer des courriels - * TINYMCE_URL: url du chemin vers tinymce (le chemin par défaut est adapté + * EMAIL_HOST : SMTP du serveur de courriel pour envoyer des courriels + * TINYMCE_URL : url du chemin vers tinymce (le chemin par défaut est adapté pour une installation sous Debian avec le paquet tinymce installé) - * JQUERY_JS_URLS: liste des adresses des fichiers javascript jquery et + * JQUERY_JS_URLS : liste des adresses des fichiers javascript jquery et jquery-ui (les valeurs par défaut sont appropriées pour une installation sous Debian avec les paquets libjs-jquery et libjs-jquery-ui installés) - * JQUERY_CSS_URLS: liste des adresses des fichiers CSS jquery et + * JQUERY_CSS_URLS : liste des adresses des fichiers CSS jquery et jquery-ui (les valeurs par défaut sont appropriées pour une installation sous Debian avec les paquets libjs-jquery et libjs-jquery-ui installés) - * GPSBABEL: chemin de gpsbabel (la valeur par défaut est approprié pour + * GPSBABEL : chemin de gpsbabel (la valeur par défaut est appropriée pour une installation sous Debian avec le paquet gpsbabel installé) - * TIME_ZONE: fuseau horaire local de cette installation - * LANGUAGE_CODE: code de langage pour cette installation + * TIME_ZONE : fuseau horaire local de cette installation + * LANGUAGE_CODE : code de langage pour cette installation Gérez les permissions du dossier de média:: @@ -215,11 +216,11 @@ français, remplacez cela avec le code de langage approprié) :: django-admin compilemessages Si votre langage n'est pas disponible, n'hésitez pas à créer le fichier **po** -par défaut et de le proposer (les contributions sont bienvenues). +par défaut et à le proposer (les contributions sont bienvenues). La procédure est la suivante :: Il est d'abord nécessaire de créer le fichier po par défaut (bien sûr remplacez -**fr** par le langage que vous souhaitez créer) :: +**fr** [pour français] par le code du langage que vous souhaitez créer) :: django-admin makemessages -l fr @@ -228,7 +229,7 @@ Il doit y avoir maintenant un fichier *django.po* dans le répertoire traduction. Maintenant que votre fichier de traduction est complété, il suffit de le -compléter de la même manière que vous l'auriez fait si ce fichier était +compiler de la même manière que vous l'auriez fait si ce fichier était initialement disponible. Initialisation de la base de données diff --git a/docs/import_export.rst b/docs/import_export.rst index e8d283b..eb581ce 100644 --- a/docs/import_export.rst +++ b/docs/import_export.rst @@ -16,16 +16,19 @@ It has been updated for version 2.0.0. Importing --------- -In Chimère the import mechanism is based on **Import object**. Theses objects +In Chimère the import mechanism is based on **Import object**. These objects are stored in database to keep trace of imports and to facilitate the re-importation from the same source. In fact if possible the update of data from -a same type of source is managed. The ability to do such updates depends on the -existence of a unique id for each object on your source. +a same type of source is managed. + +.. Note:: + The ability to do such updates depends on the existence of a unique id + for each object on your source. To add an **Import object** you need to go to *Chimere > Imports* then **Add**. After that you'll have to select your source type and then the form depends on -the type of source. +this source type. Common fields ************* @@ -35,7 +38,7 @@ Common fields associated category will be use. - **SRID**: Chimère will try to identify automatically the correct projection from the given source. But sometimes the information is not present or cannot - be guessed (for instance a Shapefile that uses non standard proj file). In + be guessed (for instance a shapefile that uses non standard proj file). In this case Chimère will use WGS84 by default (the classic latitude/longitude) but it is not always correct. If you experience problems with items localisation you should put here the SRID associated to the projection of @@ -60,7 +63,7 @@ KML import file. You'll have to fill one of the two fields. - **Filter**: if you want to import only a specific *Folder* of your KML file put his name on this field. -- **Zipped file**: if your source is a KMLZ file (a zipped KML) check this case. +- **Zipped file**: if your source is a KMLZ file (a zipped KML), check this case. Shapefile import **************** @@ -68,9 +71,9 @@ Shapefile import .. image:: _static/chimere_admin_import_shapefile.png -- **Web address/source file (mandatory)**: your KML could be distant or a local - file. You'll have to fill one of the two fields. -- **Zipped file**: only zipped shapefile are accepted this checkbox have to be +- **Web address/source file (mandatory)**: your shapefile could be distant or a + local file. You'll have to fill one of the two fields. +- **Zipped file**: only zipped shapefiles are accepted so this checkbox has to be checked. GeoRSS import @@ -85,12 +88,17 @@ Simple GeoRSS and W3C GeoRSS are managed. CSV import ********** -As the format of the CSV file managed by Chimère could vary depending on the -property you have add on your Chimère instance we recommend you to first do -an export of some items in CSV with Chimère. The CSV format of the exported -file will meet Chimère requirements. By the way because of the geometry of -the item this format is not very convenient to add new content but could -be handy to update informations. +The format of the CSV file (number and order of columns) managed by Chimère +varies depending on the properties you have added on your Chimère instance. +So we recommend you to first do an export of some items in CSV with Chimère. +The CSV format of the exported file will meet Chimère requirements. + +By the way because of the geometry of the item this format is not very +convenient to add new content but could be handy to update informations. + +.. Warning:: + If you mean to update existing data by this import, do *not* modify the + geometry column. .. image:: _static/chimere_admin_import_CSV.png @@ -104,11 +112,11 @@ OpenStreetMap import .. image:: _static/chimere_admin_import_OSM.png -To import from OSM Chimère uses the XAPI API of OSM. +To import from OSM Chimère use the XAPI API of OSM. - **Web address (mandatory)**: XAPI url used to import data. This field should be filled with a default address. By default the MapQuest server is used as it - seems to be the more robust. If you experience problems with OSM import check + seems to be the more robust. If you experience problems with OSM import, check the availability of the XAPI server used and eventually change it. - **Filter area (mandatory)**: draw the bounding box you want to use for your OSM import. @@ -123,18 +131,18 @@ To import from OSM Chimère uses the XAPI API of OSM. Importing ********* -Once your new import item created. Select it in the import object list, select -the **Import** action and validated. +Once your new import item created, select it in the import object list, choose +the **Import** action and validate. -The import should be processing normally. If not an explicit error message -should be print in the state column of your import. +The import should be processing normally. If not, an explicit error message +should be printed in the state column of your import. Managing imported data ********************** All new imported items have the state **Imported**. To make them available on -the map you'll have to validate them. If you don't want an item to be visible on -the map instead of delete them it is recommended to set them to the state +the map you'll have to validate them. If you don't want some items to be visible on +the map, instead of deleting them it is recommended to set them to the state **Disabled**. .. Warning:: @@ -148,7 +156,7 @@ Export to CSV/KML/Shapefile *************************** Directly from the :ref:`geographic items list <geographic-items-management>` you -can export to the choose format. All you have to do is to select the desired +can export to the chosen format. All you have to do is to select the desired items, choose the appropriate action in the action list and validate. Export to OSM @@ -156,19 +164,19 @@ Export to OSM .. Warning:: If you are not sure of what you are doing with OSM export: don't do it! It is - really important to not mess with others data. + really important to not mess with others' data. .. Note:: Only export of OSM nodes are managed. OSM export is not that easily managed. First (if not yet done) you'll have to -define an import (:ref:`see above <osm-import>` for details). This will permit +define an import (:ref:`see above <osm-import>` for details). This will enable to determine: - the area concerned by your export. - the key/value tag to append to your new/updated items. - the subcategories concerned by your export. If you think that some items in - theses subcategories should not be in OSM database (because there are not + these subcategories should not be in OSM database (because there are not relevant or because of license issues) beforehand mark them as **Not for OSM** in the *import fields* of the :ref:`geographic items forms <geographic-items-management>`. @@ -176,23 +184,23 @@ to determine: The OSM export in Chimère is designed to be the more preservative possible in regards to OSM database. That's why before any export an import is done. If -the new import has updated data theses new data will overload data in your +the new import has updated data, these new data will overload data in your Chimère (if you don't want that: don't do export). All pending imported items should have been treated before doing an export. To launch an export select the appropriate Import object in the imports list. Then select the **Export to OSM** action and validate. Then you'll be asked for your OSM username and password and the API you want to -use. If you use regularly Chimère to do export it is recommended to create an +use. If you regularly use Chimère to do export, it is recommended to create an OSM specific account for that. The test API is available to make export test. If you want to use the test API you'll have to create a specific account on the test platform. .. Warning:: - The data on the test platform are not synced with the main platform you are - not going to have the same data that you got with XAPI. + The data on the test platform are not synced with the main platform. You won't + have the same data than the ones you got with XAPI. -Once all this field filled you can (finally!) launch the export. +Once all this field filled, you can (finally!) launch the export. When exporting tags are automatically added/updated: diff --git a/docs/install.rst b/docs/install.rst index 9a5af1f..b68b365 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -138,15 +138,15 @@ Another solution is to get it from the git repository:: Create a custom project template ******************************** -There a default project provided *example_project*. Copy and modify it (or -get another project based on Chimère):: +There, a default project is provided (*example_project*). Copy and modify +it (or get another project based on Chimère):: cd $INSTALL_PATH/chimere cp -ra example_project mychimere_project Your project name is used for the name of the Python package of your template. As a Python package it should follow the rule of Python variable name: -it must be at least one letter and can have a string of numbers, letters and +it must contain at least one letter and can have a string of numbers, letters and underscores ("_") to any length. Don't use accentuated letters. Don't begin the name by "_" because it has special significance in Python. diff --git a/docs/upgrade.rst b/docs/upgrade.rst index d7c7233..e292235 100644 --- a/docs/upgrade.rst +++ b/docs/upgrade.rst @@ -8,6 +8,8 @@ Upgrade :date: 2012-10-08 :Copyright: CC-BY 3.0 +This document presents the upgrade of Chimère. +It has been updated for version 2.0.0. Before any upgrade backup the database and all your installation files (specially if you have made changes to them). |