From c590082daa7b5eca6d5f021e356e4ddd15cee595 Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Wed, 28 Nov 2012 00:54:09 +0100 Subject: Update documentation --- docs/_build/html/configuration.html | 69 +++++++++++++++++++++++-------------- 1 file changed, 44 insertions(+), 25 deletions(-) (limited to 'docs/_build/html/configuration.html') diff --git a/docs/_build/html/configuration.html b/docs/_build/html/configuration.html index 01ab81f..18966df 100644 --- a/docs/_build/html/configuration.html +++ b/docs/_build/html/configuration.html @@ -26,7 +26,7 @@ - + @@ -37,7 +37,7 @@ index
  • - next |
  • +

    Configuring the sites framework

    +

    Sites 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 Sites > Sites +You only need to change example.com by your domain name. If you forgot to +do that functionality such as RSS feeds will not work properly.

    +
    -

    Managing areas

    +

    Managing areas

    An Area is the base of your map. It defines:

    • a name: a human readable label for this area.
    • +
    • an associated URN (not mandatory): 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.
    • a welcome message (not mandatory): this message is displayed once a day per user arriving on the map.
    • -
    • a map bounding box: this is the default area to display when arriving on the -map.
    • -
    • restriction on the bounding box: if set to restricted, the end user can’t pan -outside the defined bounding box.
    • -
    • available layers (not mandatory 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. managing-layers.
    • -
    • categories restriction (not mandatory): if no restriction is set all -categories are available.
    • +
    • an order (to sort areas).
    • +
    • an availability.
    • +
    • a default state. The /default/ area is viewed by default. Only one area can +be the default: activating this state disable it on the possible other area +with a default state.
    • default checked categories (not mandatory).
    • -
    • an external CSS file (not mandatory): an URL to an external CSS file.
    • 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).
    • -
    • an associated URN (not mandatory): 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.
    • +
    • categories restriction (not mandatory): if no restriction is set all +categories are available.
    • +
    • an external CSS file (not mandatory): an URL to an external CSS file.
    • +
    • restriction on the bounding box: if set to restricted, the end user can’t pan +outside the defined bounding box. Due to technical reasons, there is at this +time no restriction on the zoom.
    • +
    • 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 restrict the end user. +Hold the control key, click and drag to draw the bounding box.
    • +
    • available layers (not mandatory 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. Managing layers.

    Areas are customizable directly on the web administration interface in -Chimere/Areas.

    +Chimere > Areas.

    As there is little chance that the default area is appropriate for you, you’ll have to set at least one default area.

    Adding many area can be a mean to show your map in different flavors.

    @@ -129,8 +144,8 @@ password):

    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).

    Then complete the other pieces of information.

    -

    Check the case: Staff status (or this user will not be able to log to -the administration website).

    +

    Check the case: Staff status (or this user will not be able to log to the +administration website).

    If this account is a new technical administrator, check Superuser status (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 @@ -229,16 +244,19 @@ model).

    The administration page ask you for:

    • a name,
    • -
    • an order (to order between other properties),
    • +
    • an order (to sort properties),
    • an availability to the end user (this can be used to set hidden properties),
    • a mandatory status,
    • the categories the property applied to (if no categories selected it applied to all),
    • the type: text, long text, password or date.
    -

    To make this property available it is necessary to reload your webserver (the +

    To make this property available it is necessary to reload your web server (the property is cached).

    All forms are then automatically updated with this new field.

    +

    If you don’t want to allow add and modification of properties you can disable +this form by setting CHIMERE_HIDE_PROPERTYMODEL to True in your +local_settings.py file.

    @@ -251,6 +269,7 @@ property is cached).

    Table Of Contents