From d09de4b20d942f322608dd695c09d463fd017bc1 Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Thu, 29 Nov 2012 01:18:11 +0100 Subject: Begin french translation of documentation --- docs/fr/install.rst | 297 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 297 insertions(+) create mode 100644 docs/fr/install.rst (limited to 'docs/fr') diff --git a/docs/fr/install.rst b/docs/fr/install.rst new file mode 100644 index 0000000..a61846d --- /dev/null +++ b/docs/fr/install.rst @@ -0,0 +1,297 @@ +.. -*- coding: utf-8 -*- + +============ +Installation +============ + +:Auteur: Étienne Loks +:date: 2012-10-08 +: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. + +Prerequis +********* + + - `apache `_ version 2.x + - `python `_ versions 2.6 ou 2.7 + - `django `_ >= version 1.4 + - `south `_ + - `postgres `_ >= version 8.x + - `gettext `_ + - `psycopg2 `_ + - `Python Imaging Library `_ + - `pyexiv2 `_ + - `Beautiful Soup `_ + - python-simplejson + - python-gdal + - `unidecode _ + - `lxml `_ + - `jquery `_ version 1.7.1 or better + - `jquery-ui `_ + - `Universal Feed Parser `_ + +geodjango fait parti de Django depuis la version 1.0 mas nécessite quelques +dépendances supplémentaires.:: + + - `geos `_ 3.0.x + - `proj.4 `_ 4.4 to 4.6 + - `posgis `_ versions 1.2.1 ou 1.3.x + - `gdal `_ + + +Optionnel (mais recommandé): + + - `tinymce `_ + - `gpsbabel `_ + - django-celery pour une meilleure gestion des imports importants. + +La manière la plus simple de satisfaire à ces pré-prequis est de les installer +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 + +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 + +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. + +Configuration de la base de données +*********************************** + +Maintenant que postgres et postgis sont installés, vous avez besoin de créer +un nouvel utilisateur pour Chimère:: + + su postgres + createuser --echo --adduser --createdb --encrypted --pwprompt chimere-user + +Ensuite, vous avez besoin de créer la base de données et d'initialiser les types +géographiques (adaptez les chemins par rapport à vos besoins):: + + PG_VERSION=9.1 # 8.4 pour debian Squeeze + createdb --echo --owner chimere-user --encoding UNICODE chimere "Ma base de données Chimère" + createlang plpgsql chimere # seulement nécessaire sous Debian Squeeze + psql -d chimere -f /usr/share/postgresql/$PG_VERSION/contrib/postgis-1.5/postgis.sql + psql -d chimere -f /usr/share/postgresql/$PG_VERSION/contrib/postgis-1.5/spatial_ref_sys.sql + +Installer les sources +********************* + +Choisissez un chemin où installer Chimère:: + + INSTALL_PATH=/var/local/django + mkdir $INSTALL_PATH + +Depuis une archive +++++++++++++++++++ + +La dernière version « stable » est disponible dans ce `répertoire +`_. +Prenez garde à prendre la dernière version de la branche souhaitée +(par exemple la dernière version de la branche 1.0 est la version 1.0.2).:: + + wget http://www.peacefrogs.net/download/chimere -q -O -| html2text + (...) + [[ ]] chimere-1.0.0.tar.bz2 17-Nov-2010 16:51 53K + [[ ]] chimere-1.0.1.tar.bz2 17-Nov-2010 16:51 53K + [[ ]] chimere-1.0.2.tar.bz2 17-Nov-2010 16:51 53K + (...) + + 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).:: + + cd $INSTALL_PATH + tar xvjf chimere-last.tar.bz2 + chown -R myusername:www-data chimere + +Depuis le dépôt git ++++++++++++++++++++ + +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 + + +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):: + + cd $INSTALL_PATH/chimere + cp -ra example_project mychimere_project + +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. + +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 +*settings.py*.:: + + cd $INSTALL_PATH/chimere/mychimere_project + cp local_settings.py.sample local_settings.py + vim local_settings.py + +: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. + 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é + pour une installation sous Debian avec le paquet tinymce installé) + * 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-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 + 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 + +Gérez les permissions du dossier de média:: + + cd $INSTALL_PATH/chimere/mychimere_project + chown -R user:www-data media + chmod -R g+w media + +Créez le fichier de log:: + + mkdir /var/log/django + touch /var/log/django/chimere.log + chown -R root:www-data /var/log/django/ + chmod -R g+w /var/log/django/ + +Regroupez les fichiers static dans un seul répertoire:: + + cd $INSTALL_PATH/chimere/mychimere_project + ./manage.py collectstatic + +Compilation des langages +************************ + +Si votre langage est disponible dans le dossier *chimere/locale/*, il est juste +nécessaire de le compiler. +Pour faire cela, il faut lancer la commande suivante (ici, **fr** est pour le +français, remplacez cela avec le code de langage approprié) :: + + cd $INSTALL_PATH/chimere/chimere/ + 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). +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) :: + + django-admin makemessages -l fr + +Il doit y avoir maintenant un fichier *django.po* dans le répertoire +*locale/fr/LC_MESSAGES*. Ensuite il est nécessaire de le compléter avec votre +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 +initialement disponible. + +Initialisation de la base de données +************************************ + +Créez les tables de la base de données (toujours dans le répertoire de votre +projet):: + + cd $INSTALL_PATH/chimere/mychimere_project + ./manage.py syncdb + + +Vous aurez à rentrer les informations pour la création du compte administrateur +(les pages d'administration se trouvent à l'adresse : +http://where_is_chimere/admin/). Ensuite pour créer les tables de la base de +données gérés par Django-South :: + + ./manage.py migrate + +La base de données est en place, félicitations ! + +Si vous voulez remplir votre installation avec des données par défaut (ne le +faites pas sur une instance de Chimère contenant déjà des données !) :: + + ./manage.py loaddata ../chimere/fixtures/default_data.json + +Configuration du serveur web +**************************** + +Configuration d'Apache avec mod_wsgi +++++++++++++++++++++++++++++++++++++ + +Installez *mod_wsgi* pour Apache:: + + apt-get install libapache2-mod-wsgi + + +Créez et éditez la configuration de Chimère en fonction de votre installation :: + + cp $INSTALL_PATH/chimere/apache/django.wsgi \ + $INSTALL_PATH/chimere/apache/mydjango.wsgi + vim $INSTALL_PATH/chimere/apache/mydjango.wsgi + cp $INSTALL_PATH/chimere/apache/apache-wsgi.conf \ + /etc/apache2/sites-available/chimere + vim /etc/apache2/sites-available/chimere + # create log dir + mkdir /var/log/apache2/chimere/ + chown www-data /var/log/apache2/chimere/ + +Adaptez les fichiers *mydjango.wsgi* (avec le chemin correct *sys* des +bibliothèques python de Chimère et le nom correct pour le module) et le fichier +*chimere* de Apache (avec le nom de serveur correct et les chemins corrects). + +Pour activer le site web rechargez Apache :: + + a2ensite chimere + /etc/init.d/apache2 reload + +Si vous avez des problèmes de dépôt de fichier avec des caractères Unicode dans +leurs noms activez la locale appropriée dans Apache. Sur un serveur Debian avec +UTF-8 comme codage par défaut, dans le fichier */etc/apache2/envvars* +décommentez la ligne suivante :: + + . /etc/default/locale + + -- cgit v1.2.3 From 29733981680ef96482ad7adb6fb6fc3f4cef685a Mon Sep 17 00:00:00 2001 From: Nawa Date: Thu, 29 Nov 2012 02:28:05 +0100 Subject: Documentation: new corrections --- docs/customisation.rst | 2 +- docs/fr/install.rst | 89 +++++++++++++++++++++++++------------------------- docs/import_export.rst | 72 ++++++++++++++++++++++------------------ docs/install.rst | 6 ++-- docs/upgrade.rst | 2 ++ 5 files changed, 91 insertions(+), 80 deletions(-) (limited to 'docs/fr') 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 `_ version 2.x @@ -26,13 +26,13 @@ Prerequis - `Beautiful Soup `_ - python-simplejson - python-gdal - - `unidecode _ + - `unidecode `_ - `lxml `_ - `jquery `_ version 1.7.1 or better - `jquery-ui `_ - `Universal Feed Parser `_ -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 `_ 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 ` 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 ` for details). This will permit +define an import (:ref:`see above ` 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 `. @@ -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). -- cgit v1.2.3 From 32cbf101cefcb4928a751429c09f00d544893037 Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Thu, 29 Nov 2012 17:39:12 +0100 Subject: Documentation: french translation of "administration". * First version of french version of "administration" file. * Minor change on english "administration" file. --- docs/administration.rst | 8 +- docs/fr/administration.rst | 232 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 238 insertions(+), 2 deletions(-) create mode 100644 docs/fr/administration.rst (limited to 'docs/fr') diff --git a/docs/administration.rst b/docs/administration.rst index fa95012..72fd116 100644 --- a/docs/administration.rst +++ b/docs/administration.rst @@ -146,7 +146,7 @@ There is a some actions available in the action list. - **Delete** to delete selected items. A confirmation step is displayed. - **Validate** to set the status *Available* to selected items. -- **Disable** to set teh status *Disabled* to selected items. This is useful to +- **Disable** to set the status *Disabled* to selected items. This is useful to keep items you don't want to be exposed on the map. - **Managed modified items** to manage the amendment made by end users on the main site cf. to :ref:`managing-modified`. Modified item has to be treated @@ -156,6 +156,9 @@ There is a some actions available in the action list. To modify an item, classically you have to click on his name. Then you access to a form to freely modify the item. + +.. image:: _static/chimere_admin_modify_item.png + In this form there is all data available to the end user form plus some extra fields. - The *Import fields* only make sense with data imported from an external @@ -200,4 +203,5 @@ This form is a table with three columns. validation, the value of the modified item will replace the value of the reference item. -To reject all modification validate the form with no checkbox checked. +.. Note:: + To reject all modification validate the form with no checkbox checked. diff --git a/docs/fr/administration.rst b/docs/fr/administration.rst new file mode 100644 index 0000000..dd8c856 --- /dev/null +++ b/docs/fr/administration.rst @@ -0,0 +1,232 @@ +.. -*- coding: utf-8 -*- +.. _administration: + +============== +Administration +============== + +:Auteur: Étienne Loks +:date: 2012-11-29 +: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. + +Présentation des pages d'administration +--------------------------------------- + +Les pages d'administration sont accessible à l'adresse : +http://where_is_your_chimere/admin/ + +N'oubliez pas la barre oblique à la fin de l'adresse. + +Identification +************** + +Tout d'abord vous avez à vous identifier avec l'identifiant et le mot de +passe fourni. + +.. image:: _static/chimere_admin_00.png + + +Page principale +*************** + +Une fois identifié vous avez accès à la page principale d'administration. + +Cela s'affiche ainsi : + +.. image:: _static/chimere_admin_01.png + +#. lien vers cette **Documentation**, vers le formulaire de **Changement de mot + de passe** et la déconnexion. +#. la liste des actions récemment faites avec ce compte +#. un titre d'application, la plupart des actions vont se faire dans + l'application **Chimere**. +#. un élément à l'intérieur de l'application. Depuis ces pages, vous pouvez + *Ajouter* un nouvel élément ou consulter/**Changer** des éléments. Le lien + **Ajouter** conduit au `Formulaire des éléments`_. Le lien **Modifier** + conduit à la `Liste des éléments`_. La `Liste des éléments`_ est également + disponible en cliquant sur le libellé de l'élément. + + +Liste des éléments +****************** + +.. image:: _static/chimere_admin_02.png + +#. chemin dans le site d'administration. C'est un raccourci pratique pour + revenir à la page principale. +#. lien pour créer un nouvel élément depuis la liste des éléments +#. recherche des éléments par mot (n'est pas disponible pour tous les types + d'éléments) +#. cette boite permet de filtrer les entrées actuelles avec des filtres (n'est + pas disponible pour tous les types d'éléments) +#. les entêtes de cette table est cliquable. Cliquer sur une entête permet de + trier les éléments de manière ascendante et descendante. Un tri multi-entête + est possible (le nombre à droite de l'entête indique l'ordre de prise en + compte dans le tri). +#. chaque élément peut être coché (pour lui appliquer une action) ou sélectionné + (en cliquant sur la première colonne) pour voir son détail et éventuellement + le modifier ou le supprimer. + +Formulaire des éléments +*********************** + +.. image:: _static/chimere_admin_03.png + +#. les champs pour l'élément sélectionné (ou vide si c'est un nouvel élément) + sont affichés dans ce formulaire. Parfois certains champs sont en lecture + seule et d'autres sont cachés. Les champs obligatoires ont leur intitulé en + gras. Les changements sur ces champs ne sont effectifs qu'une fois le + formulaire validé. +#. pour certains éléments il y a des sous-éléments associés. Ces sous-éléments + peuvent être modifiés directement dans ce formulaire. Lorsque plusieurs + sous-éléments sont associés à un élément, ils peuvent être réagencés par + glissé-déposé. +#. le formulaire doit être validé par un de ces boutons. Ils parlent d'eux-même. + +États +***** + +Les *États* sont des propriétés rattachés à chaque élément géographique dans +Chimère. Pour administrer Chimère efficacement il est nécessaire de comprendre +chacun de ces états. + +- **Proposé**: État d'un élément nouvellement proposé par un utilisateur. Cet + élément n'est pas visible sur la carte. +- **Disponible**: État d'un élément visible sur la carte. +- **Désactivé**: État d'un élément écarté. +- **Modifié**: État d'une proposition de modification d'un élément par un + utilisateur. +- **Importé**: État d'un élément nouvellement importé. Les opérations d'import + et d'export nécessite que tous les élément avec l'état *importé* soient + traités (validés, désactivés ou supprimés). + + +Gestion des nouvelles +--------------------- + +Un système de nouvelle est disponible. +Tout ce que vous avez à faire est de cliquer sur le bouton *Ajouter* à côté de +*Nouvelles*. +Pour chaque nouvelle il est nécessaire de fournir un nom et un contenu. Le +contenu peut contenir des balises HTML. +La disponibilité est gérée avec une case à cocher. + +Creation de catégories/sous-catégories +-------------------------------------- + +Avant l'ajout de catégories, il est nécessaire de définir des icônes. Ces icônes +apparaissent sur la carte et sur la boite contenant les catégories sur la carte +principale. +Faites attention de bien redimensionner vos icônes. En effet les icônes vont +être présentés à leur taille réelle sur la carte. +Pour ajouter des icônes : cliquez sur le bouton **Ajout** à côté de *Icônes*. + +Les catégories sont fait des conteneurs à sous-catégories. Il est juste +nécessaire de fournir nom et ordre d'affichage. +Pour ajouter des catégories : cliquez sur le bouton **Ajout** près des +catégories (cela devrait être clair maintenant, non ?). + +Les champs concernant les sous-catégories sont : un nom, une icône, un ordre, +un thème de couleur et un type d'élément. +La plupart des champs parlent d'eux-même. +Les thèmes de couleurs sont composés de plusieurs couleurs. +Les couleurs sont utilisés pour le tracé des trajets (si la sous-catégorie +contient des trajets). Si c'est une couleur de base cela peut être défini +par le nom en anglais (pare exemple *red* pour rouge, *blue* pour bleu, +*purple* pour violet) sinon vous pouvez donner le code couleur HTML RVB +(par exemple *#9227c9*). +Le type d'élément est le type d'élément que la sous-catégorie peut contenir : +points d'intérêts, trajets ou les deux. + +.. _geographic-items-management: + +Édition/modération des éléments +------------------------------- + +L'étape de modération est relativement simple. Il fonctionne de la même manière +que ce soit avec les points d'intérêt ou les trajets. +Le modérateur accède classiquement aux points d'intérêts (ou trajets) en +cliquant sur leur nom dans la liste d'éléments. + +Un champ de recherche est disponible pour rechercher par nom mais il est +généralement plus intéressant de filtrer par état et sous-catégories. + +Il y a un certain nombre d'action disponible. + +- **Supprimer** pour supprimer les éléments sélectionnés. Une étape de + confirmation est affichée. +- **Valider** pour donner le status *Disponible* aux éléments sélectionnés. +- **Désactiver** pour donner le status *Désactivé* aux éléments sélectionnés. + C'est particulièrement utile pour garder des éléments que vous ne voulez + pas voir apparaître sur la carte mais conserver en base de données. +- **Gérer les éléments modifiés** pour gérer les propositions de modification + par les utilisateurs sur le site principal cf. to :ref:`managing-modified`. + Les éléments modifiés doivent ne peuvent être traités qu'un à la fois. +- **Export en...** pour exporter les éléments sélectionnés vers le format + sélectionné. + + +Pour modifier un élément, classiquement, vous cliquez sur son nom pour accéder +ensuite à un formulaire pour modifier librement l'élément. + +.. image:: _static/chimere_admin_modify_item.png + +Sur ce formulaire il y a tous les éléments disponibles à l'utilisateur plus +quelques champs supplémentaires. +- Les champs *Imports* ne sont pertinent que pour les données importées depuis + une source externe ou pour les données destinées à être exportées vers OSM + cf. à la :ref:`section import ` de cette documentation. +- Les *Éléments associés* sont des champs en lecture seule qui listent les + éléments associés à l'élément courant (élément de référence d'une + modification, fichier associé à un trajet). + +Les éléments multimédias sont listés à la fin du formulaire. Vous pouvez +librement ajouter, modifier, changer l'ordre (avec du glissé-déposé) de ces +éléments. + +Si un élément n'est pas pertinent, le bouton **Supprimer** permet de le +supprimer. + +.. Warning:: + N'oubliez pas de valider vis changements avec un des boutons d'enregistrement + disponibles à la fin du formulaire (notamment il est assez facile d'oublier + de confirmer les changements faits aux éléments multimédias). + +.. _managing-modified: + +Managing end user amendment +--------------------------- + +Des propositions de modification peuvent être faits sur le site principal par +les utilisateurs. + +Dans Chimère, une proposition de modification est un nouvel élément avec l'état +**Modifié** qui dispose d'un lien vers l'élément de référence. + +.. Note:: + Si vous êtes identifié en tant qu'administrateur et que vous faites des + changements sur la carte avec le « formulaire utilisateur » les changements + vont être directement pris en compte. + +Un formulaire spécifique a été développé pour faciliter le traitement de ces +éléments modifiés. + +Vous pouvez accéder à ce formulaire spécifique avec l'action *Gérer les éléments +modifiés*. + +.. image:: _static/chimere_admin_modified_management.png + +Ce formulaire est un tableau à 3 colonnes. + +#. La première colonne affiche les informations de l'élément de référence. +#. La seconde colonne affiche les informations que propose l'utilisateur. +#. La troisième colonne est une liste de cases à cocher. Après validation, pour + chaque ligne cochée, la valeur de l'élément modifié remplacera la valeur de + l'élément de référence. + +.. Note:: + Pour rejeter toutes les modifications proposées, validez le formulaire avec + aucune case à cocher sélectionnée. -- cgit v1.2.3 From 8342a51dc542a0304025fda2171f7af11a4047b7 Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Thu, 29 Nov 2012 23:54:00 +0100 Subject: Documentation: french translation of customisation section. --- docs/fr/customisation.rst | 58 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 docs/fr/customisation.rst (limited to 'docs/fr') diff --git a/docs/fr/customisation.rst b/docs/fr/customisation.rst new file mode 100644 index 0000000..7d00432 --- /dev/null +++ b/docs/fr/customisation.rst @@ -0,0 +1,58 @@ +.. -*- coding: utf-8 -*- + +============= +Customisation +============= + +:Auteur: Étienne Loks +:date: 2012-11-29 +: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. + +.. _managing-layers: + +Gestion des calques +------------------- + +Il y a différents calques disponibles par défaut dans Chimère (OSM Mapnik, OSM +Mapquest, OSM Transport map, OSM Cyclemap). Vous pouvez ajouter d'autres calques +en utilisant les pages d'administration de Chimère. + +Le nouveau calque est défini en utilisant une chaîne de code Javascript adéquate +de la bibliothèque `Openlayers `_. Ce code Javascript +dois être une instance de *Openlayers Layer* sans point virgule final. + +Par exemple définir un calque Bing peut être fait avec un code de ce type :: + + new OpenLayers.Layer.Bing({ + name: "Aerial", + key: "my-bing-API-key", + type: "Aerial"}) + + +Référez vous à la `documentation de l'API Openlayers +`_ +pour plus de détail. + + +Personnaliser l'agencement et le design +--------------------------------------- + +Si vous souhaitez simplement améliorer la feuille de style CSS, le plus simple +est d'ajouter un lien vers une feuille de style supplémentaire dans vos *Zones* +cf. :ref:`managing-areas`. + +Si vous souhaitez faire des changements plus importants dans l'agencement et la +présentation le (bien nommé) *example_project* peut être personnalisé pour +correspondre à vos besoins. Chaque fichier de patron de page présent dans le +dossier *chimere/templates* peut être copié dans votre dossier +*monprojet/templates* puis modifié. + +Il est juste nécessaire de copier les fichiers que vous souhaitez modifier. +Ces fichiers sont écrits dans le langage de patron Django principalement composé +de HTML avec des éléments de logique. Référez vous à la `documentation des +patrons Django `_ pour +plus de détails. + -- cgit v1.2.3 From 43ff3b958fe3f60d48fc92d2fc2e42789cdccf5f Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Fri, 30 Nov 2012 00:27:24 +0100 Subject: Documentation: integration of Nawa's remarks --- docs/fr/install.rst | 9 +++++---- docs/install.rst | 8 ++++---- requirements.txt | 1 - 3 files changed, 9 insertions(+), 9 deletions(-) (limited to 'docs/fr') diff --git a/docs/fr/install.rst b/docs/fr/install.rst index 404cf4c..9c72af0 100644 --- a/docs/fr/install.rst +++ b/docs/fr/install.rst @@ -26,7 +26,6 @@ Pré-requis - `Beautiful Soup `_ - python-simplejson - python-gdal - - `unidecode `_ - `lxml `_ - `jquery `_ version 1.7.1 or better - `jquery-ui `_ @@ -56,7 +55,7 @@ pour Debian Wheezy:: 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 \ + gdal-bin tinymce gpsbabel python-django-celery Pour Debian Squeeze (il est nécessaire d'activer les backports):: @@ -67,7 +66,9 @@ Pour Debian Squeeze (il est nécessaire d'activer les backports):: 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 \ + gdal-bin tinymce gpsbabel + +Le paquet *python-django-celery* n'existe pas pour Debian Squeeze. 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. @@ -213,7 +214,7 @@ Pour faire cela, il faut lancer la commande suivante (ici, **fr** est pour le français, remplacez cela avec le code de langage approprié) :: cd $INSTALL_PATH/chimere/chimere/ - django-admin compilemessages + django-admin compilemessages -l fr Si votre langage n'est pas disponible, n'hésitez pas à créer le fichier **po** par défaut et à le proposer (les contributions sont bienvenues). diff --git a/docs/install.rst b/docs/install.rst index 248ece9..f26da83 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -26,7 +26,6 @@ Prerequisites - `Beautiful Soup `_ - python-simplejson - python-gdal - - `unidecode `_ - `lxml `_ - `jquery `_ version 1.7.1 or better - `jquery-ui `_ @@ -56,7 +55,7 @@ Linux distribution repositories. For instance on Debian Wheezy:: 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 \ + gdal-bin tinymce gpsbabel python-django-celery On Debian Squeeze (you need to activate backports):: @@ -68,8 +67,9 @@ On Debian Squeeze (you need to activate backports):: 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 \ + gdal-bin tinymce gpsbabel +The package *python-django-celery* doesn't exist for Debian Squeeze. If these packages do not exist in your distribution's repository, please refer to the applications' websites. @@ -209,7 +209,7 @@ need to get it compiled. This can be done with the following command (here, **fr** stands for French, replace it with the appropriate language code):: cd $INSTALL_PATH/chimere/chimere/ - django-admin compilemessages + django-admin compilemessages -l fr If your language is not available, feel free to create the default po file and to submit it, contributions are well appreciated. Procedure is as follows: diff --git a/requirements.txt b/requirements.txt index b7d71a1..f458f31 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,7 +5,6 @@ pil lxml south==0.7.3 simplejson -unidecode feedparser django-extensions django-tinymce -- cgit v1.2.3 From 7f182b3e4a47390fec8a03877d1b0207d7ce870b Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Fri, 30 Nov 2012 16:22:37 +0100 Subject: Documentation: minor changes - first work on french version of upgrade --- docs/fr/administration.rst | 4 +- docs/fr/upgrade.rst | 332 +++++++++++++++++++++++++++++++++++++++++++++ docs/upgrade.rst | 8 +- 3 files changed, 338 insertions(+), 6 deletions(-) create mode 100644 docs/fr/upgrade.rst (limited to 'docs/fr') diff --git a/docs/fr/administration.rst b/docs/fr/administration.rst index dd8c856..afd2b74 100644 --- a/docs/fr/administration.rst +++ b/docs/fr/administration.rst @@ -9,8 +9,8 @@ Administration :date: 2012-11-29 :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. +Ce document présente l'administration de Chimère. +Il a été mis à jour pour la version 2.0.0 de Chimère. Présentation des pages d'administration --------------------------------------- diff --git a/docs/fr/upgrade.rst b/docs/fr/upgrade.rst new file mode 100644 index 0000000..19d4c1d --- /dev/null +++ b/docs/fr/upgrade.rst @@ -0,0 +1,332 @@ +.. -*- coding: utf-8 -*- + +======= +Upgrade +======= + +:Auteur: Étienne Loks +:date: 2012-11-29 +:Copyright: CC-BY 3.0 + +Ce document présente la mise à jour de Chimère. +Il a été mis à jour pour la version 2.0.0 de Chimère. + +.. Warning:: + Avant toute mise à jour la base de données et toutes vos fichiers + d'installation (en particulier si vous avez fait des changements sur + ceux-ci). + +La procédure de migration nécessite une connaissance de base de Git et la ligne +de commande Linux. Ce n'est *pas* une procédure facile. Un travail est en cours +pour faciliter les mises à jour des futures versions de Chimère (>2.0). + +Si plusieurs versions de Chimère ont été publiées depuis votre installation, +vous devez répéter toutes les étapes de mise à jour. +Par exemple pour mettre à jour depuis la version 1.1 vers la version 2.0, vous +devez d'abord mettre à jour vers la version 1.2 puis vers la version 2.0. +La seule étape optionnelle est l'intégration de vos personnalisations. + +La version stable actuelle est la version 2.0. + +.. Note:: + Si vous souhaitez améliorer Chimère prenez la branche *master* sur Git. + +Les instructions sont données pour Debian Squeeze et Debian Wheezy. + + +Obtenir des nouvelles versions des dépendances +---------------------------------------------- + +Version 1.1 -> 1.2 +****************** + +.. code-block:: bash + + apt-get install python-lxml libjs-jquery gpsbabel python-gdal + +Version 1.2 -> 2.0 +****************** + +Debian Squeeze +++++++++++++++ +Activez les backports: http://backports-master.debian.org/Instructions/ +Puis installez les nouvelles dépendances :: + + apt-get install -t squeeze-backports python-django python-django-south \ + python-simplejson libjs-jquery-ui python-pyexiv2 \ + python-feedparser javascript-common libjs-jquery + +Debian Wheezy ++++++++++++++ + +.. code-block:: bash + + apt-get install python-django-south python-simplejson libjs-jquery-ui \ + python-pyexiv2 python-feedparser javascript-common + +Si vous envisagez de réaliser des imports importants envisagez l'installation +de `Celery `_. + +.. code-block:: bash + + apt-get install python-django-celery python-kombu + +Obtenir les nouvelles sources +----------------------------- + +Tout d'abord vous avez à obtenir la nouvelle version du code source. +Pour la procédure d'installation, le code source doit être pris depuis +le dépôt Git. + +Pour simplifier les instructions suivantes, quelques variables d'environnement +sont initialisées. + +.. code-block:: bash + + CHIMERE_PATH=/srv/chimere + CHIMERE_TAG=v1.2.0 # version 1.1 -> 1.2 + CHIMERE_TAG=v2.0-RC3 # version 1.2 -> 2.0 + CHIMERE_TAG=master # version 2.0 -> master + CHIMERE_LOCALNAME=mychimere + +Le nom de votre projet (*CHIMERE_LOCALNAME*) est utilisé pour le nom de la +bibliothèque Python correspondant à votre projet ainsi que votre propre +branche Git. +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 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. + + +Pour une précédente installation Git +************************************ + +.. code-block:: bash + + cd $CHIMERE_PATH + git checkout -b $CHIMERE_LOCALNAME # seulement si vous n'avez pas encore + # créé votre branche locale + git stash # si vous avez des changements pas encore « commités » + git checkout master + git pull + git checkout $CHIMERE_LOCALNAME + git rebase $CHIMERE_TAG + +Pour une précédente installation depuis une archive +*************************************************** + +Supprimez d'abord votre ancienne installation et obtenez la version Git :: + +.. code-block:: bash + + cd $CHIMERE_PATH + cd .. + rm -rf $CHIMERE_PATH + git clone git://www.peacefrogs.net/git/chimere + cd chimere + git checkout $CHIMERE_TAG + git checkout -b $CHIMERE_LOCALNAME + + +Mettre à jour les paramètres de base +************************************ + +Version 1.1 -> 1.2 +++++++++++++++++++ + +.. code-block:: bash + + CHIMERE_APP_PATH=$CHIMERE_PATH/chimere + vim $CHIMERE_APP_PATH/settings.py + +Ajoutez les lignes suivantes (adaptez en fonction de vos installations +jquery et gpsbabel) : + +.. code-block:: python + + JQUERY_URL = SERVER_URL + 'jquery/jquery-1.4.4.min.js' + GPSBABEL = '/usr/bin/gpsbabel' + # simplification des trajets avec une tolérance de 5 metres + GPSBABEL_OPTIONS = 'simplify,crosstrack,error=0.005k' + +Version 1.2 -> 2.0 +++++++++++++++++++ + +Patron de projet +................ +Créez un nouveau patron de projet : + +.. code-block:: bash + + cd $CHIMERE_PATH + cp -ra $CHIMERE_PATH/example_project $CHIMERE_LOCALNAME + CHIMERE_APP_PATH=$CHIMERE_PATH/$CHIMERE_LOCALNAME + +local_settings +.............. +Un fichier *local_settings* est maintenant utilisé. + +.. code-block:: bash + + cd $CHIMERE_APP_PATH + cp local_settings.py.sample local_settings.py + vim local_settings.py + +Reportez vos anciens paramètres de *settings.py* vers *local_settings.py* +(au minimum la configuration de votre base de données). +Le paramètre *ROOT_URLCONF* doit être mis à la valeur +**nom_de_votre_projet.urls**. + +logs +.... +Par défaut, des fichiers de *log* sont maintenant écrit dans le fichier : +*/var/log/django/chimere.log*. + +.. code-block:: bash + + mkdir /var/log/django + touch /var/log/django/chimere.log + chown www-data -R /var/log/django + +Fichiers statiques +.................. + +Les fichiers statiques sont maintenant gérés avec *django.contrib.staticfiles*. + +.. code-block:: bash + + cd $CHIMERE_APP_PATH + ./manage.py collectstatic + + +Déplacez vos anciens fichiers statiques vers le nouveau répertoire : + +.. code-block:: bash + + cp -ra $CHIMERE_PATH/chimere/static/* $CHIMERE_APP_PATH/static/ + cp -ra $CHIMERE_PATH/chimere/static/icons/* $CHIMERE_APP_PATH/media/icons/ + cp -ra $CHIMERE_PATH/chimere/static/upload $CHIMERE_APP_PATH/media/ + +Configuration du serveur Web +............................ + +If you are using Apache and WSGI to serve your Chimère, change your WSGI +configuration file to point to the correct settings: +**value_of_your_localname.settings**. + +Change your webserver directive to point to the correct static directory from +**your_chimere_path/chimere/static** to +**your_chimere_path/your_local_name/static**. + +Version 2.0 -> master ++++++++++++++++++++++ + +Update settings and static files. + +.. code-block:: bash + + cp $CHIMERE_PATH/example_project/settings.py $CHIMERE_LOCALNAME + ./manage.py collectstatic + +Migrate database +---------------- + +Version 1.1 -> 1.2 +****************** + +Migration scripts test your installation before making changes so you probably +won't have any lost but by precaution before running these scripts don't forget +to backup your database. +You can also make a copy of your current database into a new database and make +the new installation to this new database. + +The gdal binding for python is necessary to run the upgrade scripts (available +in the python-gdal package in Debian). + +If you run the migration scripts in a production environnement stop the old +instance of Chimère before executing the migration script. Perhaps prepare the +web server to point to the new installation before doing the database upgrade +(cf. next paragraph). + +In *settings.py* verify that **chimere.scripts** is in the *INSTALLED_APPS*. + +After that in the chimere directory just execute the script. + +.. code-block:: bash + + cd $CHIMERE_APP_PATH + python ./scripts/upgrade.py + +Version 1.2 -> 2.0 +****************** + +Django South is now used to manage database migrations. + +.. code-block:: bash + + cd $CHIMERE_APP_PATH + ./manage.py syncdb + ./manage.py migrate chimere 0001 --fake # fake the database initialisation + ./manage.py migrate chimere + +A description field is now available for markers. If you would like to move +values of an old *Property model* to this new field, a script is available. + +.. code-block:: bash + + cd $CHIMERE_APP_PATH + ../chimere/scripts/migrate_properties.py + # follow the instructions + +From 2.0 to master +****************** + +.. code-block:: bash + + cd $CHIMERE_APP_PATH + ./manage.py syncdb + ./manage.py migrate chimere + +Update translations +------------------- + +Version 1.1 -> 1.2 +****************** + +.. code-block:: bash + + cd $CHIMERE_APP_PATH + ./manage.py compilemessages + +Version 1.2 -> 2.0 -> master +**************************** + +.. code-block:: bash + + cd $CHIMERE_PATH/chimere + django-admin compilemessages + +Forcing the refresh of visitor's web browser cache +-------------------------------------------------- + +If major changes in the javascript has been done between versions, many of your +users could experience problems. There are many tricks to force the refresh +of their cache. One of them is to change the location of statics files. To do +that edit your local_settings.py and change:: + + STATIC_URL = '/static/' + +to:: + + STATIC_URL = '/static/v2.0.0/' + +Then in the static directory: + +.. code-block:: bash + + cd $CHIMERE_APP_PATH/static + ln -s `pwd` v2.0.0 + +Restart the web server to apply this changes. + diff --git a/docs/upgrade.rst b/docs/upgrade.rst index 377e5e7..32b6e43 100644 --- a/docs/upgrade.rst +++ b/docs/upgrade.rst @@ -132,7 +132,7 @@ Version 1.1 -> 1.2 CHIMERE_APP_PATH=$CHIMERE_PATH/chimere vim $CHIMERE_APP_PATH/settings.py -Add the line (adapted for your jquery and gpsbabel installation): +Add the following lines (adapted for your jquery and gpsbabel installation): .. code-block:: python @@ -164,9 +164,9 @@ A *local_settings* file is now used. cp local_settings.py.sample local_settings.py vim local_settings.py -Report your old settings.py in local_settings.py (at least the database -configuration). -Your *ROOT_URLCONF* must be set to **value_of_your_localname.urls**. +Report your old settings from *settings.py* to *local_settings.py* (at least the +database configuration). +The setting *ROOT_URLCONF* must be set to **value_of_your_localname.urls**. logs .... -- cgit v1.2.3 From 5ff35a6b7ce6466696ce7b6611c0bd6cf88152ff Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Fri, 30 Nov 2012 17:03:49 +0100 Subject: Documentation: french translation of upgrade documentation --- docs/fr/upgrade.rst | 91 +++++++++++++++++++++++++++-------------------------- docs/upgrade.rst | 20 ++++-------- 2 files changed, 52 insertions(+), 59 deletions(-) (limited to 'docs/fr') diff --git a/docs/fr/upgrade.rst b/docs/fr/upgrade.rst index 19d4c1d..8e3f583 100644 --- a/docs/fr/upgrade.rst +++ b/docs/fr/upgrade.rst @@ -211,47 +211,49 @@ Déplacez vos anciens fichiers statiques vers le nouveau répertoire : Configuration du serveur Web ............................ -If you are using Apache and WSGI to serve your Chimère, change your WSGI -configuration file to point to the correct settings: -**value_of_your_localname.settings**. +Si vous utilisez Apache et WSGI pour mettre à disposition votre Chimère, +changez la configuration pour pointer vers le chemin correct de +configuration : **nom_de_votre_projet.settings**. -Change your webserver directive to point to the correct static directory from -**your_chimere_path/chimere/static** to -**your_chimere_path/your_local_name/static**. +Changez la directive de votre serveur web pour qu'elle pointe vers le bon +répertoire statique de **votre_chemin_vers_chimere/chimere/static** en +**votre_chemin_vers_chimere/nom_de_votre_projet/static**. Version 2.0 -> master +++++++++++++++++++++ -Update settings and static files. +Mettez à jour les paramètres et les fichiers statiques. .. code-block:: bash cp $CHIMERE_PATH/example_project/settings.py $CHIMERE_LOCALNAME ./manage.py collectstatic -Migrate database ----------------- +Migration de la base de données +------------------------------- Version 1.1 -> 1.2 ****************** -Migration scripts test your installation before making changes so you probably -won't have any lost but by precaution before running these scripts don't forget -to backup your database. -You can also make a copy of your current database into a new database and make -the new installation to this new database. +Les scripts de migration testent votre installation avant de faire des +changements vous n'aurez donc probablement pas de perte mais par précaution +avant de les lancer n'oubliez pas de faire une sauvegarde de votre base de +données. +Vous pouvez aussi faire une copie de votre base de données actuelle dans une +nouvelle base et faire la mise à jour sur cette nouvelle base de données. -The gdal binding for python is necessary to run the upgrade scripts (available -in the python-gdal package in Debian). +La bibliothèque GDAL pour python est nécessaire pour faire fonctionner ces +scripts (disponible avec le paquet *python-gdal* dans Debian). -If you run the migration scripts in a production environnement stop the old -instance of Chimère before executing the migration script. Perhaps prepare the -web server to point to the new installation before doing the database upgrade -(cf. next paragraph). +Si vous souhaitez lancer le script de migration dans un environnement de +production stoppez l'instance de Chimère avant d'exécuter le script de +migration. -In *settings.py* verify that **chimere.scripts** is in the *INSTALLED_APPS*. +Dans le fichier *settings.py* vérifiez que **chimere.scripts** fait parti +des *INSTALLED_APPS*. -After that in the chimere directory just execute the script. +Après cela dans le répertoire d'installation de Chimère exécutez simplement +le script. .. code-block:: bash @@ -261,7 +263,7 @@ After that in the chimere directory just execute the script. Version 1.2 -> 2.0 ****************** -Django South is now used to manage database migrations. +Django South est maintenant utilisé pour les migrations de base de données. .. code-block:: bash @@ -270,17 +272,18 @@ Django South is now used to manage database migrations. ./manage.py migrate chimere 0001 --fake # fake the database initialisation ./manage.py migrate chimere -A description field is now available for markers. If you would like to move -values of an old *Property model* to this new field, a script is available. +Un champ descriptif est maintenant disponible pour les points d'intérêts. Si +vous souhaitez bouger un ancien *modèle de propriété* vers ce nouveau champ, +un script est disponible. .. code-block:: bash cd $CHIMERE_APP_PATH ../chimere/scripts/migrate_properties.py - # follow the instructions + # suivez les instructions -From 2.0 to master -****************** +Version 2.0 -> master +********************* .. code-block:: bash @@ -288,8 +291,8 @@ From 2.0 to master ./manage.py syncdb ./manage.py migrate chimere -Update translations -------------------- +Mise à jour des traductions +--------------------------- Version 1.1 -> 1.2 ****************** @@ -307,26 +310,24 @@ Version 1.2 -> 2.0 -> master cd $CHIMERE_PATH/chimere django-admin compilemessages -Forcing the refresh of visitor's web browser cache --------------------------------------------------- +Forcer le rafraîchissement du cache du navigateur des utilisateurs +------------------------------------------------------------------ -If major changes in the javascript has been done between versions, many of your -users could experience problems. There are many tricks to force the refresh -of their cache. One of them is to change the location of statics files. To do -that edit your local_settings.py and change:: +Des changements importants au niveau des styles et du javascript sont fait entre +les différentes version. Cela peut provoquer des dysfonctionnements important +chez des utilisateurs dont le navigateur web a conservé les anciennes versions +de certains fichiers en cache. Il y a pas mal de moyens de forcer le +rafraîchissement de leur cache. Un de ceux-ci est de changer le chemin vers les +fichiers statiques. Pour faire cela éditez votre fichier *local_settings.py* et +changez :: STATIC_URL = '/static/' -to:: +en :: STATIC_URL = '/static/v2.0.0/' -Then in the static directory: - -.. code-block:: bash - - cd $CHIMERE_APP_PATH/static - ln -s `pwd` v2.0.0 - -Restart the web server to apply this changes. +Changez alors la directive concernant les fichiers statiques sur le fichier de +configuration de votre serveur web. +Redémarrez alors le serveur web pour appliquer les changements. diff --git a/docs/upgrade.rst b/docs/upgrade.rst index 32b6e43..021317b 100644 --- a/docs/upgrade.rst +++ b/docs/upgrade.rst @@ -232,13 +232,11 @@ The gdal binding for python is necessary to run the upgrade scripts (available in the python-gdal package in Debian). If you run the migration scripts in a production environnement stop the old -instance of Chimère before executing the migration script. Perhaps prepare the -web server to point to the new installation before doing the database upgrade -(cf. next paragraph). +instance of Chimère before executing the migration script. In *settings.py* verify that **chimere.scripts** is in the *INSTALLED_APPS*. -After that in the chimere directory just execute the script. +After that in the Chimère directory just execute the script. .. code-block:: bash @@ -266,8 +264,8 @@ values of an old *Property model* to this new field, a script is available. ../chimere/scripts/migrate_properties.py # follow the instructions -From 2.0 to master -****************** +Version 2.0 -> master +********************* .. code-block:: bash @@ -297,7 +295,7 @@ Version 1.2 -> 2.0 -> master Forcing the refresh of visitor's web browser cache -------------------------------------------------- -If major changes in the javascript has been done between versions, many of your +Major changes in the javascript has been done between versions, many of your users could experience problems. There are many tricks to force the refresh of their cache. One of them is to change the location of statics files. To do that edit your local_settings.py and change:: @@ -308,12 +306,6 @@ to:: STATIC_URL = '/static/v2.0.0/' -Then in the static directory: - -.. code-block:: bash - - cd $CHIMERE_APP_PATH/static - ln -s `pwd` v2.0.0 - +Then change the webserver directive to point to your new path. Restart the web server to apply this changes. -- cgit v1.2.3 From 384a6157afe3172f7e42dd2ffb0dd22c2f939b2e Mon Sep 17 00:00:00 2001 From: Nawa Date: Fri, 30 Nov 2012 17:21:22 +0100 Subject: Documentation: new corrections, mainly on the french pages --- docs/fr/administration.rst | 10 +- docs/fr/customisation.rst | 8 +- docs/fr/import_export.rst | 233 +++++++++++++++++++++++++++++++++++++++++++++ docs/fr/install.rst | 86 ++++++++--------- docs/fr/upgrade.rst | 2 +- docs/import_export.rst | 2 +- docs/install.rst | 36 +++---- 7 files changed, 305 insertions(+), 72 deletions(-) create mode 100644 docs/fr/import_export.rst (limited to 'docs/fr') diff --git a/docs/fr/administration.rst b/docs/fr/administration.rst index afd2b74..d4fb145 100644 --- a/docs/fr/administration.rst +++ b/docs/fr/administration.rst @@ -18,7 +18,7 @@ Présentation des pages d'administration Les pages d'administration sont accessible à l'adresse : http://where_is_your_chimere/admin/ -N'oubliez pas la barre oblique à la fin de l'adresse. +N'oubliez pas la barre oblique (slash) à la fin de l'adresse. Identification ************** @@ -32,17 +32,17 @@ passe fourni. Page principale *************** -Une fois identifié vous avez accès à la page principale d'administration. +Une fois identifié, vous avez accès à la page principale d'administration. Cela s'affiche ainsi : .. image:: _static/chimere_admin_01.png #. lien vers cette **Documentation**, vers le formulaire de **Changement de mot - de passe** et la déconnexion. -#. la liste des actions récemment faites avec ce compte + de passe** et la déconnexion ; +#. la liste des actions récemment faites avec ce compte ; #. un titre d'application, la plupart des actions vont se faire dans - l'application **Chimere**. + l'application **Chimere** ; #. un élément à l'intérieur de l'application. Depuis ces pages, vous pouvez *Ajouter* un nouvel élément ou consulter/**Changer** des éléments. Le lien **Ajouter** conduit au `Formulaire des éléments`_. Le lien **Modifier** diff --git a/docs/fr/customisation.rst b/docs/fr/customisation.rst index 7d00432..498cfad 100644 --- a/docs/fr/customisation.rst +++ b/docs/fr/customisation.rst @@ -8,7 +8,7 @@ Customisation :date: 2012-11-29 :Copyright: CC-BY 3.0 -Ce document présente l'installation de Chimère. +Ce document présente la personnalisation de Chimère. Ce document a été mis à jour pour la version 2.0.0 de Chimère. .. _managing-layers: @@ -22,7 +22,7 @@ en utilisant les pages d'administration de Chimère. Le nouveau calque est défini en utilisant une chaîne de code Javascript adéquate de la bibliothèque `Openlayers `_. Ce code Javascript -dois être une instance de *Openlayers Layer* sans point virgule final. +doit être une instance de *Openlayers Layer*, sans point virgule final. Par exemple définir un calque Bing peut être fait avec un code de ce type :: @@ -42,10 +42,10 @@ Personnaliser l'agencement et le design Si vous souhaitez simplement améliorer la feuille de style CSS, le plus simple est d'ajouter un lien vers une feuille de style supplémentaire dans vos *Zones* -cf. :ref:`managing-areas`. +(cf. :ref:`managing-areas`). Si vous souhaitez faire des changements plus importants dans l'agencement et la -présentation le (bien nommé) *example_project* peut être personnalisé pour +présentation le projet *example_project* peut être personnalisé pour correspondre à vos besoins. Chaque fichier de patron de page présent dans le dossier *chimere/templates* peut être copié dans votre dossier *monprojet/templates* puis modifié. diff --git a/docs/fr/import_export.rst b/docs/fr/import_export.rst new file mode 100644 index 0000000..eac21af --- /dev/null +++ b/docs/fr/import_export.rst @@ -0,0 +1,233 @@ +.. -*- coding: utf-8 -*- + +============= +Import/export +============= + +:Author: Étienne Loks +:date: 2012-11-28 +:Copyright: CC-BY 3.0 + +Ce document présente les fonctions d'import et d'export de Chimère. +Ce document a été mis à jour pour la version 2.0.0 de Chimère. + +.. _importing: + +Import +------ + +Dans Chimère, le mécanisme d'import est basé sur **Import object**. Ces objets sont +stockés dans une base de données pour garder trace des imports et pour faciliter la +ré-importation depuis une même source. En fait, si cela est possible, la mise à jour +de données depuis un même type de source est gérée, de préférence à une ré-importation. + +.. Note:: + La possibilité de réaliser de telles mises à jour est conditionnée à l'existence + d'une id unique pour chaque objet de la source. + +Pour ajouter un **Import object**, vous devez aller dans *Chimere > Imports* puis **Ajouter**. + +Après cela, vous aurez à sélectionner votre type de source. Le formulaire suivant dépend de +ce type de source. + +Champs communs à tous les types de source +***************************************** + +- **Name by default**: if no name can be identified to the newly imported object + this is the name that will be used. If this field is empty the name of the + 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 + 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 + your source. +- **Origin**: if not null this field will be associated to each item imported in + order to easily identify where the item came from. For OSM import the source + is automatically added. +- **License**: if not null this field will be associated to each item imported in + order to easily identify the license associated to the item. For OSM import + the license is automatically added. +- **Associated subcategories (mandatory)**: The selected subcategories will be + associated to newly imported items. + + +KML import +********** + +.. image:: _static/chimere_admin_import_KML.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. +- **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. + +Shapefile import +**************** + +.. image:: _static/chimere_admin_import_shapefile.png + + +- **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 +************* + +Simple GeoRSS and W3C GeoRSS are managed. + +.. image:: _static/chimere_admin_import_georss.png + +- **Web address (mandatory)**: only distant GeoRSS are managed. + +CSV import +********** + +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 + +- **Web address/source file (mandatory)**: your CSV file could be distant or a + local file. You'll have to fill one of the two fields. + +.. _osm-import: + +OpenStreetMap import +******************** + +.. image:: _static/chimere_admin_import_OSM.png + +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 + 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. +- **Filter type (mandatory)**: choose if you want to import way or nodes. +- **Filter tag (mandatory)**: choose the OSM key/value couple used to filter OSM + data. A link to the `OSM Map features page + `_ is provided to help you + find appropriate values. +- **Refresh button**: this button convert your choices to appropriate XAPI args. + You have to hit this button before validating the form. + +Importing +********* + +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 printed in the state column of your import. + +You can also launch imports with the CLI (ideal for crontab jobs). In the +project directory you only need to launch the command:: + + ./manage.py chimere_import + +- *import_id* is the import ID + +If you launch the command without *import_id* the list of imports available is +presented and you can choose one. + +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 some items to be visible on +the map, instead of deleting them it is recommended to set them to the state +**Disabled**. + +.. Warning:: + Be careful with duplicates between your existing data and imported data. This + is particularly important if you want to export your data to OSM. + +Exporting +--------- + +Export to CSV/KML/Shapefile +*************************** + +Directly from the :ref:`geographic items list ` you +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. + +You can also launch exports with the CLI (ideal for crontab jobs). In the +project directory you only need to launch the command:: + + ./manage.py chimere_export \ + + +- *subcategory_id* is the ID of the chosen subcategory +- *CSV|KML|SHP* is the chosen format +- *marker|route* is to get marker or route +- *filename* is the output filename + +If you launch the command without arguments you will be prompted for the choice +to make for your export. + + +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. + +.. 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 ` 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 + 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 + `. + + +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, 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 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 won't + have the same data than the ones you got with XAPI. + +Once all this field filled, you can (finally!) launch the export. + +When exporting tags are automatically added/updated: + +- *name*: get from the item name in Chimère. +- *source*: to identify Chimère as a source. diff --git a/docs/fr/install.rst b/docs/fr/install.rst index 9c72af0..d9acaa8 100644 --- a/docs/fr/install.rst +++ b/docs/fr/install.rst @@ -5,7 +5,7 @@ Installation ============ :Auteur: Étienne Loks -:date: 2012-10-08 +:date: 2012-11-28 :Copyright: CC-BY 3.0 Ce document présente l'installation de Chimère. @@ -14,25 +14,25 @@ Il a été mis à jour pour la version 2.0.0 de Chimère. Pré-requis ********* - - `apache `_ version 2.x - - `python `_ versions 2.6 ou 2.7 - - `django `_ >= version 1.4 - - `south `_ - - `postgres `_ >= version 8.x - - `gettext `_ - - `psycopg2 `_ + - `Apache `_ version 2.x + - `Python `_ versions 2.6 ou 2.7 + - `Django `_ >= version 1.4 + - `South `_ + - `Postgres `_ >= version 8.x + - `Gettext `_ + - `Psycopg2 `_ - `Python Imaging Library `_ - - `pyexiv2 `_ + - `Pyexiv2 `_ - `Beautiful Soup `_ - python-simplejson - python-gdal - - `lxml `_ - - `jquery `_ version 1.7.1 or better - - `jquery-ui `_ + - `Lxml `_ + - `Jquery `_ version 1.7.1 or better + - `Jquery-ui `_ - `Universal Feed Parser `_ -geodjango fait partie de Django depuis la version 1.0 mas nécessite quelques -dépendances supplémentaires.:: +geodjango fait partie de Django depuis la version 1.0 mais nécessite quelques +dépendances supplémentaires : - `geos `_ 3.0.x - `proj.4 `_ 4.4 to 4.6 @@ -40,7 +40,7 @@ dépendances supplémentaires.:: - `gdal `_ -Optionnel (mais recommandé): +Optionnel (mais recommandé) : - `tinymce `_ - `gpsbabel `_ @@ -48,36 +48,36 @@ Optionnel (mais recommandé): La manière la plus simple de satisfaire à ces pré-prequis est de les installer par le biais des dépôts de votre distribution Linux préférée. Par exemple -pour Debian Wheezy:: +pour Debian Wheezy :: 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 + 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 javascript-common -Pour Debian Squeeze (il est nécessaire d'activer les backports):: +Pour Debian Squeeze (il est nécessaire d'activer les backports) :: apt-get install -t squeeze-backports python-django libjs-jquery 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 + python-lxml libjs-jquery libjs-jquery-ui python-feedparser \ + libgeos-3.2.0 proj-bin postgresql-8.4-postgis gdal-bin \ + tinymce gpsbabel javascript-common Le paquet *python-django-celery* n'existe pas pour Debian Squeeze. -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. +Si ces paquets n'ont pas d'équivalents dans les dépôts de votre distribution +Linux, référez-vous aux sites web de ces applications. Configuration de la base de données *********************************** Maintenant que postgres et postgis sont installés, vous avez besoin de créer -un nouvel utilisateur pour Chimère:: +un nouvel utilisateur pour Chimère :: su postgres createuser --echo --adduser --createdb --encrypted --pwprompt chimere-user @@ -94,7 +94,7 @@ géographiques (adaptez les chemins par rapport à vos besoins):: Installer les sources ********************* -Choisissez un chemin où installer Chimère:: +Choisissez un chemin où installer Chimère :: INSTALL_PATH=/var/local/django mkdir $INSTALL_PATH @@ -123,10 +123,10 @@ par l'utilisateur de votre serveur web (www-data pour Debian).:: tar xvjf chimere-last.tar.bz2 chown -R myusername:www-data chimere -Depuis le dépôt git +Depuis le dépôt Git +++++++++++++++++++ -Une autre solution est d'obtenir les sources depuis le dépôt Git:: +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 @@ -139,7 +139,7 @@ Créez un patron pour votre projet ********************************* Il y a un exemple de projet fourni (*example_project*). Copiez-le et -modifiez-le (ou utilisez un autre projet basé sur Chimère):: +modifiez-le (ou utilisez un autre projet basé sur Chimère) :: cd $INSTALL_PATH/chimere cp -ra example_project mychimere_project @@ -171,7 +171,7 @@ minimum). La plupart de ces paramétrages sont initialisés dans le fichier 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. + * 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é @@ -187,20 +187,20 @@ minimum). La plupart de ces paramétrages sont initialisés dans le fichier * 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:: +Gérez les permissions du dossier de média :: cd $INSTALL_PATH/chimere/mychimere_project chown -R user:www-data media chmod -R g+w media -Créez le fichier de log:: +Créez le fichier de log :: mkdir /var/log/django touch /var/log/django/chimere.log chown -R root:www-data /var/log/django/ chmod -R g+w /var/log/django/ -Regroupez les fichiers static dans un seul répertoire:: +Regroupez les fichiers static dans un seul répertoire :: cd $INSTALL_PATH/chimere/mychimere_project ./manage.py collectstatic @@ -221,12 +221,12 @@ 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** [pour français] par le code du langage que vous souhaitez créer) :: +**fr** par le code du langage que vous souhaitez créer) :: django-admin makemessages -l fr Il doit y avoir maintenant un fichier *django.po* dans le répertoire -*locale/fr/LC_MESSAGES*. Ensuite il est nécessaire de le compléter avec votre +*locale/fr/LC_MESSAGES*. Ensuite il faut le compléter avec votre traduction. Maintenant que votre fichier de traduction est complété, il suffit de le @@ -237,7 +237,7 @@ Initialisation de la base de données ************************************ Créez les tables de la base de données (toujours dans le répertoire de votre -projet):: +projet) :: cd $INSTALL_PATH/chimere/mychimere_project ./manage.py syncdb @@ -246,7 +246,7 @@ projet):: Vous aurez à rentrer les informations pour la création du compte administrateur (les pages d'administration se trouvent à l'adresse : http://where_is_chimere/admin/). Ensuite pour créer les tables de la base de -données gérés par Django-South :: +données gérées par Django-South :: ./manage.py migrate @@ -263,7 +263,7 @@ Configuration du serveur web Configuration d'Apache avec mod_wsgi ++++++++++++++++++++++++++++++++++++ -Installez *mod_wsgi* pour Apache:: +Installez *mod_wsgi* pour Apache :: apt-get install libapache2-mod-wsgi @@ -276,21 +276,21 @@ Créez et éditez la configuration de Chimère en fonction de votre installation cp $INSTALL_PATH/chimere/apache/apache-wsgi.conf \ /etc/apache2/sites-available/chimere vim /etc/apache2/sites-available/chimere - # create log dir + # créer le répertoire des logs mkdir /var/log/apache2/chimere/ chown www-data /var/log/apache2/chimere/ Adaptez les fichiers *mydjango.wsgi* (avec le chemin correct *sys* des -bibliothèques python de Chimère et le nom correct pour le module) et le fichier +bibliothèques Python de Chimère et le nom correct pour le module) et le fichier *chimere* de Apache (avec le nom de serveur correct et les chemins corrects). -Pour activer le site web rechargez Apache :: +Pour activer le site web, rechargez Apache :: a2ensite chimere /etc/init.d/apache2 reload Si vous avez des problèmes de dépôt de fichier avec des caractères Unicode dans -leurs noms activez la locale appropriée dans Apache. Sur un serveur Debian avec +leurs noms, activez la locale appropriée dans Apache. Sur un serveur Debian avec UTF-8 comme codage par défaut, dans le fichier */etc/apache2/envvars* décommentez la ligne suivante :: diff --git a/docs/fr/upgrade.rst b/docs/fr/upgrade.rst index 19d4c1d..38424ff 100644 --- a/docs/fr/upgrade.rst +++ b/docs/fr/upgrade.rst @@ -241,7 +241,7 @@ to backup your database. You can also make a copy of your current database into a new database and make the new installation to this new database. -The gdal binding for python is necessary to run the upgrade scripts (available +The gdal binding for Python is necessary to run the upgrade scripts (available in the python-gdal package in Debian). If you run the migration scripts in a production environnement stop the old diff --git a/docs/import_export.rst b/docs/import_export.rst index bc422b1..1032804 100644 --- a/docs/import_export.rst +++ b/docs/import_export.rst @@ -8,7 +8,7 @@ Import/export :date: 2012-11-28 :Copyright: CC-BY 3.0 -This document presents the administration of Chimère. +This document presents the import/export functionnalities of Chimère. It has been updated for version 2.0.0. .. _importing: diff --git a/docs/install.rst b/docs/install.rst index 3b8fd38..ea27efc 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -5,7 +5,7 @@ Installation ============ :Author: Étienne Loks -:date: 2012-10-08 +:date: 2012-11-28 :Copyright: CC-BY 3.0 This document presents the installation of Chimère. @@ -14,21 +14,21 @@ It has been updated for version 2.0.0. Prerequisites ************* - - `apache `_ version 2.x - - `python `_ versions 2.6 or 2.7 - - `django `_ >= version 1.4 - - `south `_ - - `postgres `_ >= version 8.x - - `gettext `_ - - `psycopg2 `_ + - `Apache `_ version 2.x + - `Python `_ versions 2.6 or 2.7 + - `Django `_ >= version 1.4 + - `South `_ + - `Postgres `_ >= version 8.x + - `Gettext `_ + - `Psycopg2 `_ - `Python Imaging Library `_ - - `pyexiv2 `_ + - `Pyexiv2 `_ - `Beautiful Soup `_ - python-simplejson - python-gdal - - `lxml `_ - - `jquery `_ version 1.7.1 or better - - `jquery-ui `_ + - `Lxml `_ + - `Jquery `_ version 1.7.1 or better + - `Jquery-ui `_ - `Universal Feed Parser `_ geodjango is a part of django since version 1.0 but it has some specific @@ -53,9 +53,9 @@ Linux distribution repositories. For instance on Debian Wheezy:: 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 + 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 javascript-common On Debian Squeeze (you need to activate backports):: @@ -65,9 +65,9 @@ On Debian Squeeze (you need to activate backports):: 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 + python-lxml libjs-jquery libjs-jquery-ui python-feedparser \ + libgeos-3.2.0 proj-bin postgresql-8.4-postgis gdal-bin \ + tinymce gpsbabel javascript-common The package *python-django-celery* doesn't exist for Debian Squeeze. -- cgit v1.2.3 From 1f188cbc3b52142ea0f0dc645858498f4e17df42 Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Sat, 1 Dec 2012 17:41:23 +0100 Subject: Documentation: french translation of configuration --- .gitignore | 1 + docs/configuration.rst | 38 ++++----- docs/fr/configuration.rst | 202 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 223 insertions(+), 18 deletions(-) create mode 100644 docs/fr/configuration.rst (limited to 'docs/fr') diff --git a/.gitignore b/.gitignore index 4cfffce..323a5e4 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,4 @@ example_project/static/upload/* example_project/media/* example_project/local_settings.py chimere_env/ +docs/_build/html/ diff --git a/docs/configuration.rst b/docs/configuration.rst index 3aa34ac..e5870bb 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -11,7 +11,7 @@ Configuration This document presents the first steps to configure your Chimère. It has been updated for version 2.0.0. -Your session has to be initialised with these environment variables in +Your session has to be initialised with these environment variables in the Command Line Interface:: CHIMERE_PATH=/srv/chimere # change with your installation path @@ -32,7 +32,7 @@ To access these pages you have to identify with an account with *staff* and A *superuser* account is created at the initialization of the database. -Configuring the sites framework +Configuring the Sites framework ------------------------------- *Sites* framework allow you to serve the same content on different domains. @@ -57,25 +57,26 @@ An *Area* is the base of your map. It defines: user arriving on the map, * an order (to sort areas), * an availability, -* a default state. The /default/ area is viewed by default. Only one area can - be the default: activating this state disables it on the possible other area - with a default state, +* a "*default*" state. The "*default*" area is viewed by default. Only one area + can be the default: activating this state disables it on the possible other + area with a default state, * default checked categories (*not mandatory*), -* if categories are displayed dynamically (if dynamically is set, the end user +* if categories are displayed dynamically. If dynamically is set, the end user only views categories which have items on the map section he is currently - looking at), + looking at, * categories restriction (*not mandatory*): if no restriction is set all categories are available, * an external CSS file (*not mandatory*): an URL to an external CSS file, * restriction on the bounding box: if set to restricted, the end user can't pan - outside the defined bounding box. Due to technical reasons of OpenLayers, there - is at this time no restriction on the zoom, + outside the defined bounding box. Due to technical reasons of OpenLayers, + there is at this time no restriction on the zoom, * a map bounding box: this is the area to display when arriving on the map. If - the area is restricted it will be the bounding box that restricts the end user. - Hold the control key, click and drag to draw the bounding box, -* available layers (*not mandatory*; OSM Mapnik is used by default): OSM Mapnik - render, OSM MapQuest render, OSM Transport Map render, OSM CycleMap are - available by default. You can add new custom layers (cf. :ref:`managing-layers`). + the area is restricted it will be the bounding box that restricts the end + user. Hold the *control* key, click and drag to draw the bounding box, +* available layers (*not mandatory*: OSM Mapnik is used by default): OSM + Mapnik render, OSM MapQuest render, OSM Transport Map render, OSM CycleMap are + available by default. You can add new custom layers (cf. + :ref:`managing-layers`). *Areas* are customizable directly on the web administration interface in *Chimere > Areas*. @@ -103,8 +104,8 @@ password):: *Users* are customizable directly on the web administration interface in *Auth/User*. -To create a new account, simply click on the Add button near Users. Give a name -and a default password (the user can change it on his own later). +To create a new account, simply click on the *Add* button near *Users*. Give a +name and a default password (the user can change it on his own later). Then complete the other pieces of information. @@ -116,7 +117,8 @@ user must be trustworthy!). Otherwise you'll have to give permissions to this new user. It is easier not to add permission manually but to make this user a member of a group. -Two types of default group are proposed: application administrator and moderator. +Two types of default group are proposed: application administrator and +moderator. Moderator are limited to an *Area* (they only see items that are inside the bounding box). If a moderator manages many areas you'll have to select many @@ -125,7 +127,7 @@ groups. Detail of rights for default groups: +-----------------------------------------+-------------------------+---------------------------+-----------+ -| Task (add/modify/delete on) | Technical administrator | Application administrator | Moderator | +| Item (add/modify/delete on) | Technical administrator | Application administrator | Moderator | +=========================================+=========================+===========================+===========+ | User | yes | no | no | +-----------------------------------------+-------------------------+---------------------------+-----------+ diff --git a/docs/fr/configuration.rst b/docs/fr/configuration.rst new file mode 100644 index 0000000..cb3e3e3 --- /dev/null +++ b/docs/fr/configuration.rst @@ -0,0 +1,202 @@ +.. -*- coding: utf-8 -*- + +============= +Configuration +============= + +:Auteur: Étienne Loks +:date: 2012-11-29 +:Copyright: CC-BY 3.0 + +Ce document présente l'installation de Chimère. +Il a été mis à jour pour la version 2.0.0 de Chimère. + +Votre session a à être initialisée avec ces variables d'environnements +en ligne de commande :: + + CHIMERE_PATH=/srv/chimere # changez avec votre répertoire d'installation + CHIMERE_LOCALNAME=mychimere # changez avec le nom de votre projet + CHIMERE_APP_PATH=$CHIMERE_PATH/$CHIMERE_LOCALNAME + + +Une fois l'application installée, il y a un certain nombre d'étapes à suivre +pour configurer *votre* Chimère. + +La plupart de ces étapes sont faites dans les pages web d'administration. + +Si vous n'êtes pas familiarisé avec les pages d'administration de *type +Django* vous pouvez dès maintenant regarder le premier paragraphe de +l':ref:`administration` où elle est présentée. + +Pour accéder à ces pages vous avez à vous identifier avec un compte ayant +pour état *équipe* ou *super-utilisateur*. + +Un compte *super-utilisateur* est créé à l'initialisation de la base de données. + +Configurer le framework Sites +----------------------------- + +Le framework *Sites* vous permet de servir le contenu pour différents domaines +Internet. La plupart des installations serviront le contenu pour un seul domaine +mais ce domaine unique a à être configuré. + +Pour cela allez dans les pages web d'administration *Sites > Sites*. +Vous avez juste à changer *example.com* par votre nom de domaine. Si vous +oubliez de faire cela quelques fonctionnalités comme les flux RSS ne +fonctionneront pas correctement. + +.. _managing-areas: + +Gérer les zones +--------------- + +Une zone est la base de votre carte. Pour une zone il est définit : + +* un nom : un libellé pour cette zone ; +* une URN associée (*facultatif*) : le nom de la zone en tant que ressource + Web. En pratique si la zone définie n'est pas celle par défaut, elle est + utilisée à la fin de l'adresse Web de base pour pouvoir accéder à cette zone. + Ce n'est pas obligatoire mais nécessaire en pratique pour chaque zone qui + n'est pas celle par défaut. +* un message par défaut (*facultatif*) : ce message est affiché une fois par + jour par utilisateur consultant la carte ; +* un ordre (pour trier les zones) ; +* une disponibilité ; +* un état « *par défaut* ». La zone *par défaut* est vue par défaut. Une seul + zone peut être *par défaut* : activez cet état sur une zone le désactive sur + toutes les autres. +* des catégories cochées par défaut (*facultatif*) ; +* si les catégories sont affichées dynamiquement. Si les catégories sont + affichées dynamiquement, l'utilisateur ne voit seulement que les catégories + qui ont des éléments sur la portion de carte actuellement à l'écran ; +* des restrictions sur les catégories (*facultatif*): si aucune restriction + n'est définie toutes les catégories sont disponibles ; +* une feuille de style CSS externe (*facultatif*) : une adresse Web qui pointe + vers une feuille de style CSS externe ; +* une restriction à la portion de carte : si restreint, l'utilisateur ne pourra + pas faire glisser la carte en dehors de la portion de carte. À cause de + restrictions de la bibliothèque OpenLayers utilisée par Chimère, il n'y a pas + de restriction sur le zoom ; +* une portion de carte : c'est la zone qui sera affichée par défaut en arrivant + sur la carte. Si la restriction sur une portion de carte est activée, la + restriction portera sur cette portion. Laissez appuyé la touche *Control* + cliquez et glissez pour dessiner la portion de carte choisie. +* calques disponibles (*facultatif* : OSM Mapnik est utilisé par défaut): les + rendus OSM Mapnik, OSM MapQuest, OSM Transport Map, OSM CycleMap sont + disponibles par défaut. Vous pouvez ajouter des nouveaux calques (cf. + :ref:`managing-layers`). + +Les *Zones* sont personnalisables directement depuis l'interface +d'administration dans *Chimere > Zones*. + +Comme il y a peu de chance que la zone définie par défaut vous convienne, il +sera au minimum nécessaire de définir une zone par défaut. + +Ajouter plusieurs zones peut être un moyen d'afficher vos données sous +différents jours. + +Gestion des utilisateurs +------------------------ + +Si vous n'êtes pas le seul administrator/modérateur de cette installation de +Chimère vous aurez à créer et gérer des comptes pour les autres utilisateurs. + +Vous pouvez créer un nouvel administrateur en ligne de commande :: + + ./manage.py createsuperuser + +Les mots de passe peuvent être changés en ligne de commande (utile si vous +avez oublié votre mot de passe) :: + + ./manage.py changepassword username + +Les *Utilisateurs* sont directement éditables depuis les pages d'administration +au niveau de la section *Auth/Utilisateur*. + +Pour créer un nouveau compte, cliquez simplement sur le bouton *Ajouter* à côté +de *Utilisateur*. Donnez un nom et un mot de passe (l'utilisateur pourra changer +son mot de passe plus tard). + +Ensuite complétez les autres informations. + +Cochez la case : *Statut équipe* (ou cet utilisateur ne sera pas capable +d'accéder aux pages d'administration). + +Si ce compte est un nouveau administrateur technique, cochez la case *Statut +superutilisateur* (cet utilisateur doit être digne de confiance !). Sinon +vous allez devoir donner des permissions à ce nouvel utilisateur. Plutôt que +d'assigner manuellement des permissions aux utilisateurs, il est plus simple +de leur affecter un groupe avec des permissions pré-définies. + +Deux types de groupe sont proposés par défaut : les administrateurs de +l'application et les modérateurs. + +Les groupes de modérateurs ont des droits limités à une seule zone (le nom +du groupe est *Nom de zone modération*). Ils ne voient que les éléments +qui concernent leur zone. Un utilisateur pouvant faire partie de plusieurs +groupes, il peut modérer plusieurs zones. + + +Détails des droits pour les groupes par défaut : + ++------------------------------------------+--------------------------+---------------------------------+------------+ +| Élément (ajout/modification/suppression) | Administrateur technique | Administrateur de l'application | Modérateur | ++==========================================+==========================+=================================+============+ +| User | Oui | Non | Non | ++------------------------------------------+--------------------------+---------------------------------+------------+ +| Group | Oui | Non | Non | ++------------------------------------------+--------------------------+---------------------------------+------------+ +| Property model | Oui | Non | Non | ++------------------------------------------+--------------------------+---------------------------------+------------+ +| Import | Oui | Non | Non | ++------------------------------------------+--------------------------+---------------------------------+------------+ +| Layer | Oui | Non | Non | ++------------------------------------------+--------------------------+---------------------------------+------------+ +| News | Oui | Oui | Non | ++------------------------------------------+--------------------------+---------------------------------+------------+ +| Area | Oui | Oui | Non | ++------------------------------------------+--------------------------+---------------------------------+------------+ +| Icon | Oui | Oui | Non | ++------------------------------------------+--------------------------+---------------------------------+------------+ +| Color/Color theme | Oui | Oui | Non | ++------------------------------------------+--------------------------+---------------------------------+------------+ +| Category/Subcategory | Oui | Oui | Non | ++------------------------------------------+--------------------------+---------------------------------+------------+ +| Point Of Interest | Oui | Oui | Oui | ++------------------------------------------+--------------------------+---------------------------------+------------+ +| Route | Oui | Oui | Oui | ++------------------------------------------+--------------------------+---------------------------------+------------+ + + +Créer des modèles de propriété +------------------------------ + +Une installation de base de Chimère permet d'associer un nom, des catégories, +une description, des dates, des fichiers multimédias, des fichiers d'image +à chaque fichier géographique. + +Vous souhaitez peut-être des champs personnalisés tels que des numéros de +téléphone ou des horaires d'ouverture. Pour cela, il suffit d'ajouter un nouveau +modèle de propriété (*Chimere/Modèle de propriété*). + +La page d'administration vous demande : + +* un nom ; +* un ordre (pour ordonner les propriétés entre-elles) ; +* une disponibilité pour l'utilisateur (cela peut être utilisé pour associer + des propriétés cachées) ; +* un état « Obligatoire » qui oblige à remplir ce champ dans les formulaires ; +* les catégories auxquelles associer cette propriété (si aucune catégorie n'est + sélectionnée la propriété est disponible pour toutes les categories) ; +* le type : texte, texte long, mot de passe ou date. + +.. Warning:: + Pour rendre cette propriété disponible, il est nécessaire de recharger le + serveur Web (les propriétés sont mis en cache). + +Les formulaires sont alors automatiquement mis à jour avec ce nouveau champ. + +En tant qu'administrateur, si vous ne souhaitez pas rendre disponible l'ajout +ou la modification des propriétés vous pouvez désactiver la gestion des modèles +de propriété en mettant *CHIMERE_HIDE_PROPERTYMODEL* à la valeur *True* dans +votre fichier *local_settings.py*. -- cgit v1.2.3 From bed043b0ec551f30036642c983a574a356809ce2 Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Sat, 1 Dec 2012 17:45:04 +0100 Subject: Documentation: french translation of index --- docs/fr/index.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/fr/index.rst (limited to 'docs/fr') diff --git a/docs/fr/index.rst b/docs/fr/index.rst new file mode 100644 index 0000000..308a9ad --- /dev/null +++ b/docs/fr/index.rst @@ -0,0 +1,17 @@ +.. Chimère documentation master file, created by + sphinx-quickstart on Wed Feb 15 00:42:28 2012. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Bienvenu dans la documentation de Chimère ! +=========================================== + +.. toctree:: + :maxdepth: 2 + + install + upgrade + configuration + administration + import_export + customisation -- cgit v1.2.3 From 271c770caeb7d3a3788c84b12164903b598fbd87 Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Sun, 2 Dec 2012 20:09:44 +0100 Subject: Documentation: french translation of import_export --- docs/fr/import_export.rst | 312 +++++++++++++++++++++++++--------------------- docs/import_export.rst | 34 ++--- 2 files changed, 188 insertions(+), 158 deletions(-) (limited to 'docs/fr') diff --git a/docs/fr/import_export.rst b/docs/fr/import_export.rst index eac21af..b63f874 100644 --- a/docs/fr/import_export.rst +++ b/docs/fr/import_export.rst @@ -16,218 +16,246 @@ Ce document a été mis à jour pour la version 2.0.0 de Chimère. Import ------ -Dans Chimère, le mécanisme d'import est basé sur **Import object**. Ces objets sont -stockés dans une base de données pour garder trace des imports et pour faciliter la -ré-importation depuis une même source. En fait, si cela est possible, la mise à jour -de données depuis un même type de source est gérée, de préférence à une ré-importation. +Dans Chimère, le mécanisme d'import est basé sur les objets **Import**. Ces +objets sont stockés dans une base de données pour garder trace des imports et +pour faciliter la ré-importation depuis une même source. En fait, si cela est +possible, la mise à jour de données depuis un même type de source est gérée, de +préférence à une ré-importation. .. Note:: - La possibilité de réaliser de telles mises à jour est conditionnée à l'existence - d'une id unique pour chaque objet de la source. + La possibilité de réaliser de telles mises à jour est conditionnée à + l'existence d'un identifiant unique pour chaque objet de la source. -Pour ajouter un **Import object**, vous devez aller dans *Chimere > Imports* puis **Ajouter**. +Pour ajouter un objet **Import**, vous devez aller dans *Chimere > Imports* puis +cliquer sur **Ajouter**. -Après cela, vous aurez à sélectionner votre type de source. Le formulaire suivant dépend de -ce type de source. +Après cela, vous aurez à sélectionner votre type de source. Le formulaire +suivant dépend de ce type de source. Champs communs à tous les types de source ***************************************** -- **Name by default**: if no name can be identified to the newly imported object - this is the name that will be used. If this field is empty the name of the - 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 - 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 - your source. -- **Origin**: if not null this field will be associated to each item imported in - order to easily identify where the item came from. For OSM import the source - is automatically added. -- **License**: if not null this field will be associated to each item imported in - order to easily identify the license associated to the item. For OSM import - the license is automatically added. -- **Associated subcategories (mandatory)**: The selected subcategories will be - associated to newly imported items. - - -KML import +- **Nom par défaut** : si aucun nom ne peut être trouvé dans la source pour ce + nouvel objet le nom par défaut sera utilisé. Si ce champ est vide le nom de + la catégorie associée sera utilisée. +- **SRID** : Chimère tente d'identifier automatiquement le système de coordonnées + utilisé par la source. Mais parfois l'information n'est pas présente ou ne + peut pas être devinée (par exemple un fichier Shapefile qui utilise un fichier + proj non standard). Dans ce cas, Chimère utilise WGS84 par défaut (latitude et + longitude). Si vous avez des problèmes avec la localisation des éléments vous + devez probablement mettre ici le `SRID `_ + correspondant au système de coordonnées de votre source. +- **Origine** : si non nul, ce champ va être associé à chaque élément importé + afin d'identifier facilement d'où l'élément provient. Pour les imports OSM + la source est ajoutée automatiquement. +- **Licence** : si non nul, ce champ va être associé à chaque élément importé + afin d'identifier facilement la license de l'élément. Pour les imports OSM + la license est ajoutée automatiquement. +- **Sous-catégories (obligatoire)** : les sous-catégories sélectionnées seront + associées automatiquement aux nouveaux éléments importés. + + +Import KML ********** .. image:: _static/chimere_admin_import_KML.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. -- **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. +- **Adresse Web/fichier source (obligatoire)** : votre fichier KML peut être + local ou distant. Vous avez à remplir un des deux champs. +- **Filtre**: si vous souhaitez importer seulement un dossier (**Folder**) du + fichier KML mettez son nom dans ce champ. +- **Fichier zippé**: si votre source est un fichier KMLZ (un fichier KML zippé), + cochez cette case. -Shapefile import +Import Shapefile **************** .. image:: _static/chimere_admin_import_shapefile.png -- **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. +- **Adresse Web/fichier source (obligatoire)** : votre fichier Shapefile peut + être local ou distant. Vous avez à remplir un des deux champs. +- **Fichier zippé**: seuls les fichiers Shapefile zippé sont acceptés aussi + cette case devrait être cochée. -GeoRSS import +Import GeoRSS ************* -Simple GeoRSS and W3C GeoRSS are managed. +Simple GeoRSS et W3C GeoRSS sont gérés. .. image:: _static/chimere_admin_import_georss.png -- **Web address (mandatory)**: only distant GeoRSS are managed. +- **Adresse Web (obligatoire)**: seul les flux GeoRSS distant sont gérés. -CSV import +Import CSV ********** -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. +Le format du fichier CSV (nombre et ordres des colonnes) géré par Chimère +varie en fonction des modèles de propriété que vous avez utilisé sur votre +instance Chimère. +Aussi, il est recommandé dans un premier temps de faire un export CSV de +quelques éléments. +Le format du fichier CSV exporté sera compatible avec Chimère pour l'import. -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. + +En tout cas à cause des champs géographiques ce format n'est pas très +pratique pour l'ajout de nouveau contenu mais peut s'avérer utile pour les +mises à jour d'information. .. Warning:: - If you mean to update existing data by this import, do *not* modify the - geometry column. + Si vous souhaitez mettre à jour des données existantes avec cet import, à + moins que vous sachiez éditer du WKT ne modifiez **pas** la colonne qui + concerne la géométrie de l'élément. .. image:: _static/chimere_admin_import_CSV.png -- **Web address/source file (mandatory)**: your CSV file could be distant or a - local file. You'll have to fill one of the two fields. +- **Adresse Web/fichier source (obligatoire)** : votre fichier CSV peut être + distant ou local. Vous avez à remplir un des deux champs. .. _osm-import: -OpenStreetMap import +Import OpenStreetMap ******************** .. image:: _static/chimere_admin_import_OSM.png -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 - 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. -- **Filter type (mandatory)**: choose if you want to import way or nodes. -- **Filter tag (mandatory)**: choose the OSM key/value couple used to filter OSM - data. A link to the `OSM Map features page - `_ is provided to help you - find appropriate values. -- **Refresh button**: this button convert your choices to appropriate XAPI args. - You have to hit this button before validating the form. - -Importing -********* - -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 printed in the state column of your import. - -You can also launch imports with the CLI (ideal for crontab jobs). In the -project directory you only need to launch the command:: +Pour importer depuis OSM, Chimère utilise l'API XAPI d'OSM. + +- **Adresse Web (obligatoire)**: l'URL XAPI à utiliser pour importer. Ce champ + doit être rempli par défaut. Par défaut le serveur MapQuest est utilisé car + il semble le plus robuste. Si vous avez des problèmes avec l'import de données + OSM, vérifiez la disponibilité du serveur utilisé et le cas échéant changez + le. +- **Filtre sur zone (obligatoire)**: dessinez la section de carte à utiliser + pour votre import OSM. +- **Filtre sur types (obligatoire)**: choisissez si vous souhaitez importer des + routes ou des nœuds. +- **Filtre sur les clé/valeur (obligatoire)**: choisissez la paire clé/valeur + à utiliser pour filtrer les données OSM. Un lien vers la `page de « Map + features » OSM `_ est + fourni pour vous aider à trouver les valeurs adaptées. +- **Bouton de rafraîchissement**: ce bouton converti vos choix en arguments + XAPI adaptés. N'oubliez pas de presser sur ce bouton avant de valider le + formulaire. + +Importer +******** + +Une fois que le nouvel objet *Import* est créé, sélectionnez le dans la liste +des objets, choisissez *Importer* et valider. + +L'import doit se dérouler normalement. Dans le cas contraire, un message +d'erreur explicite doit s'afficher dans la colonne *État* de votre import. + +Vous pouvez aussi lancer vos imports en ligne de commande (idéal pour les +travaux à mettre dans la table *cron*). Dans le répertoire du projet, il est +juste nécessaire de lancer la commande :: ./manage.py chimere_import -- *import_id* is the import ID +- *import_id* est l'identifiant de l'import -If you launch the command without *import_id* the list of imports available is -presented and you can choose one. +Si vous lancez l'import en ligne de commande sans l'identifiant d'import, la +liste des imports disponibles est affichée et vous pouvez alors en choisir un. -Managing imported data -********************** +Gérer les données importées +*************************** -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 some items to be visible on -the map, instead of deleting them it is recommended to set them to the state -**Disabled**. +Tous les nouveaux éléments importés ont l'état **Importé**. Pour que ceux-ci +soient disponible sur la carte, il est nécessaire de les valider. Si vous +ne souhaitez pas afficher certains éléments plutôt que de les supprimer, il est +recommandé de les mettre à l'état **Désactivé**. Ainsi lors de la prochaine +mise à jour depuis la source, ceux-ci resteront désactivés plutôt que +d'apparaître comme nouveaux éléments. .. Warning:: - Be careful with duplicates between your existing data and imported data. This - is particularly important if you want to export your data to OSM. + Soyez vigilants avec les doublons entre les données existantes et les données + importées. C'est particulièrement important si vous souhaitez exporter vos + données vers OSM. -Exporting ---------- +Exporter +-------- -Export to CSV/KML/Shapefile -*************************** +Exporter vers CSV/KML/Shapefile +******************************* -Directly from the :ref:`geographic items list ` you -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. +Depuis les `listes d'éléments géographiques ` vous +pouvez exporter directement vers le format choisi. +Tout ce que vous avez à faire c'est de sélectionner les éléments que vous +souhaitez exporter, choisir l'action appropriée dans la liste d'action et de +valider. -You can also launch exports with the CLI (ideal for crontab jobs). In the -project directory you only need to launch the command:: +Vous pouvez aussi lancer les exports depuis la ligne de commande (idéal pour les +travaux à mettre dans la table *cron*). Dans le répertoire du projet, vous avez +juste à lancer :: ./manage.py chimere_export \ -- *subcategory_id* is the ID of the chosen subcategory -- *CSV|KML|SHP* is the chosen format -- *marker|route* is to get marker or route -- *filename* is the output filename +- *subcategory_id* est l'identifiant de la sous-categorie choisie ; +- *CSV|KML|SHP* est le format choisi ; +- *marker|route* est pour obtenir points d'intérêts (marker) ou trajets + (route) ; +- *filename* est le nom du fichier de sortie -If you launch the command without arguments you will be prompted for the choice -to make for your export. +Si vous lancez la commande sans arguments il vous sera demandé les choix à faire +pour votre export. -Export to OSM -************* +Exporter vers 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. + Si vous n'êtes pas sûr de ce que vous êtes entrain de faire avec les exports + vers OSM : **ne le faites pas !** C'est vraiment important de ne pas + plaisanter avec les données des autres. .. 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 ` 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 - 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 + Seuls les exports des nœuds OSM sont gérés. + +Les exports ne sont pas aussi facile à gérer que les autres exports. Tout +d'abord (si cela n'est pas déjà fait) vous avez à définir un import OSM +(:ref:`regarder dessus` pour plus de détail). Cela permettra de +déterminer : + +- la zone géographique concernée par votre export ; +- la clé/valeur à ajouter à vos éléments (nouveaux ou mis à jour) ; +- les sous-catégories concernées par cet export. Si vosu pensez que certains + éléments dans ces sous-catégories ne devraient pas être dans la base de + données OSM (car ils ne sont pas pertinents ou à cause de question de licence) + préalablement marquez les comme **À ne pas exporter vers OSM** dans les + *champs d'imports* des :ref:`formulaires concernant les éléments géographiques `. -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, 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. +L'export vers OSM dans Chimère est fait de telle sorte à être le plus +conservateur possible par rapport à la base de données OSM. C'est pour cela +qu'avant tout export, un import est fait. Si le nouvel import a des données +mises à jour, les valeurs de ces nouvelles données écraseront les données +présentes dans votre Chimère (si vous ne souhaitez pas cela : ne faites pas +de ré-imports et de fait pas d'exports). Tous les éléments importés doivent +être traités avant de faire un 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 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. +Pour lancer un export sélectionnez l'objet *Import* approprié dans la liste +des imports. Ensuite sélectionnez l'action **Exporter vers OSM** et validez. +Puis on vous demande votre identifiant OSM, votre mot de passe OSM et l'API +que vous souhaitez utiliser. Si vous comptez faire des exports régulièrement +avec Chimère, il est recommandé de créer un compte spécifique pour cela. +L'API de test est disponible pour faire des tests d'export. Si vous souhaitez +utiliser l'API de test vous aurez à créer un compte spécifique sur la plateforme +de test. .. Warning:: - 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. + Les données sur la plateforme de test ne sont pas synchronisées avec la + plateforme principale. Vous n'aurez pas les mêmes données que les données + que vous aurez avec XAPI. -Once all this field filled, you can (finally!) launch the export. +Une fois que tout ces champs sont remplis, vous pouvez (enfin !) lancer +l'export. -When exporting tags are automatically added/updated: +Quand vous exportez des couples clés/valeurs sont automatiquement ajoutés/mis à +jour : -- *name*: get from the item name in Chimère. -- *source*: to identify Chimère as a source. +- *name*: obtenu depuis le nom de l'élément dans Chimère. +- *source*: pour identifier Chimère comme une source. diff --git a/docs/import_export.rst b/docs/import_export.rst index 1032804..3574a66 100644 --- a/docs/import_export.rst +++ b/docs/import_export.rst @@ -36,12 +36,13 @@ Common fields - **Name by default**: if no name can be identified to the newly imported object this is the name that will be used. If this field is empty the name of the 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 - 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 +- **SRID**: Chimère will try to identify automatically the correct coordinate + system 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 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 coordinate system of your source. - **Origin**: if not null this field will be associated to each item imported in order to easily identify where the item came from. For OSM import the source @@ -71,9 +72,9 @@ Shapefile import .. image:: _static/chimere_admin_import_shapefile.png -- **Web address/source file (mandatory)**: your shapefile could be distant or a +- **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 +- **Zipped file**: only zipped Shapefiles are accepted so this checkbox has to be checked. GeoRSS import @@ -97,8 +98,8 @@ 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. + If you mean to update existing data by this import, unless you know how to + edit WKT do *not* modify the geometry column. .. image:: _static/chimere_admin_import_CSV.png @@ -151,9 +152,10 @@ 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 some items to be visible on -the map, instead of deleting them it is recommended to set them to the state -**Disabled**. +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**. So on the next update from the source, rather than appear as new +items they remain disabled. .. Warning:: Be careful with duplicates between your existing data and imported data. This @@ -210,10 +212,10 @@ 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, 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. +Chimère (if you don't want that: don't do re-imports so dont do exports). 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. +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 regularly use Chimère to do export, it is recommended to create an -- cgit v1.2.3 From 01166165bee89dfc11e69589fd05a9e74e0aeea1 Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Wed, 5 Dec 2012 17:24:15 +0100 Subject: Documentation: reorganization to generate multi-languages docs --- .gitignore | 3 +- docs/Makefile | 130 --------- docs/_static/chimere_admin_00.png | Bin 5855 -> 0 bytes docs/_static/chimere_admin_01.png | Bin 69448 -> 0 bytes docs/_static/chimere_admin_02.png | Bin 62730 -> 0 bytes docs/_static/chimere_admin_03.png | Bin 65588 -> 0 bytes docs/_static/chimere_admin_import_CSV.png | Bin 12579 -> 0 bytes docs/_static/chimere_admin_import_KML.png | Bin 14953 -> 0 bytes docs/_static/chimere_admin_import_OSM.png | Bin 113738 -> 0 bytes docs/_static/chimere_admin_import_georss.png | Bin 10260 -> 0 bytes docs/_static/chimere_admin_import_shapefile.png | Bin 13807 -> 0 bytes docs/_static/chimere_admin_modified_management.png | Bin 93852 -> 0 bytes docs/_static/chimere_admin_modify_item.png | Bin 109282 -> 0 bytes docs/administration.rst | 209 -------------- docs/conf.py | 216 -------------- docs/configuration.rst | 187 ------------- docs/customisation.rst | 52 ---- docs/en/Makefile | 130 +++++++++ docs/en/administration.rst | 209 ++++++++++++++ docs/en/conf.py | 216 ++++++++++++++ docs/en/configuration.rst | 187 +++++++++++++ docs/en/customisation.rst | 52 ++++ docs/en/import_export.rst | 235 ++++++++++++++++ docs/en/index.rst | 17 ++ docs/en/install.rst | 290 +++++++++++++++++++ docs/en/static/chimere_admin_00.png | Bin 0 -> 5855 bytes docs/en/static/chimere_admin_01.png | Bin 0 -> 69448 bytes docs/en/static/chimere_admin_02.png | Bin 0 -> 62730 bytes docs/en/static/chimere_admin_03.png | Bin 0 -> 65588 bytes docs/en/static/chimere_admin_import_CSV.png | Bin 0 -> 12579 bytes docs/en/static/chimere_admin_import_KML.png | Bin 0 -> 14953 bytes docs/en/static/chimere_admin_import_OSM.png | Bin 0 -> 113738 bytes docs/en/static/chimere_admin_import_georss.png | Bin 0 -> 10260 bytes docs/en/static/chimere_admin_import_shapefile.png | Bin 0 -> 13807 bytes .../static/chimere_admin_modified_management.png | Bin 0 -> 93852 bytes docs/en/static/chimere_admin_modify_item.png | Bin 0 -> 109282 bytes docs/en/upgrade.rst | 311 +++++++++++++++++++++ docs/fr/Makefile | 130 +++++++++ docs/fr/administration.rst | 12 +- docs/fr/conf.py | 216 ++++++++++++++ docs/fr/import_export.rst | 10 +- docs/fr/static/chimere_admin_00.png | Bin 0 -> 5855 bytes docs/fr/static/chimere_admin_01.png | Bin 0 -> 69448 bytes docs/fr/static/chimere_admin_02.png | Bin 0 -> 62730 bytes docs/fr/static/chimere_admin_03.png | Bin 0 -> 65588 bytes docs/fr/static/chimere_admin_import_CSV.png | Bin 0 -> 12579 bytes docs/fr/static/chimere_admin_import_KML.png | Bin 0 -> 14953 bytes docs/fr/static/chimere_admin_import_OSM.png | Bin 0 -> 113738 bytes docs/fr/static/chimere_admin_import_georss.png | Bin 0 -> 10260 bytes docs/fr/static/chimere_admin_import_shapefile.png | Bin 0 -> 13807 bytes .../static/chimere_admin_modified_management.png | Bin 0 -> 93852 bytes docs/fr/static/chimere_admin_modify_item.png | Bin 0 -> 109282 bytes docs/import_export.rst | 235 ---------------- docs/index.rst | 17 -- docs/install.rst | 290 ------------------- docs/upgrade.rst | 311 --------------------- 56 files changed, 2006 insertions(+), 1659 deletions(-) delete mode 100644 docs/Makefile delete mode 100644 docs/_static/chimere_admin_00.png delete mode 100644 docs/_static/chimere_admin_01.png delete mode 100644 docs/_static/chimere_admin_02.png delete mode 100644 docs/_static/chimere_admin_03.png delete mode 100644 docs/_static/chimere_admin_import_CSV.png delete mode 100644 docs/_static/chimere_admin_import_KML.png delete mode 100644 docs/_static/chimere_admin_import_OSM.png delete mode 100644 docs/_static/chimere_admin_import_georss.png delete mode 100644 docs/_static/chimere_admin_import_shapefile.png delete mode 100644 docs/_static/chimere_admin_modified_management.png delete mode 100644 docs/_static/chimere_admin_modify_item.png delete mode 100644 docs/administration.rst delete mode 100644 docs/conf.py delete mode 100644 docs/configuration.rst delete mode 100644 docs/customisation.rst create mode 100644 docs/en/Makefile create mode 100644 docs/en/administration.rst create mode 100644 docs/en/conf.py create mode 100644 docs/en/configuration.rst create mode 100644 docs/en/customisation.rst create mode 100644 docs/en/import_export.rst create mode 100644 docs/en/index.rst create mode 100644 docs/en/install.rst create mode 100644 docs/en/static/chimere_admin_00.png create mode 100644 docs/en/static/chimere_admin_01.png create mode 100644 docs/en/static/chimere_admin_02.png create mode 100644 docs/en/static/chimere_admin_03.png create mode 100644 docs/en/static/chimere_admin_import_CSV.png create mode 100644 docs/en/static/chimere_admin_import_KML.png create mode 100644 docs/en/static/chimere_admin_import_OSM.png create mode 100644 docs/en/static/chimere_admin_import_georss.png create mode 100644 docs/en/static/chimere_admin_import_shapefile.png create mode 100644 docs/en/static/chimere_admin_modified_management.png create mode 100644 docs/en/static/chimere_admin_modify_item.png create mode 100644 docs/en/upgrade.rst create mode 100644 docs/fr/Makefile create mode 100644 docs/fr/conf.py create mode 100644 docs/fr/static/chimere_admin_00.png create mode 100644 docs/fr/static/chimere_admin_01.png create mode 100644 docs/fr/static/chimere_admin_02.png create mode 100644 docs/fr/static/chimere_admin_03.png create mode 100644 docs/fr/static/chimere_admin_import_CSV.png create mode 100644 docs/fr/static/chimere_admin_import_KML.png create mode 100644 docs/fr/static/chimere_admin_import_OSM.png create mode 100644 docs/fr/static/chimere_admin_import_georss.png create mode 100644 docs/fr/static/chimere_admin_import_shapefile.png create mode 100644 docs/fr/static/chimere_admin_modified_management.png create mode 100644 docs/fr/static/chimere_admin_modify_item.png delete mode 100644 docs/import_export.rst delete mode 100644 docs/index.rst delete mode 100644 docs/install.rst delete mode 100644 docs/upgrade.rst (limited to 'docs/fr') diff --git a/.gitignore b/.gitignore index 323a5e4..35b0ba8 100644 --- a/.gitignore +++ b/.gitignore @@ -9,4 +9,5 @@ example_project/static/upload/* example_project/media/* example_project/local_settings.py chimere_env/ -docs/_build/html/ +docs/en/build/ +docs/fr/build/ diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index dc549a6..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,130 +0,0 @@ -# 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) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest - -help: - @echo "Please use \`make ' where 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/Chimre.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Chimre.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/Chimre" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Chimre" - @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." diff --git a/docs/_static/chimere_admin_00.png b/docs/_static/chimere_admin_00.png deleted file mode 100644 index 374c6b6..0000000 Binary files a/docs/_static/chimere_admin_00.png and /dev/null differ diff --git a/docs/_static/chimere_admin_01.png b/docs/_static/chimere_admin_01.png deleted file mode 100644 index 0db7f4d..0000000 Binary files a/docs/_static/chimere_admin_01.png and /dev/null differ diff --git a/docs/_static/chimere_admin_02.png b/docs/_static/chimere_admin_02.png deleted file mode 100644 index d0fd6fe..0000000 Binary files a/docs/_static/chimere_admin_02.png and /dev/null differ diff --git a/docs/_static/chimere_admin_03.png b/docs/_static/chimere_admin_03.png deleted file mode 100644 index e815500..0000000 Binary files a/docs/_static/chimere_admin_03.png and /dev/null differ diff --git a/docs/_static/chimere_admin_import_CSV.png b/docs/_static/chimere_admin_import_CSV.png deleted file mode 100644 index e67a37b..0000000 Binary files a/docs/_static/chimere_admin_import_CSV.png and /dev/null differ diff --git a/docs/_static/chimere_admin_import_KML.png b/docs/_static/chimere_admin_import_KML.png deleted file mode 100644 index b48d69a..0000000 Binary files a/docs/_static/chimere_admin_import_KML.png and /dev/null differ diff --git a/docs/_static/chimere_admin_import_OSM.png b/docs/_static/chimere_admin_import_OSM.png deleted file mode 100644 index a599348..0000000 Binary files a/docs/_static/chimere_admin_import_OSM.png and /dev/null differ diff --git a/docs/_static/chimere_admin_import_georss.png b/docs/_static/chimere_admin_import_georss.png deleted file mode 100644 index 5278652..0000000 Binary files a/docs/_static/chimere_admin_import_georss.png and /dev/null differ diff --git a/docs/_static/chimere_admin_import_shapefile.png b/docs/_static/chimere_admin_import_shapefile.png deleted file mode 100644 index ce612be..0000000 Binary files a/docs/_static/chimere_admin_import_shapefile.png and /dev/null differ diff --git a/docs/_static/chimere_admin_modified_management.png b/docs/_static/chimere_admin_modified_management.png deleted file mode 100644 index 84e069e..0000000 Binary files a/docs/_static/chimere_admin_modified_management.png and /dev/null differ diff --git a/docs/_static/chimere_admin_modify_item.png b/docs/_static/chimere_admin_modify_item.png deleted file mode 100644 index 861ea20..0000000 Binary files a/docs/_static/chimere_admin_modify_item.png and /dev/null differ diff --git a/docs/administration.rst b/docs/administration.rst deleted file mode 100644 index 672caa9..0000000 --- a/docs/administration.rst +++ /dev/null @@ -1,209 +0,0 @@ -.. -*- coding: utf-8 -*- -.. _administration: - -============== -Administration -============== - -:Author: Étienne Loks -:date: 2012-11-28 -:Copyright: CC-BY 3.0 - -This document presents the administration of Chimère. -It has been updated for version 2.0.0. - - -Administration pages presentation ---------------------------------- - -Administration pages are accessible at: http://where_is_your_chimere/admin/ - -Don't forget the ending slash in the URL. - -Identification -************** - -First of all, you'll have to identify yourself with the login and password -provided. - -.. image:: _static/chimere_admin_00.png - - -Main page -********* - -Once authentified you'll have access to the main admin page. - -It looks like this: - -.. image:: _static/chimere_admin_01.png - -#. links to this **Documentation**, to the **Change password** form and to - **Log out**, -#. the list of recent actions made with this account, -#. an application title, most of your action will be in the **Chimere** - application, -#. an item inside the application. From these pages you can **Add** a new item or - consult/**Change** items. The **Add** link leads to the new `Item form`_. The - **Change** link leads to the `Item list`_. The `Item list`_ is also available - by clicking on the item label. - - -Item list -********* - -.. image:: _static/chimere_admin_02.png - -#. path in the admin site. This is a convenient shortcut to come back to the - main page, -#. link to create a new item from the item list, -#. search items by words (not available for all item types), -#. this filter box permits to filter current entries with some criteria (not - available for all type of items), -#. the header of the table is clickable. Clicking on an header sorts the items by - this header (ascending or descending). Multiple header sort is possible (the - number on the right of the header explains the sorting order), -#. each item can be checked (for applying an action) or selected (by clicking on - the first column) to see the detail and edit or delete it. - -Item form -********* - -.. image:: _static/chimere_admin_03.png - -#. fields for the selected item (or blank if it is a new item) are displayed in - this form. A few fields are read-only and another few are hidden. Mandatory - fields have their label in bold. Changes on these fields are only effective - once the form is submitted. -#. for some items there are associated sub-items. These associated items can be - modified in this form. If there are many sub-items associated for the current - item, they can be ordered by drag and drop. -#. the form has to be validated by one of these action buttons. They are - self-explanatory. - -Status -****** - -*Status* is a property attached to each geographic item in Chimère. To -administrate efficiently Chimère you need to understand the mean of each status. - -- **Submitted**: Status of a new item freshly proposed by an end user. This item - is not visible on the map. -- **Available**: Status of an item visible on the map. -- **Disabled**: Status of a discarded item. -- **Modified**: Status of an amendment proposed by an end-user. -- **Imported**: Status of a newly imported item. Import and export operations - need that all items with *imported* status are treated (validated, disabled - or deleted). - - -Managing news -------------- - -A news system is available. -All you have to to do is to click on the **Add** button near News. -For each news you have to provide a name and a content. The content can contain -HTML tags. -The availability is set with a checkbox. - -Creating categories/subcategories ---------------------------------- - -Before adding categories you have to set some icons. These icons appear on the -map and in the categories' box on the main map. -Be careful to resize correctly your icons. Indeed the icon will be presented at -their real size on the map. -To add icons: the **Add** button near Icons. - -Categories are in fact only containers for subcategories. You'll have to provide -only a name and an order. -To add categories: the **Add** button near categories (quite clear now, isn't -it?) - -Fields of subcategories are: an associated category, a name, an icon, an order, -a color and an element type. -These fields are mainly quite self- explanatory. -The color is used to draw routes (if this subcategory contains routes). If it a -basic color it can be set with the English name (for instance: *red*, *blue*, -*yellow* or *purple*) otherwise you can put the HTML RVB code (for instance -*#9227c9*). -The element type is the type of element that the subcategory can contain: POI, route -or both. - -.. _geographic-items-management: - -Editing or moderating items ---------------------------- - -The moderation step is quite simple. It works the same with POIs and routes. -The moderator can access to all POIs (or routes) by clicking on them on the -list. - -A search field is available to search by name but the more interesting is to -filter POIs (or route) by state and by subcategory. - -There are some actions available in the action list: - -- **Delete**: to delete selected items. A confirmation step is displayed, -- **Validate**: to set the status *Available* to selected items, -- **Disable**: to set the status *Disabled* to selected items. This is useful to - keep items you don't want to be exposed on the map, -- **Managed modified items**: to manage the amendment made by end users on the - main site (cf. :ref:`managing-modified`). Modified item has to be treated - one by one, -- **Export to...**: to export selected item to the selected format. - - -To modify an item, classically you have to click on its name. -Then you access to a form to freely modify the item. - -.. image:: _static/chimere_admin_modify_item.png - -In this form there are all data available to the end user form plus some extra -fields. - -- The *Import fields* only make sense with data imported from an external - source or for data to be exported to OSM (cf. the :ref:`import section - ` of this documentation), -- *Associated items fields* are read-only fields that list items associated to - the current one (for example the reference item of an amendment or an associated - file of a route). - -Associated multimedia items are at the bottom of the form. You can freely add, -change items and change their order with drag and drop. - -Don't forget to validate your change with one of the **Save** buttons at the -bottom of the form (it is easily forgotten when you change multimedia items). - -If an item is not relevant the **Delete** button enables to remove it. - -.. _managing-modified: - -Managing end user amendment ---------------------------- - -Amendment can be proposed on the main site by end-users. -In Chimère an amendment is a new item with the status *Modified* and with a link -to the reference item modified. - -.. Note:: - If you are logged as an administrator and make changes on the map with the - end user form they will be directly validated. - -A special form has been developed to facilitate the processing of these -modified items. - -You can access to this special form with the action *Managed modified items*. - -.. image:: _static/chimere_admin_modified_management.png - -This form is a table with three columns: - -#. The first column displays the information for the reference item, -#. The second column displays the information proposed by the submitter, -#. The third column is a list of checkboxes. For each row checked, after the - validation, the value of the modified item will replace the value of the - reference item. - -.. Note:: - To reject all modifications validate the form with no checkbox checked. diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 9221eb1..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,216 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Chimère documentation build configuration file, created by -# sphinx-quickstart on Wed Feb 15 00:42:28 2012. -# -# 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'Chimère' -copyright = u'2012, É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 = '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 = ['_build'] - -# 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 -# " v 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 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 = 'Chimredoc' - - -# -- 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', 'Chimre.tex', u'Chimère 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', 'chimre', u'Chimère Documentation', - [u'Étienne Loks'], 1) -] diff --git a/docs/configuration.rst b/docs/configuration.rst deleted file mode 100644 index e5870bb..0000000 --- a/docs/configuration.rst +++ /dev/null @@ -1,187 +0,0 @@ -.. -*- coding: utf-8 -*- - -============= -Configuration -============= - -:Author: Étienne Loks -:date: 2012-10-08 -:Copyright: CC-BY 3.0 - -This document presents the first steps to configure your Chimère. -It has been updated for version 2.0.0. - -Your session has to be initialised with these environment variables in -the Command Line Interface:: - - CHIMERE_PATH=/srv/chimere # change with your installation path - CHIMERE_LOCALNAME=mychimere # change with your local project name - CHIMERE_APP_PATH=$CHIMERE_PATH/$CHIMERE_LOCALNAME - - -Once the application installed, there are a few simple steps to follow to -configure *your* Chimère. - -Most of these steps are done in the web administration pages. - -If you are not familiar with *Django-like* administration pages you can look -at the first paragraph of :ref:`administration` where it is presented. - -To access these pages you have to identify with an account with *staff* and -*superuser* status. - -A *superuser* account is created at the initialization of the database. - -Configuring the Sites framework -------------------------------- - -*Sites* framework allow you to serve the same content on different domains. -Most of you will probably use only one domain but this unique domain has to -be configured. This is done in the web administration interface in *Sites > Sites*. -You only need to change *example.com* by your domain name. If you forget to -do that, some functionalities such as RSS feeds will not work properly. - -.. _managing-areas: - -Managing areas --------------- - -An *Area* is the base of your map. It defines: - -* a name: a human readable label for this area, -* an associated URN (*not mandatory*): the name of the area as a web ressource. - In practice, if the area is not the default area the URN is used at the end of - the default URL to access to this area. This is not mandatory but necessary - for each area that is not the default one, -* a welcome message (*not mandatory*): this message is displayed once a day per - user arriving on the map, -* an order (to sort areas), -* an availability, -* a "*default*" state. The "*default*" area is viewed by default. Only one area - can be the default: activating this state disables it on the possible other - area with a default state, -* default checked categories (*not mandatory*), -* if categories are displayed dynamically. If dynamically is set, the end user - only views categories which have items on the map section he is currently - looking at, -* categories restriction (*not mandatory*): if no restriction is set all - categories are available, -* an external CSS file (*not mandatory*): an URL to an external CSS file, -* restriction on the bounding box: if set to restricted, the end user can't pan - outside the defined bounding box. Due to technical reasons of OpenLayers, - there is at this time no restriction on the zoom, -* a map bounding box: this is the area to display when arriving on the map. If - the area is restricted it will be the bounding box that restricts the end - user. Hold the *control* key, click and drag to draw the bounding box, -* available layers (*not mandatory*: OSM Mapnik is used by default): OSM - Mapnik render, OSM MapQuest render, OSM Transport Map render, OSM CycleMap are - available by default. You can add new custom layers (cf. - :ref:`managing-layers`). - -*Areas* are customizable directly on the web administration interface in -*Chimere > Areas*. - -As there is little chance that the default area should be appropriated for you, -you'll have to set at least one default area. - -Adding many areas can be a mean to show your map in different flavors. - -Managing users --------------- - -If you are not the only administrator/moderator of this Chimère installation -you have to create and manage account for the other users. - -You can create a new *superuser* account with the Command Line Interface (CLI):: - - ./manage.py createsuperuser - -User password can be changed with the CLI (useful if you have forgotten your -password):: - - ./manage.py changepassword username - -*Users* are customizable directly on the web administration interface in -*Auth/User*. - -To create a new account, simply click on the *Add* button near *Users*. Give a -name and a default password (the user can change it on his own later). - -Then complete the other pieces of information. - -Check the case: *Staff status* (or this user will not be able to log to the -administration website). - -If this account is a new technical administrator, check *Superuser status* (this -user must be trustworthy!). Otherwise you'll have to give permissions to this -new user. It is easier not to add permission manually but to make this user -a member of a group. - -Two types of default group are proposed: application administrator and -moderator. - -Moderator are limited to an *Area* (they only see items that are inside the -bounding box). If a moderator manages many areas you'll have to select many -groups. - -Detail of rights for default groups: - -+-----------------------------------------+-------------------------+---------------------------+-----------+ -| Item (add/modify/delete on) | Technical administrator | Application administrator | Moderator | -+=========================================+=========================+===========================+===========+ -| User | yes | no | no | -+-----------------------------------------+-------------------------+---------------------------+-----------+ -| Group | yes | no | no | -+-----------------------------------------+-------------------------+---------------------------+-----------+ -| Property model | yes | no | no | -+-----------------------------------------+-------------------------+---------------------------+-----------+ -| Import | yes | no | no | -+-----------------------------------------+-------------------------+---------------------------+-----------+ -| Layer | yes | no | no | -+-----------------------------------------+-------------------------+---------------------------+-----------+ -| News | yes | yes | no | -+-----------------------------------------+-------------------------+---------------------------+-----------+ -| Area | yes | yes | no | -+-----------------------------------------+-------------------------+---------------------------+-----------+ -| Icon | yes | yes | no | -+-----------------------------------------+-------------------------+---------------------------+-----------+ -| Color/Color theme | yes | yes | no | -+-----------------------------------------+-------------------------+---------------------------+-----------+ -| Category/Subcategory | yes | yes | no | -+-----------------------------------------+-------------------------+---------------------------+-----------+ -| Point Of Interest | yes | yes | yes | -+-----------------------------------------+-------------------------+---------------------------+-----------+ -| Route | yes | yes | yes | -+-----------------------------------------+-------------------------+---------------------------+-----------+ - - -Creating property models ------------------------- - -A basic installation of Chimère permits to associate a name, a category, a -description, dates, multimedia files, picture files, etc. for each geographic -item. - -You may want to add more custom fields like phone number or opening hours. For -that all you have to do is to add a new property model (*Chimere/Property -model*). - -The administration page asks you for: - -* a name, -* an order (to sort properties), -* an availability to the end user (this can be used to set hidden properties), -* a mandatory status, -* the categories the property applies to (if no categories selected it applies - to all), -* the type: text, long text, password or date. - -To make this property available it is necessary to reload your web server (the -property is cached). - -All forms are then automatically updated with this new field. - -If you don't want to allow add and modification of properties you can disable -this form by setting CHIMERE_HIDE_PROPERTYMODEL to *True* in your -*local_settings.py* file. - diff --git a/docs/customisation.rst b/docs/customisation.rst deleted file mode 100644 index 665e2f8..0000000 --- a/docs/customisation.rst +++ /dev/null @@ -1,52 +0,0 @@ -.. -*- coding: utf-8 -*- - -============= -Customisation -============= - -:Author: Étienne Loks -:date: 2012-11-28 -:Copyright: CC-BY 3.0 - -This document presents the customisation of Chimère. -It has been updated for version 2.0.0. - - -.. _managing-layers: - -Managing layers ---------------- - -There are some different layers available by default in Chimère (OSM Mapnik, OSM -Mapquest, OSM Transport map, OSM Cyclemap). You can add some extra layer using -the web administration pages of Chimère. The new layer is defined with the -appropriate `Openlayers `_ JS code. This JS code must -be a compatible Openlayers Layer instance with no ending semi-colon. For -instance defining a Bing layer can be done with this kind of code:: - - new OpenLayers.Layer.Bing({ - name: "Aerial", - key: "my-bing-API-key", - type: "Aerial"}) - - -Refer to the `Openlayers documentation API -`_ -for more details. - - -Customizing the layout and the design -------------------------------------- - -If you only want to customize the CSS, the easiest way to do it is to add a -link to an extra CSS to your *Areas* cf. :ref:`managing-areas`. - -If you want to do larger changes in the layout and the style the (well named) -example_project can be customized to fit your needs. Each template file present -in the *chimere/templates* directory can be copied in your *myproject/templates* -directory and then modified. -You only need to copy files that you want to modify. These files are in -Django template language mainly made of pure HTML with some logic. Refer to -the `Django template documentation `_ -for more details. - diff --git a/docs/en/Makefile b/docs/en/Makefile new file mode 100644 index 0000000..fcccf30 --- /dev/null +++ b/docs/en/Makefile @@ -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) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest + +help: + @echo "Please use \`make ' where 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/Chimre.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Chimre.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/Chimre" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Chimre" + @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." diff --git a/docs/en/administration.rst b/docs/en/administration.rst new file mode 100644 index 0000000..8b7e581 --- /dev/null +++ b/docs/en/administration.rst @@ -0,0 +1,209 @@ +.. -*- coding: utf-8 -*- +.. _administration: + +============== +Administration +============== + +:Author: Étienne Loks +:date: 2012-11-28 +:Copyright: CC-BY 3.0 + +This document presents the administration of Chimère. +It has been updated for version 2.0.0. + + +Administration pages presentation +--------------------------------- + +Administration pages are accessible at: http://where_is_your_chimere/admin/ + +Don't forget the ending slash in the URL. + +Identification +************** + +First of all, you'll have to identify yourself with the login and password +provided. + +.. image:: static/chimere_admin_00.png + + +Main page +********* + +Once authentified you'll have access to the main admin page. + +It looks like this: + +.. image:: static/chimere_admin_01.png + +#. links to this **Documentation**, to the **Change password** form and to + **Log out**, +#. the list of recent actions made with this account, +#. an application title, most of your action will be in the **Chimere** + application, +#. an item inside the application. From these pages you can **Add** a new item or + consult/**Change** items. The **Add** link leads to the new `Item form`_. The + **Change** link leads to the `Item list`_. The `Item list`_ is also available + by clicking on the item label. + + +Item list +********* + +.. image:: static/chimere_admin_02.png + +#. path in the admin site. This is a convenient shortcut to come back to the + main page, +#. link to create a new item from the item list, +#. search items by words (not available for all item types), +#. this filter box permits to filter current entries with some criteria (not + available for all type of items), +#. the header of the table is clickable. Clicking on an header sorts the items by + this header (ascending or descending). Multiple header sort is possible (the + number on the right of the header explains the sorting order), +#. each item can be checked (for applying an action) or selected (by clicking on + the first column) to see the detail and edit or delete it. + +Item form +********* + +.. image:: static/chimere_admin_03.png + +#. fields for the selected item (or blank if it is a new item) are displayed in + this form. A few fields are read-only and another few are hidden. Mandatory + fields have their label in bold. Changes on these fields are only effective + once the form is submitted. +#. for some items there are associated sub-items. These associated items can be + modified in this form. If there are many sub-items associated for the current + item, they can be ordered by drag and drop. +#. the form has to be validated by one of these action buttons. They are + self-explanatory. + +Status +****** + +*Status* is a property attached to each geographic item in Chimère. To +administrate efficiently Chimère you need to understand the mean of each status. + +- **Submitted**: Status of a new item freshly proposed by an end user. This item + is not visible on the map. +- **Available**: Status of an item visible on the map. +- **Disabled**: Status of a discarded item. +- **Modified**: Status of an amendment proposed by an end-user. +- **Imported**: Status of a newly imported item. Import and export operations + need that all items with *imported* status are treated (validated, disabled + or deleted). + + +Managing news +------------- + +A news system is available. +All you have to to do is to click on the **Add** button near News. +For each news you have to provide a name and a content. The content can contain +HTML tags. +The availability is set with a checkbox. + +Creating categories/subcategories +--------------------------------- + +Before adding categories you have to set some icons. These icons appear on the +map and in the categories' box on the main map. +Be careful to resize correctly your icons. Indeed the icon will be presented at +their real size on the map. +To add icons: the **Add** button near Icons. + +Categories are in fact only containers for subcategories. You'll have to provide +only a name and an order. +To add categories: the **Add** button near categories (quite clear now, isn't +it?) + +Fields of subcategories are: an associated category, a name, an icon, an order, +a color and an element type. +These fields are mainly quite self- explanatory. +The color is used to draw routes (if this subcategory contains routes). If it a +basic color it can be set with the English name (for instance: *red*, *blue*, +*yellow* or *purple*) otherwise you can put the HTML RVB code (for instance +*#9227c9*). +The element type is the type of element that the subcategory can contain: POI, route +or both. + +.. _geographic-items-management: + +Editing or moderating items +--------------------------- + +The moderation step is quite simple. It works the same with POIs and routes. +The moderator can access to all POIs (or routes) by clicking on them on the +list. + +A search field is available to search by name but the more interesting is to +filter POIs (or route) by state and by subcategory. + +There are some actions available in the action list: + +- **Delete**: to delete selected items. A confirmation step is displayed, +- **Validate**: to set the status *Available* to selected items, +- **Disable**: to set the status *Disabled* to selected items. This is useful to + keep items you don't want to be exposed on the map, +- **Managed modified items**: to manage the amendment made by end users on the + main site (cf. :ref:`managing-modified`). Modified item has to be treated + one by one, +- **Export to...**: to export selected item to the selected format. + + +To modify an item, classically you have to click on its name. +Then you access to a form to freely modify the item. + +.. image:: static/chimere_admin_modify_item.png + +In this form there are all data available to the end user form plus some extra +fields. + +- The *Import fields* only make sense with data imported from an external + source or for data to be exported to OSM (cf. the :ref:`import section + ` of this documentation), +- *Associated items fields* are read-only fields that list items associated to + the current one (for example the reference item of an amendment or an associated + file of a route). + +Associated multimedia items are at the bottom of the form. You can freely add, +change items and change their order with drag and drop. + +Don't forget to validate your change with one of the **Save** buttons at the +bottom of the form (it is easily forgotten when you change multimedia items). + +If an item is not relevant the **Delete** button enables to remove it. + +.. _managing-modified: + +Managing end user amendment +--------------------------- + +Amendment can be proposed on the main site by end-users. +In Chimère an amendment is a new item with the status *Modified* and with a link +to the reference item modified. + +.. Note:: + If you are logged as an administrator and make changes on the map with the + end user form they will be directly validated. + +A special form has been developed to facilitate the processing of these +modified items. + +You can access to this special form with the action *Managed modified items*. + +.. image:: static/chimere_admin_modified_management.png + +This form is a table with three columns: + +#. The first column displays the information for the reference item, +#. The second column displays the information proposed by the submitter, +#. The third column is a list of checkboxes. For each row checked, after the + validation, the value of the modified item will replace the value of the + reference item. + +.. Note:: + To reject all modifications validate the form with no checkbox checked. diff --git a/docs/en/conf.py b/docs/en/conf.py new file mode 100644 index 0000000..7b92da9 --- /dev/null +++ b/docs/en/conf.py @@ -0,0 +1,216 @@ +# -*- coding: utf-8 -*- +# +# Chimère documentation build configuration file, created by +# sphinx-quickstart on Wed Feb 15 00:42:28 2012. +# +# 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'Chimère' +copyright = u'2012, É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 = '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 = ['build'] + +# 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 +# " v 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 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 = 'Chimredoc' + + +# -- 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', 'Chimre.tex', u'Chimère 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', 'chimre', u'Chimère Documentation', + [u'Étienne Loks'], 1) +] diff --git a/docs/en/configuration.rst b/docs/en/configuration.rst new file mode 100644 index 0000000..e5870bb --- /dev/null +++ b/docs/en/configuration.rst @@ -0,0 +1,187 @@ +.. -*- coding: utf-8 -*- + +============= +Configuration +============= + +:Author: Étienne Loks +:date: 2012-10-08 +:Copyright: CC-BY 3.0 + +This document presents the first steps to configure your Chimère. +It has been updated for version 2.0.0. + +Your session has to be initialised with these environment variables in +the Command Line Interface:: + + CHIMERE_PATH=/srv/chimere # change with your installation path + CHIMERE_LOCALNAME=mychimere # change with your local project name + CHIMERE_APP_PATH=$CHIMERE_PATH/$CHIMERE_LOCALNAME + + +Once the application installed, there are a few simple steps to follow to +configure *your* Chimère. + +Most of these steps are done in the web administration pages. + +If you are not familiar with *Django-like* administration pages you can look +at the first paragraph of :ref:`administration` where it is presented. + +To access these pages you have to identify with an account with *staff* and +*superuser* status. + +A *superuser* account is created at the initialization of the database. + +Configuring the Sites framework +------------------------------- + +*Sites* framework allow you to serve the same content on different domains. +Most of you will probably use only one domain but this unique domain has to +be configured. This is done in the web administration interface in *Sites > Sites*. +You only need to change *example.com* by your domain name. If you forget to +do that, some functionalities such as RSS feeds will not work properly. + +.. _managing-areas: + +Managing areas +-------------- + +An *Area* is the base of your map. It defines: + +* a name: a human readable label for this area, +* an associated URN (*not mandatory*): the name of the area as a web ressource. + In practice, if the area is not the default area the URN is used at the end of + the default URL to access to this area. This is not mandatory but necessary + for each area that is not the default one, +* a welcome message (*not mandatory*): this message is displayed once a day per + user arriving on the map, +* an order (to sort areas), +* an availability, +* a "*default*" state. The "*default*" area is viewed by default. Only one area + can be the default: activating this state disables it on the possible other + area with a default state, +* default checked categories (*not mandatory*), +* if categories are displayed dynamically. If dynamically is set, the end user + only views categories which have items on the map section he is currently + looking at, +* categories restriction (*not mandatory*): if no restriction is set all + categories are available, +* an external CSS file (*not mandatory*): an URL to an external CSS file, +* restriction on the bounding box: if set to restricted, the end user can't pan + outside the defined bounding box. Due to technical reasons of OpenLayers, + there is at this time no restriction on the zoom, +* a map bounding box: this is the area to display when arriving on the map. If + the area is restricted it will be the bounding box that restricts the end + user. Hold the *control* key, click and drag to draw the bounding box, +* available layers (*not mandatory*: OSM Mapnik is used by default): OSM + Mapnik render, OSM MapQuest render, OSM Transport Map render, OSM CycleMap are + available by default. You can add new custom layers (cf. + :ref:`managing-layers`). + +*Areas* are customizable directly on the web administration interface in +*Chimere > Areas*. + +As there is little chance that the default area should be appropriated for you, +you'll have to set at least one default area. + +Adding many areas can be a mean to show your map in different flavors. + +Managing users +-------------- + +If you are not the only administrator/moderator of this Chimère installation +you have to create and manage account for the other users. + +You can create a new *superuser* account with the Command Line Interface (CLI):: + + ./manage.py createsuperuser + +User password can be changed with the CLI (useful if you have forgotten your +password):: + + ./manage.py changepassword username + +*Users* are customizable directly on the web administration interface in +*Auth/User*. + +To create a new account, simply click on the *Add* button near *Users*. Give a +name and a default password (the user can change it on his own later). + +Then complete the other pieces of information. + +Check the case: *Staff status* (or this user will not be able to log to the +administration website). + +If this account is a new technical administrator, check *Superuser status* (this +user must be trustworthy!). Otherwise you'll have to give permissions to this +new user. It is easier not to add permission manually but to make this user +a member of a group. + +Two types of default group are proposed: application administrator and +moderator. + +Moderator are limited to an *Area* (they only see items that are inside the +bounding box). If a moderator manages many areas you'll have to select many +groups. + +Detail of rights for default groups: + ++-----------------------------------------+-------------------------+---------------------------+-----------+ +| Item (add/modify/delete on) | Technical administrator | Application administrator | Moderator | ++=========================================+=========================+===========================+===========+ +| User | yes | no | no | ++-----------------------------------------+-------------------------+---------------------------+-----------+ +| Group | yes | no | no | ++-----------------------------------------+-------------------------+---------------------------+-----------+ +| Property model | yes | no | no | ++-----------------------------------------+-------------------------+---------------------------+-----------+ +| Import | yes | no | no | ++-----------------------------------------+-------------------------+---------------------------+-----------+ +| Layer | yes | no | no | ++-----------------------------------------+-------------------------+---------------------------+-----------+ +| News | yes | yes | no | ++-----------------------------------------+-------------------------+---------------------------+-----------+ +| Area | yes | yes | no | ++-----------------------------------------+-------------------------+---------------------------+-----------+ +| Icon | yes | yes | no | ++-----------------------------------------+-------------------------+---------------------------+-----------+ +| Color/Color theme | yes | yes | no | ++-----------------------------------------+-------------------------+---------------------------+-----------+ +| Category/Subcategory | yes | yes | no | ++-----------------------------------------+-------------------------+---------------------------+-----------+ +| Point Of Interest | yes | yes | yes | ++-----------------------------------------+-------------------------+---------------------------+-----------+ +| Route | yes | yes | yes | ++-----------------------------------------+-------------------------+---------------------------+-----------+ + + +Creating property models +------------------------ + +A basic installation of Chimère permits to associate a name, a category, a +description, dates, multimedia files, picture files, etc. for each geographic +item. + +You may want to add more custom fields like phone number or opening hours. For +that all you have to do is to add a new property model (*Chimere/Property +model*). + +The administration page asks you for: + +* a name, +* an order (to sort properties), +* an availability to the end user (this can be used to set hidden properties), +* a mandatory status, +* the categories the property applies to (if no categories selected it applies + to all), +* the type: text, long text, password or date. + +To make this property available it is necessary to reload your web server (the +property is cached). + +All forms are then automatically updated with this new field. + +If you don't want to allow add and modification of properties you can disable +this form by setting CHIMERE_HIDE_PROPERTYMODEL to *True* in your +*local_settings.py* file. + diff --git a/docs/en/customisation.rst b/docs/en/customisation.rst new file mode 100644 index 0000000..665e2f8 --- /dev/null +++ b/docs/en/customisation.rst @@ -0,0 +1,52 @@ +.. -*- coding: utf-8 -*- + +============= +Customisation +============= + +:Author: Étienne Loks +:date: 2012-11-28 +:Copyright: CC-BY 3.0 + +This document presents the customisation of Chimère. +It has been updated for version 2.0.0. + + +.. _managing-layers: + +Managing layers +--------------- + +There are some different layers available by default in Chimère (OSM Mapnik, OSM +Mapquest, OSM Transport map, OSM Cyclemap). You can add some extra layer using +the web administration pages of Chimère. The new layer is defined with the +appropriate `Openlayers `_ JS code. This JS code must +be a compatible Openlayers Layer instance with no ending semi-colon. For +instance defining a Bing layer can be done with this kind of code:: + + new OpenLayers.Layer.Bing({ + name: "Aerial", + key: "my-bing-API-key", + type: "Aerial"}) + + +Refer to the `Openlayers documentation API +`_ +for more details. + + +Customizing the layout and the design +------------------------------------- + +If you only want to customize the CSS, the easiest way to do it is to add a +link to an extra CSS to your *Areas* cf. :ref:`managing-areas`. + +If you want to do larger changes in the layout and the style the (well named) +example_project can be customized to fit your needs. Each template file present +in the *chimere/templates* directory can be copied in your *myproject/templates* +directory and then modified. +You only need to copy files that you want to modify. These files are in +Django template language mainly made of pure HTML with some logic. Refer to +the `Django template documentation `_ +for more details. + diff --git a/docs/en/import_export.rst b/docs/en/import_export.rst new file mode 100644 index 0000000..73a95af --- /dev/null +++ b/docs/en/import_export.rst @@ -0,0 +1,235 @@ +.. -*- coding: utf-8 -*- + +============= +Import/export +============= + +:Author: Étienne Loks +:date: 2012-11-28 +:Copyright: CC-BY 3.0 + +This document presents the import/export functionnalities of Chimère. +It has been updated for version 2.0.0. + +.. _importing: + +Importing +--------- + +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. + +.. 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 +this source type. + +Common fields +************* + +- **Name by default**: if no name can be identified to the newly imported object + this is the name that will be used. If this field is empty the name of the + associated category will be use. +- **SRID**: Chimère will try to identify automatically the correct coordinate + system 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 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 coordinate system of + your source. +- **Origin**: if not null this field will be associated to each item imported in + order to easily identify where the item came from. For OSM import the source + is automatically added. +- **License**: if not null this field will be associated to each item imported in + order to easily identify the license associated to the item. For OSM import + the license is automatically added. +- **Associated subcategories (mandatory)**: The selected subcategories will be + associated to newly imported items. + + +KML import +********** + +.. image:: static/chimere_admin_import_KML.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. +- **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. + +Shapefile import +**************** + +.. image:: static/chimere_admin_import_shapefile.png + + +- **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 +************* + +Simple GeoRSS and W3C GeoRSS are managed. + +.. image:: static/chimere_admin_import_georss.png + +- **Web address (mandatory)**: only distant GeoRSS are managed. + +CSV import +********** + +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, unless you know how to + edit WKT do *not* modify the geometry column. + +.. image:: static/chimere_admin_import_CSV.png + +- **Web address/source file (mandatory)**: your CSV file could be distant or a + local file. You'll have to fill one of the two fields. + +.. _osm-import: + +OpenStreetMap import +******************** + +.. image:: static/chimere_admin_import_OSM.png + +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 + 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. +- **Filter type (mandatory)**: choose if you want to import way or nodes. +- **Filter tag (mandatory)**: choose the OSM key/value couple used to filter OSM + data. A link to the `OSM Map features page + `_ is provided to help you + find appropriate values. +- **Refresh button**: this button convert your choices to appropriate XAPI args. + You have to hit this button before validating the form. + +Importing +********* + +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 printed in the state column of your import. + +You can also launch imports with the CLI (ideal for crontab jobs). In the +project directory you only need to launch the command:: + + ./manage.py chimere_import + +- *import_id* is the import ID + +If you launch the command without *import_id* the list of imports available is +presented and you can choose one. + +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 some items to be visible +on the map, instead of deleting them it is recommended to set them to the state +**Disabled**. So on the next update from the source, rather than appear as new +items they remain disabled. + +.. Warning:: + Be careful with duplicates between your existing data and imported data. This + is particularly important if you want to export your data to OSM. + +Exporting +--------- + +Export to CSV/KML/Shapefile +*************************** + +Directly from the :ref:`geographic items list ` you +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. + +You can also launch exports with the CLI (ideal for crontab jobs). In the +project directory you only need to launch the command:: + + ./manage.py chimere_export \ + + +- *subcategory_id* is the ID of the chosen subcategory +- *CSV|KML|SHP* is the chosen format +- *marker|route* is to get marker or route +- *filename* is the output filename + +If you launch the command without arguments you will be prompted for the choice +to make for your export. + + +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. + +.. 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 ` 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 + 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 + `. + + +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, these new data will overload data in your +Chimère (if you don't want that: don't do re-imports so dont do exports). 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 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 won't + have the same data than the ones you got with XAPI. + +Once all this field filled, you can (finally!) launch the export. + +When exporting tags are automatically added/updated: + +- *name*: get from the item name in Chimère. +- *source*: to identify Chimère as a source. diff --git a/docs/en/index.rst b/docs/en/index.rst new file mode 100644 index 0000000..ee1dd6f --- /dev/null +++ b/docs/en/index.rst @@ -0,0 +1,17 @@ +.. Chimère documentation master file, created by + sphinx-quickstart on Wed Feb 15 00:42:28 2012. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Chimère's documentation! +=================================== + +.. toctree:: + :maxdepth: 2 + + install + upgrade + configuration + administration + import_export + customisation diff --git a/docs/en/install.rst b/docs/en/install.rst new file mode 100644 index 0000000..ea27efc --- /dev/null +++ b/docs/en/install.rst @@ -0,0 +1,290 @@ +.. -*- coding: utf-8 -*- + +============ +Installation +============ + +:Author: Étienne Loks +:date: 2012-11-28 +:Copyright: CC-BY 3.0 + +This document presents the installation of Chimère. +It has been updated for version 2.0.0. + +Prerequisites +************* + + - `Apache `_ version 2.x + - `Python `_ versions 2.6 or 2.7 + - `Django `_ >= version 1.4 + - `South `_ + - `Postgres `_ >= version 8.x + - `Gettext `_ + - `Psycopg2 `_ + - `Python Imaging Library `_ + - `Pyexiv2 `_ + - `Beautiful Soup `_ + - python-simplejson + - python-gdal + - `Lxml `_ + - `Jquery `_ version 1.7.1 or better + - `Jquery-ui `_ + - `Universal Feed Parser `_ + +geodjango is a part of django since version 1.0 but it has some specific +(geographically related) additional dependencies: + + - `geos `_ 3.0.x + - `proj.4 `_ 4.4 to 4.6 + - `postgis `_ versions 1.2.1 or 1.3.x + - `gdal `_ + + +Optionaly (but recommanded): + + - `tinymce `_ + - `gpsbabel `_ + - django-celery if you want to manage large imports + + +The simpliest way to obtain these packages is to get them from your favorite +Linux distribution repositories. For instance on Debian Wheezy:: + + 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 \ + 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 javascript-common + + +On Debian Squeeze (you need to activate backports):: + + apt-get install -t squeeze-backports python-django libjs-jquery + + 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 \ + python-lxml libjs-jquery libjs-jquery-ui python-feedparser \ + libgeos-3.2.0 proj-bin postgresql-8.4-postgis gdal-bin \ + tinymce gpsbabel javascript-common + +The package *python-django-celery* doesn't exist for Debian Squeeze. + +If these packages do not exist in your distribution's repository, please refer +to the applications' websites. + +Database configuration +********************** + +Now that postgres and postgis are installed, you need to create a new user for +Chimère:: + + su postgres + createuser --echo --adduser --createdb --encrypted --pwprompt chimere-user + +Then, you have to create the database and initialize the geographic types (adapt +the paths accordingly to your needs):: + + PG_VERSION=9.1 # 8.4 for debian Squeeze + createdb --echo --owner chimere-user --encoding UNICODE chimere "My Chimère database" + createlang plpgsql chimere # only necessary on Debian Squeeze + psql -d chimere -f /usr/share/postgresql/$PG_VERSION/contrib/postgis-1.5/postgis.sql + psql -d chimere -f /usr/share/postgresql/$PG_VERSION/contrib/postgis-1.5/spatial_ref_sys.sql + +Installing the sources +********************** + +.. Note:: + If you are considering to contribute on Chimère get the Git master. + +Choose a path to install your Chimère:: + + INSTALL_PATH=/var/local/django + mkdir $INSTALL_PATH + +From an archive ++++++++++++++++ + +The last "stable" version is available in this `directory `_. +Take care of getting the last version in the desired X.Y branch (for instance +the last version for the 1.0 branch is version 1.0.2).:: + + wget http://www.peacefrogs.net/download/chimere -q -O -| html2text + (...) + [[ ]] chimere-1.0.0.tar.bz2 17-Nov-2010 16:51 53K + [[ ]] chimere-1.0.1.tar.bz2 17-Nov-2010 16:51 53K + [[ ]] chimere-1.0.2.tar.bz2 17-Nov-2010 16:51 53K + (...) + + wget http://www.peacefrogs.net/download/chimere/chimere-1.0.2.tar.bz2 + +Download, unpack and move the files in an apache user (www-data for Debian) +readable directory:: + + cd $INSTALL_PATH + tar xvjf chimere-last.tar.bz2 + chown -R myusername:www-data chimere + +From the Git repository ++++++++++++++++++++++++ + +Another solution is to get it from the Git repository:: + + 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 + + +Creating a custom project template +********************************** + +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 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. + +In your Chimère application directory create *local_settings.py* to fit to your +configuration. +A base template is provided (*local_settings.py.example*) and short descriptions +of the more relevant fields are given below (at least check them). Most of +these settings are initialized in *settings.py*. :: + + cd $INSTALL_PATH/chimere/mychimere_project + cp local_settings.py.sample local_settings.py + vim local_settings.py + +:Fields: + + * DATABASES: parameters for the database + * PROJECT_NAME: name of the project + * SECRET_KEY: a secret key for a particular Django installation. This is + used to provide cryptographic signing, and should be set to a unique, + unpredictable value. **Change it!** + * ROOT_URLCONF: url configuration for your project something like: + 'mychimere_project.urls' + * EMAIL_HOST: smtp of an email server to send emails + * TINYMCE_URL: url to tinymce path (default is appropriate for a Debian + installation with tinymce package installed) + * JQUERY_JS_URLS: list of jquery and jquery-ui javascript urls (default is + appropriate for a Debian installation with libjs-jquery libjs-jquery-ui + packages installed) + * JQUERY_CSS_URLS: list of jquery and jquery-ui CSS urls (default is + appropriate for a Debian installation with libjs-jquery libjs-jquery-ui + packages installed) + * GPSBABEL: path to gpsbabel (default is appropriate for a Debian + installation with gpsbabel package installed) + * TIME_ZONE: local time zone for this installation + * LANGUAGE_CODE: language code for this installation + +Manage media path permission:: + + cd $INSTALL_PATH/chimere/mychimere_project + chown -R user:www-data media + chmod -R g+w media + +Create log file:: + + mkdir /var/log/django + touch /var/log/django/chimere.log + chown -R root:www-data /var/log/django/ + chmod -R g+w /var/log/django/ + +Regroup static files in one path:: + + cd $INSTALL_PATH/chimere/mychimere_project + ./manage.py collectstatic + +Compiling languages +******************* + +If your language is available in the directory *chimere/locale/*, you will just +need to get it compiled. This can be done with the following command (here, +**fr** stands for French, replace it with the appropriate language code):: + + cd $INSTALL_PATH/chimere/chimere/ + django-admin compilemessages -l fr + +If your language is not available, feel free to create the default po file and +to submit it, contributions are well appreciated. Procedure is as follows: + +You first need to create the default po file (of course, replace **fr** +according to the language you choose to create):: + + django-admin makemessages -l fr + +There should now be a *django.po* file in *locale/fr/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 +*********************** + +Create the appropriate tables (still being in your Chimère project directory):: + + cd $INSTALL_PATH/chimere/mychimere_project + ./manage.py syncdb + +You will be prompted for the creation of an administrator account +(administration can be found at: http://where_is_chimere/admin/). Then you have +to create tables managed with Django-South:: + + ./manage.py migrate + +The database is set, congratulations! + +If you want to populate your installation with default data (don't do this on +an already populated instance!):: + + ./manage.py loaddata ../chimere/fixtures/default_data.json + +Webserver configuration +*********************** + +Apache configuration with mod_wsgi +++++++++++++++++++++++++++++++++++ + +Install *mod_wsgi* for Apache:: + + apt-get install libapache2-mod-wsgi + + +Create and edit a configuration for Chimère:: + + cp $INSTALL_PATH/chimere/apache/django.wsgi \ + $INSTALL_PATH/chimere/apache/mydjango.wsgi + vim $INSTALL_PATH/chimere/apache/mydjango.wsgi + cp $INSTALL_PATH/chimere/apache/apache-wsgi.conf \ + /etc/apache2/sites-available/chimere + vim /etc/apache2/sites-available/chimere + # create log dir + mkdir /var/log/apache2/chimere/ + chown www-data /var/log/apache2/chimere/ + +Adapt the files *mydjango.wsgi* (with the correct sys path and the correct +module) and Apache *chimere* (with the correct servername and correct paths). + +To activate the website, reload apache:: + + a2ensite chimere + /etc/init.d/apache2 reload + +If you encounter problem with the upload of files with Unicode chars in their +names, activate the appropriate locale in Apache. On a Debian server with UTF-8 +as default encoding, in the file */etc/apache2/envvars* uncomment the following +line:: + + . /etc/default/locale + + diff --git a/docs/en/static/chimere_admin_00.png b/docs/en/static/chimere_admin_00.png new file mode 100644 index 0000000..374c6b6 Binary files /dev/null and b/docs/en/static/chimere_admin_00.png differ diff --git a/docs/en/static/chimere_admin_01.png b/docs/en/static/chimere_admin_01.png new file mode 100644 index 0000000..0db7f4d Binary files /dev/null and b/docs/en/static/chimere_admin_01.png differ diff --git a/docs/en/static/chimere_admin_02.png b/docs/en/static/chimere_admin_02.png new file mode 100644 index 0000000..d0fd6fe Binary files /dev/null and b/docs/en/static/chimere_admin_02.png differ diff --git a/docs/en/static/chimere_admin_03.png b/docs/en/static/chimere_admin_03.png new file mode 100644 index 0000000..e815500 Binary files /dev/null and b/docs/en/static/chimere_admin_03.png differ diff --git a/docs/en/static/chimere_admin_import_CSV.png b/docs/en/static/chimere_admin_import_CSV.png new file mode 100644 index 0000000..e67a37b Binary files /dev/null and b/docs/en/static/chimere_admin_import_CSV.png differ diff --git a/docs/en/static/chimere_admin_import_KML.png b/docs/en/static/chimere_admin_import_KML.png new file mode 100644 index 0000000..b48d69a Binary files /dev/null and b/docs/en/static/chimere_admin_import_KML.png differ diff --git a/docs/en/static/chimere_admin_import_OSM.png b/docs/en/static/chimere_admin_import_OSM.png new file mode 100644 index 0000000..a599348 Binary files /dev/null and b/docs/en/static/chimere_admin_import_OSM.png differ diff --git a/docs/en/static/chimere_admin_import_georss.png b/docs/en/static/chimere_admin_import_georss.png new file mode 100644 index 0000000..5278652 Binary files /dev/null and b/docs/en/static/chimere_admin_import_georss.png differ diff --git a/docs/en/static/chimere_admin_import_shapefile.png b/docs/en/static/chimere_admin_import_shapefile.png new file mode 100644 index 0000000..ce612be Binary files /dev/null and b/docs/en/static/chimere_admin_import_shapefile.png differ diff --git a/docs/en/static/chimere_admin_modified_management.png b/docs/en/static/chimere_admin_modified_management.png new file mode 100644 index 0000000..84e069e Binary files /dev/null and b/docs/en/static/chimere_admin_modified_management.png differ diff --git a/docs/en/static/chimere_admin_modify_item.png b/docs/en/static/chimere_admin_modify_item.png new file mode 100644 index 0000000..861ea20 Binary files /dev/null and b/docs/en/static/chimere_admin_modify_item.png differ diff --git a/docs/en/upgrade.rst b/docs/en/upgrade.rst new file mode 100644 index 0000000..d44ae02 --- /dev/null +++ b/docs/en/upgrade.rst @@ -0,0 +1,311 @@ +.. -*- coding: utf-8 -*- + +======= +Upgrade +======= + +:Author: Étienne Loks +: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. + +.. Warning:: + Before any upgrade backup the database and all your installation files + (specially if you have made changes to them). + +The process for migration requires a basic knowledge of Git and Linux CLI. It is +*not* an easy process. A work is currently done to easy the upgrade in later +versions (>2.0) of Chimère. + +If several versions have been published, you should repeat all upgrading steps. +For instance to upgrade from v1.1 to v2.0 you should first upgrade to v1.2 then +to v2.0. The only optional step is the integration of your customisations. + +The current stable version is 2.0. + +.. Note:: + If you are considering to contribute on Chimère get the Git master. + +The instructions are given for Debian Squeeze and Debian Wheezy. + + +Getting new versions of dependencies +------------------------------------ + +Version 1.1 -> 1.2 +****************** + +.. code-block:: bash + + apt-get install python-lxml libjs-jquery gpsbabel python-gdal + +Version 1.2 -> 2.0 +****************** + +Debian Squeeze +++++++++++++++ +Activate the backports: http://backports-master.debian.org/Instructions/ +Then install the new dependencies:: + + apt-get install -t squeeze-backports python-django python-django-south \ + python-simplejson libjs-jquery-ui python-pyexiv2 \ + python-feedparser javascript-common libjs-jquery + +Debian Wheezy ++++++++++++++ + +.. code-block:: bash + + apt-get install python-django-south python-simplejson libjs-jquery-ui \ + python-pyexiv2 python-feedparser javascript-common + +If you are planning to do major import consider the install of `Celery +`_. + +.. code-block:: bash + + apt-get install python-django-celery python-kombu + +Getting the new sources +----------------------- + +First of all you have to get the new version of the source code. +For the upgrade process, the source code has to be from the Git +repository. + +To simplify further instructions, some environment variables are +initialized. + +.. code-block:: bash + + CHIMERE_PATH=/srv/chimere + CHIMERE_TAG=v1.2.0 # version 1.1 -> 1.2 + CHIMERE_TAG=v2.0-RC3 # version 1.2 -> 2.0 + CHIMERE_TAG=master # version 2.0 -> master + CHIMERE_LOCALNAME=mychimere + +Your local name is used for the name of your local Git branch and the Python +package. 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 +underscores ("_") to any length. Don't begin the name by "_" because it has special +significance in Python. + +From a previous Git installation +******************************** + +.. code-block:: bash + + cd $CHIMERE_PATH + git checkout -b $CHIMERE_LOCALNAME # only if you haven't created yet a local branch + git stash # if you have uncommited changes + git checkout master + git pull + git checkout $CHIMERE_LOCALNAME + git rebase $CHIMERE_TAG + +From a previous tarball installation +************************************ + +First remove your old installation and get the Git version: + +.. code-block:: bash + + cd $CHIMERE_PATH + cd .. + rm -rf $CHIMERE_PATH + git clone git://www.peacefrogs.net/git/chimere + cd chimere + git checkout $CHIMERE_TAG + git checkout -b $CHIMERE_LOCALNAME + + +Update basic settings +********************* + +Version 1.1 -> 1.2 +++++++++++++++++++ + +.. code-block:: bash + + CHIMERE_APP_PATH=$CHIMERE_PATH/chimere + vim $CHIMERE_APP_PATH/settings.py + +Add the following lines (adapted for your jquery and gpsbabel installation): + +.. code-block:: python + + JQUERY_URL = SERVER_URL + 'jquery/jquery-1.4.4.min.js' + GPSBABEL = '/usr/bin/gpsbabel' + # simplify with an error of 5 meters + GPSBABEL_OPTIONS = 'simplify,crosstrack,error=0.005k' + +Version 1.2 -> 2.0 +++++++++++++++++++ + +Project template +................ +Create a new project template: + +.. code-block:: bash + + cd $CHIMERE_PATH + cp -ra $CHIMERE_PATH/example_project $CHIMERE_LOCALNAME + CHIMERE_APP_PATH=$CHIMERE_PATH/$CHIMERE_LOCALNAME + +local_settings +.............. +A *local_settings* file is now used. + +.. code-block:: bash + + cd $CHIMERE_APP_PATH + cp local_settings.py.sample local_settings.py + vim local_settings.py + +Report your old settings from *settings.py* to *local_settings.py* (at least the +database configuration). +The setting *ROOT_URLCONF* must be set to **value_of_your_localname.urls**. + +logs +.... +Logging is now enabled by default in the file */var/log/django/chimere.log*. + +.. code-block:: bash + + mkdir /var/log/django + touch /var/log/django/chimere.log + chown www-data -R /var/log/django + +Static files +............ + +Now static files are managed with *django.contrib.staticfiles*. + +.. code-block:: bash + + cd $CHIMERE_APP_PATH + ./manage.py collectstatic + +Move old static files to the new static directory: + +.. code-block:: bash + + cp -ra $CHIMERE_PATH/chimere/static/* $CHIMERE_APP_PATH/static/ + cp -ra $CHIMERE_PATH/chimere/static/icons/* $CHIMERE_APP_PATH/media/icons/ + cp -ra $CHIMERE_PATH/chimere/static/upload $CHIMERE_APP_PATH/media/ + +Webserver configuration +....................... +If you are using Apache and WSGI to serve your Chimère, change your WSGI +configuration file to point to the correct settings: +**value_of_your_localname.settings**. + +Change your webserver directive to point to the correct static directory from +**your_chimere_path/chimere/static** to +**your_chimere_path/your_local_name/static**. + +Version 2.0 -> master ++++++++++++++++++++++ + +Update settings and static files. + +.. code-block:: bash + + cp $CHIMERE_PATH/example_project/settings.py $CHIMERE_LOCALNAME + ./manage.py collectstatic + +Migrate database +---------------- + +Version 1.1 -> 1.2 +****************** + +Migration scripts test your installation before making changes so you probably +won't have any lost but by precaution before running these scripts don't forget +to backup your database. +You can also make a copy of your current database into a new database and make +the new installation to this new database. + +The gdal binding for Python is necessary to run the upgrade scripts (available +in the python-gdal package in Debian). + +If you run the migration scripts in a production environnement stop the old +instance of Chimère before executing the migration script. + +In *settings.py* verify that **chimere.scripts** is in the *INSTALLED_APPS*. + +After that in the Chimère directory just execute the script. + +.. code-block:: bash + + cd $CHIMERE_APP_PATH + python ./scripts/upgrade.py + +Version 1.2 -> 2.0 +****************** + +Django South is now used to manage database migrations. + +.. code-block:: bash + + cd $CHIMERE_APP_PATH + ./manage.py syncdb + ./manage.py migrate chimere 0001 --fake # fake the database initialisation + ./manage.py migrate chimere + +A description field is now available for markers. If you would like to move +values of an old *Property model* to this new field, a script is available. + +.. code-block:: bash + + cd $CHIMERE_APP_PATH + ../chimere/scripts/migrate_properties.py + # follow the instructions + +Version 2.0 -> master +********************* + +.. code-block:: bash + + cd $CHIMERE_APP_PATH + ./manage.py syncdb + ./manage.py migrate chimere + +Update translations +------------------- + +Version 1.1 -> 1.2 +****************** + +.. code-block:: bash + + cd $CHIMERE_APP_PATH + ./manage.py compilemessages + +Version 1.2 -> 2.0 -> master +**************************** + +.. code-block:: bash + + cd $CHIMERE_PATH/chimere + django-admin compilemessages + +Forcing the refresh of visitor's web browser cache +-------------------------------------------------- + +Major changes in the javascript has been done between versions, many of your +users could experience problems. There are many tricks to force the refresh +of their cache. One of them is to change the location of statics files. To do +that edit your local_settings.py and change:: + + STATIC_URL = '/static/' + +to:: + + STATIC_URL = '/static/v2.0.0/' + +Then change the webserver directive to point to your new path. +Restart the web server to apply this changes. + diff --git a/docs/fr/Makefile b/docs/fr/Makefile new file mode 100644 index 0000000..fcccf30 --- /dev/null +++ b/docs/fr/Makefile @@ -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) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest + +help: + @echo "Please use \`make ' where 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/Chimre.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Chimre.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/Chimre" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Chimre" + @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." diff --git a/docs/fr/administration.rst b/docs/fr/administration.rst index d4fb145..cdf79b5 100644 --- a/docs/fr/administration.rst +++ b/docs/fr/administration.rst @@ -26,7 +26,7 @@ Identification Tout d'abord vous avez à vous identifier avec l'identifiant et le mot de passe fourni. -.. image:: _static/chimere_admin_00.png +.. image:: static/chimere_admin_00.png Page principale @@ -36,7 +36,7 @@ Une fois identifié, vous avez accès à la page principale d'administration. Cela s'affiche ainsi : -.. image:: _static/chimere_admin_01.png +.. image:: static/chimere_admin_01.png #. lien vers cette **Documentation**, vers le formulaire de **Changement de mot de passe** et la déconnexion ; @@ -53,7 +53,7 @@ Cela s'affiche ainsi : Liste des éléments ****************** -.. image:: _static/chimere_admin_02.png +.. image:: static/chimere_admin_02.png #. chemin dans le site d'administration. C'est un raccourci pratique pour revenir à la page principale. @@ -73,7 +73,7 @@ Liste des éléments Formulaire des éléments *********************** -.. image:: _static/chimere_admin_03.png +.. image:: static/chimere_admin_03.png #. les champs pour l'élément sélectionné (ou vide si c'est un nouvel élément) sont affichés dans ce formulaire. Parfois certains champs sont en lecture @@ -172,7 +172,7 @@ Il y a un certain nombre d'action disponible. Pour modifier un élément, classiquement, vous cliquez sur son nom pour accéder ensuite à un formulaire pour modifier librement l'élément. -.. image:: _static/chimere_admin_modify_item.png +.. image:: static/chimere_admin_modify_item.png Sur ce formulaire il y a tous les éléments disponibles à l'utilisateur plus quelques champs supplémentaires. @@ -217,7 +217,7 @@ Un formulaire spécifique a été développé pour faciliter le traitement de ce Vous pouvez accéder à ce formulaire spécifique avec l'action *Gérer les éléments modifiés*. -.. image:: _static/chimere_admin_modified_management.png +.. image:: static/chimere_admin_modified_management.png Ce formulaire est un tableau à 3 colonnes. diff --git a/docs/fr/conf.py b/docs/fr/conf.py new file mode 100644 index 0000000..6a0724e --- /dev/null +++ b/docs/fr/conf.py @@ -0,0 +1,216 @@ +# -*- coding: utf-8 -*- +# +# Chimère documentation build configuration file, created by +# sphinx-quickstart on Wed Feb 15 00:42:28 2012. +# +# 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'Chimère' +copyright = u'2012, É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 = '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 = ['build'] + +# 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 +# " v 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 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 = 'Chimredoc' + + +# -- 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', 'Chimre.tex', u'Documentation de Chimère', + 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', 'chimere', u'Chimère Documentation', + [u'Étienne Loks'], 1) +] diff --git a/docs/fr/import_export.rst b/docs/fr/import_export.rst index b63f874..11ffaa3 100644 --- a/docs/fr/import_export.rst +++ b/docs/fr/import_export.rst @@ -58,7 +58,7 @@ Champs communs à tous les types de source Import KML ********** -.. image:: _static/chimere_admin_import_KML.png +.. image:: static/chimere_admin_import_KML.png - **Adresse Web/fichier source (obligatoire)** : votre fichier KML peut être @@ -71,7 +71,7 @@ Import KML Import Shapefile **************** -.. image:: _static/chimere_admin_import_shapefile.png +.. image:: static/chimere_admin_import_shapefile.png - **Adresse Web/fichier source (obligatoire)** : votre fichier Shapefile peut @@ -84,7 +84,7 @@ Import GeoRSS Simple GeoRSS et W3C GeoRSS sont gérés. -.. image:: _static/chimere_admin_import_georss.png +.. image:: static/chimere_admin_import_georss.png - **Adresse Web (obligatoire)**: seul les flux GeoRSS distant sont gérés. @@ -108,7 +108,7 @@ mises à jour d'information. moins que vous sachiez éditer du WKT ne modifiez **pas** la colonne qui concerne la géométrie de l'élément. -.. image:: _static/chimere_admin_import_CSV.png +.. image:: static/chimere_admin_import_CSV.png - **Adresse Web/fichier source (obligatoire)** : votre fichier CSV peut être distant ou local. Vous avez à remplir un des deux champs. @@ -118,7 +118,7 @@ mises à jour d'information. Import OpenStreetMap ******************** -.. image:: _static/chimere_admin_import_OSM.png +.. image:: static/chimere_admin_import_OSM.png Pour importer depuis OSM, Chimère utilise l'API XAPI d'OSM. diff --git a/docs/fr/static/chimere_admin_00.png b/docs/fr/static/chimere_admin_00.png new file mode 100644 index 0000000..374c6b6 Binary files /dev/null and b/docs/fr/static/chimere_admin_00.png differ diff --git a/docs/fr/static/chimere_admin_01.png b/docs/fr/static/chimere_admin_01.png new file mode 100644 index 0000000..0db7f4d Binary files /dev/null and b/docs/fr/static/chimere_admin_01.png differ diff --git a/docs/fr/static/chimere_admin_02.png b/docs/fr/static/chimere_admin_02.png new file mode 100644 index 0000000..d0fd6fe Binary files /dev/null and b/docs/fr/static/chimere_admin_02.png differ diff --git a/docs/fr/static/chimere_admin_03.png b/docs/fr/static/chimere_admin_03.png new file mode 100644 index 0000000..e815500 Binary files /dev/null and b/docs/fr/static/chimere_admin_03.png differ diff --git a/docs/fr/static/chimere_admin_import_CSV.png b/docs/fr/static/chimere_admin_import_CSV.png new file mode 100644 index 0000000..e67a37b Binary files /dev/null and b/docs/fr/static/chimere_admin_import_CSV.png differ diff --git a/docs/fr/static/chimere_admin_import_KML.png b/docs/fr/static/chimere_admin_import_KML.png new file mode 100644 index 0000000..b48d69a Binary files /dev/null and b/docs/fr/static/chimere_admin_import_KML.png differ diff --git a/docs/fr/static/chimere_admin_import_OSM.png b/docs/fr/static/chimere_admin_import_OSM.png new file mode 100644 index 0000000..a599348 Binary files /dev/null and b/docs/fr/static/chimere_admin_import_OSM.png differ diff --git a/docs/fr/static/chimere_admin_import_georss.png b/docs/fr/static/chimere_admin_import_georss.png new file mode 100644 index 0000000..5278652 Binary files /dev/null and b/docs/fr/static/chimere_admin_import_georss.png differ diff --git a/docs/fr/static/chimere_admin_import_shapefile.png b/docs/fr/static/chimere_admin_import_shapefile.png new file mode 100644 index 0000000..ce612be Binary files /dev/null and b/docs/fr/static/chimere_admin_import_shapefile.png differ diff --git a/docs/fr/static/chimere_admin_modified_management.png b/docs/fr/static/chimere_admin_modified_management.png new file mode 100644 index 0000000..84e069e Binary files /dev/null and b/docs/fr/static/chimere_admin_modified_management.png differ diff --git a/docs/fr/static/chimere_admin_modify_item.png b/docs/fr/static/chimere_admin_modify_item.png new file mode 100644 index 0000000..861ea20 Binary files /dev/null and b/docs/fr/static/chimere_admin_modify_item.png differ diff --git a/docs/import_export.rst b/docs/import_export.rst deleted file mode 100644 index 3574a66..0000000 --- a/docs/import_export.rst +++ /dev/null @@ -1,235 +0,0 @@ -.. -*- coding: utf-8 -*- - -============= -Import/export -============= - -:Author: Étienne Loks -:date: 2012-11-28 -:Copyright: CC-BY 3.0 - -This document presents the import/export functionnalities of Chimère. -It has been updated for version 2.0.0. - -.. _importing: - -Importing ---------- - -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. - -.. 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 -this source type. - -Common fields -************* - -- **Name by default**: if no name can be identified to the newly imported object - this is the name that will be used. If this field is empty the name of the - associated category will be use. -- **SRID**: Chimère will try to identify automatically the correct coordinate - system 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 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 coordinate system of - your source. -- **Origin**: if not null this field will be associated to each item imported in - order to easily identify where the item came from. For OSM import the source - is automatically added. -- **License**: if not null this field will be associated to each item imported in - order to easily identify the license associated to the item. For OSM import - the license is automatically added. -- **Associated subcategories (mandatory)**: The selected subcategories will be - associated to newly imported items. - - -KML import -********** - -.. image:: _static/chimere_admin_import_KML.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. -- **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. - -Shapefile import -**************** - -.. image:: _static/chimere_admin_import_shapefile.png - - -- **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 -************* - -Simple GeoRSS and W3C GeoRSS are managed. - -.. image:: _static/chimere_admin_import_georss.png - -- **Web address (mandatory)**: only distant GeoRSS are managed. - -CSV import -********** - -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, unless you know how to - edit WKT do *not* modify the geometry column. - -.. image:: _static/chimere_admin_import_CSV.png - -- **Web address/source file (mandatory)**: your CSV file could be distant or a - local file. You'll have to fill one of the two fields. - -.. _osm-import: - -OpenStreetMap import -******************** - -.. image:: _static/chimere_admin_import_OSM.png - -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 - 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. -- **Filter type (mandatory)**: choose if you want to import way or nodes. -- **Filter tag (mandatory)**: choose the OSM key/value couple used to filter OSM - data. A link to the `OSM Map features page - `_ is provided to help you - find appropriate values. -- **Refresh button**: this button convert your choices to appropriate XAPI args. - You have to hit this button before validating the form. - -Importing -********* - -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 printed in the state column of your import. - -You can also launch imports with the CLI (ideal for crontab jobs). In the -project directory you only need to launch the command:: - - ./manage.py chimere_import - -- *import_id* is the import ID - -If you launch the command without *import_id* the list of imports available is -presented and you can choose one. - -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 some items to be visible -on the map, instead of deleting them it is recommended to set them to the state -**Disabled**. So on the next update from the source, rather than appear as new -items they remain disabled. - -.. Warning:: - Be careful with duplicates between your existing data and imported data. This - is particularly important if you want to export your data to OSM. - -Exporting ---------- - -Export to CSV/KML/Shapefile -*************************** - -Directly from the :ref:`geographic items list ` you -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. - -You can also launch exports with the CLI (ideal for crontab jobs). In the -project directory you only need to launch the command:: - - ./manage.py chimere_export \ - - -- *subcategory_id* is the ID of the chosen subcategory -- *CSV|KML|SHP* is the chosen format -- *marker|route* is to get marker or route -- *filename* is the output filename - -If you launch the command without arguments you will be prompted for the choice -to make for your export. - - -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. - -.. 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 ` 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 - 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 - `. - - -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, these new data will overload data in your -Chimère (if you don't want that: don't do re-imports so dont do exports). 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 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 won't - have the same data than the ones you got with XAPI. - -Once all this field filled, you can (finally!) launch the export. - -When exporting tags are automatically added/updated: - -- *name*: get from the item name in Chimère. -- *source*: to identify Chimère as a source. diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index ee1dd6f..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. Chimère documentation master file, created by - sphinx-quickstart on Wed Feb 15 00:42:28 2012. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to Chimère's documentation! -=================================== - -.. toctree:: - :maxdepth: 2 - - install - upgrade - configuration - administration - import_export - customisation diff --git a/docs/install.rst b/docs/install.rst deleted file mode 100644 index ea27efc..0000000 --- a/docs/install.rst +++ /dev/null @@ -1,290 +0,0 @@ -.. -*- coding: utf-8 -*- - -============ -Installation -============ - -:Author: Étienne Loks -:date: 2012-11-28 -:Copyright: CC-BY 3.0 - -This document presents the installation of Chimère. -It has been updated for version 2.0.0. - -Prerequisites -************* - - - `Apache `_ version 2.x - - `Python `_ versions 2.6 or 2.7 - - `Django `_ >= version 1.4 - - `South `_ - - `Postgres `_ >= version 8.x - - `Gettext `_ - - `Psycopg2 `_ - - `Python Imaging Library `_ - - `Pyexiv2 `_ - - `Beautiful Soup `_ - - python-simplejson - - python-gdal - - `Lxml `_ - - `Jquery `_ version 1.7.1 or better - - `Jquery-ui `_ - - `Universal Feed Parser `_ - -geodjango is a part of django since version 1.0 but it has some specific -(geographically related) additional dependencies: - - - `geos `_ 3.0.x - - `proj.4 `_ 4.4 to 4.6 - - `postgis `_ versions 1.2.1 or 1.3.x - - `gdal `_ - - -Optionaly (but recommanded): - - - `tinymce `_ - - `gpsbabel `_ - - django-celery if you want to manage large imports - - -The simpliest way to obtain these packages is to get them from your favorite -Linux distribution repositories. For instance on Debian Wheezy:: - - 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 \ - 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 javascript-common - - -On Debian Squeeze (you need to activate backports):: - - apt-get install -t squeeze-backports python-django libjs-jquery - - 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 \ - python-lxml libjs-jquery libjs-jquery-ui python-feedparser \ - libgeos-3.2.0 proj-bin postgresql-8.4-postgis gdal-bin \ - tinymce gpsbabel javascript-common - -The package *python-django-celery* doesn't exist for Debian Squeeze. - -If these packages do not exist in your distribution's repository, please refer -to the applications' websites. - -Database configuration -********************** - -Now that postgres and postgis are installed, you need to create a new user for -Chimère:: - - su postgres - createuser --echo --adduser --createdb --encrypted --pwprompt chimere-user - -Then, you have to create the database and initialize the geographic types (adapt -the paths accordingly to your needs):: - - PG_VERSION=9.1 # 8.4 for debian Squeeze - createdb --echo --owner chimere-user --encoding UNICODE chimere "My Chimère database" - createlang plpgsql chimere # only necessary on Debian Squeeze - psql -d chimere -f /usr/share/postgresql/$PG_VERSION/contrib/postgis-1.5/postgis.sql - psql -d chimere -f /usr/share/postgresql/$PG_VERSION/contrib/postgis-1.5/spatial_ref_sys.sql - -Installing the sources -********************** - -.. Note:: - If you are considering to contribute on Chimère get the Git master. - -Choose a path to install your Chimère:: - - INSTALL_PATH=/var/local/django - mkdir $INSTALL_PATH - -From an archive -+++++++++++++++ - -The last "stable" version is available in this `directory `_. -Take care of getting the last version in the desired X.Y branch (for instance -the last version for the 1.0 branch is version 1.0.2).:: - - wget http://www.peacefrogs.net/download/chimere -q -O -| html2text - (...) - [[ ]] chimere-1.0.0.tar.bz2 17-Nov-2010 16:51 53K - [[ ]] chimere-1.0.1.tar.bz2 17-Nov-2010 16:51 53K - [[ ]] chimere-1.0.2.tar.bz2 17-Nov-2010 16:51 53K - (...) - - wget http://www.peacefrogs.net/download/chimere/chimere-1.0.2.tar.bz2 - -Download, unpack and move the files in an apache user (www-data for Debian) -readable directory:: - - cd $INSTALL_PATH - tar xvjf chimere-last.tar.bz2 - chown -R myusername:www-data chimere - -From the Git repository -+++++++++++++++++++++++ - -Another solution is to get it from the Git repository:: - - 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 - - -Creating a custom project template -********************************** - -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 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. - -In your Chimère application directory create *local_settings.py* to fit to your -configuration. -A base template is provided (*local_settings.py.example*) and short descriptions -of the more relevant fields are given below (at least check them). Most of -these settings are initialized in *settings.py*. :: - - cd $INSTALL_PATH/chimere/mychimere_project - cp local_settings.py.sample local_settings.py - vim local_settings.py - -:Fields: - - * DATABASES: parameters for the database - * PROJECT_NAME: name of the project - * SECRET_KEY: a secret key for a particular Django installation. This is - used to provide cryptographic signing, and should be set to a unique, - unpredictable value. **Change it!** - * ROOT_URLCONF: url configuration for your project something like: - 'mychimere_project.urls' - * EMAIL_HOST: smtp of an email server to send emails - * TINYMCE_URL: url to tinymce path (default is appropriate for a Debian - installation with tinymce package installed) - * JQUERY_JS_URLS: list of jquery and jquery-ui javascript urls (default is - appropriate for a Debian installation with libjs-jquery libjs-jquery-ui - packages installed) - * JQUERY_CSS_URLS: list of jquery and jquery-ui CSS urls (default is - appropriate for a Debian installation with libjs-jquery libjs-jquery-ui - packages installed) - * GPSBABEL: path to gpsbabel (default is appropriate for a Debian - installation with gpsbabel package installed) - * TIME_ZONE: local time zone for this installation - * LANGUAGE_CODE: language code for this installation - -Manage media path permission:: - - cd $INSTALL_PATH/chimere/mychimere_project - chown -R user:www-data media - chmod -R g+w media - -Create log file:: - - mkdir /var/log/django - touch /var/log/django/chimere.log - chown -R root:www-data /var/log/django/ - chmod -R g+w /var/log/django/ - -Regroup static files in one path:: - - cd $INSTALL_PATH/chimere/mychimere_project - ./manage.py collectstatic - -Compiling languages -******************* - -If your language is available in the directory *chimere/locale/*, you will just -need to get it compiled. This can be done with the following command (here, -**fr** stands for French, replace it with the appropriate language code):: - - cd $INSTALL_PATH/chimere/chimere/ - django-admin compilemessages -l fr - -If your language is not available, feel free to create the default po file and -to submit it, contributions are well appreciated. Procedure is as follows: - -You first need to create the default po file (of course, replace **fr** -according to the language you choose to create):: - - django-admin makemessages -l fr - -There should now be a *django.po* file in *locale/fr/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 -*********************** - -Create the appropriate tables (still being in your Chimère project directory):: - - cd $INSTALL_PATH/chimere/mychimere_project - ./manage.py syncdb - -You will be prompted for the creation of an administrator account -(administration can be found at: http://where_is_chimere/admin/). Then you have -to create tables managed with Django-South:: - - ./manage.py migrate - -The database is set, congratulations! - -If you want to populate your installation with default data (don't do this on -an already populated instance!):: - - ./manage.py loaddata ../chimere/fixtures/default_data.json - -Webserver configuration -*********************** - -Apache configuration with mod_wsgi -++++++++++++++++++++++++++++++++++ - -Install *mod_wsgi* for Apache:: - - apt-get install libapache2-mod-wsgi - - -Create and edit a configuration for Chimère:: - - cp $INSTALL_PATH/chimere/apache/django.wsgi \ - $INSTALL_PATH/chimere/apache/mydjango.wsgi - vim $INSTALL_PATH/chimere/apache/mydjango.wsgi - cp $INSTALL_PATH/chimere/apache/apache-wsgi.conf \ - /etc/apache2/sites-available/chimere - vim /etc/apache2/sites-available/chimere - # create log dir - mkdir /var/log/apache2/chimere/ - chown www-data /var/log/apache2/chimere/ - -Adapt the files *mydjango.wsgi* (with the correct sys path and the correct -module) and Apache *chimere* (with the correct servername and correct paths). - -To activate the website, reload apache:: - - a2ensite chimere - /etc/init.d/apache2 reload - -If you encounter problem with the upload of files with Unicode chars in their -names, activate the appropriate locale in Apache. On a Debian server with UTF-8 -as default encoding, in the file */etc/apache2/envvars* uncomment the following -line:: - - . /etc/default/locale - - diff --git a/docs/upgrade.rst b/docs/upgrade.rst deleted file mode 100644 index d44ae02..0000000 --- a/docs/upgrade.rst +++ /dev/null @@ -1,311 +0,0 @@ -.. -*- coding: utf-8 -*- - -======= -Upgrade -======= - -:Author: Étienne Loks -: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. - -.. Warning:: - Before any upgrade backup the database and all your installation files - (specially if you have made changes to them). - -The process for migration requires a basic knowledge of Git and Linux CLI. It is -*not* an easy process. A work is currently done to easy the upgrade in later -versions (>2.0) of Chimère. - -If several versions have been published, you should repeat all upgrading steps. -For instance to upgrade from v1.1 to v2.0 you should first upgrade to v1.2 then -to v2.0. The only optional step is the integration of your customisations. - -The current stable version is 2.0. - -.. Note:: - If you are considering to contribute on Chimère get the Git master. - -The instructions are given for Debian Squeeze and Debian Wheezy. - - -Getting new versions of dependencies ------------------------------------- - -Version 1.1 -> 1.2 -****************** - -.. code-block:: bash - - apt-get install python-lxml libjs-jquery gpsbabel python-gdal - -Version 1.2 -> 2.0 -****************** - -Debian Squeeze -++++++++++++++ -Activate the backports: http://backports-master.debian.org/Instructions/ -Then install the new dependencies:: - - apt-get install -t squeeze-backports python-django python-django-south \ - python-simplejson libjs-jquery-ui python-pyexiv2 \ - python-feedparser javascript-common libjs-jquery - -Debian Wheezy -+++++++++++++ - -.. code-block:: bash - - apt-get install python-django-south python-simplejson libjs-jquery-ui \ - python-pyexiv2 python-feedparser javascript-common - -If you are planning to do major import consider the install of `Celery -`_. - -.. code-block:: bash - - apt-get install python-django-celery python-kombu - -Getting the new sources ------------------------ - -First of all you have to get the new version of the source code. -For the upgrade process, the source code has to be from the Git -repository. - -To simplify further instructions, some environment variables are -initialized. - -.. code-block:: bash - - CHIMERE_PATH=/srv/chimere - CHIMERE_TAG=v1.2.0 # version 1.1 -> 1.2 - CHIMERE_TAG=v2.0-RC3 # version 1.2 -> 2.0 - CHIMERE_TAG=master # version 2.0 -> master - CHIMERE_LOCALNAME=mychimere - -Your local name is used for the name of your local Git branch and the Python -package. 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 -underscores ("_") to any length. Don't begin the name by "_" because it has special -significance in Python. - -From a previous Git installation -******************************** - -.. code-block:: bash - - cd $CHIMERE_PATH - git checkout -b $CHIMERE_LOCALNAME # only if you haven't created yet a local branch - git stash # if you have uncommited changes - git checkout master - git pull - git checkout $CHIMERE_LOCALNAME - git rebase $CHIMERE_TAG - -From a previous tarball installation -************************************ - -First remove your old installation and get the Git version: - -.. code-block:: bash - - cd $CHIMERE_PATH - cd .. - rm -rf $CHIMERE_PATH - git clone git://www.peacefrogs.net/git/chimere - cd chimere - git checkout $CHIMERE_TAG - git checkout -b $CHIMERE_LOCALNAME - - -Update basic settings -********************* - -Version 1.1 -> 1.2 -++++++++++++++++++ - -.. code-block:: bash - - CHIMERE_APP_PATH=$CHIMERE_PATH/chimere - vim $CHIMERE_APP_PATH/settings.py - -Add the following lines (adapted for your jquery and gpsbabel installation): - -.. code-block:: python - - JQUERY_URL = SERVER_URL + 'jquery/jquery-1.4.4.min.js' - GPSBABEL = '/usr/bin/gpsbabel' - # simplify with an error of 5 meters - GPSBABEL_OPTIONS = 'simplify,crosstrack,error=0.005k' - -Version 1.2 -> 2.0 -++++++++++++++++++ - -Project template -................ -Create a new project template: - -.. code-block:: bash - - cd $CHIMERE_PATH - cp -ra $CHIMERE_PATH/example_project $CHIMERE_LOCALNAME - CHIMERE_APP_PATH=$CHIMERE_PATH/$CHIMERE_LOCALNAME - -local_settings -.............. -A *local_settings* file is now used. - -.. code-block:: bash - - cd $CHIMERE_APP_PATH - cp local_settings.py.sample local_settings.py - vim local_settings.py - -Report your old settings from *settings.py* to *local_settings.py* (at least the -database configuration). -The setting *ROOT_URLCONF* must be set to **value_of_your_localname.urls**. - -logs -.... -Logging is now enabled by default in the file */var/log/django/chimere.log*. - -.. code-block:: bash - - mkdir /var/log/django - touch /var/log/django/chimere.log - chown www-data -R /var/log/django - -Static files -............ - -Now static files are managed with *django.contrib.staticfiles*. - -.. code-block:: bash - - cd $CHIMERE_APP_PATH - ./manage.py collectstatic - -Move old static files to the new static directory: - -.. code-block:: bash - - cp -ra $CHIMERE_PATH/chimere/static/* $CHIMERE_APP_PATH/static/ - cp -ra $CHIMERE_PATH/chimere/static/icons/* $CHIMERE_APP_PATH/media/icons/ - cp -ra $CHIMERE_PATH/chimere/static/upload $CHIMERE_APP_PATH/media/ - -Webserver configuration -....................... -If you are using Apache and WSGI to serve your Chimère, change your WSGI -configuration file to point to the correct settings: -**value_of_your_localname.settings**. - -Change your webserver directive to point to the correct static directory from -**your_chimere_path/chimere/static** to -**your_chimere_path/your_local_name/static**. - -Version 2.0 -> master -+++++++++++++++++++++ - -Update settings and static files. - -.. code-block:: bash - - cp $CHIMERE_PATH/example_project/settings.py $CHIMERE_LOCALNAME - ./manage.py collectstatic - -Migrate database ----------------- - -Version 1.1 -> 1.2 -****************** - -Migration scripts test your installation before making changes so you probably -won't have any lost but by precaution before running these scripts don't forget -to backup your database. -You can also make a copy of your current database into a new database and make -the new installation to this new database. - -The gdal binding for Python is necessary to run the upgrade scripts (available -in the python-gdal package in Debian). - -If you run the migration scripts in a production environnement stop the old -instance of Chimère before executing the migration script. - -In *settings.py* verify that **chimere.scripts** is in the *INSTALLED_APPS*. - -After that in the Chimère directory just execute the script. - -.. code-block:: bash - - cd $CHIMERE_APP_PATH - python ./scripts/upgrade.py - -Version 1.2 -> 2.0 -****************** - -Django South is now used to manage database migrations. - -.. code-block:: bash - - cd $CHIMERE_APP_PATH - ./manage.py syncdb - ./manage.py migrate chimere 0001 --fake # fake the database initialisation - ./manage.py migrate chimere - -A description field is now available for markers. If you would like to move -values of an old *Property model* to this new field, a script is available. - -.. code-block:: bash - - cd $CHIMERE_APP_PATH - ../chimere/scripts/migrate_properties.py - # follow the instructions - -Version 2.0 -> master -********************* - -.. code-block:: bash - - cd $CHIMERE_APP_PATH - ./manage.py syncdb - ./manage.py migrate chimere - -Update translations -------------------- - -Version 1.1 -> 1.2 -****************** - -.. code-block:: bash - - cd $CHIMERE_APP_PATH - ./manage.py compilemessages - -Version 1.2 -> 2.0 -> master -**************************** - -.. code-block:: bash - - cd $CHIMERE_PATH/chimere - django-admin compilemessages - -Forcing the refresh of visitor's web browser cache --------------------------------------------------- - -Major changes in the javascript has been done between versions, many of your -users could experience problems. There are many tricks to force the refresh -of their cache. One of them is to change the location of statics files. To do -that edit your local_settings.py and change:: - - STATIC_URL = '/static/' - -to:: - - STATIC_URL = '/static/v2.0.0/' - -Then change the webserver directive to point to your new path. -Restart the web server to apply this changes. - -- cgit v1.2.3 From 154e29c852e9a0caa43fe630e9f1c70d1a833e87 Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Thu, 6 Dec 2012 20:40:53 +0100 Subject: Documentation: screenshots for french documentation --- docs/fr/static/chimere_admin_00.png | Bin 5855 -> 5812 bytes docs/fr/static/chimere_admin_01.png | Bin 69448 -> 59556 bytes docs/fr/static/chimere_admin_02.png | Bin 62730 -> 53533 bytes docs/fr/static/chimere_admin_03.png | Bin 65588 -> 44317 bytes docs/fr/static/chimere_admin_import_CSV.png | Bin 12579 -> 12726 bytes docs/fr/static/chimere_admin_import_KML.png | Bin 14953 -> 15775 bytes docs/fr/static/chimere_admin_import_OSM.png | Bin 113738 -> 124540 bytes docs/fr/static/chimere_admin_import_georss.png | Bin 10260 -> 10363 bytes docs/fr/static/chimere_admin_import_shapefile.png | Bin 13807 -> 14040 bytes .../static/chimere_admin_modified_management.png | Bin 93852 -> 70257 bytes docs/fr/static/chimere_admin_modify_item.png | Bin 109282 -> 190914 bytes 11 files changed, 0 insertions(+), 0 deletions(-) (limited to 'docs/fr') diff --git a/docs/fr/static/chimere_admin_00.png b/docs/fr/static/chimere_admin_00.png index 374c6b6..e9f6bf7 100644 Binary files a/docs/fr/static/chimere_admin_00.png and b/docs/fr/static/chimere_admin_00.png differ diff --git a/docs/fr/static/chimere_admin_01.png b/docs/fr/static/chimere_admin_01.png index 0db7f4d..f387677 100644 Binary files a/docs/fr/static/chimere_admin_01.png and b/docs/fr/static/chimere_admin_01.png differ diff --git a/docs/fr/static/chimere_admin_02.png b/docs/fr/static/chimere_admin_02.png index d0fd6fe..b14878c 100644 Binary files a/docs/fr/static/chimere_admin_02.png and b/docs/fr/static/chimere_admin_02.png differ diff --git a/docs/fr/static/chimere_admin_03.png b/docs/fr/static/chimere_admin_03.png index e815500..b8f6774 100644 Binary files a/docs/fr/static/chimere_admin_03.png and b/docs/fr/static/chimere_admin_03.png differ diff --git a/docs/fr/static/chimere_admin_import_CSV.png b/docs/fr/static/chimere_admin_import_CSV.png index e67a37b..4c967b1 100644 Binary files a/docs/fr/static/chimere_admin_import_CSV.png and b/docs/fr/static/chimere_admin_import_CSV.png differ diff --git a/docs/fr/static/chimere_admin_import_KML.png b/docs/fr/static/chimere_admin_import_KML.png index b48d69a..e56226f 100644 Binary files a/docs/fr/static/chimere_admin_import_KML.png and b/docs/fr/static/chimere_admin_import_KML.png differ diff --git a/docs/fr/static/chimere_admin_import_OSM.png b/docs/fr/static/chimere_admin_import_OSM.png index a599348..fba6ef0 100644 Binary files a/docs/fr/static/chimere_admin_import_OSM.png and b/docs/fr/static/chimere_admin_import_OSM.png differ diff --git a/docs/fr/static/chimere_admin_import_georss.png b/docs/fr/static/chimere_admin_import_georss.png index 5278652..ed67815 100644 Binary files a/docs/fr/static/chimere_admin_import_georss.png and b/docs/fr/static/chimere_admin_import_georss.png differ diff --git a/docs/fr/static/chimere_admin_import_shapefile.png b/docs/fr/static/chimere_admin_import_shapefile.png index ce612be..8778943 100644 Binary files a/docs/fr/static/chimere_admin_import_shapefile.png and b/docs/fr/static/chimere_admin_import_shapefile.png differ diff --git a/docs/fr/static/chimere_admin_modified_management.png b/docs/fr/static/chimere_admin_modified_management.png index 84e069e..2281511 100644 Binary files a/docs/fr/static/chimere_admin_modified_management.png and b/docs/fr/static/chimere_admin_modified_management.png differ diff --git a/docs/fr/static/chimere_admin_modify_item.png b/docs/fr/static/chimere_admin_modify_item.png index 861ea20..e40ca11 100644 Binary files a/docs/fr/static/chimere_admin_modify_item.png and b/docs/fr/static/chimere_admin_modify_item.png differ -- cgit v1.2.3 From d69f934044a306a17dd4e24a79aaad58fc84ef25 Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Thu, 6 Dec 2012 20:50:16 +0100 Subject: Documentation: syntax fix and config for french documentation --- docs/fr/administration.rst | 2 ++ docs/fr/conf.py | 8 ++++---- 2 files changed, 6 insertions(+), 4 deletions(-) (limited to 'docs/fr') diff --git a/docs/fr/administration.rst b/docs/fr/administration.rst index cdf79b5..126ca4b 100644 --- a/docs/fr/administration.rst +++ b/docs/fr/administration.rst @@ -176,6 +176,7 @@ ensuite à un formulaire pour modifier librement l'élément. Sur ce formulaire il y a tous les éléments disponibles à l'utilisateur plus quelques champs supplémentaires. + - Les champs *Imports* ne sont pertinent que pour les données importées depuis une source externe ou pour les données destinées à être exportées vers OSM cf. à la :ref:`section import ` de cette documentation. @@ -183,6 +184,7 @@ quelques champs supplémentaires. éléments associés à l'élément courant (élément de référence d'une modification, fichier associé à un trajet). + Les éléments multimédias sont listés à la fin du formulaire. Vous pouvez librement ajouter, modifier, changer l'ordre (avec du glissé-déposé) de ces éléments. diff --git a/docs/fr/conf.py b/docs/fr/conf.py index 6a0724e..f1ad157 100644 --- a/docs/fr/conf.py +++ b/docs/fr/conf.py @@ -54,7 +54,7 @@ release = '2.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +language = 'fr' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -103,7 +103,7 @@ html_theme = 'default' # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +html_title = u"Documentation de Chimère" # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None @@ -164,7 +164,7 @@ html_static_path = ['static'] #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'Chimredoc' +htmlhelp_basename = 'Chimeredoc' # -- Options for LaTeX output -------------------------------------------------- @@ -178,7 +178,7 @@ htmlhelp_basename = 'Chimredoc' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'Chimre.tex', u'Documentation de Chimère', + ('index', 'Chimere.tex', u'Documentation de Chimère', u'Étienne Loks', 'manual'), ] -- cgit v1.2.3 From fff82d3ba66485fdfc58297507ae1438bc9996ab Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Thu, 6 Dec 2012 20:57:18 +0100 Subject: Documentation: syntax fix --- docs/fr/install.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/fr') diff --git a/docs/fr/install.rst b/docs/fr/install.rst index d9acaa8..2788d72 100644 --- a/docs/fr/install.rst +++ b/docs/fr/install.rst @@ -12,7 +12,7 @@ Ce document présente l'installation de Chimère. Il a été mis à jour pour la version 2.0.0 de Chimère. Pré-requis -********* +********** - `Apache `_ version 2.x - `Python `_ versions 2.6 ou 2.7 @@ -163,7 +163,7 @@ minimum). La plupart de ces paramétrages sont initialisés dans le fichier cp local_settings.py.sample local_settings.py vim local_settings.py -:Fields: +:Champs: * DATABASES : paramètres relatifs à la base de données * PROJECT_NAME : nom du projet @@ -218,7 +218,7 @@ français, remplacez cela avec le code de langage approprié) :: Si votre langage n'est pas disponible, n'hésitez pas à créer le fichier **po** par défaut et à le proposer (les contributions sont bienvenues). -La procédure est la suivante :: +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 code du langage que vous souhaitez créer) :: -- cgit v1.2.3 From fd184becdf661eb33049f7adaf58046281d30740 Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Sat, 8 Dec 2012 01:19:42 +0100 Subject: Documentation: update import with overwrite option --- docs/en/administration.rst | 13 +++++++++---- docs/en/import_export.rst | 5 +++++ docs/en/static/chimere_admin_import_CSV.png | Bin 12579 -> 16957 bytes docs/en/static/chimere_admin_import_KML.png | Bin 14953 -> 19520 bytes docs/en/static/chimere_admin_import_OSM.png | Bin 113738 -> 127457 bytes docs/en/static/chimere_admin_import_georss.png | Bin 10260 -> 14414 bytes docs/en/static/chimere_admin_import_shapefile.png | Bin 13807 -> 18301 bytes docs/fr/administration.rst | 8 ++++++-- docs/fr/import_export.rst | 6 ++++++ docs/fr/static/chimere_admin_import_CSV.png | Bin 12726 -> 16780 bytes docs/fr/static/chimere_admin_import_KML.png | Bin 15775 -> 20123 bytes docs/fr/static/chimere_admin_import_OSM.png | Bin 124540 -> 126286 bytes docs/fr/static/chimere_admin_import_georss.png | Bin 10363 -> 14208 bytes docs/fr/static/chimere_admin_import_shapefile.png | Bin 14040 -> 18208 bytes 14 files changed, 26 insertions(+), 6 deletions(-) (limited to 'docs/fr') diff --git a/docs/en/administration.rst b/docs/en/administration.rst index 8b7e581..73e1dbe 100644 --- a/docs/en/administration.rst +++ b/docs/en/administration.rst @@ -179,17 +179,22 @@ If an item is not relevant the **Delete** button enables to remove it. .. _managing-modified: -Managing end user amendment ---------------------------- +Managing end user amendment/imported item modified locally +---------------------------------------------------------- Amendment can be proposed on the main site by end-users. -In Chimère an amendment is a new item with the status *Modified* and with a link -to the reference item modified. +In Chimère an amendment is a new item with the status **Modified** and with a +link to the reference item modified. + +You can also have imported items which have been modified both locally and on +the external source. The new version from the external source has the status +**Imported** and have a link to the reference item. .. Note:: If you are logged as an administrator and make changes on the map with the end user form they will be directly validated. + A special form has been developed to facilitate the processing of these modified items. diff --git a/docs/en/import_export.rst b/docs/en/import_export.rst index 73a95af..79a13bb 100644 --- a/docs/en/import_export.rst +++ b/docs/en/import_export.rst @@ -44,6 +44,11 @@ Common fields with items localisation you should put here the `SRID `_ associated to the coordinate system of your source. +- **Overload existing data**: by default when data is updated on the source and + has been changed in your Chimère instance a new item is created and has to + be reconciled with the `amendment form `. If you don't want + to use this form and then overwrite with the data from the external source, + check this option. - **Origin**: if not null this field will be associated to each item imported in order to easily identify where the item came from. For OSM import the source is automatically added. diff --git a/docs/en/static/chimere_admin_import_CSV.png b/docs/en/static/chimere_admin_import_CSV.png index e67a37b..20e53c9 100644 Binary files a/docs/en/static/chimere_admin_import_CSV.png and b/docs/en/static/chimere_admin_import_CSV.png differ diff --git a/docs/en/static/chimere_admin_import_KML.png b/docs/en/static/chimere_admin_import_KML.png index b48d69a..ad35302 100644 Binary files a/docs/en/static/chimere_admin_import_KML.png and b/docs/en/static/chimere_admin_import_KML.png differ diff --git a/docs/en/static/chimere_admin_import_OSM.png b/docs/en/static/chimere_admin_import_OSM.png index a599348..03b3632 100644 Binary files a/docs/en/static/chimere_admin_import_OSM.png and b/docs/en/static/chimere_admin_import_OSM.png differ diff --git a/docs/en/static/chimere_admin_import_georss.png b/docs/en/static/chimere_admin_import_georss.png index 5278652..6c95693 100644 Binary files a/docs/en/static/chimere_admin_import_georss.png and b/docs/en/static/chimere_admin_import_georss.png differ diff --git a/docs/en/static/chimere_admin_import_shapefile.png b/docs/en/static/chimere_admin_import_shapefile.png index ce612be..0f5bdcf 100644 Binary files a/docs/en/static/chimere_admin_import_shapefile.png and b/docs/en/static/chimere_admin_import_shapefile.png differ diff --git a/docs/fr/administration.rst b/docs/fr/administration.rst index 126ca4b..e3f3992 100644 --- a/docs/fr/administration.rst +++ b/docs/fr/administration.rst @@ -199,8 +199,8 @@ supprimer. .. _managing-modified: -Managing end user amendment ---------------------------- +Gérer les modifications des utilisateurs/les éléments importés ayant des modifications locales +---------------------------------------------------------------------------------------------- Des propositions de modification peuvent être faits sur le site principal par les utilisateurs. @@ -208,6 +208,10 @@ les utilisateurs. Dans Chimère, une proposition de modification est un nouvel élément avec l'état **Modifié** qui dispose d'un lien vers l'élément de référence. +Vous pouvez avoir aussi des éléments importés qui ont à la fois des +modifications locales et sur la source externe. La nouvelle version de la source +externe a l'état **Importé** et un lien vers l'élément de référence. + .. Note:: Si vous êtes identifié en tant qu'administrateur et que vous faites des changements sur la carte avec le « formulaire utilisateur » les changements diff --git a/docs/fr/import_export.rst b/docs/fr/import_export.rst index 11ffaa3..db35bf3 100644 --- a/docs/fr/import_export.rst +++ b/docs/fr/import_export.rst @@ -45,6 +45,12 @@ Champs communs à tous les types de source longitude). Si vous avez des problèmes avec la localisation des éléments vous devez probablement mettre ici le `SRID `_ correspondant au système de coordonnées de votre source. +- **Écraser les données existantes** : par défaut quand les données ont été + mises à jour à la fois sur la source externe et sur votre source externe un + nouvel élément est créé et a à être rapproché avec le `formulaire de gestion + des modifications `. Si vous ne souhaitez pas avoir à faire + ce rapprochement et alors écraser les données existantes avec les données de + la source externe, cochez cette option. - **Origine** : si non nul, ce champ va être associé à chaque élément importé afin d'identifier facilement d'où l'élément provient. Pour les imports OSM la source est ajoutée automatiquement. diff --git a/docs/fr/static/chimere_admin_import_CSV.png b/docs/fr/static/chimere_admin_import_CSV.png index 4c967b1..6783564 100644 Binary files a/docs/fr/static/chimere_admin_import_CSV.png and b/docs/fr/static/chimere_admin_import_CSV.png differ diff --git a/docs/fr/static/chimere_admin_import_KML.png b/docs/fr/static/chimere_admin_import_KML.png index e56226f..2c4e72b 100644 Binary files a/docs/fr/static/chimere_admin_import_KML.png and b/docs/fr/static/chimere_admin_import_KML.png differ diff --git a/docs/fr/static/chimere_admin_import_OSM.png b/docs/fr/static/chimere_admin_import_OSM.png index fba6ef0..1fa75a6 100644 Binary files a/docs/fr/static/chimere_admin_import_OSM.png and b/docs/fr/static/chimere_admin_import_OSM.png differ diff --git a/docs/fr/static/chimere_admin_import_georss.png b/docs/fr/static/chimere_admin_import_georss.png index ed67815..6faf556 100644 Binary files a/docs/fr/static/chimere_admin_import_georss.png and b/docs/fr/static/chimere_admin_import_georss.png differ diff --git a/docs/fr/static/chimere_admin_import_shapefile.png b/docs/fr/static/chimere_admin_import_shapefile.png index 8778943..74a92d9 100644 Binary files a/docs/fr/static/chimere_admin_import_shapefile.png and b/docs/fr/static/chimere_admin_import_shapefile.png differ -- cgit v1.2.3 From 7c1505cd72f25d43584f0abb2e05e332976bbc26 Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Mon, 10 Dec 2012 01:12:43 +0100 Subject: Documentation: french doc corrections --- docs/en/import_export.rst | 7 +++-- docs/fr/administration.rst | 54 +++++++++++++++++----------------- docs/fr/configuration.rst | 70 ++++++++++++++++++++++---------------------- docs/fr/customisation.rst | 10 +++---- docs/fr/import_export.rst | 47 ++++++++++++++--------------- docs/fr/install.rst | 52 ++++++++++++++++----------------- docs/fr/upgrade.rst | 73 +++++++++++++++++++++++----------------------- 7 files changed, 158 insertions(+), 155 deletions(-) (limited to 'docs/fr') diff --git a/docs/en/import_export.rst b/docs/en/import_export.rst index 79a13bb..cbbff70 100644 --- a/docs/en/import_export.rst +++ b/docs/en/import_export.rst @@ -153,6 +153,8 @@ project directory you only need to launch the command:: If you launch the command without *import_id* the list of imports available is presented and you can choose one. +.. _manage-imported-data: + Managing imported data ********************** @@ -216,9 +218,8 @@ 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, these new data will overload data in your -Chimère (if you don't want that: don't do re-imports so dont do exports). All -pending imported items should have been treated before doing an export. +the new import has updated data, treat them before doing an export (cf `manage +imported data `). To launch an export select the appropriate *Import* object in the imports list. Then select the **Export to OSM** action and validate. diff --git a/docs/fr/administration.rst b/docs/fr/administration.rst index e3f3992..d581986 100644 --- a/docs/fr/administration.rst +++ b/docs/fr/administration.rst @@ -15,7 +15,7 @@ Il a été mis à jour pour la version 2.0.0 de Chimère. Présentation des pages d'administration --------------------------------------- -Les pages d'administration sont accessible à l'adresse : +Les pages d'administration sont accessibles à l'adresse : http://where_is_your_chimere/admin/ N'oubliez pas la barre oblique (slash) à la fin de l'adresse. @@ -24,7 +24,7 @@ Identification ************** Tout d'abord vous avez à vous identifier avec l'identifiant et le mot de -passe fourni. +passe fournis. .. image:: static/chimere_admin_00.png @@ -57,14 +57,14 @@ Liste des éléments #. chemin dans le site d'administration. C'est un raccourci pratique pour revenir à la page principale. -#. lien pour créer un nouvel élément depuis la liste des éléments +#. lien pour créer un nouvel élément depuis la liste des éléments. #. recherche des éléments par mot (n'est pas disponible pour tous les types - d'éléments) + d'éléments). #. cette boite permet de filtrer les entrées actuelles avec des filtres (n'est pas disponible pour tous les types d'éléments) -#. les entêtes de cette table est cliquable. Cliquer sur une entête permet de - trier les éléments de manière ascendante et descendante. Un tri multi-entête - est possible (le nombre à droite de l'entête indique l'ordre de prise en +#. les en-têtes de cette table sont cliquables. Cliquer sur une en-tête permet + de trier les éléments de manière ascendante et descendante. Un tri multi-en-tête + est possible (le nombre à droite de l'en-tête indique l'ordre de prise en compte dans le tri). #. chaque élément peut être coché (pour lui appliquer une action) ou sélectionné (en cliquant sur la première colonne) pour voir son détail et éventuellement @@ -83,13 +83,13 @@ Formulaire des éléments #. pour certains éléments il y a des sous-éléments associés. Ces sous-éléments peuvent être modifiés directement dans ce formulaire. Lorsque plusieurs sous-éléments sont associés à un élément, ils peuvent être réagencés par - glissé-déposé. + glisser-déposer. #. le formulaire doit être validé par un de ces boutons. Ils parlent d'eux-même. États ***** -Les *États* sont des propriétés rattachés à chaque élément géographique dans +Les *États* sont des propriétés rattachées à chaque élément géographique dans Chimère. Pour administrer Chimère efficacement il est nécessaire de comprendre chacun de ces états. @@ -100,42 +100,42 @@ chacun de ces états. - **Modifié**: État d'une proposition de modification d'un élément par un utilisateur. - **Importé**: État d'un élément nouvellement importé. Les opérations d'import - et d'export nécessite que tous les élément avec l'état *importé* soient + et d'export nécessitent que tous les éléments avec l'état *importé* soient traités (validés, désactivés ou supprimés). Gestion des nouvelles --------------------- -Un système de nouvelle est disponible. +Un système de nouvelles est disponible. Tout ce que vous avez à faire est de cliquer sur le bouton *Ajouter* à côté de *Nouvelles*. Pour chaque nouvelle il est nécessaire de fournir un nom et un contenu. Le contenu peut contenir des balises HTML. La disponibilité est gérée avec une case à cocher. -Creation de catégories/sous-catégories +Création de catégories/sous-catégories -------------------------------------- Avant l'ajout de catégories, il est nécessaire de définir des icônes. Ces icônes -apparaissent sur la carte et sur la boite contenant les catégories sur la carte +apparaissent sur la carte et sur la boîte contenant les catégories sur la carte principale. Faites attention de bien redimensionner vos icônes. En effet les icônes vont -être présentés à leur taille réelle sur la carte. +être présentées à leur taille réelle sur la carte. Pour ajouter des icônes : cliquez sur le bouton **Ajout** à côté de *Icônes*. -Les catégories sont fait des conteneurs à sous-catégories. Il est juste +Les catégories sont en fait des conteneurs à sous-catégories. Il est juste nécessaire de fournir nom et ordre d'affichage. Pour ajouter des catégories : cliquez sur le bouton **Ajout** près des -catégories (cela devrait être clair maintenant, non ?). +catégories. Les champs concernant les sous-catégories sont : un nom, une icône, un ordre, un thème de couleur et un type d'élément. -La plupart des champs parlent d'eux-même. +La plupart des champs parlent d'eux-mêmes. Les thèmes de couleurs sont composés de plusieurs couleurs. -Les couleurs sont utilisés pour le tracé des trajets (si la sous-catégorie -contient des trajets). Si c'est une couleur de base cela peut être défini -par le nom en anglais (pare exemple *red* pour rouge, *blue* pour bleu, +Les couleurs sont utilisées pour le tracé des trajets (si la sous-catégorie +contient des trajets). Si c'est une couleur de base, cela peut être défini +par le nom en anglais (par exemple *red* pour rouge, *blue* pour bleu, *purple* pour violet) sinon vous pouvez donner le code couleur HTML RVB (par exemple *#9227c9*). Le type d'élément est le type d'élément que la sous-catégorie peut contenir : @@ -146,8 +146,8 @@ points d'intérêts, trajets ou les deux. Édition/modération des éléments ------------------------------- -L'étape de modération est relativement simple. Il fonctionne de la même manière -que ce soit avec les points d'intérêt ou les trajets. +L'étape de modération est relativement simple. Elle fonctionne de la même +manière avec les points d'intérêt ou avec les trajets. Le modérateur accède classiquement aux points d'intérêts (ou trajets) en cliquant sur leur nom dans la liste d'éléments. @@ -163,8 +163,8 @@ Il y a un certain nombre d'action disponible. C'est particulièrement utile pour garder des éléments que vous ne voulez pas voir apparaître sur la carte mais conserver en base de données. - **Gérer les éléments modifiés** pour gérer les propositions de modification - par les utilisateurs sur le site principal cf. to :ref:`managing-modified`. - Les éléments modifiés doivent ne peuvent être traités qu'un à la fois. + par les utilisateurs sur le site principal (cf. :ref:`managing-modified`). + Les éléments modifiés ne peuvent être traités qu'un par un. - **Export en...** pour exporter les éléments sélectionnés vers le format sélectionné. @@ -186,7 +186,7 @@ quelques champs supplémentaires. Les éléments multimédias sont listés à la fin du formulaire. Vous pouvez -librement ajouter, modifier, changer l'ordre (avec du glissé-déposé) de ces +librement ajouter, modifier, changer l'ordre (avec du glisser-déposer) de ces éléments. Si un élément n'est pas pertinent, le bouton **Supprimer** permet de le @@ -234,5 +234,5 @@ Ce formulaire est un tableau à 3 colonnes. l'élément de référence. .. Note:: - Pour rejeter toutes les modifications proposées, validez le formulaire avec - aucune case à cocher sélectionnée. + Pour rejeter toutes les modifications proposées, validez le formulaire sans + cocher aucune case. diff --git a/docs/fr/configuration.rst b/docs/fr/configuration.rst index cb3e3e3..f419a0d 100644 --- a/docs/fr/configuration.rst +++ b/docs/fr/configuration.rst @@ -11,8 +11,8 @@ Configuration Ce document présente l'installation de Chimère. Il a été mis à jour pour la version 2.0.0 de Chimère. -Votre session a à être initialisée avec ces variables d'environnements -en ligne de commande :: +Votre session doit être initialisée avec ces variables d'environnement +en ligne de commande : :: CHIMERE_PATH=/srv/chimere # changez avec votre répertoire d'installation CHIMERE_LOCALNAME=mychimere # changez avec le nom de votre projet @@ -26,7 +26,7 @@ La plupart de ces étapes sont faites dans les pages web d'administration. Si vous n'êtes pas familiarisé avec les pages d'administration de *type Django* vous pouvez dès maintenant regarder le premier paragraphe de -l':ref:`administration` où elle est présentée. +l':ref:`administration` où elles sont présentées. Pour accéder à ces pages vous avez à vous identifier avec un compte ayant pour état *équipe* ou *super-utilisateur*. @@ -38,11 +38,11 @@ Configurer le framework Sites Le framework *Sites* vous permet de servir le contenu pour différents domaines Internet. La plupart des installations serviront le contenu pour un seul domaine -mais ce domaine unique a à être configuré. +mais ce domaine unique doit être configuré. Pour cela allez dans les pages web d'administration *Sites > Sites*. Vous avez juste à changer *example.com* par votre nom de domaine. Si vous -oubliez de faire cela quelques fonctionnalités comme les flux RSS ne +oubliez de faire cela, quelques fonctionnalités comme les flux RSS ne fonctionneront pas correctement. .. _managing-areas: @@ -50,40 +50,40 @@ fonctionneront pas correctement. Gérer les zones --------------- -Une zone est la base de votre carte. Pour une zone il est définit : +Une zone est la base de votre carte. Pour une zone il est défini : * un nom : un libellé pour cette zone ; * une URN associée (*facultatif*) : le nom de la zone en tant que ressource Web. En pratique si la zone définie n'est pas celle par défaut, elle est utilisée à la fin de l'adresse Web de base pour pouvoir accéder à cette zone. Ce n'est pas obligatoire mais nécessaire en pratique pour chaque zone qui - n'est pas celle par défaut. + n'est pas celle par défaut ; * un message par défaut (*facultatif*) : ce message est affiché une fois par jour par utilisateur consultant la carte ; * un ordre (pour trier les zones) ; * une disponibilité ; * un état « *par défaut* ». La zone *par défaut* est vue par défaut. Une seul zone peut être *par défaut* : activez cet état sur une zone le désactive sur - toutes les autres. + toutes les autres ; * des catégories cochées par défaut (*facultatif*) ; * si les catégories sont affichées dynamiquement. Si les catégories sont affichées dynamiquement, l'utilisateur ne voit seulement que les catégories qui ont des éléments sur la portion de carte actuellement à l'écran ; * des restrictions sur les catégories (*facultatif*): si aucune restriction - n'est définie toutes les catégories sont disponibles ; + n'est définie, toutes les catégories sont disponibles ; * une feuille de style CSS externe (*facultatif*) : une adresse Web qui pointe vers une feuille de style CSS externe ; -* une restriction à la portion de carte : si restreint, l'utilisateur ne pourra +* une restriction à la portion de carte : si coché, l'utilisateur ne pourra pas faire glisser la carte en dehors de la portion de carte. À cause de - restrictions de la bibliothèque OpenLayers utilisée par Chimère, il n'y a pas + limitations de la bibliothèque OpenLayers utilisée par Chimère, il n'y a pas de restriction sur le zoom ; * une portion de carte : c'est la zone qui sera affichée par défaut en arrivant sur la carte. Si la restriction sur une portion de carte est activée, la - restriction portera sur cette portion. Laissez appuyé la touche *Control* + restriction portera sur cette portion. Laissez appuyée la touche *Control*, cliquez et glissez pour dessiner la portion de carte choisie. * calques disponibles (*facultatif* : OSM Mapnik est utilisé par défaut): les rendus OSM Mapnik, OSM MapQuest, OSM Transport Map, OSM CycleMap sont - disponibles par défaut. Vous pouvez ajouter des nouveaux calques (cf. + disponibles par défaut. Vous pouvez ajouter de nouveaux calques (cf. :ref:`managing-layers`). Les *Zones* sont personnalisables directement depuis l'interface @@ -92,21 +92,21 @@ d'administration dans *Chimere > Zones*. Comme il y a peu de chance que la zone définie par défaut vous convienne, il sera au minimum nécessaire de définir une zone par défaut. -Ajouter plusieurs zones peut être un moyen d'afficher vos données sous -différents jours. +Ajouter plusieurs zones peut être un moyen d'afficher vos données de différentes +manières. Gestion des utilisateurs ------------------------ -Si vous n'êtes pas le seul administrator/modérateur de cette installation de +Si vous n'êtes pas le seul administrateur/modérateur de cette installation de Chimère vous aurez à créer et gérer des comptes pour les autres utilisateurs. -Vous pouvez créer un nouvel administrateur en ligne de commande :: +Vous pouvez créer un nouvel administrateur en ligne de commande : :: ./manage.py createsuperuser Les mots de passe peuvent être changés en ligne de commande (utile si vous -avez oublié votre mot de passe) :: +avez oublié votre mot de passe) : :: ./manage.py changepassword username @@ -122,7 +122,7 @@ Ensuite complétez les autres informations. Cochez la case : *Statut équipe* (ou cet utilisateur ne sera pas capable d'accéder aux pages d'administration). -Si ce compte est un nouveau administrateur technique, cochez la case *Statut +Si ce compte est un nouvel administrateur technique, cochez la case *Statut superutilisateur* (cet utilisateur doit être digne de confiance !). Sinon vous allez devoir donner des permissions à ce nouvel utilisateur. Plutôt que d'assigner manuellement des permissions aux utilisateurs, il est plus simple @@ -132,7 +132,7 @@ Deux types de groupe sont proposés par défaut : les administrateurs de l'application et les modérateurs. Les groupes de modérateurs ont des droits limités à une seule zone (le nom -du groupe est *Nom de zone modération*). Ils ne voient que les éléments +du groupe est *Nom_de_zone modération*). Ils ne voient que les éléments qui concernent leur zone. Un utilisateur pouvant faire partie de plusieurs groupes, il peut modérer plusieurs zones. @@ -142,29 +142,29 @@ Détails des droits pour les groupes par défaut : +------------------------------------------+--------------------------+---------------------------------+------------+ | Élément (ajout/modification/suppression) | Administrateur technique | Administrateur de l'application | Modérateur | +==========================================+==========================+=================================+============+ -| User | Oui | Non | Non | +| Utilisateur | Oui | Non | Non | +------------------------------------------+--------------------------+---------------------------------+------------+ -| Group | Oui | Non | Non | +| Groupe | Oui | Non | Non | +------------------------------------------+--------------------------+---------------------------------+------------+ -| Property model | Oui | Non | Non | +| Modèle de propriété | Oui | Non | Non | +------------------------------------------+--------------------------+---------------------------------+------------+ | Import | Oui | Non | Non | +------------------------------------------+--------------------------+---------------------------------+------------+ -| Layer | Oui | Non | Non | +| Calque | Oui | Non | Non | +------------------------------------------+--------------------------+---------------------------------+------------+ -| News | Oui | Oui | Non | +| Nouvelles | Oui | Oui | Non | +------------------------------------------+--------------------------+---------------------------------+------------+ -| Area | Oui | Oui | Non | +| Zone | Oui | Oui | Non | +------------------------------------------+--------------------------+---------------------------------+------------+ -| Icon | Oui | Oui | Non | +| Icône | Oui | Oui | Non | +------------------------------------------+--------------------------+---------------------------------+------------+ -| Color/Color theme | Oui | Oui | Non | +| Couleurs/thème de couleur | Oui | Oui | Non | +------------------------------------------+--------------------------+---------------------------------+------------+ -| Category/Subcategory | Oui | Oui | Non | +| Catégorie/Sous-catégorie | Oui | Oui | Non | +------------------------------------------+--------------------------+---------------------------------+------------+ -| Point Of Interest | Oui | Oui | Oui | +| Point d'intérêt | Oui | Oui | Oui | +------------------------------------------+--------------------------+---------------------------------+------------+ -| Route | Oui | Oui | Oui | +| Trajet | Oui | Oui | Oui | +------------------------------------------+--------------------------+---------------------------------+------------+ @@ -173,7 +173,7 @@ Créer des modèles de propriété Une installation de base de Chimère permet d'associer un nom, des catégories, une description, des dates, des fichiers multimédias, des fichiers d'image -à chaque fichier géographique. +à chaque élément géographique. Vous souhaitez peut-être des champs personnalisés tels que des numéros de téléphone ou des horaires d'ouverture. Pour cela, il suffit d'ajouter un nouveau @@ -182,12 +182,12 @@ modèle de propriété (*Chimere/Modèle de propriété*). La page d'administration vous demande : * un nom ; -* un ordre (pour ordonner les propriétés entre-elles) ; +* un ordre (pour ordonner les propriétés entre elles) ; * une disponibilité pour l'utilisateur (cela peut être utilisé pour associer des propriétés cachées) ; * un état « Obligatoire » qui oblige à remplir ce champ dans les formulaires ; * les catégories auxquelles associer cette propriété (si aucune catégorie n'est - sélectionnée la propriété est disponible pour toutes les categories) ; + sélectionnée, la propriété est disponible pour toutes les categories) ; * le type : texte, texte long, mot de passe ou date. .. Warning:: @@ -197,6 +197,6 @@ La page d'administration vous demande : Les formulaires sont alors automatiquement mis à jour avec ce nouveau champ. En tant qu'administrateur, si vous ne souhaitez pas rendre disponible l'ajout -ou la modification des propriétés vous pouvez désactiver la gestion des modèles +ou la modification des propriétés, vous pouvez désactiver la gestion des modèles de propriété en mettant *CHIMERE_HIDE_PROPERTYMODEL* à la valeur *True* dans votre fichier *local_settings.py*. diff --git a/docs/fr/customisation.rst b/docs/fr/customisation.rst index 498cfad..016f9e4 100644 --- a/docs/fr/customisation.rst +++ b/docs/fr/customisation.rst @@ -1,8 +1,8 @@ .. -*- coding: utf-8 -*- -============= -Customisation -============= +================ +Personnalisation +================ :Auteur: Étienne Loks :date: 2012-11-29 @@ -24,7 +24,7 @@ Le nouveau calque est défini en utilisant une chaîne de code Javascript adéqu de la bibliothèque `Openlayers `_. Ce code Javascript doit être une instance de *Openlayers Layer*, sans point virgule final. -Par exemple définir un calque Bing peut être fait avec un code de ce type :: +Par exemple définir un calque Bing peut être fait avec un code de ce type : :: new OpenLayers.Layer.Bing({ name: "Aerial", @@ -45,7 +45,7 @@ est d'ajouter un lien vers une feuille de style supplémentaire dans vos *Zones* (cf. :ref:`managing-areas`). Si vous souhaitez faire des changements plus importants dans l'agencement et la -présentation le projet *example_project* peut être personnalisé pour +présentation, le projet *example_project* peut être personnalisé pour correspondre à vos besoins. Chaque fichier de patron de page présent dans le dossier *chimere/templates* peut être copié dans votre dossier *monprojet/templates* puis modifié. diff --git a/docs/fr/import_export.rst b/docs/fr/import_export.rst index db35bf3..fc2902e 100644 --- a/docs/fr/import_export.rst +++ b/docs/fr/import_export.rst @@ -55,8 +55,8 @@ Champs communs à tous les types de source afin d'identifier facilement d'où l'élément provient. Pour les imports OSM la source est ajoutée automatiquement. - **Licence** : si non nul, ce champ va être associé à chaque élément importé - afin d'identifier facilement la license de l'élément. Pour les imports OSM - la license est ajoutée automatiquement. + afin d'identifier facilement la licence de l'élément. Pour les imports OSM + la licence est ajoutée automatiquement. - **Sous-catégories (obligatoire)** : les sous-catégories sélectionnées seront associées automatiquement aux nouveaux éléments importés. @@ -67,7 +67,7 @@ Import KML .. image:: static/chimere_admin_import_KML.png -- **Adresse Web/fichier source (obligatoire)** : votre fichier KML peut être +- **Adresse Web / fichier source (obligatoire)** : votre fichier KML peut être local ou distant. Vous avez à remplir un des deux champs. - **Filtre**: si vous souhaitez importer seulement un dossier (**Folder**) du fichier KML mettez son nom dans ce champ. @@ -80,9 +80,9 @@ Import Shapefile .. image:: static/chimere_admin_import_shapefile.png -- **Adresse Web/fichier source (obligatoire)** : votre fichier Shapefile peut +- **Adresse Web / fichier source (obligatoire)** : votre fichier shapefile peut être local ou distant. Vous avez à remplir un des deux champs. -- **Fichier zippé**: seuls les fichiers Shapefile zippé sont acceptés aussi +- **Fichier zippé**: seuls les fichiers shapefile zippés sont acceptés aussi cette case devrait être cochée. Import GeoRSS @@ -141,7 +141,7 @@ Pour importer depuis OSM, Chimère utilise l'API XAPI d'OSM. à utiliser pour filtrer les données OSM. Un lien vers la `page de « Map features » OSM `_ est fourni pour vous aider à trouver les valeurs adaptées. -- **Bouton de rafraîchissement**: ce bouton converti vos choix en arguments +- **Bouton de rafraîchissement**: ce bouton convertit vos choix en arguments XAPI adaptés. N'oubliez pas de presser sur ce bouton avant de valider le formulaire. @@ -165,6 +165,8 @@ juste nécessaire de lancer la commande :: Si vous lancez l'import en ligne de commande sans l'identifiant d'import, la liste des imports disponibles est affichée et vous pouvez alors en choisir un. +.. _manage-imported-data: + Gérer les données importées *************************** @@ -180,8 +182,8 @@ d'apparaître comme nouveaux éléments. importées. C'est particulièrement important si vous souhaitez exporter vos données vers OSM. -Exporter --------- +Export +------ Exporter vers CSV/KML/Shapefile ******************************* @@ -227,21 +229,20 @@ déterminer : - la zone géographique concernée par votre export ; - la clé/valeur à ajouter à vos éléments (nouveaux ou mis à jour) ; -- les sous-catégories concernées par cet export. Si vosu pensez que certains +- les sous-catégories concernées par cet export. Si vous pensez que certains éléments dans ces sous-catégories ne devraient pas être dans la base de données OSM (car ils ne sont pas pertinents ou à cause de question de licence) - préalablement marquez les comme **À ne pas exporter vers OSM** dans les + marquez les préalablement comme **À ne pas exporter vers OSM** dans les *champs d'imports* des :ref:`formulaires concernant les éléments géographiques `. -L'export vers OSM dans Chimère est fait de telle sorte à être le plus +L'export vers OSM dans Chimère est fait de sorte à être le plus conservateur possible par rapport à la base de données OSM. C'est pour cela qu'avant tout export, un import est fait. Si le nouvel import a des données -mises à jour, les valeurs de ces nouvelles données écraseront les données -présentes dans votre Chimère (si vous ne souhaitez pas cela : ne faites pas -de ré-imports et de fait pas d'exports). Tous les éléments importés doivent -être traités avant de faire un export. +mises à jour, il est nécessaire de retraiter les nouvelles données importées +avant de faire un export (cf. :ref:`gérer les données importées +`). Pour lancer un export sélectionnez l'objet *Import* approprié dans la liste des imports. Ensuite sélectionnez l'action **Exporter vers OSM** et validez. @@ -249,19 +250,19 @@ Puis on vous demande votre identifiant OSM, votre mot de passe OSM et l'API que vous souhaitez utiliser. Si vous comptez faire des exports régulièrement avec Chimère, il est recommandé de créer un compte spécifique pour cela. L'API de test est disponible pour faire des tests d'export. Si vous souhaitez -utiliser l'API de test vous aurez à créer un compte spécifique sur la plateforme -de test. +utiliser l'API de test, vous aurez à créer un compte spécifique sur la +plateforme de test. .. Warning:: Les données sur la plateforme de test ne sont pas synchronisées avec la - plateforme principale. Vous n'aurez pas les mêmes données que les données - que vous aurez avec XAPI. + plateforme principale. Vous n'aurez pas les mêmes données que celles celles + importées avec XAPI. -Une fois que tout ces champs sont remplis, vous pouvez (enfin !) lancer +Une fois que tous ces champs sont remplis, vous pouvez (enfin !) lancer l'export. -Quand vous exportez des couples clés/valeurs sont automatiquement ajoutés/mis à -jour : +Quand vous exportez, des couples clés/valeurs sont automatiquement ajoutés/mis à +jour dans la base de données OSM : -- *name*: obtenu depuis le nom de l'élément dans Chimère. +- *name*: obtenu depuis le nom de l'élément dans Chimère ; - *source*: pour identifier Chimère comme une source. diff --git a/docs/fr/install.rst b/docs/fr/install.rst index 2788d72..841eae2 100644 --- a/docs/fr/install.rst +++ b/docs/fr/install.rst @@ -44,11 +44,11 @@ Optionnel (mais recommandé) : - `tinymce `_ - `gpsbabel `_ - - django-celery pour une meilleure gestion des imports importants. + - django-celery pour une meilleure gestion des imports importants La manière la plus simple de satisfaire à ces pré-prequis est de les installer par le biais des dépôts de votre distribution Linux préférée. Par exemple -pour Debian Wheezy :: +pour Debian Wheezy : :: apt-get install apache2 python python-django python-django-south \ postgresql-9.1 gettext python-psycopg2 python-imaging \ @@ -57,7 +57,7 @@ pour Debian Wheezy :: libgeos-3.3.3 proj-bin postgresql-9.1-postgis gdal-bin \ tinymce gpsbabel python-django-celery javascript-common -Pour Debian Squeeze (il est nécessaire d'activer les backports) :: +Pour Debian Squeeze (il est nécessaire d'activer les backports) : :: apt-get install -t squeeze-backports python-django libjs-jquery @@ -77,13 +77,13 @@ Configuration de la base de données *********************************** Maintenant que postgres et postgis sont installés, vous avez besoin de créer -un nouvel utilisateur pour Chimère :: +un nouvel utilisateur pour Chimère : :: su postgres createuser --echo --adduser --createdb --encrypted --pwprompt chimere-user Ensuite, vous avez besoin de créer la base de données et d'initialiser les types -géographiques (adaptez les chemins par rapport à vos besoins):: +géographiques (adaptez les chemins par rapport à vos besoins) : :: PG_VERSION=9.1 # 8.4 pour debian Squeeze createdb --echo --owner chimere-user --encoding UNICODE chimere "Ma base de données Chimère" @@ -105,7 +105,7 @@ Depuis une archive La dernière version « stable » est disponible dans ce `répertoire `_. Prenez garde à prendre la dernière version de la branche souhaitée -(par exemple la dernière version de la branche 1.0 est la version 1.0.2).:: +(par exemple la dernière version de la branche 1.0 est la version 1.0.2). :: wget http://www.peacefrogs.net/download/chimere -q -O -| html2text (...) @@ -117,7 +117,7 @@ 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 déplacez les fichiers dans un répertoire lisible -par l'utilisateur de votre serveur web (www-data pour Debian).:: +par l'utilisateur de votre serveur web (www-data pour Debian). :: cd $INSTALL_PATH tar xvjf chimere-last.tar.bz2 @@ -126,7 +126,7 @@ par l'utilisateur de votre serveur web (www-data pour Debian).:: Depuis le dépôt Git +++++++++++++++++++ -Une autre solution est d'obtenir les sources depuis le dépôt Git :: +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 @@ -139,7 +139,7 @@ Créez un patron pour votre projet ********************************* Il y a un exemple de projet fourni (*example_project*). Copiez-le et -modifiez-le (ou utilisez un autre projet basé sur Chimère) :: +modifiez-le (ou utilisez un autre projet basé sur Chimère) : :: cd $INSTALL_PATH/chimere cp -ra example_project mychimere_project @@ -155,9 +155,9 @@ 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 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*.:: +courtes des variables les plus pertinentes 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 cp local_settings.py.sample local_settings.py @@ -172,7 +172,7 @@ minimum). La plupart de ces paramétrages sont initialisés dans le fichier 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' + Cela devrait être 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é pour une installation sous Debian avec le paquet tinymce installé) @@ -187,20 +187,20 @@ minimum). La plupart de ces paramétrages sont initialisés dans le fichier * 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 :: +Gérez les permissions du dossier de média : :: cd $INSTALL_PATH/chimere/mychimere_project chown -R user:www-data media chmod -R g+w media -Créez le fichier de log :: +Créez le fichier de log : :: mkdir /var/log/django touch /var/log/django/chimere.log chown -R root:www-data /var/log/django/ chmod -R g+w /var/log/django/ -Regroupez les fichiers static dans un seul répertoire :: +Regroupez les fichiers static dans un seul répertoire : :: cd $INSTALL_PATH/chimere/mychimere_project ./manage.py collectstatic @@ -211,17 +211,17 @@ Compilation des langages Si votre langage est disponible dans le dossier *chimere/locale/*, il est juste nécessaire de le compiler. Pour faire cela, il faut lancer la commande suivante (ici, **fr** est pour le -français, remplacez cela avec le code de langage approprié) :: +français, remplacez cela avec le code de langage approprié) : :: cd $INSTALL_PATH/chimere/chimere/ django-admin compilemessages -l fr Si votre langage n'est pas disponible, n'hésitez pas à créer le fichier **po** par défaut et à le proposer (les contributions sont bienvenues). -La procédure est la suivante : +La procédure est explicité ci-dessous. Il est d'abord nécessaire de créer le fichier po par défaut (bien sûr remplacez -**fr** par le code du langage que vous souhaitez créer) :: +**fr** par le code du langage que vous souhaitez créer) : :: django-admin makemessages -l fr @@ -229,7 +229,7 @@ Il doit y avoir maintenant un fichier *django.po* dans le répertoire *locale/fr/LC_MESSAGES*. Ensuite il faut le compléter avec votre traduction. -Maintenant que votre fichier de traduction est complété, il suffit de le +Une fois le votre fichier de traduction complété, il suffit de le compiler de la même manière que vous l'auriez fait si ce fichier était initialement disponible. @@ -237,7 +237,7 @@ Initialisation de la base de données ************************************ Créez les tables de la base de données (toujours dans le répertoire de votre -projet) :: +projet) : :: cd $INSTALL_PATH/chimere/mychimere_project ./manage.py syncdb @@ -246,14 +246,14 @@ projet) :: Vous aurez à rentrer les informations pour la création du compte administrateur (les pages d'administration se trouvent à l'adresse : http://where_is_chimere/admin/). Ensuite pour créer les tables de la base de -données gérées par Django-South :: +données gérées par Django-South : :: ./manage.py migrate La base de données est en place, félicitations ! Si vous voulez remplir votre installation avec des données par défaut (ne le -faites pas sur une instance de Chimère contenant déjà des données !) :: +faites pas sur une instance de Chimère contenant déjà des données !) : :: ./manage.py loaddata ../chimere/fixtures/default_data.json @@ -263,7 +263,7 @@ Configuration du serveur web Configuration d'Apache avec mod_wsgi ++++++++++++++++++++++++++++++++++++ -Installez *mod_wsgi* pour Apache :: +Installez *mod_wsgi* pour Apache : :: apt-get install libapache2-mod-wsgi @@ -284,7 +284,7 @@ Adaptez les fichiers *mydjango.wsgi* (avec le chemin correct *sys* des bibliothèques Python de Chimère et le nom correct pour le module) et le fichier *chimere* de Apache (avec le nom de serveur correct et les chemins corrects). -Pour activer le site web, rechargez Apache :: +Pour activer le site web, rechargez Apache : :: a2ensite chimere /etc/init.d/apache2 reload @@ -292,7 +292,7 @@ Pour activer le site web, rechargez Apache :: Si vous avez des problèmes de dépôt de fichier avec des caractères Unicode dans leurs noms, activez la locale appropriée dans Apache. Sur un serveur Debian avec UTF-8 comme codage par défaut, dans le fichier */etc/apache2/envvars* -décommentez la ligne suivante :: +décommentez la ligne suivante : :: . /etc/default/locale diff --git a/docs/fr/upgrade.rst b/docs/fr/upgrade.rst index 8a13bf7..a092b4b 100644 --- a/docs/fr/upgrade.rst +++ b/docs/fr/upgrade.rst @@ -1,8 +1,8 @@ .. -*- coding: utf-8 -*- -======= -Upgrade -======= +=========== +Mise à jour +=========== :Auteur: Étienne Loks :date: 2012-11-29 @@ -12,13 +12,13 @@ Ce document présente la mise à jour de Chimère. Il a été mis à jour pour la version 2.0.0 de Chimère. .. Warning:: - Avant toute mise à jour la base de données et toutes vos fichiers - d'installation (en particulier si vous avez fait des changements sur - ceux-ci). + Avant toute mise à jour faites une sauvegarde de la base de données et de + tous vos fichiers d'installation (en particulier si vous avez fait des + changements sur ceux-ci). -La procédure de migration nécessite une connaissance de base de Git et la ligne -de commande Linux. Ce n'est *pas* une procédure facile. Un travail est en cours -pour faciliter les mises à jour des futures versions de Chimère (>2.0). +La procédure de migration nécessite une connaissance de base de Git et de la +ligne de commande Linux. Ce n'est *pas* une procédure facile. Un travail est en +cours pour faciliter les mises à jour des futures versions de Chimère (>2.0). Si plusieurs versions de Chimère ont été publiées depuis votre installation, vous devez répéter toutes les étapes de mise à jour. @@ -49,7 +49,7 @@ Version 1.2 -> 2.0 Debian Squeeze ++++++++++++++ -Activez les backports: http://backports-master.debian.org/Instructions/ +Activez les backports (http://backports-master.debian.org/Instructions/). Puis installez les nouvelles dépendances :: apt-get install -t squeeze-backports python-django python-django-south \ @@ -64,7 +64,7 @@ Debian Wheezy apt-get install python-django-south python-simplejson libjs-jquery-ui \ python-pyexiv2 python-feedparser javascript-common -Si vous envisagez de réaliser des imports importants envisagez l'installation +Si vous comptez réaliser des imports importants envisagez l'installation de `Celery `_. .. code-block:: bash @@ -74,9 +74,8 @@ de `Celery `_. Obtenir les nouvelles sources ----------------------------- -Tout d'abord vous avez à obtenir la nouvelle version du code source. -Pour la procédure d'installation, le code source doit être pris depuis -le dépôt Git. +Tout d'abord vous avez besoin de la nouvelle version du code source. +Pour la procédure d'installation, le code source doit être celui du dépôt Git. Pour simplifier les instructions suivantes, quelques variables d'environnement sont initialisées. @@ -116,7 +115,7 @@ Pour une précédente installation Git Pour une précédente installation depuis une archive *************************************************** -Supprimez d'abord votre ancienne installation et obtenez la version Git :: +Supprimez d'abord votre ancienne installation et obtenez la version Git : .. code-block:: bash @@ -147,7 +146,7 @@ jquery et gpsbabel) : JQUERY_URL = SERVER_URL + 'jquery/jquery-1.4.4.min.js' GPSBABEL = '/usr/bin/gpsbabel' - # simplification des trajets avec une tolérance de 5 metres + # simplification des trajets avec une tolérance de 5 mètres GPSBABEL_OPTIONS = 'simplify,crosstrack,error=0.005k' Version 1.2 -> 2.0 @@ -176,12 +175,12 @@ Un fichier *local_settings* est maintenant utilisé. Reportez vos anciens paramètres de *settings.py* vers *local_settings.py* (au minimum la configuration de votre base de données). Le paramètre *ROOT_URLCONF* doit être mis à la valeur -**nom_de_votre_projet.urls**. +« **nom_de_votre_projet.urls** ». logs .... Par défaut, des fichiers de *log* sont maintenant écrit dans le fichier : -*/var/log/django/chimere.log*. +« */var/log/django/chimere.log* ». .. code-block:: bash @@ -192,7 +191,8 @@ Par défaut, des fichiers de *log* sont maintenant écrit dans le fichier : Fichiers statiques .................. -Les fichiers statiques sont maintenant gérés avec *django.contrib.staticfiles*. +Les fichiers statiques sont maintenant gérés avec +« **django.contrib.staticfiles** ». .. code-block:: bash @@ -213,11 +213,11 @@ Configuration du serveur Web Si vous utilisez Apache et WSGI pour mettre à disposition votre Chimère, changez la configuration pour pointer vers le chemin correct de -configuration : **nom_de_votre_projet.settings**. +configuration : « **nom_de_votre_projet.settings** ». Changez la directive de votre serveur web pour qu'elle pointe vers le bon -répertoire statique de **votre_chemin_vers_chimere/chimere/static** en -**votre_chemin_vers_chimere/nom_de_votre_projet/static**. +répertoire statique de « **votre_chemin_vers_chimere/chimere/static** » en +« **votre_chemin_vers_chimere/nom_de_votre_projet/static** ». Version 2.0 -> master +++++++++++++++++++++ @@ -236,7 +236,7 @@ Version 1.1 -> 1.2 ****************** Les scripts de migration testent votre installation avant de faire des -changements vous n'aurez donc probablement pas de perte mais par précaution +changements. Vous n'aurez donc probablement pas de perte mais par précaution avant de les lancer n'oubliez pas de faire une sauvegarde de votre base de données. Vous pouvez aussi faire une copie de votre base de données actuelle dans une @@ -246,13 +246,13 @@ La bibliothèque GDAL pour Python est nécessaire pour faire fonctionner ces scripts (disponible avec le paquet *python-gdal* dans Debian). Si vous souhaitez lancer le script de migration dans un environnement de -production stoppez l'instance de Chimère avant d'exécuter le script de +production, stoppez l'instance de Chimère avant d'exécuter le script de migration. -Dans le fichier *settings.py* vérifiez que **chimere.scripts** fait parti +Dans le fichier *settings.py* vérifiez que **chimere.scripts** fait partie des *INSTALLED_APPS*. -Après cela dans le répertoire d'installation de Chimère exécutez simplement +Après cela, dans le répertoire d'installation de Chimère, exécutez simplement le script. .. code-block:: bash @@ -269,11 +269,12 @@ Django South est maintenant utilisé pour les migrations de base de données. cd $CHIMERE_APP_PATH ./manage.py syncdb - ./manage.py migrate chimere 0001 --fake # fake the database initialisation + ./manage.py migrate chimere 0001 --fake # simule l'initialisation de la base + # de données ./manage.py migrate chimere Un champ descriptif est maintenant disponible pour les points d'intérêts. Si -vous souhaitez bouger un ancien *modèle de propriété* vers ce nouveau champ, +vous souhaitez migrer un ancien *modèle de propriété* vers ce nouveau champ, un script est disponible. .. code-block:: bash @@ -313,21 +314,21 @@ Version 1.2 -> 2.0 -> master Forcer le rafraîchissement du cache du navigateur des utilisateurs ------------------------------------------------------------------ -Des changements importants au niveau des styles et du javascript sont fait entre -les différentes version. Cela peut provoquer des dysfonctionnements important -chez des utilisateurs dont le navigateur web a conservé les anciennes versions -de certains fichiers en cache. Il y a pas mal de moyens de forcer le +Des changements importants au niveau des styles et du javascript sont faits +entre les différentes versions. Cela peut provoquer des dysfonctionnements +importants chez des utilisateurs dont le navigateur web a conservé les anciennes +versions de certains fichiers en cache. Il y a plusieurs moyens de forcer le rafraîchissement de leur cache. Un de ceux-ci est de changer le chemin vers les -fichiers statiques. Pour faire cela éditez votre fichier *local_settings.py* et -changez :: +fichiers statiques. Pour faire cela, éditez votre fichier *local_settings.py* et +changez : :: STATIC_URL = '/static/' -en :: +en : :: STATIC_URL = '/static/v2.0.0/' -Changez alors la directive concernant les fichiers statiques sur le fichier de +Changez la directive concernant les fichiers statiques sur le fichier de configuration de votre serveur web. Redémarrez alors le serveur web pour appliquer les changements. -- cgit v1.2.3 From afe689019792d509d3ce2640bbc1ecfbf544d77a Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Mon, 10 Dec 2012 11:22:23 +0100 Subject: Documentation: fix bad links --- docs/en/import_export.rst | 10 +++++----- docs/fr/import_export.rst | 14 +++++++------- 2 files changed, 12 insertions(+), 12 deletions(-) (limited to 'docs/fr') diff --git a/docs/en/import_export.rst b/docs/en/import_export.rst index cbbff70..6dd1d7a 100644 --- a/docs/en/import_export.rst +++ b/docs/en/import_export.rst @@ -46,9 +46,9 @@ Common fields your source. - **Overload existing data**: by default when data is updated on the source and has been changed in your Chimère instance a new item is created and has to - be reconciled with the `amendment form `. If you don't want - to use this form and then overwrite with the data from the external source, - check this option. + be reconciled with the :ref:`amendment form `. If you don't + want to use this form and then overwrite with the data from the external + source, check this option. - **Origin**: if not null this field will be associated to each item imported in order to easily identify where the item came from. For OSM import the source is automatically added. @@ -218,8 +218,8 @@ 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, treat them before doing an export (cf `manage -imported data `). +the new import has updated data, treat them before doing an export (cf. +:ref:`manage imported data `). To launch an export select the appropriate *Import* object in the imports list. Then select the **Export to OSM** action and validate. diff --git a/docs/fr/import_export.rst b/docs/fr/import_export.rst index fc2902e..beca4e7 100644 --- a/docs/fr/import_export.rst +++ b/docs/fr/import_export.rst @@ -47,10 +47,10 @@ Champs communs à tous les types de source correspondant au système de coordonnées de votre source. - **Écraser les données existantes** : par défaut quand les données ont été mises à jour à la fois sur la source externe et sur votre source externe un - nouvel élément est créé et a à être rapproché avec le `formulaire de gestion - des modifications `. Si vous ne souhaitez pas avoir à faire - ce rapprochement et alors écraser les données existantes avec les données de - la source externe, cochez cette option. + nouvel élément est créé et a à être rapproché avec le :ref:`formulaire de + gestion des modifications `. Si vous ne souhaitez pas avoir + à faire ce rapprochement et alors écraser les données existantes avec les + données de la source externe, cochez cette option. - **Origine** : si non nul, ce champ va être associé à chaque élément importé afin d'identifier facilement d'où l'élément provient. Pour les imports OSM la source est ajoutée automatiquement. @@ -188,8 +188,8 @@ Export Exporter vers CSV/KML/Shapefile ******************************* -Depuis les `listes d'éléments géographiques ` vous -pouvez exporter directement vers le format choisi. +Depuis les :ref:`listes d'éléments géographiques ` +vous pouvez exporter directement vers le format choisi. Tout ce que vous avez à faire c'est de sélectionner les éléments que vous souhaitez exporter, choisir l'action appropriée dans la liste d'action et de valider. @@ -224,7 +224,7 @@ Exporter vers OSM Les exports ne sont pas aussi facile à gérer que les autres exports. Tout d'abord (si cela n'est pas déjà fait) vous avez à définir un import OSM -(:ref:`regarder dessus` pour plus de détail). Cela permettra de +(:ref:`regarder dessus ` pour plus de détail). Cela permettra de déterminer : - la zone géographique concernée par votre export ; -- cgit v1.2.3 From a0b6c59e11d425e9f2874652cbfa4fc570511546 Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Mon, 10 Dec 2012 14:06:40 +0100 Subject: Documentation: add icon generator website --- docs/en/administration.rst | 5 ++++- docs/fr/administration.rst | 3 +++ 2 files changed, 7 insertions(+), 1 deletion(-) (limited to 'docs/fr') diff --git a/docs/en/administration.rst b/docs/en/administration.rst index 73e1dbe..1f13f11 100644 --- a/docs/en/administration.rst +++ b/docs/en/administration.rst @@ -115,10 +115,13 @@ Be careful to resize correctly your icons. Indeed the icon will be presented at their real size on the map. To add icons: the **Add** button near Icons. +The website http://mapicons.nicolasmollet.com/ allow to easily generate map +icons. + Categories are in fact only containers for subcategories. You'll have to provide only a name and an order. To add categories: the **Add** button near categories (quite clear now, isn't -it?) +it?). Fields of subcategories are: an associated category, a name, an icon, an order, a color and an element type. diff --git a/docs/fr/administration.rst b/docs/fr/administration.rst index d581986..8fcf41a 100644 --- a/docs/fr/administration.rst +++ b/docs/fr/administration.rst @@ -124,6 +124,9 @@ Faites attention de bien redimensionner vos icônes. En effet les icônes vont être présentées à leur taille réelle sur la carte. Pour ajouter des icônes : cliquez sur le bouton **Ajout** à côté de *Icônes*. +Le site http://mapicons.nicolasmollet.com/ permet de générer facilement des +icônes adaptées à un usage dans Chimère. + Les catégories sont en fait des conteneurs à sous-catégories. Il est juste nécessaire de fournir nom et ordre d'affichage. Pour ajouter des catégories : cliquez sur le bouton **Ajout** près des -- cgit v1.2.3 From 3aaae876d73a9c16d2961bea9ae2012ae0bc5b0e Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Tue, 11 Dec 2012 11:35:52 +0100 Subject: Documentation: minor --- docs/fr/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/fr') diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 308a9ad..dd9b1e7 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -3,8 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Bienvenu dans la documentation de Chimère ! -=========================================== +Bienvenue dans la documentation de Chimère ! +============================================ .. toctree:: :maxdepth: 2 -- cgit v1.2.3