diff options
Diffstat (limited to 'docs/_build/html/administration.html')
| -rw-r--r-- | docs/_build/html/administration.html | 113 |
1 files changed, 60 insertions, 53 deletions
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> |