diff options
Diffstat (limited to 'docs/administration.rst')
| -rw-r--r-- | docs/administration.rst | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/docs/administration.rst b/docs/administration.rst new file mode 100644 index 0000000..db7e078 --- /dev/null +++ b/docs/administration.rst @@ -0,0 +1,115 @@ +.. -*- coding: utf-8 -*- +.. _administration: + +============== +Administration +============== + +:Author: Étienne Loks +:date: 2012-10-08 +:Copyright: CC-BY 3.0 + +This documents presents the administration of Chimère. +The version has been updated for version 2.0.0. + + +Administration pages presentation +--------------------------------- + +Administration pages accessible at: http://where_is_your_chimere/admin/ + +Don't forget the ending slash in the URL. + +Identification +************** + +First of all, you'll have to identify yourself with the login and password +provided. + +.. image:: _static/chimere_admin_00.png + + +Main page +********* + +Once authentified you'll have access to the main admin page. + +This 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 +#. 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 + by clicking on the item label. + + +Item list +********* + +.. image:: _static/chimere_admin_02.png + +#. path in the admin site. This is a convenient shortcut to come back to the + main page. +#. link to create a new item from the item list +#. search items by 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 clickable. Click on an header sort 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). +#. 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. + +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 + 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 + self-explanatory. +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. + +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. + +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. + |