summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorÉtienne Loks <etienne.loks@peacefrogs.net>2013-03-14 18:48:00 +0100
committerÉtienne Loks <etienne.loks@peacefrogs.net>2013-03-14 18:48:00 +0100
commit054fdbdf7a1e5106725b8b5a36db99242cfa65c1 (patch)
tree1633b26e884feb1f29afedbb80cef7a6ecbdba2d /docs
parent8a5ba2650678ec22107a1a0a10650b6e0cc14683 (diff)
parentd02ec4246813eb0787bf3ab54af1af9ce32bd376 (diff)
downloadChimère-054fdbdf7a1e5106725b8b5a36db99242cfa65c1.tar.bz2
Chimère-054fdbdf7a1e5106725b8b5a36db99242cfa65c1.zip
Merge branch 'master' into saclay
Conflicts: chimere/locale/fr/LC_MESSAGES/django.po chimere/static/chimere/css/styles.css chimere/static/chimere/js/jquery.chimere.js chimere/templates/chimere/detail.html chimere/templatetags/chimere_tags.py chimere/utils.py chimere/views.py example_project/settings.py
Diffstat (limited to 'docs')
-rw-r--r--docs/en/configuration.rst11
-rw-r--r--docs/en/import_export.rst7
-rw-r--r--docs/en/install.rst28
-rw-r--r--docs/en/upgrade.rst37
-rw-r--r--docs/fr/configuration.rst13
-rw-r--r--docs/fr/import_export.rst8
-rw-r--r--docs/fr/install.rst34
-rw-r--r--docs/fr/upgrade.rst38
8 files changed, 127 insertions, 49 deletions
diff --git a/docs/en/configuration.rst b/docs/en/configuration.rst
index e5870bb..2a7f4d0 100644
--- a/docs/en/configuration.rst
+++ b/docs/en/configuration.rst
@@ -5,7 +5,7 @@ Configuration
=============
:Author: Étienne Loks
-:date: 2012-10-08
+:date: 2013-02-01
:Copyright: CC-BY 3.0
This document presents the first steps to configure your Chimère.
@@ -32,15 +32,6 @@ 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
--------------------------------
-
-*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
diff --git a/docs/en/import_export.rst b/docs/en/import_export.rst
index 6dd1d7a..9144938 100644
--- a/docs/en/import_export.rst
+++ b/docs/en/import_export.rst
@@ -5,7 +5,7 @@ Import/export
=============
:Author: Étienne Loks
-:date: 2012-11-28
+:date: 2013-02-01
:Copyright: CC-BY 3.0
This document presents the import/export functionnalities of Chimère.
@@ -49,6 +49,11 @@ Common fields
be reconciled with the :ref:`amendment form <managing-modified>`. If you don't
want to use this form and then overwrite with the data from the external
source, check this option.
+- **Get description from source**: If this case is checked, the importer will
+ try to get the description from the source file. This option is only available
+ for certain file formats.
+- **Default description**: A default description to be added to new items. This
+ field is only available when **Get description from source** is not checked.
- **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/install.rst b/docs/en/install.rst
index ea27efc..1bb5771 100644
--- a/docs/en/install.rst
+++ b/docs/en/install.rst
@@ -5,7 +5,7 @@ Installation
============
:Author: Étienne Loks
-:date: 2012-11-28
+:date: 2013-02-01
:Copyright: CC-BY 3.0
This document presents the installation of Chimère.
@@ -141,11 +141,14 @@ Another solution is to get it from the Git repository::
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)::
+A default project can be found on `Gitorious
+<https://gitorious.org/chimere-example-project/chimere-example-project>`_. Get
+it and start a new project with it (or get another project based on Chimère)::
cd $INSTALL_PATH/chimere
- cp -ra example_project mychimere_project
+ git clone git://gitorious.org/chimere-example-project/chimere-example-project.git
+ django-admin startproject --template=chimere-example-project mychimere_project
+ rm -rf chimere-example-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:
@@ -244,6 +247,10 @@ to create tables managed with Django-South::
The database is set, congratulations!
+You can load the default group permissions (it is at least a good start)::
+
+ ./manage.py loaddata ../chimere/fixtures/auth_group.json
+
If you want to populate your installation with default data (don't do this on
an already populated instance!)::
@@ -272,8 +279,8 @@ Create and edit a configuration for Chimère::
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).
+Adapt the files *mydjango.wsgi* (with the correct module) and Apache
+*chimere* (with the correct servername and correct paths).
To activate the website, reload apache::
@@ -288,3 +295,12 @@ line::
. /etc/default/locale
+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.
+
diff --git a/docs/en/upgrade.rst b/docs/en/upgrade.rst
index d44ae02..d0eaa4c 100644
--- a/docs/en/upgrade.rst
+++ b/docs/en/upgrade.rst
@@ -5,7 +5,7 @@ Upgrade
=======
:Author: Étienne Loks
-:date: 2012-10-08
+:date: 2013-02-01
:Copyright: CC-BY 3.0
This document presents the upgrade of Chimère.
@@ -146,13 +146,16 @@ Version 1.2 -> 2.0
Project template
................
-Create a new project template:
+A default project can be found on `Gitorious
+<https://gitorious.org/chimere-example-project/chimere-example-project>`_. Get
+it and start a new project with it (or get another project based on Chimère)::
.. code-block:: bash
cd $CHIMERE_PATH
- cp -ra $CHIMERE_PATH/example_project $CHIMERE_LOCALNAME
- CHIMERE_APP_PATH=$CHIMERE_PATH/$CHIMERE_LOCALNAME
+ git clone git://gitorious.org/chimere-example-project/chimere-example-project.git
+ django-admin startproject --template=chimere-example-project mychimere_project
+ rm -rf chimere-example-project
local_settings
..............
@@ -195,6 +198,15 @@ Move old static files to the new static directory:
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/
+ rm -rf $CHIMERE_PATH/chimere/static/icons
+ rm -rf $CHIMERE_PATH/chimere/static/upload
+
+Update permissions for media directory:
+
+.. code-block:: bash
+
+ chown www-data -R $CHIMERE_APP_PATH/media/
+
Webserver configuration
.......................
@@ -251,7 +263,7 @@ Django South is now used to manage database migrations.
.. code-block:: bash
cd $CHIMERE_APP_PATH
- ./manage.py syncdb
+ ./manage.py syncdb --noinput
./manage.py migrate chimere 0001 --fake # fake the database initialisation
./manage.py migrate chimere
@@ -292,6 +304,7 @@ Version 1.2 -> 2.0 -> master
cd $CHIMERE_PATH/chimere
django-admin compilemessages
+
Forcing the refresh of visitor's web browser cache
--------------------------------------------------
@@ -304,8 +317,20 @@ that edit your local_settings.py and change::
to::
- STATIC_URL = '/static/v2.0.0/'
+ 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.
+Configuring the Sites framework
+-------------------------------
+
+Version 1.2 -> 2.0
+******************
+
+*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.
+
diff --git a/docs/fr/configuration.rst b/docs/fr/configuration.rst
index f419a0d..1ea8f50 100644
--- a/docs/fr/configuration.rst
+++ b/docs/fr/configuration.rst
@@ -5,7 +5,7 @@ Configuration
=============
:Auteur: Étienne Loks
-:date: 2012-11-29
+:date: 2013-02-01
:Copyright: CC-BY 3.0
Ce document présente l'installation de Chimère.
@@ -33,17 +33,6 @@ 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 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
-fonctionneront pas correctement.
.. _managing-areas:
diff --git a/docs/fr/import_export.rst b/docs/fr/import_export.rst
index beca4e7..4da40dd 100644
--- a/docs/fr/import_export.rst
+++ b/docs/fr/import_export.rst
@@ -5,7 +5,7 @@ Import/export
=============
:Author: Étienne Loks
-:date: 2012-11-28
+:date: 2013-02-01
:Copyright: CC-BY 3.0
Ce document présente les fonctions d'import et d'export de Chimère.
@@ -51,6 +51,12 @@ Champs communs à tous les types de source
gestion des modifications <managing-modified>`. 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.
+- **Obtenir la description depuis la source** : si cette case est cochée,
+ l'importeur va essayer d'obtenir une description depuis le fichier source.
+ Cette option n'est valable que pour certains formats.
+- **Description par défaut** : Une description par défaut à ajouter aux nouveaux
+ éléments. Ce champ n'est disponible que lorsque **Obtenir la description
+ depuis la source** n'est pas coché.
- **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/install.rst b/docs/fr/install.rst
index 841eae2..8e8f8ce 100644
--- a/docs/fr/install.rst
+++ b/docs/fr/install.rst
@@ -5,7 +5,7 @@ Installation
============
:Auteur: Étienne Loks
-:date: 2012-11-28
+:date: 2013-02-01
:Copyright: CC-BY 3.0
Ce document présente l'installation de Chimère.
@@ -138,11 +138,14 @@ Une autre solution est d'obtenir les sources depuis le dépôt Git : ::
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) : ::
+Un exemple de projet peut être trouvé sur `Gitorious
+<https://gitorious.org/chimere-example-project/chimere-example-project>`_.
+Clonez-le et modifiez-le (ou utilisez un autre projet basé sur Chimère) : ::
cd $INSTALL_PATH/chimere
- cp -ra example_project mychimere_project
+ git clone git://gitorious.org/chimere-example-project/chimere-example-project.git
+ django-admin startproject --template=chimere-example-project mychimere_project
+ rm -rf chimere-example-project
Le nom de votre projet est utilisé pour le nom de la bibliothèque Python
correspondant à votre projet.
@@ -252,6 +255,11 @@ données gérées par Django-South : ::
La base de données est en place, félicitations !
+Vous pouvez alors charger les permissions poar défaut pour les groupes
+(c'est au minimum un bon départ) : ::
+
+ ./manage.py loaddata ../chimere/fixtures/auth_group.json
+
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 !) : ::
@@ -280,9 +288,9 @@ Créez et éditez la configuration de Chimère en fonction de votre installation
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).
+Adaptez les fichiers *mydjango.wsgi* (avec 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 : ::
@@ -297,3 +305,15 @@ décommentez la ligne suivante : ::
. /etc/default/locale
+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 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
+fonctionneront pas correctement.
+
diff --git a/docs/fr/upgrade.rst b/docs/fr/upgrade.rst
index a092b4b..841485b 100644
--- a/docs/fr/upgrade.rst
+++ b/docs/fr/upgrade.rst
@@ -5,7 +5,7 @@ Mise à jour
===========
:Auteur: Étienne Loks
-:date: 2012-11-29
+:date: 2013-02-01
:Copyright: CC-BY 3.0
Ce document présente la mise à jour de Chimère.
@@ -154,13 +154,16 @@ Version 1.2 -> 2.0
Patron de projet
................
-Créez un nouveau patron de projet :
+Un exemple de projet peut être trouvé sur `Gitorious
+<https://gitorious.org/chimere-example-project/chimere-example-project>`_.
+Clonez-le et modifiez-le (ou utilisez un autre projet basé sur Chimère) : ::
.. code-block:: bash
cd $CHIMERE_PATH
- cp -ra $CHIMERE_PATH/example_project $CHIMERE_LOCALNAME
- CHIMERE_APP_PATH=$CHIMERE_PATH/$CHIMERE_LOCALNAME
+ git clone git://gitorious.org/chimere-example-project/chimere-example-project.git
+ django-admin startproject --template=chimere-example-project mychimere_project
+ rm -rf chimere-example-project
local_settings
..............
@@ -207,6 +210,14 @@ Déplacez vos anciens fichiers statiques vers le nouveau répertoire :
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/
+ rm -rf $CHIMERE_PATH/chimere/static/icons
+ rm -rf $CHIMERE_PATH/chimere/static/upload
+
+Mettre à jour les permissions des répertoires media :
+
+.. code-block:: bash
+
+ chown www-data -R $CHIMERE_APP_PATH/media/
Configuration du serveur Web
............................
@@ -268,7 +279,7 @@ Django South est maintenant utilisé pour les migrations de base de données.
.. code-block:: bash
cd $CHIMERE_APP_PATH
- ./manage.py syncdb
+ ./manage.py syncdb --noinput
./manage.py migrate chimere 0001 --fake # simule l'initialisation de la base
# de données
./manage.py migrate chimere
@@ -326,9 +337,24 @@ changez : ::
en : ::
- STATIC_URL = '/static/v2.0.0/'
+ STATIC_URL = '/static-v2.0.0/'
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.
+Configurer le framework Sites
+-----------------------------
+
+Version 1.2 -> 2.0
+******************
+
+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 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
+fonctionneront pas correctement.
+