summaryrefslogtreecommitdiff
path: root/docs/_build/html/configuration.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/_build/html/configuration.html')
-rw-r--r--docs/_build/html/configuration.html114
1 files changed, 81 insertions, 33 deletions
diff --git a/docs/_build/html/configuration.html b/docs/_build/html/configuration.html
index 44e58c9..01ab81f 100644
--- a/docs/_build/html/configuration.html
+++ b/docs/_build/html/configuration.html
@@ -80,37 +80,76 @@ configure <em>your</em> Chimère.</p>
at the first paragraph of <a class="reference internal" href="administration.html#administration"><em>Administration</em></a> where it is presented.</p>
<p>To access theses 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. You can
-create a new <em>superuser</em> account in the web interface (see the account
-management section) or with the CLI:</p>
+<p>A <em>superuser</em> account is created at the initialization of the database.</p>
+<div class="section" id="managing-areas">
+<h2>Managing areas<a class="headerlink" href="#managing-areas" title="Permalink to this headline">¶</a></h2>
+<p>An <em>Area</em> is the base of your map. It defines:</p>
+<ul class="simple">
+<li>a name: a human readable label for this area.</li>
+<li>a welcome message (<em>not mandatory</em>): this message is displayed once a day per
+user arriving on the map.</li>
+<li>a map bounding box: this is the default area to display when arriving on the
+map.</li>
+<li>restriction on the bounding box: if set to restricted, the end user can&#8217;t pan
+outside the defined bounding box.</li>
+<li>available layers (<em>not mandatory</em> OSM Mapnik is used by default): OSM Mapnik
+render, OSM MapQuest render, OSM Transport Map render, OSM CycleMap are
+available by default. You can add new custom layer cf. <em class="xref std std-ref">managing-layers</em>.</li>
+<li>categories restriction (<em>not mandatory</em>): if no restriction is set all
+categories are available.</li>
+<li>default checked categories (<em>not mandatory</em>).</li>
+<li>an external CSS file (<em>not mandatory</em>): an URL to an external CSS file.</li>
+<li>if categories are displayed dynamically (if dynamically is set, the end user
+only view categories witch have items on the map section the user currently
+see).</li>
+<li>an associated URN (<em>not mandatory</em>): the name of the area as a web ressource.
+In practice, if the area is not the default area the URN is used at the end of
+the default URL to access to this area. This is not mandatory but necessary
+for each area that is not the default one.</li>
+</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&#8217;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">
+<h2>Managing users<a class="headerlink" href="#managing-users" title="Permalink to this headline">¶</a></h2>
+<p>If you are not the only administrator/moderator of this Chimère installation
+you have to create and manage account for the other users.</p>
+<p>You can create a new <em>superuser</em> account with the CLI:</p>
<div class="highlight-python"><pre>./manage.py createsuperuser</pre>
</div>
-<div class="section" id="creating-areas">
-<h2>Creating areas<a class="headerlink" href="#creating-areas" title="Permalink to this headline">¶</a></h2>
-<p>You probably want to define at least one default area. The configuration of
-this area allow you to define the default zoom, welcome message, etc. of your
-Chimère.</p>
+<p>User password can be changed with the CLI (useful if you have forgotten your
+password):</p>
+<div class="highlight-python"><pre>./manage.py changepassword username</pre>
</div>
-<div class="section" id="creating-users">
-<h2>Creating users<a class="headerlink" href="#creating-users" title="Permalink to this headline">¶</a></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&#8217;t add permission manualy but make this user member of a group.
-Two default group are proposed: application administrator and moderator.</p>
+<p><em>Users</em> are customizable directly on the web administration interface in
+<em>Auth/User</em>.</p>
+<p>To create a new account, simply click on the Add button near Users. Give a name
+and a default password (the user can change it on in own later).</p>
+<p>Then complete the other pieces of information.</p>
+<p>Check the case: <em>Staff status</em> (or this user will not be able to log to
+the administration website).</p>
+<p>If this account is a new technical administrator, check <em>Superuser status</em> (this
+user must be trustworthy!). Otherwise you&#8217;ll have to give permissions to this
+new user. It is easier to don&#8217;t add permission manually but make this user
+member of a group.</p>
+<p>Two type of default group are proposed: application administrator and moderator.</p>
+<p>Moderator are limited to an <em>Area</em> (they only see items that are inside the
+bounding box). If a moderator manage many areas you&#8217;ll have to select many
+groups.</p>
<p>Detail of rights for default user/groups:</p>
<table border="1" class="docutils">
<colgroup>
-<col width="42%" />
-<col width="19%" />
-<col width="28%" />
+<col width="39%" />
+<col width="24%" />
+<col width="26%" />
<col width="11%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Task</th>
-<th class="head">Application owner</th>
+<th class="head">Technical administrator</th>
<th class="head">Application administrator</th>
<th class="head">Moderator</th>
</tr>
@@ -181,16 +220,25 @@ Two default group are proposed: application administrator and moderator.</p>
</div>
<div class="section" id="creating-property-models">
<h2>Creating property models<a class="headerlink" href="#creating-property-models" title="Permalink to this headline">¶</a></h2>
-<p>A basic installation of Chimère only permit to associate a name, a category, a
-description and (for the point of interest) multimedia files 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 automatically updated with this new field.</p>
+<p>A basic installation of Chimère permit to associate a name, a category, a
+description, dates, multimedia files, picture files, etc. for each geographic
+item.</p>
+<p>You may want to add more custom fields like phone number or opening hours. For
+that all you have to do is to add a new property model (<em>Chimere/Property
+model</em>).</p>
+<p>The administration page ask you for:</p>
+<ul class="simple">
+<li>a name,</li>
+<li>an order (to order between other properties),</li>
+<li>an availability to the end user (this can be used to set hidden properties),</li>
+<li>a mandatory status,</li>
+<li>the categories the property applied to (if no categories selected it applied
+to all),</li>
+<li>the type: text, long text, password or date.</li>
+</ul>
+<p>To make this property available it is necessary to reload your webserver (the
+property is cached).</p>
+<p>All forms are then automatically updated with this new field.</p>
</div>
</div>
@@ -203,8 +251,8 @@ All forms are then automatically updated with this new field.</p>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Configuration</a><ul>
-<li><a class="reference internal" href="#creating-areas">Creating areas</a></li>
-<li><a class="reference internal" href="#creating-users">Creating users</a></li>
+<li><a class="reference internal" href="#managing-areas">Managing areas</a></li>
+<li><a class="reference internal" href="#managing-users">Managing users</a></li>
<li><a class="reference internal" href="#creating-property-models">Creating property models</a></li>
</ul>
</li>