diff options
author | etienne <etienne@9215b0d5-fb2c-4bbd-8d3e-bd2e9090e864> | 2010-07-04 22:34:28 +0000 |
---|---|---|
committer | etienne <etienne@9215b0d5-fb2c-4bbd-8d3e-bd2e9090e864> | 2010-07-04 22:34:28 +0000 |
commit | ec145c338abd3e783a2eaa3937f2c6b11a43e0f0 (patch) | |
tree | 4f3d8e2b818dc81ce0cd941058c5809425900830 | |
parent | ad503a5c8b56e640bfe217edf99304d11076d865 (diff) | |
download | Chimère-ec145c338abd3e783a2eaa3937f2c6b11a43e0f0.tar.bz2 Chimère-ec145c338abd3e783a2eaa3937f2c6b11a43e0f0.zip |
Adding some french documentation - rearrangement of the documentation
git-svn-id: http://www.peacefrogs.net/svn/chimere/trunk@83 9215b0d5-fb2c-4bbd-8d3e-bd2e9090e864
-rw-r--r-- | INSTALL | 354 | ||||
-rw-r--r-- | README | 3 | ||||
-rw-r--r-- | docs/INSTALL.html | 464 | ||||
-rw-r--r-- | docs/en/INSTALL.t2t (renamed from docs/INSTALL.t2t) | 0 | ||||
-rw-r--r-- | docs/fr/documentation-utilisateur.t2t | 185 | ||||
-rwxr-xr-x | docs/generate | 24 |
6 files changed, 209 insertions, 821 deletions
diff --git a/INSTALL b/INSTALL deleted file mode 100644 index fb3b323..0000000 --- a/INSTALL +++ /dev/null @@ -1,354 +0,0 @@ -Chimère installation -Étienne Loks -Last update: 02-27-2010 - - ------------------------------------------------------------------------- - - 1. Base installation - 1.1. Installation - 1.1.1. Prerequisites - 1.1.2. Database configuration - 1.1.3. Getting the sources - 1.1.4. Install the sources - 1.1.5. Compiling languages - 1.1.6. Database initialisation - 1.1.7. Apache configuration - 2. Base configuration - 2.1. Creating users - 2.2. Setting the welcome page - 2.3. Creating property models - 2.4. Updating the detail window - 2.5. Updating the design - 3. Site administration - 3.1. Creating news - 3.2. Creating categories/subcategories - 3.3. Creating areas - 4. Moderation - - ------------------------------------------------------------------------- - - - 1. Base installation - ==================== - - - 1.1. Installation - ================= - - - 1.1.1. Prerequisites - ==================== - -- apache (http://www.apache.org/) version 2.x with mod_python (http://www.modpython.org/) 3.x -- python (http://www.python.org/) versions 2.4 or superior -- geodjango (http://www.djangoproject.com/) version 1.0 -- postgres (http://www.postgresql.org/) version 8.x -- gettext (http://www.gnu.org/software/gettext/) -- psycopg2 (http://freshmeat.net/projects/psycopg/) -- Python Imaging Library (http://www.pythonware.com/products/pil/) - -geodjango is a part of django version 1.0 but it has some specific (geographically related) additionnal dependencies: - - - geos (http://trac.osgeo.org/geos/) 3.0.x - - proj.4 (http://trac.osgeo.org/proj/) 4.4 to 4.6 - - posgis (http://postgis.refractions.net/) versions 1.2.1 or 1.3.x - - gdal (http://www.gdal.org/) - -Optionaly (but recommanded): - - - tinymce (http://tinymce.moxiecode.com/) - -The simpliest way to obtain these packages is to get them from your favorite Linux distribution repositories (for instance python, python-django, tinymce, apache2, libapache2-mod-python, libgeos-3.0.0, proj, gdal-bin, python-psycopg2, python-imaging, postgresql-8.3 and postgresql-8.3-postgis packages for Debian Lenny). If these packages do not exist in your distribution's repository, please refer to the applications' websites. - - - 1.1.2. Database configuration - ============================= - -Now that postgres and postgis are installed, you need to create a new user for chimere: - - - createuser --echo --adduser --createdb --encrypted --pwprompt chimere-user - - -Then, you have to create the database, and initialize the geographic types (adapt the paths accordingly to your needs): - - - createdb --echo --owner chimere-user --encoding UNICODE chimere "My Chimère database" - createlang plpgsql chimere - psql -d chimere -f /usr/share/postgresql-8.3-postgis/lwpostgis.sql - psql -d chimere -f /usr/share/postgresql-8.3-postgis/spatial_ref_sys.sql - - - - 1.1.3. Getting the sources - ========================== - -The last "stable" version is available in this directory (http://www.peacefrogs.net/download/). - -Another solution is to get the last subversion version: - - - svn co http://www.peacefrogs.net/svn/chimere/trunk/ . - - - - 1.1.4. Install the sources - ========================== - -Unpack and move the files in an apache user (www-data for Debian) readable directory - - - sudo mkdir /var/local/django - cd /var/local/django - sudo tar xvjf /home/etienne/chimere-last.tar.bz2 - sudo chown -R etienne:www-data chimere - - -In your chimere application directory modify settings.py to fit to your configuration: - - - cd chimere/chimere/ - vim settings.py - #### - PROJECT_NAME = u'Chimère' - - ROOT_PATH = '/var/local/django/chimere/chimere/' # path to the installation of Chimère - - SERVER_URL = "http://www.peacefrogs.net/" # root of the web address of Chimère - EXTRA_URL = 'chimere/' # suffix to the web address of Chimère - BASE_URL = SERVER_URL + EXTRA_URL - EMAIL_HOST = 'localhost' # smtp of an email server to send emails - - TINYMCE_URL = SERVER_URL + 'tinymce/' - - # chimere specific - DEFAULT_CENTER = (-1.679444, 48.114722) # default center of the map - EPSG_PROJECTION = 900913 # projection used for data exchange (JSON flow) - EPSG_DISPLAY_PROJECTION = 4326 # projection used to display on the map - - # default id category to check on the map - DEFAULT_CATEGORIES = [1] # list of default category ids checked on the map - - # JS definition of the main map cf. OpenLayers documentation for more details - # to begin you can leave the default OpenStreetMap map rendered with Mapnik - MAP_LAYER = "new OpenLayers.Layer.OSM.Mapnik('Mapnik')" - - # setting the appropriate language code for your site - LANGUAGE_CODE = 'en-gb' - - # database configuration - DATABASE_ENGINE = 'postgresql_psycopg2' # leave it to 'postgresql_psycopg2' - DATABASE_NAME = 'chimere' # database name - DATABASE_USER = 'chimere-user' # database user - DATABASE_PASSWORD = 'mypassword' # database password - DATABASE_HOST = '' # set to empty string for localhost - - DATABASE_PORT = '' # set to empty string for default - - #### - - -If you want to use tinymce don't forget to make it available to Chimère. - -In this same chimere directory, make a symbolic link to django's basic styles (do not forget to change the path according to your configuration, it is the last time I will recall it to you. Next time, you are on your own !): - - - ln -s /usr/share/python-support/python-django/django/contrib/admin/media/ . - - - - 1.1.5. Compiling languages - ========================== - -If your language is available in the locale directory of chimere, you will just need to get it compiled. Still being in the chimere directory, this can be done with (here, "de" stands for german. Replace it with the appropriate language code) : - - - django-admin compilemessages -l de - - -If your language is not available, feel free to create the default po files and to submit it, contributions are well appreciated. Procedure is as follows : - -You first need to create the default po file (of course, replace "de" according to the language you chose to create) : - - - django-admin makemessages -l de - - -There should now be a django.po file in locale/de/LC_MESSAGES. Complete it with your translation. - -Now that the translation file is completed, just compile it the same way you would have if the language file was already available. - - - 1.1.6. Database initialisation - ============================== - -Create the appropriate tables (still being in chimère application directory): - - - ./manage.py syncdb - - -You will be prompted for the creation of an administrator account (administration can be found at: http://where_is_chimere/admin). -The database is set, congratulations! - - - 1.1.7. Apache configuration - =========================== - -Create and edit a configuration file for Chimère. - - - sudo vim /etc/apache2/sites-available/chimere - - -Insert Apache directives for your installation. - - - # part of the address after the root of your site - <Location "/chimere/"> - # directory path to the father of the installation of Chimère - PythonPath "['/var/local/django/'] + sys.path" - SetHandler python-program - PythonHandler django.core.handlers.modpython - SetEnv DJANGO_SETTINGS_MODULE chimere.settings - # set it to on or off if in test or production environment - PythonDebug On - # put differents interpreter names if you deploy several Chimère - PythonInterpreter chimere - </Location> - - -To activate the website reload apache. - - - sudo a2ensite chimere - sudo /etc/init.d/apache2 reload - - -Now that you have gone through ALL this configuration procedure (which was not that hard after all) you can configure the site. - - - 2. Base configuration - ===================== - -When you have installed the application there is a few simple steps to follow to configure *your* Chimère. - -Most of theses steps are done in the administration pages accessible at : http://where_is_chimere/admin -To access theses pages you have to identify you with login and password provided at the initialization of the database. - - - 2.1. Creating users - =================== - -If you are not the only administrator of this Chimère installation you have to create account for the other users. -Currently the process has to be done manualy. - -Simply click on the Add button near Users. Give a name and a default password (the user can change it on in own later). -Then complete the other pieces of information. -Check the case: Member of the staff (or this user will not be able to log to this administration site). -To simply give this user correct rights don't add permission manualy but make this user member of a group. -Two default group are proposed: application administrator and moderator. - -Detail of rights for default user/groups: - - - || Task | Application owner | Application administrator | Moderator | - | User add/modify/delete | yes | no | no | - | Group add/modify/delete | yes | no | no | - | Property model add/modify/delete | yes | no | no | - | News add/modify/delete | yes | yes | no | - | Area add/modify/delete | yes | yes | no | - | Icon add/modify/delete | yes | yes | no | - | Category/Subcategory add/modify/delete | yes | yes | no | - | Point Of Interest add/modify/delete | yes | yes | yes | - | Route add/modify/delete | yes | yes | yes | - - - 2.2. Setting the welcome page - ============================= - -The message has to be set by updating the file templates/welcome.html. -You only have to change the message at the begin of #detail_content. - - - 2.3. Creating property models - ============================= - -A basic installation of Chimère only permit to associate a name, a category and (for the point of interest) a picture for each point of interest and each route. You may want to add more fields like phone number or opening hours. For that all you have to do is to add a new property model. -The administration ask you for name, order (to order between other properties), availability for the user and type (only text field and long text field are available for the moment). -Then to make this property available it is necessary to restart your application (and then probably to reload Apache). -All forms are then automaticaly updated with this new field. - - - 2.4. Updating the detail window - =============================== - -When clicking on a POI a window appear with the details. -Particulary if you have set some new property models you may want to customize this window. -Each property is in a paragraph with id: property_i_j (i is the order and j is the model property id - the first model property is id 1 then 2...). -You can simply adapt the CSS file (static/styles.css) to match the desired presentation. -If you want to really change the whole presentation you can change the template file templates/detail.html (go to the Django template documentation for details). - - - 2.5. Updating the design - ======================== - -You can of course customize Chimère with your own CSS. To do that just edit the file static/styles.css. - -After this basic configuration done the harder is done. You can do now application administration tasks. - - - 3. Site administration - ====================== - -The explanation are to create new elements. To modify these elements it is the same if only some fields are already filled. - - - 3.1. Creating 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 HTML tags. -The avaibility is set with a checkbox. - - - 3.2. Creating categories/subcategories - ====================================== - -Before adding categories you have to set some icons. Theses icons appears on the map and in the categories' box on the main map. -Be careful to resize correctly your icons. Indeed the icon will be presented at their real size on the map. -To add icons: the Add button near Icons. - -Categories are in fact only containers for subcategories. You'll have to provide only a name and an order. -To add categories: the Add button near categories (quite clear now, isn't it?) - -Fields of subcategories are: an associated category, a name, an icon, an order, a color and an element type. -Theses fields are mainly quite self-explainatory. -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 or both. - - - 3.3. Creating areas - =================== - -Areas are useful to provide a quick access to a particular town, a district, etc. -To define an area fill a name and move/zoom to the choosed location. Submit it and that's all. - - - 4. Moderation - ============= - -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 the Modify button. -A search field is available to search by name but the more interesting is to filter POIs (or route) by state and by subcategory. -Then to modify an item you have to click on his name. -The submission can now freely modified. Compared to the main submission interface there is only on field add: the state field. To be publish in the main site the item must have the state: Available. -If an item is not revelant the Delete button permit to remove it. - - - - - @@ -0,0 +1,3 @@ +To generate the documentation run the generate script in the docs directory. +By default the documentation is generated in english. To generate for a +different language add the appropriate language code as a parameter. diff --git a/docs/INSTALL.html b/docs/INSTALL.html deleted file mode 100644 index 2bfc051..0000000 --- a/docs/INSTALL.html +++ /dev/null @@ -1,464 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> -<title>Chimère installation</title> -<meta name="generator" content="http://txt2tags.sf.net" /> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<link rel="stylesheet" type="text/css" href="style.css" /> -</head> -<body> - -<div class="header" id="header"> -<h1>Chimère installation</h1> -<h2>Étienne Loks</h2> -<h3>Last update: 02-27-2010</h3> -</div> - -<div class="toc" id="toc"> - <ul> - <li><a href="#toc1">1. Base installation</a> - <ul> - <li><a href="#toc2">1.1. Installation</a> - <ul> - <li><a href="#toc3">1.1.1. Prerequisites</a> - </li> - <li><a href="#toc4">1.1.2. Database configuration</a> - </li> - <li><a href="#toc5">1.1.3. Getting the sources</a> - </li> - <li><a href="#toc6">1.1.4. Install the sources</a> - </li> - <li><a href="#toc7">1.1.5. Compiling languages</a> - </li> - <li><a href="#toc8">1.1.6. Database initialisation</a> - </li> - <li><a href="#toc9">1.1.7. Apache configuration</a> - </li> - </ul> - </li> - </ul> - </li> - <li><a href="#toc10">2. Base configuration</a> - <ul> - <li><a href="#toc11">2.1. Creating users</a> - </li> - <li><a href="#toc12">2.2. Setting the welcome page</a> - </li> - <li><a href="#toc13">2.3. Creating property models</a> - </li> - <li><a href="#toc14">2.4. Updating the detail window</a> - </li> - <li><a href="#toc15">2.5. Updating the design</a> - </li> - </ul> - </li> - <li><a href="#toc16">3. Site administration</a> - <ul> - <li><a href="#toc17">3.1. Creating news</a> - </li> - <li><a href="#toc18">3.2. Creating categories/subcategories</a> - </li> - <li><a href="#toc19">3.3. Creating areas</a> - </li> - </ul> - </li> - <li><a href="#toc20">4. Moderation</a> - </li> - </ul> - -</div> -<div class="body" id="body"> -<a id="toc1" name="toc1"></a> -<h1>1. Base installation</h1> -<a id="toc2" name="toc2"></a> -<h2>1.1. Installation</h2> -<a id="toc3" name="toc3"></a> -<h3>1.1.1. Prerequisites</h3> -<ul> -<li><a href="http://www.apache.org/">apache</a> version 2.x with <a href="http://www.modpython.org/">mod_python</a> 3.x -</li> -<li><a href="http://www.python.org/">python</a> versions 2.4 or superior -</li> -<li><a href="http://www.djangoproject.com/">geodjango</a> version 1.0 -</li> -<li><a href="http://www.postgresql.org/">postgres</a> version 8.x -</li> -<li><a href="http://www.gnu.org/software/gettext/">gettext</a> -</li> -<li><a href="http://freshmeat.net/projects/psycopg/">psycopg2</a> -</li> -<li><a href="http://www.pythonware.com/products/pil/">Python Imaging Library</a> -</li> -</ul> - -<p> -geodjango is a part of django version 1.0 but it has some specific (geographically related) additionnal dependencies: -</p> - <ul> - <li><a href="http://trac.osgeo.org/geos/">geos</a> 3.0.x - </li> - <li><a href="http://trac.osgeo.org/proj/">proj.4</a> 4.4 to 4.6 - </li> - <li><a href="http://postgis.refractions.net/">posgis</a> versions 1.2.1 or 1.3.x - </li> - <li><a href="http://www.gdal.org/">gdal</a> - </li> - </ul> - -<p> -Optionaly (but recommanded): -</p> - <ul> - <li><a href="http://tinymce.moxiecode.com/">tinymce</a> - </li> - </ul> - -<p> -The simpliest way to obtain these packages is to get them from your favorite Linux distribution repositories (for instance python, python-django, tinymce, apache2, libapache2-mod-python, libgeos-3.0.0, proj, gdal-bin, python-psycopg2, python-imaging, postgresql-8.3 and postgresql-8.3-postgis packages for Debian Lenny). If these packages do not exist in your distribution's repository, please refer to the applications' websites. -</p> -<a id="toc4" name="toc4"></a> -<h3>1.1.2. Database configuration</h3> -<p> -Now that postgres and postgis are installed, you need to create a new user for chimere: -</p> -<pre> -createuser --echo --adduser --createdb --encrypted --pwprompt chimere-user -</pre> -<p></p> -<p> -Then, you have to create the database, and initialize the geographic types (adapt the paths accordingly to your needs): -</p> -<pre> -createdb --echo --owner chimere-user --encoding UNICODE chimere "My Chimère database" -createlang plpgsql chimere -psql -d chimere -f /usr/share/postgresql-8.3-postgis/lwpostgis.sql -psql -d chimere -f /usr/share/postgresql-8.3-postgis/spatial_ref_sys.sql -</pre> -<p></p> -<a id="toc5" name="toc5"></a> -<h3>1.1.3. Getting the sources</h3> -<p> -The last "stable" version is available in this <a href="http://www.peacefrogs.net/download/">directory</a>. -</p> -<p> -Another solution is to get the last subversion version: -</p> -<pre> -svn co http://www.peacefrogs.net/svn/chimere/trunk/ . -</pre> -<p></p> -<a id="toc6" name="toc6"></a> -<h3>1.1.4. Install the sources</h3> -<p> -Unpack and move the files in an apache user (www-data for Debian) readable directory -</p> -<pre> -sudo mkdir /var/local/django -cd /var/local/django -sudo tar xvjf /home/etienne/chimere-last.tar.bz2 -sudo chown -R etienne:www-data chimere -</pre> -<p></p> -<p> -In your chimere application directory modify settings.py to fit to your configuration: -</p> -<pre> -cd chimere/chimere/ -vim settings.py -#### -PROJECT_NAME = u'Chimère' - -ROOT_PATH = '/var/local/django/chimere/chimere/' # path to the installation of Chimère - -SERVER_URL = "http://www.peacefrogs.net/" # root of the web address of Chimère -EXTRA_URL = 'chimere/' # suffix to the web address of Chimère -BASE_URL = SERVER_URL + EXTRA_URL -EMAIL_HOST = 'localhost' # smtp of an email server to send emails - -TINYMCE_URL = SERVER_URL + 'tinymce/' - -# chimere specific -DEFAULT_CENTER = (-1.679444, 48.114722) # default center of the map -EPSG_PROJECTION = 900913 # projection used for data exchange (JSON flow) -EPSG_DISPLAY_PROJECTION = 4326 # projection used to display on the map - -# default id category to check on the map -DEFAULT_CATEGORIES = [1] # list of default category ids checked on the map - -# JS definition of the main map cf. OpenLayers documentation for more details -# to begin you can leave the default OpenStreetMap map rendered with Mapnik -MAP_LAYER = "new OpenLayers.Layer.OSM.Mapnik('Mapnik')" - -# setting the appropriate language code for your site -LANGUAGE_CODE = 'en-gb' - -# database configuration -DATABASE_ENGINE = 'postgresql_psycopg2' # leave it to 'postgresql_psycopg2' -DATABASE_NAME = 'chimere' # database name -DATABASE_USER = 'chimere-user' # database user -DATABASE_PASSWORD = 'mypassword' # database password -DATABASE_HOST = '' # set to empty string for localhost - -DATABASE_PORT = '' # set to empty string for default - -#### -</pre> -<p></p> -<p> -If you want to use tinymce don't forget to make it available to Chimère. -</p> -<p> -In this same chimere directory, make a symbolic link to django's basic styles (do not forget to change the path according to your configuration, it is the last time I will recall it to you. Next time, you are on your own !): -</p> -<pre> -ln -s /usr/share/python-support/python-django/django/contrib/admin/media/ . -</pre> -<p></p> -<a id="toc7" name="toc7"></a> -<h3>1.1.5. Compiling languages</h3> -<p> -If your language is available in the locale directory of chimere, you will just need to get it compiled. Still being in the chimere directory, this can be done with (here, "de" stands for german. Replace it with the appropriate language code) : -</p> -<pre> -django-admin compilemessages -l de -</pre> -<p></p> -<p> -If your language is not available, feel free to create the default po files and to submit it, contributions are well appreciated. Procedure is as follows : -</p> -<p> -You first need to create the default po file (of course, replace "de" according to the language you chose to create) : -</p> -<pre> -django-admin makemessages -l de -</pre> -<p></p> -<p> -There should now be a django.po file in locale/de/LC_MESSAGES. Complete it with your translation. -</p> -<p> -Now that the translation file is completed, just compile it the same way you would have if the language file was already available. -</p> -<a id="toc8" name="toc8"></a> -<h3>1.1.6. Database initialisation</h3> -<p> -Create the appropriate tables (still being in chimère application directory): -</p> -<pre> -./manage.py syncdb -</pre> -<p></p> -<p> -You will be prompted for the creation of an administrator account (administration can be found at: <a href="http://where_is_chimere/admin">http://where_is_chimere/admin</a>). -The database is set, congratulations! -</p> -<a id="toc9" name="toc9"></a> -<h3>1.1.7. Apache configuration</h3> -<p> -Create and edit a configuration file for Chimère. -</p> -<pre> -sudo vim /etc/apache2/sites-available/chimere -</pre> -<p></p> -<p> -Insert Apache directives for your installation. -</p> -<pre> -# part of the address after the root of your site -<Location "/chimere/"> -# directory path to the father of the installation of Chimère -PythonPath "['/var/local/django/'] + sys.path" -SetHandler python-program -PythonHandler django.core.handlers.modpython -SetEnv DJANGO_SETTINGS_MODULE chimere.settings -# set it to on or off if in test or production environment -PythonDebug On -# put differents interpreter names if you deploy several Chimère -PythonInterpreter chimere -</Location> -</pre> -<p></p> -<p> -To activate the website reload apache. -</p> -<pre> -sudo a2ensite chimere -sudo /etc/init.d/apache2 reload -</pre> -<p></p> -<p> -Now that you have gone through ALL this configuration procedure (which was not that hard after all) you can configure the site. -</p> -<a id="toc10" name="toc10"></a> -<h1>2. Base configuration</h1> -<p> -When you have installed the application there is a few simple steps to follow to configure *your* Chimère. -</p> -<p> -Most of theses steps are done in the administration pages accessible at : <a href="http://where_is_chimere/admin">http://where_is_chimere/admin</a> -To access theses pages you have to identify you with login and password provided at the initialization of the database. -</p> -<a id="toc11" name="toc11"></a> -<h2>2.1. Creating users</h2> -<p> -If you are not the only administrator of this Chimère installation you have to create account for the other users. -Currently the process has to be done manualy. -</p> -<p> -Simply click on the Add button near Users. Give a name and a default password (the user can change it on in own later). -Then complete the other pieces of information. -Check the case: Member of the staff (or this user will not be able to log to this administration site). -To simply give this user correct rights don't add permission manualy but make this user member of a group. -Two default group are proposed: application administrator and moderator. -</p> -<p> -Detail of rights for default user/groups: -</p> -<table border="1"> -<tr> -<th>Task</th> -<th>Application owner</th> -<th>Application administrator</th> -<th>Moderator</th> -</tr> -<tr> -<td>User add/modify/delete</td> -<td align="center">yes</td> -<td align="center">no</td> -<td align="center">no</td> -</tr> -<tr> -<td>Group add/modify/delete</td> -<td align="center">yes</td> -<td align="center">no</td> -<td align="center">no</td> -</tr> -<tr> -<td>Property model add/modify/delete</td> -<td align="center">yes</td> -<td align="center">no</td> -<td align="center">no</td> -</tr> -<tr> -<td>News add/modify/delete</td> -<td align="center">yes</td> -<td align="center">yes</td> -<td align="center">no</td> -</tr> -<tr> -<td>Area add/modify/delete</td> -<td align="center">yes</td> -<td align="center">yes</td> -<td align="center">no</td> -</tr> -<tr> -<td>Icon add/modify/delete</td> -<td align="center">yes</td> -<td align="center">yes</td> -<td align="center">no</td> -</tr> -<tr> -<td>Category/Subcategory add/modify/delete</td> -<td align="center">yes</td> -<td align="center">yes</td> -<td align="center">no</td> -</tr> -<tr> -<td>Point Of Interest add/modify/delete</td> -<td align="center">yes</td> -<td align="center">yes</td> -<td align="center">yes</td> -</tr> -<tr> -<td>Route add/modify/delete</td> -<td align="center">yes</td> -<td align="center">yes</td> -<td align="center">yes</td> -</tr> -</table> - -<p></p> -<a id="toc12" name="toc12"></a> -<h2>2.2. Setting the welcome page</h2> -<p> -The message has to be set by updating the file templates/welcome.html. -You only have to change the message at the begin of #detail_content. -</p> -<a id="toc13" name="toc13"></a> -<h2>2.3. Creating property models</h2> -<p> -A basic installation of Chimère only permit to associate a name, a category and (for the point of interest) a picture for each point of interest and each route. You may want to add more fields like phone number or opening hours. For that all you have to do is to add a new property model. -The administration ask you for name, order (to order between other properties), availability for the user and type (only text field and long text field are available for the moment). -Then to make this property available it is necessary to restart your application (and then probably to reload Apache). -All forms are then automaticaly updated with this new field. -</p> -<a id="toc14" name="toc14"></a> -<h2>2.4. Updating the detail window</h2> -<p> -When clicking on a POI a window appear with the details. -Particulary if you have set some new property models you may want to customize this window. -Each property is in a paragraph with id: property_i_j (i is the order and j is the model property id - the first model property is id 1 then 2...). -You can simply adapt the CSS file (static/styles.css) to match the desired presentation. -If you want to really change the whole presentation you can change the template file templates/detail.html (go to the Django template documentation for details). -</p> -<a id="toc15" name="toc15"></a> -<h2>2.5. Updating the design</h2> -<p> -You can of course customize Chimère with your own CSS. To do that just edit the file static/styles.css. -</p> -<p> -After this basic configuration done the harder is done. You can do now application administration tasks. -</p> -<a id="toc16" name="toc16"></a> -<h1>3. Site administration</h1> -<p> -The explanation are to create new elements. To modify these elements it is the same if only some fields are already filled. -</p> -<a id="toc17" name="toc17"></a> -<h2>3.1. Creating news</h2> -<p> -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 HTML tags. -The avaibility is set with a checkbox. -</p> -<a id="toc18" name="toc18"></a> -<h2>3.2. Creating categories/subcategories</h2> -<p> -Before adding categories you have to set some icons. Theses icons appears on the map and in the categories' box on the main map. -Be careful to resize correctly your icons. Indeed the icon will be presented at their real size on the map. -To add icons: the Add button near Icons. -</p> -<p> -Categories are in fact only containers for subcategories. You'll have to provide only a name and an order. -To add categories: the Add button near categories (quite clear now, isn't it?) -</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-explainatory. -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 or both. -</p> -<a id="toc19" name="toc19"></a> -<h2>3.3. Creating areas</h2> -<p> -Areas are useful to provide a quick access to a particular town, a district, etc. -To define an area fill a name and move/zoom to the choosed location. Submit it and that's all. -</p> -<a id="toc20" name="toc20"></a> -<h1>4. Moderation</h1> -<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 the Modify button. -A search field is available to search by name but the more interesting is to filter POIs (or route) by state and by subcategory. -Then to modify an item you have to click on his name. -The submission can now freely modified. Compared to the main submission interface there is only on field add: the state field. To be publish in the main site the item must have the state: Available. -If an item is not revelant the Delete button permit to remove it. -</p> -</div> - -<!-- xhtml code generated by txt2tags 2.3 (http://txt2tags.sf.net) --> -<!-- cmdline: txt2tags -\-encoding utf-8 -\-css-sugar -\-style style.css -\-toc -t xhtml -o INSTALL.html INSTALL.t2t --> -</body></html> diff --git a/docs/INSTALL.t2t b/docs/en/INSTALL.t2t index b5fb4ee..b5fb4ee 100644 --- a/docs/INSTALL.t2t +++ b/docs/en/INSTALL.t2t diff --git a/docs/fr/documentation-utilisateur.t2t b/docs/fr/documentation-utilisateur.t2t new file mode 100644 index 0000000..d4ff0e1 --- /dev/null +++ b/docs/fr/documentation-utilisateur.t2t @@ -0,0 +1,185 @@ +Documentation administrateur de Chimère +Étienne Loks +Last update: %%date(%m-%d-%Y) + += Généralités = + +Trois rôles sont disponibles en administration : + +- modérateur de l'application ; +- administrateur de l'application ; +- administrateur technique. + + +Le modérateur peut valider/modifier/ajouter les points d'intérêts et les +trajets. Le paragraphe « Modération dans Chimère » décrit les fonctionnalités +disponibles pour ce rôle. + +L'administrateur de l'application peut en plus administrer les catégories, les +sous-catégories, les icônes, les nouvelles, les thèmes de couleur et les zones. +Le paragraphe « Administration de l'application dans Chimère » décrit les +fonctionnalités disponibles pour ce rôle. + +L'administrateur technique a en plus accès à la création d'utilisateurs. + +Pour accéder aux pages d'administration, il suffit de s'identifier sur la page +accessible à l'adresse de base du site, suffixée par « /admin ». Bien sûr, il +faut préalablement que l'on ait créé un compte pour vous (ou que vous soyez +l'installateur de l'application). + +Attention, si une installation couvrant plusieurs zones a été faite, il faut +retirer le suffixe de zone dans l'adresse. + +//ex// : depuis une URL d'accès classique http://www.carte-ouverte.org/ avec une +zone d'accès http://www.carte-ouverte.org/rennes l'URL d'accès à +l'administration reste http://www.carte-ouverte.org/admin + += Modération dans Chimère = + +Une fois identifié, un utilisateur ayant les droits de modération dispose des +éléments suivants : + +- Points d'intérêts +- Trajets + + +Si certains éléments ne sont pas disponibles, c'est que le compte ne bénéficie +pas de droits suffisants pour la modération. + +== Modification des points d'intérêts/des trajets == + +Le modérateur peut accéder à tous les points d'intérêts et tous les trajets +validés ou non. +Une recherche par nom parmi les éléments est possible. De même, ces éléments +peuvent être filtrés par état ou par sous-catégorie. + +La modification/l'ajout d'élément est assez similaire à l'interface publique de +création. Seul le champ État est ajouté. +Celui-ci a trois valeurs : + + - Soumis, un élément a été proposé depuis l'interface publique ; + - Disponible, l'élément a été validé en modération ; + - Désactivé, l'élément a été mis de coté. + + +Il est possible de supprimer complètement un élément de la base. Cette opération +est non réversible mais une confirmation est demandée. + += Administration de l'application dans Chimère = + +Une fois identifié, un utilisateur ayant les droits d'administration de +l'application dispose des éléments suivants : + +- Catégories +- Icônes +- Nouvelles +- Points d'intérêts +- Sous-catégories +- Thème de couleurs +- Trajets +- Zones + + +Si certains éléments ne sont pas disponibles, c'est que le compte ne bénéficie +pas de droits suffisants pour la modération. + +La gestion des Points d'intérêts et des Trajets est décrite dans la section sur +la modération. + +== Création des zones == + +Les zones permettent de découper la carte en plusieurs parties. À chaque partie +peut être associé un suffixe spécifique pour accéder directement à cette zone +depuis une URL spécifique. + +//ex// : depuis une URL d'accès classique http://www.carte-ouverte.org/, il est +possible de définir un accès direct sur la zone de Rennes par l'URL +http://www.carte-ouverte.org/rennes + +Chaque partie peut être configurée pour accéder à seulement un sous-ensemble des +catégories disponibles (les utilisateurs finaux ne pourront proposer que des +éléments dans ces catégories sur cette zone). + +Pour chaque zone, les champs suivants sont disponibles : + +- Nom : le nom de la zone en question ; +- Urn : le suffixe associé à la zone, attention il doit respecter les règles de +nommage des URLs (pas d'accent, pas d'espace, etc.). Ce champ est optionnel, si +il est non défini il n'y a pas de raccourci ; +- Ordre : ordre d'affichage dans la liste de raccourcis (si cette liste est +visible) ; +- Disponible : pour rendre disponible ou non la zone ; +- Sous-catégories : un sous-ensemble de catégories à sélectionner pour limiter +les propositions utilisateurs. Ce champ est optionnel, si aucune sous-catégorie +n'est sélectionnée, toutes les sous-catégories sont disponibles ; +- Zone : la zone en question. Celle-ci correspond à ce qui est visible sur la +carte. + + +== Création d'icônes == + +À chaque sous-catégorie doit être associée une icône. Cette icône apparait sur +la légende de la carte et pour chaque point d'intérêt de la sous-catégorie. Une +même icône peut éventuellement être utilisée pour plusieurs sous-catégories +(même si cela est généralement une mauvaise idée). Pour une harmonie sur la +carte, il est préférable de se tenir à une taille fixe d'icône carrée (par +exemple 32 par 32 pixels). L'icône ne sera pas redimensionnée sur la carte. Les +formats jpg, gif et png sont acceptés mais le png est à privilégier. En effet, +pour de petits formats comme ceux-ci la compression jpg est peu efficace, de +plus elle ne gère pas la transparence (utile pour des icônes ne prenant pas tout +le carré). Le gif est aussi à déconseiller car ce format est maintenant obsolète +(notamment il ne prend en charge que 256 couleurs). + +== Création des thèmes de couleurs == + +Les thèmes de couleur sont utilisés par les trajets. Un thème de couleur est un +ensemble de couleurs qui coloreront aléatoirement les trajets d'une +sous-catégorie donnée. Pour faciliter la compréhension de la carte, il peut être +pertinent d'utiliser des couleurs approchantes pour un même thème de couleur +(par exemple des déclinaisons de bleu). + +Pour chaque thème de couleur, un nom est donné et une ou plusieurs couleurs sont +définies. Les couleurs sont définies en notation HTML RVB avec 6 chiffres +hexadécimaux (sans le #). Cf. une [liste de couleurs http://fr.wikipedia.org/wiki/Liste_de_couleurs]. + +== Création des catégories == + +Les catégories sont de simple conteneurs pour les sous-catégories. Elles +permettent d'organiser logiquement ces dernières et apparaissent comme nœuds +au niveau de la légende de la carte. + +Les catégories disposent des champs suivants : + +- Nom : le nom ; +- Disponible : l'affichage de la catégorie, si une catégorie est indisponible +aucune des sous-catégories sous celle-ci ne sera affichée ; +- Ordre : l'ordre d'apparition dans la légende ; +- Description : texte optionnel permettant de mettre à disposition une +description dans une rubrique « en savoir plus » de la catégorie. + + +== Création des sous-catégories == + +Les trajets et les points d'intérêts sont rangés dans des sous-catégories. +Les sous-catégories disposent des champs suivants : + +- Catégorie : la catégorie associée ; +- Nom : le nom de la sous-catégorie ; +- Disponible : l'affichage de la sous-catégorie ; +- Icône : l'icône associée à la sous-catégorie ; +- Thème de couleur : thème de couleur associé, ce champ est nécessaire pour +les sous-catégories de type trajet ou mixte ; +- Ordre : l'ordre d'apparition dans la légende ; +- Type d'élément : le type d'élément associé à la sous-catégorie : Point +d'intérêt, Trajet ou Mixte (Point d'intérêt et Trajet) ; +- Zones : les zones pour lesquelles cette sous-catégorie est disponible. Si +aucune zone n'est sélectionnée, cette sous-catégorie est disponible pour toutes +les zones. + + +== Création de nouvelles == + +Un système de nouvelles est disponible. +Pour chaque nouvelle, un nom et un contenu doit être renseigné. La disponibilité +est paramétrable. Le système de nouvelles est transversal à tous les sites. + diff --git a/docs/generate b/docs/generate index 72c2a68..c01cb57 100755 --- a/docs/generate +++ b/docs/generate @@ -1,3 +1,21 @@ -#!/bin/sh -txt2tags --encoding utf-8 --css-sugar --style style.css --toc -t xhtml -o INSTALL.html INSTALL.t2t -txt2tags --encoding utf-8 --toc -t txt -o ../INSTALL INSTALL.t2t +#!/bin/bash +LANGUAGE="en" +if [ $1 ] + then LANGUAGE=$1; +fi + +if ! [ -d $LANGUAGE ] + then echo $LANGUAGE" is not an appropriate locale."; exit; +fi + +echo "Generate documentation for "$LANGUAGE"." + +cd $LANGUAGE + +for file in `ls *.t2t` +do + name=${file:0:${#file}-4} + txt2tags -q --encoding utf-8 --css-sugar --style style.css --toc -t xhtml -o ../$name".html" $file + txt2tags -q --encoding utf-8 --toc -t txt -o ../$name $file +done + |