diff options
| -rw-r--r-- | docs/_build/html/_sources/administration.txt | 104 | ||||
| -rw-r--r-- | docs/_build/html/_sources/configuration.txt | 4 | ||||
| -rw-r--r-- | docs/_build/html/_sources/customisation.txt | 4 | ||||
| -rw-r--r-- | docs/_build/html/_sources/import_export.txt | 72 | ||||
| -rw-r--r-- | docs/_build/html/_sources/install.txt | 77 | ||||
| -rw-r--r-- | docs/_build/html/_sources/upgrade.txt | 18 | ||||
| -rw-r--r-- | docs/_build/html/administration.html | 113 | ||||
| -rw-r--r-- | docs/_build/html/configuration.html | 6 | ||||
| -rw-r--r-- | docs/_build/html/customisation.html | 4 | ||||
| -rw-r--r-- | docs/_build/html/import_export.html | 77 | ||||
| -rw-r--r-- | docs/_build/html/index.html | 12 | ||||
| -rw-r--r-- | docs/_build/html/install.html | 82 | ||||
| -rw-r--r-- | docs/_build/html/objects.inv | 5 | ||||
| -rw-r--r-- | docs/_build/html/searchindex.js | 2 | ||||
| -rw-r--r-- | docs/_build/html/upgrade.html | 24 | ||||
| -rw-r--r-- | docs/administration.rst | 98 | ||||
| -rw-r--r-- | docs/configuration.rst | 4 | ||||
| -rw-r--r-- | docs/customisation.rst | 2 | ||||
| -rw-r--r-- | docs/install.rst | 8 | ||||
| -rw-r--r-- | docs/upgrade.rst | 12 |
20 files changed, 385 insertions, 343 deletions
diff --git a/docs/_build/html/_sources/administration.txt b/docs/_build/html/_sources/administration.txt index fa95012..92b6442 100644 --- a/docs/_build/html/_sources/administration.txt +++ b/docs/_build/html/_sources/administration.txt @@ -10,7 +10,7 @@ Administration :Copyright: CC-BY 3.0 This document presents the administration of Chimère. -It has has been updated for version 2.0.0. +It has been updated for version 2.0.0. Administration pages presentation @@ -34,18 +34,18 @@ Main page Once authentified you'll have access to the main admin page. -This looks like this: +It looks like this: .. image:: _static/chimere_admin_01.png #. links to this **Documentation**, to the **Change password** form and to - **Log out** -#. a list of recent actions made with this account + **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 page you can **Add** a new item or - consult/**Change** items. The **Add** link lead to the new `Item form`_. The - **Change** link lead to the `Item list`_. The `Item list`_ is also available + 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. @@ -55,16 +55,16 @@ 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 word (not available for all type of items) -#. this filter box permit to filter current entries with some criteria (not - available for all type of items) -#. the header of the table is cliquable. Click on an header sort the items by + 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 explain the order of sorting). + 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 possibly edit, delete it. + the first column) to see the detail and edit or delete it. Item form ********* @@ -72,13 +72,13 @@ 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 of the fields concerning an item are read-only and a few of - them are hidden. Mandatory fields have their label in bold. Changes on theses - fields are only effective once the form is submitted. -#. for some items there are associated sub-items. Theses associated items can be + 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 theses actions buttons. They are +#. the form has to be validated by one of these action buttons. They are self-explanatory. Status @@ -87,7 +87,7 @@ 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. -- **Submited**: Status of a new item freshly proposed by an end user. This item +- **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. @@ -102,14 +102,14 @@ 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 provided a name and a content. The content can contain +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. Theses icons appears on the +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. @@ -122,17 +122,17 @@ it?) Fields of subcategories are: an associated category, a name, an icon, an order, a color and an element type. -Theses fields are mainly quite self- explanatory. +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 the subcategory can contain: POI, route +The element type is the type of element that the subcategory can contain: POI, route or both. .. _geographic-items-management: -Edition/moderation of items +Editing or moderating items --------------------------- The moderation step is quite simple. It works the same with POIs and routes. @@ -142,35 +142,40 @@ 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 is a some actions available in the action list. +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 teh 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 - one by one. -- **Export to...** to export selected item to the selected format. +- **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 his name. +To modify an item, classically you have to click on its name. Then you access to a form to freely modify the item. -In this form there is all data available to the end user form plus some extra + +.. 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. to the :ref:`import section -<importing>` of this documentation. -- *Associated items fields* are read only fields that list items associated to -the current one (reference item of an amendment, associated file of a route). + source or for data to be exported to OSM (cf. the :ref:`import section + <importing>` 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 forgot when you change multimedia items). +bottom of the form (it is easily forgotten when you change multimedia items). -If an item is not relevant the **Delete** button permit to remove it. +If an item is not relevant the **Delete** button enables to remove it. .. _managing-modified: @@ -183,9 +188,9 @@ to the reference item modified. .. Note:: If you are logged as an administrator and make changes on the map with the - end user form there will be directly validated. + end user form they will be directly validated. -A special form has been developed to facilitate the processing of theses +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*. @@ -194,10 +199,11 @@ You can access to this special form with the action *Managed modified items*. This form is a table with three columns. -#. The first column display the information for the reference item. -#. The second column display the information proposed by the submitter. +#. 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. -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/_build/html/_sources/configuration.txt b/docs/_build/html/_sources/configuration.txt index 39acdfd..c0cef30 100644 --- a/docs/_build/html/_sources/configuration.txt +++ b/docs/_build/html/_sources/configuration.txt @@ -80,8 +80,8 @@ An *Area* is the base of your map. It defines: *Areas* are customizable directly on the web administration interface in *Chimere > Areas*. -As there is little chance that the default area is appropriate for you, you'll -have to set at least one default area. +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 area can be a mean to show your map in different flavors. diff --git a/docs/_build/html/_sources/customisation.txt b/docs/_build/html/_sources/customisation.txt index e6615db..665e2f8 100644 --- a/docs/_build/html/_sources/customisation.txt +++ b/docs/_build/html/_sources/customisation.txt @@ -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. @@ -17,7 +17,7 @@ It has been updated for version 2.0.0. Managing layers --------------- -There is some different layers available by default in Chimère (OSM Mapnik, OSM +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 <http://openlayers.org/>`_ JS code. This JS code must diff --git a/docs/_build/html/_sources/import_export.txt b/docs/_build/html/_sources/import_export.txt index e8d283b..eb581ce 100644 --- a/docs/_build/html/_sources/import_export.txt +++ b/docs/_build/html/_sources/import_export.txt @@ -16,16 +16,19 @@ It has been updated for version 2.0.0. Importing --------- -In Chimère the import mechanism is based on **Import object**. Theses objects +In Chimère the import mechanism is based on **Import object**. These objects are stored in database to keep trace of imports and to facilitate the re-importation from the same source. In fact if possible the update of data from -a same type of source is managed. The ability to do such updates depends on the -existence of a unique id for each object on your source. +a same type of source is managed. + +.. Note:: + The ability to do such updates depends on the existence of a unique id + for each object on your source. To add an **Import object** you need to go to *Chimere > Imports* then **Add**. After that you'll have to select your source type and then the form depends on -the type of source. +this source type. Common fields ************* @@ -35,7 +38,7 @@ Common fields associated category will be use. - **SRID**: Chimère will try to identify automatically the correct projection from the given source. But sometimes the information is not present or cannot - be guessed (for instance a Shapefile that uses non standard proj file). In + be guessed (for instance a shapefile that uses non standard proj file). In this case Chimère will use WGS84 by default (the classic latitude/longitude) but it is not always correct. If you experience problems with items localisation you should put here the SRID associated to the projection of @@ -60,7 +63,7 @@ KML import file. You'll have to fill one of the two fields. - **Filter**: if you want to import only a specific *Folder* of your KML file put his name on this field. -- **Zipped file**: if your source is a KMLZ file (a zipped KML) check this case. +- **Zipped file**: if your source is a KMLZ file (a zipped KML), check this case. Shapefile import **************** @@ -68,9 +71,9 @@ Shapefile import .. image:: _static/chimere_admin_import_shapefile.png -- **Web address/source file (mandatory)**: your KML could be distant or a local - file. You'll have to fill one of the two fields. -- **Zipped file**: only zipped shapefile are accepted this checkbox have to be +- **Web address/source file (mandatory)**: your shapefile could be distant or a + local file. You'll have to fill one of the two fields. +- **Zipped file**: only zipped shapefiles are accepted so this checkbox has to be checked. GeoRSS import @@ -85,12 +88,17 @@ Simple GeoRSS and W3C GeoRSS are managed. CSV import ********** -As the format of the CSV file managed by Chimère could vary depending on the -property you have add on your Chimère instance we recommend you to first do -an export of some items in CSV with Chimère. The CSV format of the exported -file will meet Chimère requirements. By the way because of the geometry of -the item this format is not very convenient to add new content but could -be handy to update informations. +The format of the CSV file (number and order of columns) managed by Chimère +varies depending on the properties you have added on your Chimère instance. +So we recommend you to first do an export of some items in CSV with Chimère. +The CSV format of the exported file will meet Chimère requirements. + +By the way because of the geometry of the item this format is not very +convenient to add new content but could be handy to update informations. + +.. Warning:: + If you mean to update existing data by this import, do *not* modify the + geometry column. .. image:: _static/chimere_admin_import_CSV.png @@ -104,11 +112,11 @@ OpenStreetMap import .. image:: _static/chimere_admin_import_OSM.png -To import from OSM Chimère uses the XAPI API of OSM. +To import from OSM Chimère use the XAPI API of OSM. - **Web address (mandatory)**: XAPI url used to import data. This field should be filled with a default address. By default the MapQuest server is used as it - seems to be the more robust. If you experience problems with OSM import check + seems to be the more robust. If you experience problems with OSM import, check the availability of the XAPI server used and eventually change it. - **Filter area (mandatory)**: draw the bounding box you want to use for your OSM import. @@ -123,18 +131,18 @@ To import from OSM Chimère uses the XAPI API of OSM. Importing ********* -Once your new import item created. Select it in the import object list, select -the **Import** action and validated. +Once your new import item created, select it in the import object list, choose +the **Import** action and validate. -The import should be processing normally. If not an explicit error message -should be print in the state column of your import. +The import should be processing normally. If not, an explicit error message +should be printed in the state column of your import. Managing imported data ********************** All new imported items have the state **Imported**. To make them available on -the map you'll have to validate them. If you don't want an item to be visible on -the map instead of delete them it is recommended to set them to the state +the map you'll have to validate them. If you don't want some items to be visible on +the map, instead of deleting them it is recommended to set them to the state **Disabled**. .. Warning:: @@ -148,7 +156,7 @@ Export to CSV/KML/Shapefile *************************** Directly from the :ref:`geographic items list <geographic-items-management>` you -can export to the choose format. All you have to do is to select the desired +can export to the chosen format. All you have to do is to select the desired items, choose the appropriate action in the action list and validate. Export to OSM @@ -156,19 +164,19 @@ Export to OSM .. Warning:: If you are not sure of what you are doing with OSM export: don't do it! It is - really important to not mess with others data. + really important to not mess with others' data. .. Note:: Only export of OSM nodes are managed. OSM export is not that easily managed. First (if not yet done) you'll have to -define an import (:ref:`see above <osm-import>` for details). This will permit +define an import (:ref:`see above <osm-import>` for details). This will enable to determine: - the area concerned by your export. - the key/value tag to append to your new/updated items. - the subcategories concerned by your export. If you think that some items in - theses subcategories should not be in OSM database (because there are not + these subcategories should not be in OSM database (because there are not relevant or because of license issues) beforehand mark them as **Not for OSM** in the *import fields* of the :ref:`geographic items forms <geographic-items-management>`. @@ -176,23 +184,23 @@ to determine: The OSM export in Chimère is designed to be the more preservative possible in regards to OSM database. That's why before any export an import is done. If -the new import has updated data theses new data will overload data in your +the new import has updated data, these new data will overload data in your Chimère (if you don't want that: don't do export). All pending imported items should have been treated before doing an export. To launch an export select the appropriate Import object in the imports list. Then select the **Export to OSM** action and validate. Then you'll be asked for your OSM username and password and the API you want to -use. If you use regularly Chimère to do export it is recommended to create an +use. If you regularly use Chimère to do export, it is recommended to create an OSM specific account for that. The test API is available to make export test. If you want to use the test API you'll have to create a specific account on the test platform. .. Warning:: - The data on the test platform are not synced with the main platform you are - not going to have the same data that you got with XAPI. + The data on the test platform are not synced with the main platform. You won't + have the same data than the ones you got with XAPI. -Once all this field filled you can (finally!) launch the export. +Once all this field filled, you can (finally!) launch the export. When exporting tags are automatically added/updated: diff --git a/docs/_build/html/_sources/install.txt b/docs/_build/html/_sources/install.txt index f05e5f0..248ece9 100644 --- a/docs/_build/html/_sources/install.txt +++ b/docs/_build/html/_sources/install.txt @@ -78,7 +78,7 @@ Database configuration ********************** Now that postgres and postgis are installed, you need to create a new user for -chimere:: +Chimère:: su postgres createuser --echo --adduser --createdb --encrypted --pwprompt chimere-user @@ -92,8 +92,8 @@ the paths accordingly to your needs):: 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 -Install the sources -******************* +Installing the sources +********************** Choose a path to install your Chimère:: @@ -105,8 +105,7 @@ From an archive The last "stable" version is available in this `directory <http://www.peacefrogs.net/download/chimere/>`_. 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. -Extract it to the desired destination path:: +the last version for the 1.0 branch is version 1.0.2).:: wget http://www.peacefrogs.net/download/chimere -q -O -| html2text (...) @@ -127,7 +126,7 @@ readable directory:: From the git repository +++++++++++++++++++++++ -Another solution is to get the last git version:: +Another solution is to get it from the git repository:: cd $INSTALL_PATH git clone git://www.peacefrogs.net/git/chimere @@ -136,26 +135,26 @@ Another solution is to get the last git version:: git checkout v2.0 # checkout the desired version -Create a custom project template -******************************** +Creating a custom project template +********************************** -There a default project is provided (example_project). Copy and modify it (or -get another project based on Chimere):: +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 -underscores ("_") to any length. Don't begin the name by "_" because it has -special significance in Python. +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 chimere application directory create local_settings.py to fit to your +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. :: +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 @@ -167,18 +166,20 @@ settings are initialized in settings.py. :: * 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! + 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 activated) - * JQUERY_JS_URLS: list of Jquery and Jquery-ui urls (default is appropriate - for a Debian installation with Jquery and Jquery-ui activated) - * JQUERY_CSS_URLS: list of Jquery and Jquery-ui urls (default is appropriate - for a Debian installation with Jquery and Jquery-ui activated) + 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 installed) + installation with gpsbabel package installed) * TIME_ZONE: local time zone for this installation * LANGUAGE_CODE: language code for this installation @@ -203,9 +204,9 @@ Regroup static files in one path:: Compiling languages ******************* -If your language is available in the locale directory of chimere, you will just -need to get it compiled. This can be done with (here, **fr** stands for french. -Replace it with the appropriate language code):: +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 @@ -227,14 +228,14 @@ would have if the language file was already available. Database initialisation *********************** -Create the appropriate tables (still being in chimère application directory):: +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 south:: +(administration can be found at: http://where_is_chimere/admin/). Then you have +to create tables managed with Django-South:: ./manage.py migrate @@ -251,23 +252,25 @@ Webserver configuration Apache configuration with mod_wsgi ++++++++++++++++++++++++++++++++++ -Install mod_wsgi for apache:: +Install *mod_wsgi* for Apache:: apt-get install libapache2-mod-wsgi -TODO: adapt apache-wsgi.conf - Create and edit a configuration for Chimère:: - cp $INSTALL_PATH/chimere/apache/django.wsgi $INSTALL_PATH/chimere/apache/mydjango.wsgi + 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 + 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 Apache *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:: @@ -276,7 +279,7 @@ To activate the website, reload apache:: 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 +as default encoding, in the file */etc/apache2/envvars* uncomment the following line:: . /etc/default/locale diff --git a/docs/_build/html/_sources/upgrade.txt b/docs/_build/html/_sources/upgrade.txt index d7c7233..796ed98 100644 --- a/docs/_build/html/_sources/upgrade.txt +++ b/docs/_build/html/_sources/upgrade.txt @@ -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). @@ -25,8 +27,8 @@ If you are considering to contribute on Chimère get the Git master. The instruction are given for Debian Squeeze and Debian Wheezy. -Get new version of dependencies -------------------------------- +Getting new versions of dependencies +------------------------------------ Version 1.1 -> 1.2 ****************** @@ -62,8 +64,8 @@ If you are planing to do major import consider the install of `Celery apt-get install python-django-celery python-kombu -Get the new sources -------------------- +Getting the new sources +----------------------- First of all we have to get the new version of the source code. For this upgrade process, we are getting the source code from the Git @@ -102,7 +104,7 @@ From a previous Git installation From a previous tarball installation ************************************ -Remove first your old installation and get the Git version. +First remove your old installation and get the Git version. .. code-block:: bash @@ -217,7 +219,7 @@ 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 theses scripts don't forget +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. @@ -288,8 +290,8 @@ Version 1.2 -> 2.0 -> master cd $CHIMERE_PATH/chimere django-admin compilemessages -Force the upgrade of visitor's web browser cache ------------------------------------------------- +Forcing the upgrade of visitor's web browser cache +-------------------------------------------------- If major changes in the javascript has be done between version, many of your users could experience problems. There are many tricks to force the refresh diff --git a/docs/_build/html/administration.html b/docs/_build/html/administration.html index b4c3bb1..8dff6e6 100644 --- a/docs/_build/html/administration.html +++ b/docs/_build/html/administration.html @@ -63,7 +63,7 @@ </tbody> </table> <p>This document presents the administration of Chimère. -It has has been updated for version 2.0.0.</p> +It has been updated for version 2.0.0.</p> <div class="section" id="administration-pages-presentation"> <h2>Administration pages presentation<a class="headerlink" href="#administration-pages-presentation" title="Permalink to this headline">¶</a></h2> <p>Administration pages are accessible at: <a class="reference external" href="http://where_is_your_chimere/admin/">http://where_is_your_chimere/admin/</a></p> @@ -77,17 +77,17 @@ provided.</p> <div class="section" id="main-page"> <h3>Main page<a class="headerlink" href="#main-page" title="Permalink to this headline">¶</a></h3> <p>Once authentified you’ll have access to the main admin page.</p> -<p>This looks like this:</p> +<p>It looks like this:</p> <img alt="_images/chimere_admin_01.png" src="_images/chimere_admin_01.png" /> <ol class="arabic simple"> <li>links to this <strong>Documentation</strong>, to the <strong>Change password</strong> form and to -<strong>Log out</strong></li> -<li>a list of recent actions made with this account</li> +<strong>Log out</strong>,</li> +<li>the list of recent actions made with this account,</li> <li>an application title, most of your action will be in the <strong>Chimere</strong> -application</li> -<li>an item inside the application. From these page you can <strong>Add</strong> a new item or -consult/<strong>Change</strong> items. The <strong>Add</strong> link lead to the new <a class="reference internal" href="#item-form">Item form</a>. The -<strong>Change</strong> link lead to the <a class="reference internal" href="#item-list">Item list</a>. The <a class="reference internal" href="#item-list">Item list</a> is also available +application,</li> +<li>an item inside the application. From these pages you can <strong>Add</strong> a new item or +consult/<strong>Change</strong> items. The <strong>Add</strong> link leads to the new <a class="reference internal" href="#item-form">Item form</a>. The +<strong>Change</strong> link leads to the <a class="reference internal" href="#item-list">Item list</a>. The <a class="reference internal" href="#item-list">Item list</a> is also available by clicking on the item label.</li> </ol> </div> @@ -96,16 +96,16 @@ by clicking on the item label.</li> <img alt="_images/chimere_admin_02.png" src="_images/chimere_admin_02.png" /> <ol class="arabic simple"> <li>path in the admin site. This is a convenient shortcut to come back to the -main page.</li> -<li>link to create a new item from the item list</li> -<li>search items by word (not available for all type of items)</li> -<li>this filter box permit to filter current entries with some criteria (not -available for all type of items)</li> -<li>the header of the table is cliquable. Click on an header sort the items by +main page,</li> +<li>link to create a new item from the item list,</li> +<li>search items by words (not available for all item types),</li> +<li>this filter box permits to filter current entries with some criteria (not +available for all type of items),</li> +<li>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 explain the order of sorting).</li> +number on the right of the header explains the sorting order),</li> <li>each item can be checked (for applying an action) or selected (by clicking on -the first column) to see the detail and possibly edit, delete it.</li> +the first column) to see the detail and edit or delete it.</li> </ol> </div> <div class="section" id="item-form"> @@ -113,13 +113,13 @@ the first column) to see the detail and possibly edit, delete it.</li> <img alt="_images/chimere_admin_03.png" src="_images/chimere_admin_03.png" /> <ol class="arabic simple"> <li>fields for the selected item (or blank if it is a new item) are displayed in -this form. A few of the fields concerning an item are read-only and a few of -them are hidden. Mandatory fields have their label in bold. Changes on theses -fields are only effective once the form is submitted.</li> -<li>for some items there are associated sub-items. Theses associated items can be +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.</li> +<li>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.</li> -<li>the form has to be validated by one of theses actions buttons. They are +<li>the form has to be validated by one of these action buttons. They are self-explanatory.</li> </ol> </div> @@ -128,7 +128,7 @@ self-explanatory.</li> <p><em>Status</em> 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.</p> <ul class="simple"> -<li><strong>Submited</strong>: Status of a new item freshly proposed by an end user. This item +<li><strong>Submitted</strong>: Status of a new item freshly proposed by an end user. This item is not visible on the map.</li> <li><strong>Available</strong>: Status of an item visible on the map.</li> <li><strong>Disabled</strong>: Status of a discarded item.</li> @@ -143,13 +143,13 @@ or deleted).</li> <h2>Managing news<a class="headerlink" href="#managing-news" title="Permalink to this headline">¶</a></h2> <p>A news system is available. All you have to to do is to click on the <strong>Add</strong> button near News. -For each news you have to provided a name and a content. The content can contain +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.</p> </div> <div class="section" id="creating-categories-subcategories"> <h2>Creating categories/subcategories<a class="headerlink" href="#creating-categories-subcategories" title="Permalink to this headline">¶</a></h2> -<p>Before adding categories you have to set some icons. Theses icons appears on the +<p>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. @@ -160,45 +160,49 @@ To add categories: the <strong>Add</strong> button near categories (quite clear it?)</p> <p>Fields of subcategories are: an associated category, a name, an icon, an order, a color and an element type. -Theses fields are mainly quite self- explanatory. +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: <em>red</em>, <em>blue</em>, <em>yellow</em> or <em>purple</em>) otherwise you can put the HTML RVB code (for instance <em>#9227c9</em>). -The element type is the type of element the subcategory can contain: POI, route +The element type is the type of element that the subcategory can contain: POI, route or both.</p> </div> -<div class="section" id="edition-moderation-of-items"> -<span id="geographic-items-management"></span><h2>Edition/moderation of items<a class="headerlink" href="#edition-moderation-of-items" title="Permalink to this headline">¶</a></h2> +<div class="section" id="editing-or-moderating-items"> +<span id="geographic-items-management"></span><h2>Editing or moderating items<a class="headerlink" href="#editing-or-moderating-items" title="Permalink to this headline">¶</a></h2> <p>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.</p> <p>A search field is available to search by name but the more interesting is to filter POIs (or route) by state and by subcategory.</p> -<p>There is a some actions available in the action list.</p> +<p>There are some actions available in the action list:</p> <ul class="simple"> -<li><strong>Delete</strong> to delete selected items. A confirmation step is displayed.</li> -<li><strong>Validate</strong> to set the status <em>Available</em> to selected items.</li> -<li><strong>Disable</strong> to set teh status <em>Disabled</em> to selected items. This is useful to -keep items you don’t want to be exposed on the map.</li> -<li><strong>Managed modified items</strong> to manage the amendment made by end users on the -main site cf. to <a class="reference internal" href="#managing-modified"><em>Managing end user amendment</em></a>. Modified item has to be treated -one by one.</li> -<li><strong>Export to...</strong> to export selected item to the selected format.</li> +<li><strong>Delete</strong>: to delete selected items. A confirmation step is displayed,</li> +<li><strong>Validate</strong>: to set the status <em>Available</em> to selected items,</li> +<li><strong>Disable</strong>: to set the status <em>Disabled</em> to selected items. This is useful to +keep items you don’t want to be exposed on the map,</li> +<li><strong>Managed modified items</strong>: to manage the amendment made by end users on the +main site (cf. <a class="reference internal" href="fr/administration.html#managing-modified"><em>Managing end user amendment</em></a>). Modified item has to be treated +one by one,</li> +<li><strong>Export to...</strong>: to export selected item to the selected format.</li> +</ul> +<p>To modify an item, classically you have to click on its name. +Then you access to a form to freely modify the item.</p> +<img alt="_static/chimere_admin_modify_item.png" src="_static/chimere_admin_modify_item.png" /> +<p>In this form there are all data available to the end user form plus some extra +fields.</p> +<ul class="simple"> +<li>The <em>Import fields</em> only make sense with data imported from an external +source or for data to be exported to OSM (cf. the <a class="reference internal" href="import_export.html#importing"><em>import section</em></a> of this documentation),</li> +<li><em>Associated items fields</em> 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).</li> </ul> -<p>To modify an item, classically you have to click on his name. -Then you access to a form to freely modify the item. -In this form there is all data available to the end user form plus some extra -fields. -- The <em>Import fields</em> only make sense with data imported from an external -source or for data to be exported to OSM cf. to the <a class="reference internal" href="import_export.html#importing"><em>import section</em></a> of this documentation. -- <em>Associated items fields</em> are read only fields that list items associated to -the current one (reference item of an amendment, associated file of a route).</p> <p>Associated multimedia items are at the bottom of the form. You can freely add, change items and change their order with drag and drop.</p> <p>Don’t forget to validate your change with one of the <strong>Save</strong> buttons at the -bottom of the form (it is easily forgot when you change multimedia items).</p> -<p>If an item is not relevant the <strong>Delete</strong> button permit to remove it.</p> +bottom of the form (it is easily forgotten when you change multimedia items).</p> +<p>If an item is not relevant the <strong>Delete</strong> button enables to remove it.</p> </div> <div class="section" id="managing-end-user-amendment"> <span id="managing-modified"></span><h2>Managing end user amendment<a class="headerlink" href="#managing-end-user-amendment" title="Permalink to this headline">¶</a></h2> @@ -208,21 +212,24 @@ to the reference item modified.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">If you are logged as an administrator and make changes on the map with the -end user form there will be directly validated.</p> +end user form they will be directly validated.</p> </div> -<p>A special form has been developed to facilitate the processing of theses +<p>A special form has been developed to facilitate the processing of these modified items.</p> <p>You can access to this special form with the action <em>Managed modified items</em>.</p> <img alt="_images/chimere_admin_modified_management.png" src="_images/chimere_admin_modified_management.png" /> <p>This form is a table with three columns.</p> <ol class="arabic simple"> -<li>The first column display the information for the reference item.</li> -<li>The second column display the information proposed by the submitter.</li> +<li>The first column displays the information for the reference item,</li> +<li>The second column displays the information proposed by the submitter,</li> <li>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.</li> </ol> -<p>To reject all modification validate the form with no checkbox checked.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">To reject all modification validate the form with no checkbox checked.</p> +</div> </div> </div> @@ -245,7 +252,7 @@ reference item.</li> </li> <li><a class="reference internal" href="#managing-news">Managing news</a></li> <li><a class="reference internal" href="#creating-categories-subcategories">Creating categories/subcategories</a></li> -<li><a class="reference internal" href="#edition-moderation-of-items">Edition/moderation of items</a></li> +<li><a class="reference internal" href="#editing-or-moderating-items">Editing or moderating items</a></li> <li><a class="reference internal" href="#managing-end-user-amendment">Managing end user amendment</a></li> </ul> </li> diff --git a/docs/_build/html/configuration.html b/docs/_build/html/configuration.html index b86ec1a..e0be85b 100644 --- a/docs/_build/html/configuration.html +++ b/docs/_build/html/configuration.html @@ -74,7 +74,7 @@ CHIMERE_APP_PATH=$CHIMERE_PATH/$CHIMERE_LOCALNAME</pre> configure <em>your</em> Chimère.</p> <p>Most of these steps are done in the web administration pages.</p> <p>If you are not familiar with <em>Django-like</em> administration pages you can look -at the first paragraph of <a class="reference internal" href="administration.html#administration"><em>Administration</em></a> where it is presented.</p> +at the first paragraph of <a class="reference internal" href="fr/administration.html#administration"><em>Administration</em></a> where it is presented.</p> <p>To access these pages you have to identify you with an account with <em>staff</em> and <em>superuser</em> status.</p> <p>A <em>superuser</em> account is created at the initialization of the database.</p> @@ -121,8 +121,8 @@ available by default. You can add new custom layer cf. <a class="reference inter </ul> <p><em>Areas</em> are customizable directly on the web administration interface in <em>Chimere > Areas</em>.</p> -<p>As there is little chance that the default area is appropriate for you, you’ll -have to set at least one default area.</p> +<p>As there is little chance that the default area should be appropriated for you, +you’ll have to set at least one default area.</p> <p>Adding many area can be a mean to show your map in different flavors.</p> </div> <div class="section" id="managing-users"> diff --git a/docs/_build/html/customisation.html b/docs/_build/html/customisation.html index 62f864c..594f8e4 100644 --- a/docs/_build/html/customisation.html +++ b/docs/_build/html/customisation.html @@ -58,11 +58,11 @@ </tr> </tbody> </table> -<p>This document presents the installation of Chimère. +<p>This document presents the customisation of Chimère. It has been updated for version 2.0.0.</p> <div class="section" id="managing-layers"> <span id="id1"></span><h2>Managing layers<a class="headerlink" href="#managing-layers" title="Permalink to this headline">¶</a></h2> -<p>There is some different layers available by default in Chimère (OSM Mapnik, OSM +<p>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 <a class="reference external" href="http://openlayers.org/">Openlayers</a> JS code. This JS code must diff --git a/docs/_build/html/import_export.html b/docs/_build/html/import_export.html index acfb5eb..5a0dcd4 100644 --- a/docs/_build/html/import_export.html +++ b/docs/_build/html/import_export.html @@ -66,14 +66,18 @@ It has been updated for version 2.0.0.</p> <div class="section" id="importing"> <span id="id1"></span><h2>Importing<a class="headerlink" href="#importing" title="Permalink to this headline">¶</a></h2> -<p>In Chimère the import mechanism is based on <strong>Import object</strong>. Theses objects +<p>In Chimère the import mechanism is based on <strong>Import object</strong>. 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.</p> +a same type of source is managed.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">The ability to do such updates depends on the existence of a unique id +for each object on your source.</p> +</div> <p>To add an <strong>Import object</strong> you need to go to <em>Chimere > Imports</em> then <strong>Add</strong>.</p> <p>After that you’ll have to select your source type and then the form depends on -the type of source.</p> +this source type.</p> <div class="section" id="common-fields"> <h3>Common fields<a class="headerlink" href="#common-fields" title="Permalink to this headline">¶</a></h3> <ul class="simple"> @@ -82,7 +86,7 @@ this is the name that will be used. If this field is empty the name of the associated category will be use.</li> <li><strong>SRID</strong>: 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 @@ -105,16 +109,16 @@ associated to newly imported items.</li> file. You’ll have to fill one of the two fields.</li> <li><strong>Filter</strong>: if you want to import only a specific <em>Folder</em> of your KML file put his name on this field.</li> -<li><strong>Zipped file</strong>: if your source is a KMLZ file (a zipped KML) check this case.</li> +<li><strong>Zipped file</strong>: if your source is a KMLZ file (a zipped KML), check this case.</li> </ul> </div> <div class="section" id="shapefile-import"> <h3>Shapefile import<a class="headerlink" href="#shapefile-import" title="Permalink to this headline">¶</a></h3> <img alt="_images/chimere_admin_import_shapefile.png" src="_images/chimere_admin_import_shapefile.png" /> <ul class="simple"> -<li><strong>Web address/source file (mandatory)</strong>: your KML could be distant or a local -file. You’ll have to fill one of the two fields.</li> -<li><strong>Zipped file</strong>: only zipped shapefile are accepted this checkbox have to be +<li><strong>Web address/source file (mandatory)</strong>: your shapefile could be distant or a +local file. You’ll have to fill one of the two fields.</li> +<li><strong>Zipped file</strong>: only zipped shapefiles are accepted so this checkbox has to be checked.</li> </ul> </div> @@ -128,12 +132,17 @@ checked.</li> </div> <div class="section" id="csv-import"> <h3>CSV import<a class="headerlink" href="#csv-import" title="Permalink to this headline">¶</a></h3> -<p>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.</p> +<p>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.</p> +<p>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.</p> +<div class="admonition warning"> +<p class="first admonition-title">Warning</p> +<p class="last">If you mean to update existing data by this import, do <em>not</em> modify the +geometry column.</p> +</div> <img alt="_images/chimere_admin_import_CSV.png" src="_images/chimere_admin_import_CSV.png" /> <ul class="simple"> <li><strong>Web address/source file (mandatory)</strong>: your CSV file could be distant or a @@ -143,11 +152,11 @@ local file. You’ll have to fill one of the two fields.</li> <div class="section" id="openstreetmap-import"> <span id="osm-import"></span><h3>OpenStreetMap import<a class="headerlink" href="#openstreetmap-import" title="Permalink to this headline">¶</a></h3> <img alt="_images/chimere_admin_import_OSM.png" src="_images/chimere_admin_import_OSM.png" /> -<p>To import from OSM Chimère uses the XAPI API of OSM.</p> +<p>To import from OSM Chimère use the XAPI API of OSM.</p> <ul class="simple"> <li><strong>Web address (mandatory)</strong>: 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.</li> <li><strong>Filter area (mandatory)</strong>: draw the bounding box you want to use for your OSM import.</li> @@ -161,16 +170,16 @@ You have to hit this button before validating the form.</li> </div> <div class="section" id="id2"> <h3>Importing<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3> -<p>Once your new import item created. Select it in the import object list, select -the <strong>Import</strong> action and validated.</p> -<p>The import should be processing normally. If not an explicit error message -should be print in the state column of your import.</p> +<p>Once your new import item created, select it in the import object list, choose +the <strong>Import</strong> action and validate.</p> +<p>The import should be processing normally. If not, an explicit error message +should be printed in the state column of your import.</p> </div> <div class="section" id="managing-imported-data"> <h3>Managing imported data<a class="headerlink" href="#managing-imported-data" title="Permalink to this headline">¶</a></h3> <p>All new imported items have the state <strong>Imported</strong>. 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 <strong>Disabled</strong>.</p> <div class="admonition warning"> <p class="first admonition-title">Warning</p> @@ -183,8 +192,8 @@ is particularly important if you want to export your data to OSM.</p> <h2>Exporting<a class="headerlink" href="#exporting" title="Permalink to this headline">¶</a></h2> <div class="section" id="export-to-csv-kml-shapefile"> <h3>Export to CSV/KML/Shapefile<a class="headerlink" href="#export-to-csv-kml-shapefile" title="Permalink to this headline">¶</a></h3> -<p>Directly from the <a class="reference internal" href="administration.html#geographic-items-management"><em>geographic items list</em></a> you -can export to the choose format. All you have to do is to select the desired +<p>Directly from the <a class="reference internal" href="fr/administration.html#geographic-items-management"><em>geographic items list</em></a> 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.</p> </div> <div class="section" id="export-to-osm"> @@ -192,41 +201,41 @@ items, choose the appropriate action in the action list and validate.</p> <div class="admonition warning"> <p class="first admonition-title">Warning</p> <p class="last">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.</p> +really important to not mess with others’ data.</p> </div> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">Only export of OSM nodes are managed.</p> </div> <p>OSM export is not that easily managed. First (if not yet done) you’ll have to -define an import (<a class="reference internal" href="#osm-import"><em>see above</em></a> for details). This will permit +define an import (<a class="reference internal" href="#osm-import"><em>see above</em></a> for details). This will enable to determine:</p> <ul class="simple"> <li>the area concerned by your export.</li> <li>the key/value tag to append to your new/updated items.</li> <li>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 <strong>Not for OSM</strong> -in the <em>import fields</em> of the <a class="reference internal" href="administration.html#geographic-items-management"><em>geographic items forms</em></a>.</li> +in the <em>import fields</em> of the <a class="reference internal" href="fr/administration.html#geographic-items-management"><em>geographic items forms</em></a>.</li> </ul> <p>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.</p> <p>To launch an export select the appropriate Import object in the imports list. Then select the <strong>Export to OSM</strong> 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.</p> <div class="admonition warning"> <p class="first admonition-title">Warning</p> -<p class="last">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.</p> +<p class="last">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.</p> </div> -<p>Once all this field filled you can (finally!) launch the export.</p> +<p>Once all this field filled, you can (finally!) launch the export.</p> <p>When exporting tags are automatically added/updated:</p> <ul class="simple"> <li><em>name</em>: get from the item name in Chimère.</li> diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html index 216ee3f..1747ece 100644 --- a/docs/_build/html/index.html +++ b/docs/_build/html/index.html @@ -51,19 +51,19 @@ <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a><ul> <li class="toctree-l2"><a class="reference internal" href="install.html#prerequisites">Prerequisites</a></li> <li class="toctree-l2"><a class="reference internal" href="install.html#database-configuration">Database configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="install.html#install-the-sources">Install the sources</a></li> -<li class="toctree-l2"><a class="reference internal" href="install.html#create-a-custom-project-template">Create a custom project template</a></li> +<li class="toctree-l2"><a class="reference internal" href="install.html#installing-the-sources">Installing the sources</a></li> +<li class="toctree-l2"><a class="reference internal" href="install.html#creating-a-custom-project-template">Creating a custom project template</a></li> <li class="toctree-l2"><a class="reference internal" href="install.html#compiling-languages">Compiling languages</a></li> <li class="toctree-l2"><a class="reference internal" href="install.html#database-initialisation">Database initialisation</a></li> <li class="toctree-l2"><a class="reference internal" href="install.html#webserver-configuration">Webserver configuration</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="upgrade.html">Upgrade</a><ul> -<li class="toctree-l2"><a class="reference internal" href="upgrade.html#get-new-version-of-dependencies">Get new version of dependencies</a></li> -<li class="toctree-l2"><a class="reference internal" href="upgrade.html#get-the-new-sources">Get the new sources</a></li> +<li class="toctree-l2"><a class="reference internal" href="upgrade.html#getting-new-versions-of-dependencies">Getting new versions of dependencies</a></li> +<li class="toctree-l2"><a class="reference internal" href="upgrade.html#getting-the-new-sources">Getting the new sources</a></li> <li class="toctree-l2"><a class="reference internal" href="upgrade.html#migrate-database">Migrate database</a></li> <li class="toctree-l2"><a class="reference internal" href="upgrade.html#update-translations">Update translations</a></li> -<li class="toctree-l2"><a class="reference internal" href="upgrade.html#force-the-upgrade-of-visitor-s-web-browser-cache">Force the upgrade of visitor’s web browser cache</a></li> +<li class="toctree-l2"><a class="reference internal" href="upgrade.html#forcing-the-upgrade-of-visitor-s-web-browser-cache">Forcing the upgrade of visitor’s web browser cache</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a><ul> @@ -77,7 +77,7 @@ <li class="toctree-l2"><a class="reference internal" href="administration.html#administration-pages-presentation">Administration pages presentation</a></li> <li class="toctree-l2"><a class="reference internal" href="administration.html#managing-news">Managing news</a></li> <li class="toctree-l2"><a class="reference internal" href="administration.html#creating-categories-subcategories">Creating categories/subcategories</a></li> -<li class="toctree-l2"><a class="reference internal" href="administration.html#edition-moderation-of-items">Edition/moderation of items</a></li> +<li class="toctree-l2"><a class="reference internal" href="administration.html#editing-or-moderating-items">Editing or moderating items</a></li> <li class="toctree-l2"><a class="reference internal" href="administration.html#managing-end-user-amendment">Managing end user amendment</a></li> </ul> </li> diff --git a/docs/_build/html/install.html b/docs/_build/html/install.html index 3121524..6aaf672 100644 --- a/docs/_build/html/install.html +++ b/docs/_build/html/install.html @@ -130,7 +130,7 @@ to the applications’ websites.</p> <div class="section" id="database-configuration"> <h2>Database configuration<a class="headerlink" href="#database-configuration" title="Permalink to this headline">¶</a></h2> <p>Now that postgres and postgis are installed, you need to create a new user for -chimere:</p> +Chimère:</p> <div class="highlight-python"><pre>su postgres createuser --echo --adduser --createdb --encrypted --pwprompt chimere-user</pre> </div> @@ -143,8 +143,8 @@ psql -d chimere -f /usr/share/postgresql/$PG_VERSION/contrib/postgis-1.5/postgis psql -d chimere -f /usr/share/postgresql/$PG_VERSION/contrib/postgis-1.5/spatial_ref_sys.sql</pre> </div> </div> -<div class="section" id="install-the-sources"> -<h2>Install the sources<a class="headerlink" href="#install-the-sources" title="Permalink to this headline">¶</a></h2> +<div class="section" id="installing-the-sources"> +<h2>Installing the sources<a class="headerlink" href="#installing-the-sources" title="Permalink to this headline">¶</a></h2> <p>Choose a path to install your Chimère:</p> <div class="highlight-python"><pre>INSTALL_PATH=/var/local/django mkdir $INSTALL_PATH</pre> @@ -153,8 +153,7 @@ mkdir $INSTALL_PATH</pre> <h3>From an archive<a class="headerlink" href="#from-an-archive" title="Permalink to this headline">¶</a></h3> <p>The last “stable” version is available in this <a class="reference external" href="http://www.peacefrogs.net/download/chimere/">directory</a>. 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. -Extract it to the desired destination path:</p> +the last version for the 1.0 branch is version 1.0.2).:</p> <div class="highlight-python"><pre>wget http://www.peacefrogs.net/download/chimere -q -O -| html2text (...) [[ ]] chimere-1.0.0.tar.bz2 17-Nov-2010 16:51 53K @@ -173,7 +172,7 @@ chown -R myusername:www-data chimere</pre> </div> <div class="section" id="from-the-git-repository"> <h3>From the git repository<a class="headerlink" href="#from-the-git-repository" title="Permalink to this headline">¶</a></h3> -<p>Another solution is to get the last git version:</p> +<p>Another solution is to get it from the git repository:</p> <div class="highlight-python"><pre>cd $INSTALL_PATH git clone git://www.peacefrogs.net/git/chimere cd chimere @@ -182,23 +181,23 @@ git checkout v2.0 # checkout the desired version</pre> </div> </div> </div> -<div class="section" id="create-a-custom-project-template"> -<h2>Create a custom project template<a class="headerlink" href="#create-a-custom-project-template" title="Permalink to this headline">¶</a></h2> -<p>There a default project is provided (example_project). Copy and modify it (or -get another project based on Chimere):</p> +<div class="section" id="creating-a-custom-project-template"> +<h2>Creating a custom project template<a class="headerlink" href="#creating-a-custom-project-template" title="Permalink to this headline">¶</a></h2> +<p>There, a default project is provided (<em>example_project</em>). Copy and modify +it (or get another project based on Chimère):</p> <div class="highlight-python"><pre>cd $INSTALL_PATH/chimere cp -ra example_project mychimere_project</pre> </div> <p>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 -underscores (“_”) to any length. Don’t begin the name by “_” because it has -special significance in Python.</p> -<p>In your chimere application directory create local_settings.py to fit to your +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.</p> +<p>In your Chimère application directory create <em>local_settings.py</em> 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.</p> +A base template is provided (<em>local_settings.py.example</em>) and short descriptions +of the more relevant fields are given below (at least check them). Most of +these settings are initialized in <em>settings.py</em>.</p> <div class="highlight-python"><pre>cd $INSTALL_PATH/chimere/mychimere_project cp local_settings.py.sample local_settings.py vim local_settings.py</pre> @@ -212,18 +211,20 @@ vim local_settings.py</pre> <li>PROJECT_NAME: name of the project</li> <li>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!</li> +unpredictable value. <strong>Change it!</strong></li> <li>ROOT_URLCONF: url configuration for your project something like: ‘mychimere_project.urls’</li> <li>EMAIL_HOST: smtp of an email server to send emails</li> <li>TINYMCE_URL: url to tinymce path (default is appropriate for a Debian -installation with tinymce activated)</li> -<li>JQUERY_JS_URLS: list of Jquery and Jquery-ui urls (default is appropriate -for a Debian installation with Jquery and Jquery-ui activated)</li> -<li>JQUERY_CSS_URLS: list of Jquery and Jquery-ui urls (default is appropriate -for a Debian installation with Jquery and Jquery-ui activated)</li> +installation with tinymce package installed)</li> +<li>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)</li> +<li>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)</li> <li>GPSBABEL: path to gpsbabel (default is appropriate for a Debian -installation with gpsbabel installed)</li> +installation with gpsbabel package installed)</li> <li>TIME_ZONE: local time zone for this installation</li> <li>LANGUAGE_CODE: language code for this installation</li> </ul> @@ -249,9 +250,9 @@ chmod -R g+w /var/log/django/</pre> </div> <div class="section" id="compiling-languages"> <h2>Compiling languages<a class="headerlink" href="#compiling-languages" title="Permalink to this headline">¶</a></h2> -<p>If your language is available in the locale directory of chimere, you will just -need to get it compiled. This can be done with (here, <strong>fr</strong> stands for french. -Replace it with the appropriate language code):</p> +<p>If your language is available in the directory <em>chimere/locale/</em>, you will just +need to get it compiled. This can be done with the following command (here, +<strong>fr</strong> stands for French, replace it with the appropriate language code):</p> <div class="highlight-python"><pre>cd $INSTALL_PATH/chimere/chimere/ django-admin compilemessages</pre> </div> @@ -268,13 +269,13 @@ would have if the language file was already available.</p> </div> <div class="section" id="database-initialisation"> <h2>Database initialisation<a class="headerlink" href="#database-initialisation" title="Permalink to this headline">¶</a></h2> -<p>Create the appropriate tables (still being in chimère application directory):</p> +<p>Create the appropriate tables (still being in your Chimère project directory):</p> <div class="highlight-python"><pre>cd $INSTALL_PATH/chimere/mychimere_project ./manage.py syncdb</pre> </div> <p>You will be prompted for the creation of an administrator account -(administration can be found at: <a class="reference external" href="http://where_is_chimere/admin">http://where_is_chimere/admin</a>). Then you have -to create tables managed with south:</p> +(administration can be found at: <a class="reference external" href="http://where_is_chimere/admin/">http://where_is_chimere/admin/</a>). Then you have +to create tables managed with Django-South:</p> <div class="highlight-python"><pre>./manage.py migrate</pre> </div> <p>The database is set, congratulations!</p> @@ -287,26 +288,29 @@ an already populated instance!):</p> <h2>Webserver configuration<a class="headerlink" href="#webserver-configuration" title="Permalink to this headline">¶</a></h2> <div class="section" id="apache-configuration-with-mod-wsgi"> <h3>Apache configuration with mod_wsgi<a class="headerlink" href="#apache-configuration-with-mod-wsgi" title="Permalink to this headline">¶</a></h3> -<p>Install mod_wsgi for apache:</p> +<p>Install <em>mod_wsgi</em> for Apache:</p> <div class="highlight-python"><pre>apt-get install libapache2-mod-wsgi</pre> </div> -<p>TODO: adapt apache-wsgi.conf</p> <p>Create and edit a configuration for Chimère:</p> -<div class="highlight-python"><pre>cp $INSTALL_PATH/chimere/apache/django.wsgi $INSTALL_PATH/chimere/apache/mydjango.wsgi +<div class="highlight-python"><pre>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 +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/</pre> +mkdir /var/log/apache2/chimere/ +chown www-data /var/log/apache2/chimere/</pre> </div> -<p>Adapt the files <em>mydjango.wsgi</em> (with the correct sys path) and Apache <em>chimere</em>.</p> +<p>Adapt the files <em>mydjango.wsgi</em> (with the correct sys path and the correct +module) and Apache <em>chimere</em> (with the correct servername and correct paths).</p> <p>To activate the website, reload apache:</p> <div class="highlight-python"><pre>a2ensite chimere /etc/init.d/apache2 reload</pre> </div> <p>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 <em>/etc/apache2/envvars</em>, uncomment the following +as default encoding, in the file <em>/etc/apache2/envvars</em> uncomment the following line:</p> <div class="highlight-python"><pre>. /etc/default/locale</pre> </div> @@ -325,12 +329,12 @@ line:</p> <li><a class="reference internal" href="#">Installation</a><ul> <li><a class="reference internal" href="#prerequisites">Prerequisites</a></li> <li><a class="reference internal" href="#database-configuration">Database configuration</a></li> -<li><a class="reference internal" href="#install-the-sources">Install the sources</a><ul> +<li><a class="reference internal" href="#installing-the-sources">Installing the sources</a><ul> <li><a class="reference internal" href="#from-an-archive">From an archive</a></li> <li><a class="reference internal" href="#from-the-git-repository">From the git repository</a></li> </ul> </li> -<li><a class="reference internal" href="#create-a-custom-project-template">Create a custom project template</a></li> +<li><a class="reference internal" href="#creating-a-custom-project-template">Creating a custom project template</a></li> <li><a class="reference internal" href="#compiling-languages">Compiling languages</a></li> <li><a class="reference internal" href="#database-initialisation">Database initialisation</a></li> <li><a class="reference internal" href="#webserver-configuration">Webserver configuration</a><ul> diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv index ef560f1..85f3dfc 100644 --- a/docs/_build/html/objects.inv +++ b/docs/_build/html/objects.inv @@ -2,6 +2,5 @@ # Project: Chimère # Version: 2.0 # The remainder of this file is compressed using zlib. -xڍMj0 >ݺb9Ɗ# 3o ; .S$ƫ̬-M<pA?ƛ=XlhG2'` -G^GƹƝ -$3]V;|dRa[8LrK[y];#C$z-Iº.-0>n\2GqZ% ?YYgC|kyv{ENU+?sBb_1c
\ No newline at end of file +xڍMj0 >ݦCu9 ,fУ XapB%« |ͫE}5Oz:ޚQܭW1BZq_4 +P q ɻéngYW@T=:NSrb \O05r}w0}Q:2\f)a:8zKxL
'=1/kGϻWxM >Ftc c_Q
\ No newline at end of file diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index 15f7cce..55c5904 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({objects:{},terms:{all:[2,1],code:[0,1],forget:1,yellow:1,osm:[0,1,2],abil:2,row:1,categori:[3,1,2],depend:[3,2],xapi:2,specif:2,cach:3,sens:1,sourc:[3,1,2],django:0,mechan:2,veri:2,relev:[2,1],administr:[0,1,2,3],button:[2,1],list:[2,1],geograph:[2,1],"try":2,item:[3,1,2],initialis:3,teh:1,sync:2,second:1,design:[0,2,3],click:1,append:2,blue:1,what:2,appear:1,section:1,multimedia:1,overload:2,current:1,delet:[2,1],version:[0,1,2,3],"new":[0,1,2,3],here:2,georss:2,modif:1,address:2,path:1,modifi:[0,1],valu:[2,1],box:[2,1],search:1,larger:0,permit:[2,1],action:[2,1],chang:[0,1,2],extra:[0,1],appli:1,put:[2,1],api:[0,2],subcategori:[3,1,2],visibl:[2,1],instal:[0,3],select:[2,1],from:[2,1],zip:2,two:2,few:1,criteria:1,type:[0,1,2],more:[0,1,2],sort:1,where_is_your_chimer:1,desir:2,site:[3,1],warn:2,templat:[0,3],given:2,easiest:0,must:0,account:[2,1],word:1,sometim:2,work:1,uniqu:2,can:[0,1,2],meet:2,process:[2,1],accept:2,tag:[2,1],want:[0,1,2],mapnik:0,alwai:2,end:[0,1,3],freshli:1,pure:0,reject:1,instead:2,csv:2,simpl:[2,1],css:0,updat:[0,1,2,3],map:[0,1,2],mess:2,after:[2,1],befor:[2,1],date:[0,1,2],multipl:1,associ:[2,1],third:1,bing:0,explicit:2,element:1,issu:2,inform:[2,1],order:[2,1],origin:2,checkbox:[2,1],help:2,becaus:2,mainli:[0,1],style:0,fit:0,platform:2,pend:2,hidden:1,main:[2,1],them:[2,1],thei:1,handi:2,framework:3,facilit:[2,1],now:1,choic:2,document:[0,1,2,3],name:[0,1,2],edit:[3,1],drop:1,refresh:2,easili:[2,1],localis:2,each:[0,1,2],mean:1,compil:3,recommend:2,replac:1,realli:2,forgot:1,http:1,special:1,out:1,newli:[2,1],content:[2,1],print:2,got:2,correct:2,red:1,insid:1,migrat:3,differ:0,standard:2,base:2,ask:2,"9227c9":1,care:[2,1],launch:2,could:2,keep:[2,1],filter:[2,1],isn:1,geometri:2,think:2,first:[2,1],oper:1,directli:[2,1],onc:[2,1],number:1,yourself:1,done:[0,2],blank:1,size:1,guess:2,data:[2,1],licens:2,system:1,messag:2,attach:1,conveni:[2,1],"final":2,store:2,copi:0,consult:1,kind:0,provid:[2,1],remov:1,project:[3,2],browser:3,latitud:2,beforehand:2,ani:2,myproject:0,have:[2,1],tabl:1,need:[0,1,2],seem:2,"null":2,self:1,note:[2,1],also:1,compat:0,sure:2,trace:2,normal:2,usernam:2,object:2,most:1,why:2,sub:1,don:[2,1],url:[2,1],clear:1,inde:1,determin:2,databas:[3,2],came:2,visitor:3,particularli:2,find:2,chimer:[0,1,2],access:1,onli:[0,1,2],layout:[0,3],copyright:[0,1,2],explain:1,configur:3,should:2,cliquabl:1,folder:2,local:2,hit:2,get:[3,2],regularli:2,cannot:2,requir:2,common:2,contain:1,where:2,set:[2,1],"chim\u00e8r":[0,1,2,3],see:[2,1],mandatori:[2,1],arg:2,concern:[2,1],statu:1,correctli:1,vari:2,label:1,state:[2,1],between:2,"import":[3,1,2],experi:2,kei:[0,2],purpl:1,cyclemap:0,both:1,shapefil:2,admin:1,instanc:[0,1,2],logic:0,freeli:1,login:1,color:1,header:1,colon:0,poi:1,mapquest:[0,2],duplic:2,quit:1,coupl:2,come:1,three:1,empti:2,example_project:0,treat:[2,1],interest:1,basic:1,convert:2,understand:1,present:[0,1,2,3],"case":2,look:1,amend:[3,1],properti:[3,1,2],defin:[0,2],abov:2,error:2,openstreetmap:2,layer:[0,3],kmlz:2,"\u00e9tienn":[0,1,2],customis:[0,3],develop:1,welcom:3,author:[0,1,2],make:[2,1],same:[2,1],read:1,html:[0,1],descend:1,eventu:2,wgs84:2,webserv:3,effect:1,user:[3,1],mani:1,extern:1,robust:2,recent:1,appropri:[0,2],moder:[3,1],choos:2,entri:1,well:0,non:2,thi:[0,1,2],english:1,model:3,rout:1,propos:1,identifi:[2,1],distant:2,yet:2,languag:[0,3],web:[0,2,3],expos:1,shortcut:1,identif:1,add:[0,1,2],valid:[2,1],save:1,explanatori:1,real:1,applic:1,format:[2,1],preserv:2,password:[2,1],like:1,semi:0,server:2,authentifi:1,resiz:1,page:[0,1,2,3],right:1,some:[0,1,2],back:1,"export":[3,1,2],transport:0,lead:1,confirm:1,kml:2,proj:2,slash:1,refer:[0,1],plu:1,bold:1,step:1,prerequisit:3,srid:2,column:[2,1],manag:[0,1,2,3],discard:1,disabl:[2,1],effici:1,submitt:1,bound:2,automat:2,upgrad:3,been:[0,1,2],openlay:0,mark:2,your:[0,1,2],w3c:2,log:1,wai:[0,2],area:[0,2,3],lok:[0,1,2],submit:1,custom:[0,3],avail:[0,1,2],icon:1,form:[2,1],forc:3,ascend:1,regard:2,link:[0,1,2],translat:3,made:[0,1],possibl:[2,1],"default":[0,2],displai:1,otherwis:1,problem:2,rvb:1,featur:2,aerial:0,creat:[3,1,2],classic:[2,1],exist:2,file:[0,1,2],check:[2,1],fill:2,titl:1,when:[2,1],detail:[0,1,2],field:[2,1],other:2,test:2,you:[0,1,2],node:2,draw:[2,1],drag:1,longitud:2,directori:0,bottom:1,fact:[2,1]},objtypes:{},titles:["Customisation","Administration","Import/export","Welcome to Chim\u00e8re’s documentation!"],objnames:{},filenames:["customisation","administration","import_export","index"]})
\ No newline at end of file +Search.setIndex({objects:{},terms:{all:[6,2,4,7],code:[0,1,2,4,5,8],forget:[2,4],rentrer:1,"d\u00e9j\u00e0":1,wsgi:[1,2,5],yellow:4,signific:[2,5],osm:[8,0,7,4,6],conteneur:8,abil:6,fourni:[1,8],"\u00e9tape":8,redimensionn:8,row:4,votr:1,categori:[3,7,4,6],utilisateur:[1,8],hold:7,depend:[3,2,5,6],backup:2,zone:5,donner:8,"mani\u00e8r":[1,8],xapi:6,specif:[6,5],send:5,easiest:0,init:[1,5],revenir:8,visitor:[3,2],sens:4,"r\u00e9f\u00e9rez":1,"\u00e9quival":1,valeur:[1,8],"apr\u00e8":8,sourc:[3,1,2,4,5,6,8],string:[2,5],prendr:1,"valid\u00e9":8,parfoi:8,util:8,plusieur:8,mechan:6,veri:6,garder:8,voir:8,relev:[6,4,5],tri:8,"\u00e9cart\u00e9":8,administr:[0,1,3,4,5,6,7,8],button:[6,7,4],list:[6,1,8,4,5],geograph:[6,7,4,5],"pr\u00e9sentat":8,"try":6,item:[3,7,4,6],checkout:[1,2,5],courriel:1,signif:1,loaddata:[1,5],"proc\u00e9dur":1,"initialis\u00e9":1,initialis:[3,1,2,7,5],dir:[1,5],osgeo:1,teh:[],version:[0,1,2,3,4,5,6,7,8],"sp\u00e9cifiqu":8,"derni\u00e8r":1,sync:6,sign:5,second:[8,4],droit:8,design:[0,6,3],follow:[2,7,5],download:[1,5],further:2,myusernam:[1,5],click:[7,4],append:6,integr:2,blue:[8,4],what:6,lettr:1,appear:4,feedpars:[1,2,5],section:[8,7,4],multimedia:[7,4],abl:7,quelqu:[1,8],overload:6,"\u00e9l\u00e9ment":8,current:[2,4,7],delet:[6,7,4],simpliest:5,sur:[1,8],effectif:8,peuvent:8,"new":[0,2,3,4,5,6,7],net:[1,2,5],fuseau:1,cela:[1,8],celeri:[1,2,5],administrateur:[1,8],chose:1,"d\u00e9compressez":1,createdb:[1,5],supprim:8,here:[6,5],georss:6,"005k":2,modif:[8,7,4],free:5,"\u00e9tait":1,address:6,ver:[1,8],modifi:[0,4,5,6,7,8],sinc:5,valu:[6,2,4,5],"m\u00eame":[1,8],box:[6,7,4],search:4,larger:0,envoy:1,later:[2,7],permit:[7,4],action:[6,8,4],chang:[0,2,4,5,6,7],changer:8,chanc:7,environn:2,"mod\u00e9rateur":8,"d\u00e9sir\u00e9":1,repositori:[2,5],extra:[0,4],appli:[2,4,7],modul:[1,5],"syst\u00e8m":8,apt:[1,2,5],vim:[1,2,5],postgi:[1,5],api:[0,6],subcategori:[3,7,4,6],visibl:[6,8,4],marker:2,instal:[3,1,2,5,7,8],"cr\u00e9ation":1,select:[6,7,4],from:[6,2,4,5],patron:1,zip:6,univers:[1,5],upgrad:[3,2],next:2,websit:[7,5],few:[7,4],usr:[1,2,5],criteria:4,"\u00eate":8,"r\u00e9ell":8,assez:8,type:[0,1,4,5,6,7,8],more:[0,7,4,5,6],sort:[7,4],ensuit:[1,8],where_is_your_chimer:[8,4],desir:[6,5],filtrer:8,"utilis\u00e9":[1,8],relat:5,commencez:1,server_url:2,fonction:1,site:[3,1,4,5,7,8],warn:[6,8],parlent:8,migrate_properti:2,templat:[0,2,5,3],aux:[1,8],moin:1,recommand:5,unpack:5,cach:[3,2,7],"rattach\u00e9":8,must:[0,2,7,5],psql:[1,5],account:[6,7,4,5],word:4,sometim:6,hour:7,trouvent:1,car:1,prepar:2,work:[2,4,7],uniqu:[6,1,7,5],pour:[1,8],soup:[1,5],"g\u00e9rer":8,modifiez:1,can:[0,2,4,5,6,7],lc_messag:[1,5],meet:6,"g\u00e9rez":1,root:[1,5],obliqu:8,control:7,abord:[1,8],prompt:5,tar:[1,5],give:7,process:[6,2,4],requi:1,share:[1,5],accept:6,listent:8,bienvenu:1,tag:[6,1,4,5],want:[0,7,4,5,6],tarbal:2,suivant:1,"ent\u00eat":8,mapnik:[0,7],alwai:6,lxml:[1,2,5],end:[8,0,7,4,3],freshli:4,anoth:[4,5],restart:2,tableau:8,rapport:1,clair:8,pure:0,reject:4,instead:6,csv:6,simpl:[8,6,1,7,4],css:[0,1,7,5],email_host:[1,5],map:[0,7,4,6],product:2,rebas:2,mess:6,clone:[1,2,5],after:[6,2,4],minimum:1,superus:7,upload:[2,5],befor:[6,2,4],cours:5,sinon:8,attent:8,date:[0,1,2,4,5,6,7,8],multipl:4,underscor:5,classiqu:8,associ:[6,7,4],"ic\u00f4n":8,"h\u00e9sitez":1,projet:1,permet:8,practic:7,third:4,read:4,bind:2,bing:0,explicit:6,avant:8,"acc\u00e9der":8,django:[0,1,2,7,5],issu:6,inform:[8,6,1,7,4],mainten:[1,8],environ:[2,7],allow:7,media:[1,2,5],sont:[1,8],"biblioth\u00e8qu":1,order:[6,7,4],origin:6,checkbox:[6,4],creation:[8,5],help:6,bien:[1,8],apparaiss:8,"gliss\u00e9":8,becaus:[6,2,5],peut:[1,8],"int\u00e9r\u00eat":8,installez:1,own:7,addus:[1,5],tinymce_url:[1,5],nombr:[1,8],mainli:[0,4],dynam:7,paramet:5,member:7,style:0,group:7,"pr\u00e9sent\u00e9":8,fit:[0,5],chosen:6,psycopg2:[1,5],changement:8,clickabl:4,better:[1,5],platform:6,pend:6,eux:8,where_is_chimer:[1,5],suffit:1,"op\u00e9rat":8,hidden:[7,4],main:[6,4],fin:8,"g\u00e9n\u00e9ralement":8,descend:4,nom:[1,8],them:[6,2,4,5],haven:2,thei:[7,4],python:[1,2,5],encod:[1,5],dan:[1,8],taill:8,handi:6,"suppl\u00e9mentair":[1,8],number:[6,2,4,7,5],framework:[3,7],cet:8,autr:[1,8],optionnel:1,verifi:2,nov:[1,5],now:[2,4,5],regroupez:1,trajet:8,"bas\u00e9":1,choic:6,document:[0,1,2,3,4,5,6,7,8],"r\u00e9agenc\u00e9":8,trac:1,unidecod:[1,5],edit:[3,2,4,5],aucun:8,drop:4,refresh:[6,2],easili:[6,4],localis:6,"import\u00e9":8,each:[0,7,4,6],"fran\u00e7ai":1,found:5,smtp:[1,5],updat:[0,2,3,4,5,6,7],mean:[6,7,4],compil:[3,1,5],dispon:[1,8],domain:7,"int\u00e9rieur":8,replac:[4,5],lign:[1,8],mydjango:[1,5],procedur:5,realli:6,"cr\u00e9er":[1,8],local_set:[1,2,7,5],"static":[1,2,5],forgot:7,"cr\u00e9ez":1,"identifi\u00e9":8,dispos:8,"probl\u00e8m":1,special:[2,4,5],out:4,variabl:[1,2,7,5],"cl\u00e9":1,optionali:5,newli:[6,4],publish:2,content:[6,7,4],contenu:8,backport:[1,2,5],adapt:[2,5],print:6,got:6,correct:[6,1,2,5],red:[8,4],serveur:1,postgr:[1,5],ascendant:8,"propos\u00e9":8,insid:[7,4],line:[2,5],migrat:[3,1,2,5],precaut:2,given:[6,2,5],cart:8,standard:6,reason:7,base:[6,1,7,8,5],que:[1,8],put:[6,4],org:[1,2],"9227c9":[8,4],mychimer:[2,7],unpredict:5,gdal:[1,2,5],care:[6,4,5],contient:8,spatial_ref_si:[1,5],wai:[0,5,6],launch:6,"caract\u00e8r":1,could:[6,2],area:[0,7,6,3],ask:[6,7],static_url:2,keep:[6,4],filter:[6,4],length:[2,5],trier:8,place:1,isn:4,outsid:7,geometri:6,lancer:1,think:6,south:[1,2,5],first:[6,2,4,7,5],oper:4,pleas:5,major:2,initial:1,beauti:[1,5],directli:[6,7,4],"troisi\u00e8m":8,feel:5,onc:[6,7,4],"pr\u00e9":1,"pr\u00e8":8,barr:8,yourself:4,restrict:7,mai:[1,7,8],instruct:2,alreadi:5,done:[0,2,7,5,6],least:[2,7,5],blank:4,owner:[1,5],stabl:[1,2,5],installed_app:2,tinymc:[1,5],ont:[1,8],size:4,differ:[0,7],lister:1,fonctionn:8,boit:8,script:2,avec:[1,8],licens:6,mkdir:[1,2,5],system:4,messag:[6,7],tou:8,avez:[1,8],attach:4,master:2,"appropri\u00e9":1,traduct:1,proposit:8,conveni:[6,4],"final":6,store:6,"\u00e9t\u00e9":[1,8],conduit:8,pare:8,ainsi:8,"trac\u00e9":8,copi:[0,2,5],install_path:[1,5],plane:2,direct:[2,8],recherch:8,"short":5,court:1,"\u00e9galement":8,consult:[8,4],vide:8,"n\u00e9cessit":[1,8],than:6,rss:7,serv:[2,7],kind:0,"compl\u00e9t\u00e9":1,provid:[6,4,5],remov:[2,4],satisfair:1,cli:[2,7],plupart:[1,8],project:[3,2,7,5,6],ressourc:7,gestion:[1,8],initi:[2,7,5],browser:[3,2],latitud:6,"param\u00e9trag":1,"acc\u00e8":8,favorit:5,tiret:1,beforehand:6,ani:[6,2,5],correspond:1,myproject:0,packag:[2,5],"g\u00e9ographiqu":[1,8],faut:1,stash:2,have:[6,2,4,7,5],tabl:[8,1,4,5],need:[0,7,4,5,6],seem:6,element:4,pg_version:[1,5],plpgsql:[1,5],option:2,raccourci:8,suivr:1,bz2:[1,5],"\u00e9ventuel":8,min:2,rout:[7,4],"d\u00e9connexion":8,note:[6,8,4],also:[2,4],witch:7,take:5,obligatoir:8,roug:8,librari:[1,5],default_data:[1,5],"r\u00e9pertoir":1,compat:0,begin:[2,5],sure:6,distribut:[1,5],trace:6,normal:6,usernam:[6,7],object:6,"acc\u00e8d":8,createus:[1,5],doit:[1,8],most:[7,4,5],render:7,"\u00e9tat":8,compt:[1,8],remplacez:1,"g\u00e9r\u00e9":1,geodjango:[1,5],why:6,dai:7,sub:4,doivent:8,time_zon:[1,5],don:[6,2,4,7,5],refract:1,url:[1,2,4,5,6,7],clear:4,"\u00e9ditez":1,openlay:0,pwd:2,inde:4,"g\u00e9r\u00e9e":8,part:5,determin:6,databas:[3,1,2,5,6,7],efficac:8,"r\u00e9cemment":8,came:6,son:8,"n\u00e9cessair":[1,8],show:7,text:7,ajout:8,conserv:8,beautifulsoup:[1,5],session:7,particularli:6,permiss:[1,7,5],contenir:8,"compos\u00e9":8,data:[6,1,2,4,5],find:6,"multim\u00e9dia":8,chimer:[0,1,2,4,5,6,7,8],fichier:[1,8],onli:[0,2,4,5,6,7],submit:[4,5],locat:2,execut:2,copyright:[0,1,2,4,5,6,7,8],"pr\u00e9f\u00e9r\u00e9e":1,explain:4,configur:[3,1,2,7,5],apach:[1,2,5],souhaitez:1,should:[6,2,7,5],theme:7,cliquabl:8,"destin\u00e9":8,"particuli\u00e8r":[1,8],folder:6,local:[6,1,2,7,5],move:[2,5],hit:6,contribut:[1,2,5],get:[3,1,2,5,6],familiar:7,your_local_nam:2,stop:2,regularli:6,solut:[1,5],"param\u00e8tr":1,cannot:6,meter:2,wheezi:[1,2,5],a2ensit:[1,5],report:2,"d\u00e9velopp\u00e9":8,geo:[1,5],lisibl:1,requir:[6,2,7],layout:[0,3],enabl:[6,2,4],chimere_localnam:[2,7],reload:[1,7,5],qui:[1,8],leur:[1,8],common:[6,1,2,5],rechargez:1,contain:[4,5],toujour:1,where:[6,7],valid:[6,8,4],view:7,bleu:8,set:[1,2,4,5,6,7],project_nam:[1,5],fair:[1,8],"chim\u00e8r":[0,1,2,3,4,5,6,7,8],principal:8,knowledg:2,kombu:2,"m\u00e9dia":1,displai:[7,4],touch:[1,2,5],see:[6,7,4],mandatori:[6,7,4],"recommand\u00e9":1,sou:[1,8],violet:8,ordr:8,obtenir:1,concern:[6,8],jqueri:[1,2,5],statu:[8,7,4],still:5,"d\u00e9sactiv":8,correctli:4,"cach\u00e9":8,vari:6,someth:5,vont:8,below:5,label:[7,4],pouvez:8,state:[6,7,4],won:[6,2],chemin:[1,8],between:[6,2],lui:8,jquery_url:2,experi:[6,2],"list\u00e9":8,email:5,signatur:1,accord:5,appreci:5,kei:[0,7,5,6],effet:8,javascript:[1,2,5],dossier:1,auteur:[1,8],french:5,"export\u00e9":8,purpl:[8,4],addit:5,cyclemap:[0,7],both:4,adaptez:1,shapefil:6,"r\u00e9f\u00e9renc":8,admin:[8,1,2,4,5],gpsbabel_opt:2,etc:[1,7,5],"d\u00e9sactiv\u00e9":8,instanc:[0,1,2,4,5,6],tout:8,logic:0,comm:1,login:4,com:7,"adapt\u00e9":1,english:4,"c\u00f4t\u00e9":8,technic:7,point:[2,8,7],color:[7,4],devrait:8,"s\u00fbr":1,arriv:7,chmod:[1,5],"r\u00e8gle":1,colon:0,littl:7,"d\u00e9finir":8,linux:[1,2,5],mapquest:[0,7,6],colonn:8,seulement:1,lorsqu:8,duplic:6,"d\u00e9pos\u00e9":8,quit:4,arg:6,copiez:1,coupl:6,folow:2,come:4,due:7,empti:6,example_project:[0,1,2,5],depui:[1,8],json:[1,5],treat:[6,4],interest:[7,4],basic:[2,4,7],popul:5,"propri\u00e9t\u00e9":8,filtr:8,"associ\u00e9":8,createlang:[1,5],remplacera:8,regroup:5,pri:8,imag:[1,5],convert:6,understand:4,last:[1,5],present:[0,2,3,4,5,6,7],"case":[6,7,8],multi:8,save:4,chimere_path:[2,7],look:[7,4],amend:[3,8,4],"entr\u00e9":8,secret_kei:[1,5],properti:[3,2,4,7,6],chimere_tag:2,easier:7,trick:2,defin:[0,7,6],facil:8,abov:6,error:[6,2],indiqu:8,value_of_your_localnam:2,envvar:[1,5],tant:[1,8],fixtur:[1,5],codag:1,compilemessag:[1,2,5],openstreetmap:6,bin:[1,2,5],layer:[0,7,3],would:[2,5],customiz:7,"supprim\u00e9":8,kmlz:6,conten:[1,8],biai:1,"\u00e9tienn":[0,1,2,4,5,6,7,8],prenez:1,comport:1,activ:[1,2,7,5],soit:8,archiv:[1,5],uncom:5,conf:[1,5],"compl\u00e9ter":1,mod:[1,5],sever:2,par:[1,8],"null":6,develop:4,welcom:[3,7],open:7,author:[0,2,4,5,6,7],parti:1,make:[6,2,4,7],header:4,root_urlconf:[1,2,5],same:[6,7,4,5],affich:8,balis:8,pass:8,html:[0,8,4],changepassword:7,explanatori:4,easi:2,web:[0,1,2,3,6,7],eventu:6,choisissez:1,mod_wsgi:[1,5],pan:7,complet:[7,5],wgs84:6,webserv:[3,2,5],cryptographiqu:1,forgotten:[7,4],effect:4,cliquant:8,libj:[1,2,5],auth:7,jquery_css_url:[1,5],mani:[2,4,7],extern:[8,7,4],jour:[1,8],"coch\u00e9":8,posgi:1,recent:4,"modifi\u00e9":8,pwprompt:[1,5],appropri:[0,7,5,6],moder:[3,7,4],paquet:1,chimere_app_path:[2,7],entri:4,"affich\u00e9":8,well:[0,5],non:[6,1,8],exampl:[1,7,4,5],command:[1,5],thi:[0,2,4,5,6,7],choos:[6,5],soient:8,model:[3,2,7],voulez:[1,8],propos:[8,1,7,4],nommag:1,seul:[1,8],identifi:[8,6,7,4],just:[1,2,8,5],chimere_hide_propertymodel:7,couleur:8,"trait\u00e9":8,obtain:5,"s\u00e9lectionn\u00e9":8,sampl:[1,2,5],comprendr:8,distant:6,human:7,createsuperus:7,simpli:7,flavor:7,yet:[6,2],languag:[0,5,3],traitement:8,task:7,expos:4,fait:[1,8],autant:1,"53k":[1,5],shortcut:4,apache2:[1,5],identif:[8,4],add:[0,2,4,7,6],chaqu:8,simplejson:[1,2,5],xvjf:[1,5],descendant:8,adress:[1,8],survolez:1,anglai:8,applic:[8,1,7,4,5],formulair:8,deux:8,format:[6,8,4],preserv:6,regard:6,librement:8,piec:7,mot:8,relativ:8,bouton:8,password:[6,7,4],prise:8,name:[0,2,4,5,6,7],aurez:1,like:[2,4,7,5],semi:0,"d\u00e9fini":8,fournir:8,mychimere_project:[1,5],activez:1,manual:7,zoom:7,staticfil:2,server:[6,2,7,5],gpsbabel:[1,2,5],princip:8,authentifi:4,necessari:[2,7,5],"accept\u00e9":1,customis:[0,2,3],resiz:4,pratiqu:8,"d\u00e9tail":8,"d\u00e9p\u00f4t":1,encount:5,www:[1,2,5],right:[7,4],old:2,besoin:1,simplifi:2,staff:7,poi:4,paragraph:[2,7],back:4,self:4,"export":[3,8,4,6],language_cod:[1,5],syncdb:[1,2,5],guess:6,transport:[0,7],ici:1,est:[1,8],langag:1,lead:4,confirm:[8,4],kml:6,"install\u00e9":1,per:7,libapache2:[1,5],jquery_js_url:[1,5],larg:5,proj:[6,1,5],slash:4,prequi:1,"mod\u00e9rat":8,three:4,avoir:1,foi:8,refer:[0,4,5],"premi\u00e8r":8,plu:[8,1,4],previou:2,run:2,bold:4,cliquer:8,devin:1,enregistr:8,usag:7,cliquez:8,uncommit:2,step:[2,4,7],squeez:[1,2,5],prerequisit:[3,5],srid:6,wget:[1,5],unicod:[1,5],"disponibilit\u00e9":8,trustworthi:7,postgresql:[1,5],"\u00eatre":[1,8],column:[6,4],http:[8,1,2,4,5],page:[0,1,3,4,6,7,8],srv:[2,7],"f\u00e9licit":1,pertin:[1,8],discard:4,"cat\u00e9gori":8,"donn\u00e9":[1,8],"libell\u00e9":8,cett:[1,8],feed:[1,7,5],"d\u00e9commentez":1,effici:4,letter:[2,5],remplir:1,gard:1,submitt:4,lien:8,bound:[6,7],automat:[6,7],two:[6,7],champ:8,been:[0,2,4,5,6,7],contrib:[1,2,5],"import":[3,1,2,4,5,6,7,8],mark:6,your:[0,2,4,5,6,7],libgeo:[1,5],manag:[0,1,2,3,4,5,6,7,8],accordingli:5,git:[1,2,5],fill:6,log:[1,2,4,7,5],real:4,pictur:7,lok:[0,1,2,4,5,6,7,8],celui:1,secret:5,"long":7,custom:[0,7,5,3],avail:[0,1,2,4,5,6,7],lost:2,interfac:7,gra:8,"var":[1,2,5],icon:[2,4,7],"\u00e9dition":8,"intitul\u00e9":8,"function":7,auriez:1,properli:7,rejet:8,form:[6,7,4],forc:[3,2],ascend:4,recommend:6,horair:1,facilit:[6,8,4],readabl:[7,5],your_chimere_path:2,collectstat:[1,2,5],link:[0,4,6],translat:[3,2,5],pyexiv2:[1,2,5],cryptograph:5,stand:5,"true":7,meilleur:1,congratul:5,pull:2,robust:6,made:[0,2,4],utf:[1,5],possibl:[8,6,7,4],"default":[0,1,2,5,6,7],"d\u00e9placez":1,fake:2,access:[8,7,4],"th\u00e8me":8,rc3:2,makemessag:[1,5],limit:7,notam:8,otherwis:[7,4],problem:[6,2,5],urn:7,crosstrack:2,"accentu\u00e9":1,rvb:[8,4],featur:6,aerial:0,creat:[3,1,2,4,5,6,7],classic:[6,4],disabl:[6,7,4],certain:8,"pr\u00e9sent":[1,8],parser:[1,5],accentu:5,nouvel:[1,8],lectur:8,"char":5,html2text:[1,5],exist:[6,5],"d\u00e9pendanc":1,file:[0,2,4,5,6,7],some:[0,2,4,5,6],cocher:8,path:[7,4,5],check:[6,7,4,5],appliqu:8,probabl:[2,7],echo:[1,5],freeli:4,"appara\u00eetr":8,perhap:2,encrypt:[1,5],courant:8,relatif:1,titl:4,user:[3,1,2,4,5,7,8],"d\u00e9faut":1,when:[6,7,4],detail:[0,7,4,6],gettext:[1,5],vou:[1,8],field:[1,2,4,5,6,7],other:[6,7],oubliez:8,branch:[1,2,5],titr:8,test:[6,2],you:[0,2,4,5,6,7],"int\u00e9ress":8,validez:8,oublier:8,servernam:5,particular:5,node:6,draw:[6,7,4],repeat:2,chacun:8,peacefrog:[1,2,5],"souhait\u00e9":1,choisir:1,drag:[7,4],consid:2,sql:[1,5],debian:[1,2,5],longitud:6,phone:7,directori:[0,2,5],affichag:8,bottom:4,descript:[1,2,7,5],rule:[2,5],actuel:8,utilisez:1,chown:[1,2,5],fact:[6,4],time:[7,5],exempl:[1,8],w3c:6,"t\u00e9l\u00e9chargez":1,"secr\u00e8t":1},objtypes:{},titles:["Customisation","Installation","Upgrade","Welcome to Chim\u00e8re’s documentation!","Administration","Installation","Import/export","Configuration","Administration"],objnames:{},filenames:["customisation","fr/install","upgrade","index","administration","install","import_export","configuration","fr/administration"]})
\ No newline at end of file diff --git a/docs/_build/html/upgrade.html b/docs/_build/html/upgrade.html index d0cd08f..c38cc8f 100644 --- a/docs/_build/html/upgrade.html +++ b/docs/_build/html/upgrade.html @@ -62,6 +62,8 @@ </tr> </tbody> </table> +<p>This document presents the upgrade of Chimère. +It has been updated for version 2.0.0.</p> <p>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 @@ -73,8 +75,8 @@ to v2.0. The only optional step is the integration of your customisations.</p> <p>The current stable version is 2.0. If you are considering to contribute on Chimère get the Git master.</p> <p>The instruction are given for Debian Squeeze and Debian Wheezy.</p> -<div class="section" id="get-new-version-of-dependencies"> -<h2>Get new version of dependencies<a class="headerlink" href="#get-new-version-of-dependencies" title="Permalink to this headline">¶</a></h2> +<div class="section" id="getting-new-versions-of-dependencies"> +<h2>Getting new versions of dependencies<a class="headerlink" href="#getting-new-versions-of-dependencies" title="Permalink to this headline">¶</a></h2> <div class="section" id="version-1-1-1-2"> <h3>Version 1.1 -> 1.2<a class="headerlink" href="#version-1-1-1-2" title="Permalink to this headline">¶</a></h3> <div class="highlight-bash"><div class="highlight"><pre>apt-get install python-lxml libjs-jquery gpsbabel python-gdal @@ -105,8 +107,8 @@ Then install the new dependencies:</p> </div> </div> </div> -<div class="section" id="get-the-new-sources"> -<h2>Get the new sources<a class="headerlink" href="#get-the-new-sources" title="Permalink to this headline">¶</a></h2> +<div class="section" id="getting-the-new-sources"> +<h2>Getting the new sources<a class="headerlink" href="#getting-the-new-sources" title="Permalink to this headline">¶</a></h2> <p>First of all we have to get the new version of the source code. For this upgrade process, we are getting the source code from the Git repository.</p> @@ -138,7 +140,7 @@ git rebase <span class="nv">$CHIMERE_TAG</span> </div> <div class="section" id="from-a-previous-tarball-installation"> <h3>From a previous tarball installation<a class="headerlink" href="#from-a-previous-tarball-installation" title="Permalink to this headline">¶</a></h3> -<p>Remove first your old installation and get the Git version.</p> +<p>First remove your old installation and get the Git version.</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nb">cd</span> <span class="nv">$CHIMERE_PATH</span> <span class="nb">cd</span> .. rm -rf <span class="nv">$CHIMERE_PATH</span> @@ -236,7 +238,7 @@ configuration file to point to the correct settings: <div class="section" id="id3"> <h3>Version 1.1 -> 1.2<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3> <p>Migration scripts test your installation before making changes so you probably -won’t have any lost but by precaution before running theses scripts don’t forget +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.</p> @@ -296,8 +298,8 @@ django-admin compilemessages </div> </div> </div> -<div class="section" id="force-the-upgrade-of-visitor-s-web-browser-cache"> -<h2>Force the upgrade of visitor’s web browser cache<a class="headerlink" href="#force-the-upgrade-of-visitor-s-web-browser-cache" title="Permalink to this headline">¶</a></h2> +<div class="section" id="forcing-the-upgrade-of-visitor-s-web-browser-cache"> +<h2>Forcing the upgrade of visitor’s web browser cache<a class="headerlink" href="#forcing-the-upgrade-of-visitor-s-web-browser-cache" title="Permalink to this headline">¶</a></h2> <p>If major changes in the javascript has be done between version, 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 @@ -327,7 +329,7 @@ ln -s <span class="sb">`</span><span class="nb">pwd</span><span class="sb">`</sp <h3><a href="index.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">Upgrade</a><ul> -<li><a class="reference internal" href="#get-new-version-of-dependencies">Get new version of dependencies</a><ul> +<li><a class="reference internal" href="#getting-new-versions-of-dependencies">Getting new versions of dependencies</a><ul> <li><a class="reference internal" href="#version-1-1-1-2">Version 1.1 -> 1.2</a></li> <li><a class="reference internal" href="#version-1-2-2-0">Version 1.2 -> 2.0</a><ul> <li><a class="reference internal" href="#debian-squeeze">Debian Squeeze</a></li> @@ -336,7 +338,7 @@ ln -s <span class="sb">`</span><span class="nb">pwd</span><span class="sb">`</sp </li> </ul> </li> -<li><a class="reference internal" href="#get-the-new-sources">Get the new sources</a><ul> +<li><a class="reference internal" href="#getting-the-new-sources">Getting the new sources</a><ul> <li><a class="reference internal" href="#from-a-previous-git-installation">From a previous Git installation</a></li> <li><a class="reference internal" href="#from-a-previous-tarball-installation">From a previous tarball installation</a></li> <li><a class="reference internal" href="#update-basic-settings">Update basic settings</a><ul> @@ -365,7 +367,7 @@ ln -s <span class="sb">`</span><span class="nb">pwd</span><span class="sb">`</sp <li><a class="reference internal" href="#version-1-2-2-0-master">Version 1.2 -> 2.0 -> master</a></li> </ul> </li> -<li><a class="reference internal" href="#force-the-upgrade-of-visitor-s-web-browser-cache">Force the upgrade of visitor’s web browser cache</a></li> +<li><a class="reference internal" href="#forcing-the-upgrade-of-visitor-s-web-browser-cache">Forcing the upgrade of visitor’s web browser cache</a></li> </ul> </li> </ul> diff --git a/docs/administration.rst b/docs/administration.rst index 72fd116..92b6442 100644 --- a/docs/administration.rst +++ b/docs/administration.rst @@ -10,7 +10,7 @@ Administration :Copyright: CC-BY 3.0 This document presents the administration of Chimère. -It has has been updated for version 2.0.0. +It has been updated for version 2.0.0. Administration pages presentation @@ -34,18 +34,18 @@ Main page Once authentified you'll have access to the main admin page. -This looks like this: +It looks like this: .. image:: _static/chimere_admin_01.png #. links to this **Documentation**, to the **Change password** form and to - **Log out** -#. a list of recent actions made with this account + **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 page you can **Add** a new item or - consult/**Change** items. The **Add** link lead to the new `Item form`_. The - **Change** link lead to the `Item list`_. The `Item list`_ is also available + 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. @@ -55,16 +55,16 @@ 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 word (not available for all type of items) -#. this filter box permit to filter current entries with some criteria (not - available for all type of items) -#. the header of the table is cliquable. Click on an header sort the items by + 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 explain the order of sorting). + 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 possibly edit, delete it. + the first column) to see the detail and edit or delete it. Item form ********* @@ -72,13 +72,13 @@ 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 of the fields concerning an item are read-only and a few of - them are hidden. Mandatory fields have their label in bold. Changes on theses - fields are only effective once the form is submitted. -#. for some items there are associated sub-items. Theses associated items can be + 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 theses actions buttons. They are +#. the form has to be validated by one of these action buttons. They are self-explanatory. Status @@ -87,7 +87,7 @@ 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. -- **Submited**: Status of a new item freshly proposed by an end user. This item +- **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. @@ -102,14 +102,14 @@ 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 provided a name and a content. The content can contain +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. Theses icons appears on the +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. @@ -122,17 +122,17 @@ it?) Fields of subcategories are: an associated category, a name, an icon, an order, a color and an element type. -Theses fields are mainly quite self- explanatory. +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 the subcategory can contain: POI, route +The element type is the type of element that the subcategory can contain: POI, route or both. .. _geographic-items-management: -Edition/moderation of items +Editing or moderating items --------------------------- The moderation step is quite simple. It works the same with POIs and routes. @@ -142,38 +142,40 @@ 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 is a some actions available in the action list. +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. to :ref:`managing-modified`. Modified item has to be treated - one by one. -- **Export to...** to export selected item to the selected format. +- **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 his name. +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 is all data available to the end user form plus some extra +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. to the :ref:`import section -<importing>` of this documentation. -- *Associated items fields* are read only fields that list items associated to -the current one (reference item of an amendment, associated file of a route). + source or for data to be exported to OSM (cf. the :ref:`import section + <importing>` 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 forgot when you change multimedia items). +bottom of the form (it is easily forgotten when you change multimedia items). -If an item is not relevant the **Delete** button permit to remove it. +If an item is not relevant the **Delete** button enables to remove it. .. _managing-modified: @@ -186,9 +188,9 @@ to the reference item modified. .. Note:: If you are logged as an administrator and make changes on the map with the - end user form there will be directly validated. + end user form they will be directly validated. -A special form has been developed to facilitate the processing of theses +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*. @@ -197,8 +199,8 @@ You can access to this special form with the action *Managed modified items*. This form is a table with three columns. -#. The first column display the information for the reference item. -#. The second column display the information proposed by the submitter. +#. 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. diff --git a/docs/configuration.rst b/docs/configuration.rst index 39acdfd..c0cef30 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -80,8 +80,8 @@ An *Area* is the base of your map. It defines: *Areas* are customizable directly on the web administration interface in *Chimere > Areas*. -As there is little chance that the default area is appropriate for you, you'll -have to set at least one default area. +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 area can be a mean to show your map in different flavors. diff --git a/docs/customisation.rst b/docs/customisation.rst index 05f1d35..665e2f8 100644 --- a/docs/customisation.rst +++ b/docs/customisation.rst @@ -17,7 +17,7 @@ It has been updated for version 2.0.0. Managing layers --------------- -There is some different layers available by default in Chimère (OSM Mapnik, OSM +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 <http://openlayers.org/>`_ JS code. This JS code must diff --git a/docs/install.rst b/docs/install.rst index b68b365..248ece9 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -92,8 +92,8 @@ the paths accordingly to your needs):: 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 -Install the sources -******************* +Installing the sources +********************** Choose a path to install your Chimère:: @@ -135,8 +135,8 @@ Another solution is to get it from the git repository:: git checkout v2.0 # checkout the desired version -Create a custom project template -******************************** +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):: diff --git a/docs/upgrade.rst b/docs/upgrade.rst index 135a839..796ed98 100644 --- a/docs/upgrade.rst +++ b/docs/upgrade.rst @@ -27,8 +27,8 @@ If you are considering to contribute on Chimère get the Git master. The instruction are given for Debian Squeeze and Debian Wheezy. -Get new version of dependencies -------------------------------- +Getting new versions of dependencies +------------------------------------ Version 1.1 -> 1.2 ****************** @@ -64,8 +64,8 @@ If you are planing to do major import consider the install of `Celery apt-get install python-django-celery python-kombu -Get the new sources -------------------- +Getting the new sources +----------------------- First of all we have to get the new version of the source code. For this upgrade process, we are getting the source code from the Git @@ -290,8 +290,8 @@ Version 1.2 -> 2.0 -> master cd $CHIMERE_PATH/chimere django-admin compilemessages -Force the upgrade of visitor's web browser cache ------------------------------------------------- +Forcing the upgrade of visitor's web browser cache +-------------------------------------------------- If major changes in the javascript has be done between version, many of your users could experience problems. There are many tricks to force the refresh |