summaryrefslogtreecommitdiff
path: root/docs/_build/html/configuration.html
blob: 5b88a3ff83c9e7f2e11875c0288a210e071c48ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325


<!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 &mdash; Chimère v2.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 v2.0 documentation" href="index.html" />
    <link rel="next" title="Administration" href="administration.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="administration.html" title="Administration"
             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 v2.0 documentation</a> &raquo;</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"><th class="field-name">Author:</th><td class="field-body">Étienne Loks</td>
</tr>
<tr class="field"><th class="field-name">date:</th><td class="field-body">2012-10-08</td>
</tr>
<tr class="field"><th class="field-name">Copyright:</th><td class="field-body">CC-BY 3.0</td>
</tr>
</tbody>
</table>
<p>This document presents the first steps to configure your Chimère.
It has been updated for version 2.0.0.</p>
<p>Your session has to be initialised with these environment variables in
the Command Line Interface:</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>Once the application installed, there are a few simple steps to follow to
configure <em>your</em> Chimère.</p>
<p>Most of these 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="fr/administration.html#administration"><em>Administration</em></a> where it is presented.</p>
<p>To access these pages you have to identify 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="configuring-the-sites-framework">
<h2>Configuring the sites framework<a class="headerlink" href="#configuring-the-sites-framework" title="Permalink to this headline">¶</a></h2>
<p><em>Sites</em> framework allow you to serve the same content on different domains.
Most of you will probably use only one domain but this unique domain has to
be configured. This is done in the web administration interface in <em>Sites &gt; Sites</em>.
You only need to change <em>example.com</em> by your domain name. If you forget to
do that, some functionalities such as RSS feeds will not work properly.</p>
</div>
<div class="section" id="managing-areas">
<span id="id1"></span><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>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>
<li>a welcome message (<em>not mandatory</em>): this message is displayed once a day per
user arriving on the map,</li>
<li>an order (to sort areas),</li>
<li>an availability,</li>
<li>a default state. The /default/ area is viewed by default. Only one area can
be the default: activating this state disables it on the possible other area
with a default state,</li>
<li>default checked categories (<em>not mandatory</em>),</li>
<li>if categories are displayed dynamically (if dynamically is set, the end user
only views categories which have items on the map section he is currently
looking at),</li>
<li>categories restriction (<em>not mandatory</em>): if no restriction is set all
categories are available,</li>
<li>an external CSS file (<em>not mandatory</em>): an URL to an external CSS file,</li>
<li>restriction on the bounding box: if set to restricted, the end user can&#8217;t pan
outside the defined bounding box. Due to technical reasons of OpenLayers, there
is at this time no restriction on the zoom,</li>
<li>a map bounding box: this is the area to display when arriving on the map. If
the area is restricted it will be the bounding box that restricts the end user.
Hold the control key, click and drag to draw the 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 layers (cf. <a class="reference internal" href="customisation.html#managing-layers"><em>Managing layers</em></a>).</li>
</ul>
<p><em>Areas</em> are customizable directly on the web administration interface in
<em>Chimere &gt; Areas</em>.</p>
<p>As there is little chance that the default area should be appropriated for you,
you&#8217;ll have to set at least one default area.</p>
<p>Adding many areas 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 Command Line Interface (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 his 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 not to add permission manually but to make this user
a member of a group.</p>
<p>Two types 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 manages many areas you&#8217;ll have to select many
groups.</p>
<p>Detail of rights for default 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><th class="head">Task (add/modify/delete on)</th>
<th class="head">Technical administrator</th>
<th class="head">Application administrator</th>
<th class="head">Moderator</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>User</td>
<td>yes</td>
<td>no</td>
<td>no</td>
</tr>
<tr><td>Group</td>
<td>yes</td>
<td>no</td>
<td>no</td>
</tr>
<tr><td>Property model</td>
<td>yes</td>
<td>no</td>
<td>no</td>
</tr>
<tr><td>Import</td>
<td>yes</td>
<td>no</td>
<td>no</td>
</tr>
<tr><td>Layer</td>
<td>yes</td>
<td>no</td>
<td>no</td>
</tr>
<tr><td>News</td>
<td>yes</td>
<td>yes</td>
<td>no</td>
</tr>
<tr><td>Area</td>
<td>yes</td>
<td>yes</td>
<td>no</td>
</tr>
<tr><td>Icon</td>
<td>yes</td>
<td>yes</td>
<td>no</td>
</tr>
<tr><td>Color/Color theme</td>
<td>yes</td>
<td>yes</td>
<td>no</td>
</tr>
<tr><td>Category/Subcategory</td>
<td>yes</td>
<td>yes</td>
<td>no</td>
</tr>
<tr><td>Point Of Interest</td>
<td>yes</td>
<td>yes</td>
<td>yes</td>
</tr>
<tr><td>Route</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 permits 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 asks you for:</p>
<ul class="simple">
<li>a name,</li>
<li>an order (to sort 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 applies to (if no categories selected it applies
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 web server (the
property is cached).</p>
<p>All forms are then automatically updated with this new field.</p>
<p>If you don&#8217;t want to allow add and modification of properties you can disable
this form by setting CHIMERE_HIDE_PROPERTYMODEL to <em>True</em> in your
<em>local_settings.py</em> file.</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="#configuring-the-sites-framework">Configuring the sites framework</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>
</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="administration.html"
                        title="next chapter">Administration</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="administration.html" title="Administration"
             >next</a> |</li>
        <li class="right" >
          <a href="upgrade.html" title="Upgrade"
             >previous</a> |</li>
        <li><a href="index.html">Chimère v2.0 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Étienne Loks.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.
    </div>
  </body>
</html>