diff options
Diffstat (limited to 'docs/_build/html/configuration.html')
| -rw-r--r-- | docs/_build/html/configuration.html | 309 |
1 files changed, 309 insertions, 0 deletions
diff --git a/docs/_build/html/configuration.html b/docs/_build/html/configuration.html new file mode 100644 index 0000000..01ab81f --- /dev/null +++ b/docs/_build/html/configuration.html @@ -0,0 +1,309 @@ + + +<!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> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>Configuration — Chimère 2.0 documentation</title> + + <link rel="stylesheet" href="_static/default.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '', + VERSION: '2.0', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/underscore.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + <link rel="top" title="Chimère 2.0 documentation" href="index.html" /> + <link rel="next" title="Chimère customisation" href="customisation.html" /> + <link rel="prev" title="Upgrade" href="upgrade.html" /> + </head> + <body> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="customisation.html" title="Chimère customisation" + accesskey="N">next</a> |</li> + <li class="right" > + <a href="upgrade.html" title="Upgrade" + accesskey="P">previous</a> |</li> + <li><a href="index.html">Chimère 2.0 documentation</a> »</li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <div class="section" id="configuration"> +<h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Author:</th><td class="field-body">Étienne Loks</td> +</tr> +<tr class="field-even field"><th class="field-name">date:</th><td class="field-body">2012-10-08</td> +</tr> +<tr class="field-odd field"><th class="field-name">Copyright:</th><td class="field-body">CC-BY 3.0</td> +</tr> +</tbody> +</table> +<p>This documents presents the first steps to configure your Chimère.</p> +<p>The version has been updated for version 2.0.0.</p> +<p>If an usage to the CLI is required, your session has to be initialised with +theses environment variables:</p> +<div class="highlight-python"><pre>CHIMERE_PATH=/srv/chimere # change with your installation path +CHIMERE_LOCALNAME=mychimere # change with your local project name +CHIMERE_APP_PATH=$CHIMERE_PATH/$CHIMERE_LOCALNAME</pre> +</div> +<p>When you have installed the application there is a few simple steps to follow to +configure <em>your</em> Chimère.</p> +<p>Most of theses 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> +<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.</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’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’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> +<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> +<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’ll have to give permissions to this +new user. It is easier to don’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’ll have to select many +groups.</p> +<p>Detail of rights for default user/groups:</p> +<table border="1" class="docutils"> +<colgroup> +<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">Technical administrator</th> +<th class="head">Application administrator</th> +<th class="head">Moderator</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>User add/modify/delete</td> +<td>yes</td> +<td>no</td> +<td>no</td> +</tr> +<tr class="row-odd"><td>Group add/modify/delete</td> +<td>yes</td> +<td>no</td> +<td>no</td> +</tr> +<tr class="row-even"><td>Property model add/modify/delete</td> +<td>yes</td> +<td>no</td> +<td>no</td> +</tr> +<tr class="row-odd"><td>Import add/modify/delete</td> +<td>yes</td> +<td>no</td> +<td>no</td> +</tr> +<tr class="row-even"><td>Layer add/modify/delete</td> +<td>yes</td> +<td>no</td> +<td>no</td> +</tr> +<tr class="row-odd"><td>News add/modify/delete</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr class="row-even"><td>Area add/modify/delete</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr class="row-odd"><td>Icon add/modify/delete</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr class="row-even"><td>Color/Color theme add/modify/delete</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr class="row-odd"><td>Category/Subcategory add/modify/delete</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr class="row-even"><td>Point Of Interest add/modify/delete</td> +<td>yes</td> +<td>yes</td> +<td>yes</td> +</tr> +<tr class="row-odd"><td>Route add/modify/delete</td> +<td>yes</td> +<td>yes</td> +<td>yes</td> +</tr> +</tbody> +</table> +</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 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> + + + </div> + </div> + </div> + <div class="sphinxsidebar"> + <div class="sphinxsidebarwrapper"> + <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="#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> +</ul> + + <h4>Previous topic</h4> + <p class="topless"><a href="upgrade.html" + title="previous chapter">Upgrade</a></p> + <h4>Next topic</h4> + <p class="topless"><a href="customisation.html" + title="next chapter">Chimère customisation</a></p> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="_sources/configuration.txt" + rel="nofollow">Show Source</a></li> + </ul> +<div id="searchbox" style="display: none"> + <h3>Quick search</h3> + <form class="search" action="search.html" method="get"> + <input type="text" name="q" /> + <input type="submit" value="Go" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> + <p class="searchtip" style="font-size: 90%"> + Enter search terms or a module, class or function name. + </p> +</div> +<script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="genindex.html" title="General Index" + >index</a></li> + <li class="right" > + <a href="customisation.html" title="Chimère customisation" + >next</a> |</li> + <li class="right" > + <a href="upgrade.html" title="Upgrade" + >previous</a> |</li> + <li><a href="index.html">Chimère 2.0 documentation</a> »</li> + </ul> + </div> + <div class="footer"> + © Copyright 2012, Étienne Loks. + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. + </div> + </body> +</html>
\ No newline at end of file |