diff options
| author | Nawa <bellefeegore@follepensee.net> | 2012-11-29 00:53:46 +0100 |
|---|---|---|
| committer | Nawa <bellefeegore@follepensee.net> | 2012-11-29 00:53:46 +0100 |
| commit | 397ee721cef7627201f32226334a2cb57f73318f (patch) | |
| tree | cac418a132373cf2aa40b02cf8a16917a34025c9 | |
| parent | 3b63d13346bc3392c57859f6390a55863387f894 (diff) | |
| parent | 72ede57e660210de690e2641732a1860e87a2818 (diff) | |
| download | Chimère-397ee721cef7627201f32226334a2cb57f73318f.tar.bz2 Chimère-397ee721cef7627201f32226334a2cb57f73318f.zip | |
Merge branch 'master' of ssh://daenerys.peacefrogs.net/var/local/git/chimere
Conflicts:
docs/_build/html/administration.html
docs/_build/html/customisation.html
docs/_build/html/import_export.html
docs/_build/html/searchindex.js
27 files changed, 614 insertions, 58 deletions
diff --git a/docs/_build/html/_images/chimere_admin_import_CSV.png b/docs/_build/html/_images/chimere_admin_import_CSV.png Binary files differnew file mode 100644 index 0000000..e67a37b --- /dev/null +++ b/docs/_build/html/_images/chimere_admin_import_CSV.png diff --git a/docs/_build/html/_images/chimere_admin_import_KML.png b/docs/_build/html/_images/chimere_admin_import_KML.png Binary files differnew file mode 100644 index 0000000..b48d69a --- /dev/null +++ b/docs/_build/html/_images/chimere_admin_import_KML.png diff --git a/docs/_build/html/_images/chimere_admin_import_OSM.png b/docs/_build/html/_images/chimere_admin_import_OSM.png Binary files differnew file mode 100644 index 0000000..a599348 --- /dev/null +++ b/docs/_build/html/_images/chimere_admin_import_OSM.png diff --git a/docs/_build/html/_images/chimere_admin_import_georss.png b/docs/_build/html/_images/chimere_admin_import_georss.png Binary files differnew file mode 100644 index 0000000..5278652 --- /dev/null +++ b/docs/_build/html/_images/chimere_admin_import_georss.png diff --git a/docs/_build/html/_images/chimere_admin_import_shapefile.png b/docs/_build/html/_images/chimere_admin_import_shapefile.png Binary files differnew file mode 100644 index 0000000..ce612be --- /dev/null +++ b/docs/_build/html/_images/chimere_admin_import_shapefile.png diff --git a/docs/_build/html/_sources/administration.txt b/docs/_build/html/_sources/administration.txt index 641e3a3..fa95012 100644 --- a/docs/_build/html/_sources/administration.txt +++ b/docs/_build/html/_sources/administration.txt @@ -6,7 +6,7 @@ Administration ============== :Author: Étienne Loks -:date: 2012-10-08 +:date: 2012-11-28 :Copyright: CC-BY 3.0 This document presents the administration of Chimère. @@ -130,6 +130,8 @@ basic color it can be set with the English name (for instance: *red*, *blue*, The element type is the type of element the subcategory can contain: POI, route or both. +.. _geographic-items-management: + Edition/moderation of items --------------------------- @@ -155,11 +157,12 @@ There is a some actions available in the action list. 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 *Import fields* only make sense with data imported from an external +fields. +- The *Import fields* only make sense with data imported from an external source or for data to be exported to OSM cf. to the :ref:`import section -<importing>` of this documentation. *Associated items fields* are read only -fields that list items associated to the current one (reference item of an -amendment, associated file of a route). +<importing>` of this documentation. +- *Associated items fields* are read only fields that list items associated to +the current one (reference item of an amendment, associated file of a route). Associated multimedia items are at the bottom of the form. You can freely add, change items and change their order with drag and drop. diff --git a/docs/_build/html/_sources/customisation.txt b/docs/_build/html/_sources/customisation.txt index 23e3902..e6615db 100644 --- a/docs/_build/html/_sources/customisation.txt +++ b/docs/_build/html/_sources/customisation.txt @@ -1,11 +1,11 @@ .. -*- coding: utf-8 -*- -===================== -Chimère customisation -===================== +============= +Customisation +============= :Author: Étienne Loks -:date: 2012-10-08 +:date: 2012-11-28 :Copyright: CC-BY 3.0 This document presents the installation of Chimère. diff --git a/docs/_build/html/_sources/import_export.txt b/docs/_build/html/_sources/import_export.txt index a65316d..e8d283b 100644 --- a/docs/_build/html/_sources/import_export.txt +++ b/docs/_build/html/_sources/import_export.txt @@ -1,11 +1,11 @@ .. -*- coding: utf-8 -*- -===================== -Chimère import/export -===================== +============= +Import/export +============= :Author: Étienne Loks -:date: 2012-10-08 +:date: 2012-11-28 :Copyright: CC-BY 3.0 This document presents the administration of Chimère. @@ -15,3 +15,186 @@ It has been updated for version 2.0.0. Importing --------- + +In Chimère the import mechanism is based on **Import object**. Theses objects +are stored in database to keep trace of imports and to facilitate the +re-importation from the same source. In fact if possible the update of data from +a same type of source is managed. The ability to do such updates depends on the +existence of a unique id for each object on your source. + +To add an **Import object** you need to go to *Chimere > Imports* then **Add**. + +After that you'll have to select your source type and then the form depends on +the type of source. + +Common fields +************* + +- **Name by default**: if no name can be identified to the newly imported object + this is the name that will be used. If this field is empty the name of the + associated category will be use. +- **SRID**: Chimère will try to identify automatically the correct projection + from the given source. But sometimes the information is not present or cannot + be guessed (for instance a Shapefile that uses non standard proj file). In + this case Chimère will use WGS84 by default (the classic latitude/longitude) + but it is not always correct. If you experience problems with items + localisation you should put here the SRID associated to the projection of + your source. +- **Origin**: if not null this field will be associated to each item imported in + order to easily identify where the item came from. For OSM import the source + is automatically added. +- **License**: if not null this field will be associated to each item imported in + order to easily identify the license associated to the item. For OSM import + the license is automatically added. +- **Associated subcategories (mandatory)**: The selected subcategories will be + associated to newly imported items. + + +KML import +********** + +.. image:: _static/chimere_admin_import_KML.png + + +- **Web address/source file (mandatory)**: your KML could be distant or a local + file. You'll have to fill one of the two fields. +- **Filter**: if you want to import only a specific *Folder* of your KML file + put his name on this field. +- **Zipped file**: if your source is a KMLZ file (a zipped KML) check this case. + +Shapefile import +**************** + +.. image:: _static/chimere_admin_import_shapefile.png + + +- **Web address/source file (mandatory)**: your KML could be distant or a local + file. You'll have to fill one of the two fields. +- **Zipped file**: only zipped shapefile are accepted this checkbox have to be + checked. + +GeoRSS import +************* + +Simple GeoRSS and W3C GeoRSS are managed. + +.. image:: _static/chimere_admin_import_georss.png + +- **Web address (mandatory)**: only distant GeoRSS are managed. + +CSV import +********** + +As the format of the CSV file managed by Chimère could vary depending on the +property you have add on your Chimère instance we recommend you to first do +an export of some items in CSV with Chimère. The CSV format of the exported +file will meet Chimère requirements. By the way because of the geometry of +the item this format is not very convenient to add new content but could +be handy to update informations. + +.. image:: _static/chimere_admin_import_CSV.png + +- **Web address/source file (mandatory)**: your CSV file could be distant or a + local file. You'll have to fill one of the two fields. + +.. _osm-import: + +OpenStreetMap import +******************** + +.. image:: _static/chimere_admin_import_OSM.png + +To import from OSM Chimère uses the XAPI API of OSM. + +- **Web address (mandatory)**: XAPI url used to import data. This field should + be filled with a default address. By default the MapQuest server is used as it + seems to be the more robust. If you experience problems with OSM import check + the availability of the XAPI server used and eventually change it. +- **Filter area (mandatory)**: draw the bounding box you want to use for your + OSM import. +- **Filter type (mandatory)**: choose if you want to import way or nodes. +- **Filter tag (mandatory)**: choose the OSM key/value couple used to filter OSM + data. A link to the `OSM Map features page + <https://wiki.openstreetmap.org/wiki/Map_Features>`_ is provided to help you + find appropriate values. +- **Refresh button**: this button convert your choices to appropriate XAPI args. + You have to hit this button before validating the form. + +Importing +********* + +Once your new import item created. Select it in the import object list, select +the **Import** action and validated. + +The import should be processing normally. If not an explicit error message +should be print in the state column of your import. + +Managing imported data +********************** + +All new imported items have the state **Imported**. To make them available on +the map you'll have to validate them. If you don't want an item to be visible on +the map instead of delete them it is recommended to set them to the state +**Disabled**. + +.. Warning:: + Be careful with duplicates between your existing data and imported data. This + is particularly important if you want to export your data to OSM. + +Exporting +--------- + +Export to CSV/KML/Shapefile +*************************** + +Directly from the :ref:`geographic items list <geographic-items-management>` you +can export to the choose format. All you have to do is to select the desired +items, choose the appropriate action in the action list and validate. + +Export to OSM +************* + +.. Warning:: + If you are not sure of what you are doing with OSM export: don't do it! It is + really important to not mess with others data. + +.. Note:: + Only export of OSM nodes are managed. + +OSM export is not that easily managed. First (if not yet done) you'll have to +define an import (:ref:`see above <osm-import>` for details). This will permit +to determine: + +- the area concerned by your export. +- the key/value tag to append to your new/updated items. +- the subcategories concerned by your export. If you think that some items in + theses subcategories should not be in OSM database (because there are not + relevant or because of license issues) beforehand mark them as **Not for OSM** + in the *import fields* of the :ref:`geographic items forms + <geographic-items-management>`. + + +The OSM export in Chimère is designed to be the more preservative possible in +regards to OSM database. That's why before any export an import is done. If +the new import has updated data theses new data will overload data in your +Chimère (if you don't want that: don't do export). All pending imported items +should have been treated before doing an export. + +To launch an export select the appropriate Import object in the imports list. +Then select the **Export to OSM** action and validate. +Then you'll be asked for your OSM username and password and the API you want to +use. If you use regularly Chimère to do export it is recommended to create an +OSM specific account for that. +The test API is available to make export test. If you want to use the test +API you'll have to create a specific account on the test platform. + +.. Warning:: + The data on the test platform are not synced with the main platform you are + not going to have the same data that you got with XAPI. + +Once all this field filled you can (finally!) launch the export. + +When exporting tags are automatically added/updated: + +- *name*: get from the item name in Chimère. +- *source*: to identify Chimère as a source. diff --git a/docs/_build/html/_static/chimere_admin_import_CSV.png b/docs/_build/html/_static/chimere_admin_import_CSV.png Binary files differnew file mode 100644 index 0000000..e67a37b --- /dev/null +++ b/docs/_build/html/_static/chimere_admin_import_CSV.png diff --git a/docs/_build/html/_static/chimere_admin_import_KML.png b/docs/_build/html/_static/chimere_admin_import_KML.png Binary files differnew file mode 100644 index 0000000..b48d69a --- /dev/null +++ b/docs/_build/html/_static/chimere_admin_import_KML.png diff --git a/docs/_build/html/_static/chimere_admin_import_OSM.png b/docs/_build/html/_static/chimere_admin_import_OSM.png Binary files differnew file mode 100644 index 0000000..a599348 --- /dev/null +++ b/docs/_build/html/_static/chimere_admin_import_OSM.png diff --git a/docs/_build/html/_static/chimere_admin_import_georss.png b/docs/_build/html/_static/chimere_admin_import_georss.png Binary files differnew file mode 100644 index 0000000..5278652 --- /dev/null +++ b/docs/_build/html/_static/chimere_admin_import_georss.png diff --git a/docs/_build/html/_static/chimere_admin_import_shapefile.png b/docs/_build/html/_static/chimere_admin_import_shapefile.png Binary files differnew file mode 100644 index 0000000..ce612be --- /dev/null +++ b/docs/_build/html/_static/chimere_admin_import_shapefile.png diff --git a/docs/_build/html/administration.html b/docs/_build/html/administration.html index c2f1d30..b4c3bb1 100644 --- a/docs/_build/html/administration.html +++ b/docs/_build/html/administration.html @@ -23,7 +23,7 @@ <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="Chimère import/export" href="import_export.html" /> + <link rel="next" title="Import/export" href="import_export.html" /> <link rel="prev" title="Configuration" href="configuration.html" /> </head> <body> @@ -34,7 +34,7 @@ <a href="genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > - <a href="import_export.html" title="Chimère import/export" + <a href="import_export.html" title="Import/export" accesskey="N">next</a> |</li> <li class="right" > <a href="configuration.html" title="Configuration" @@ -56,7 +56,7 @@ <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 class="field"><th class="field-name">date:</th><td class="field-body">2012-11-28</td> </tr> <tr class="field"><th class="field-name">Copyright:</th><td class="field-body">CC-BY 3.0</td> </tr> @@ -169,7 +169,7 @@ The element type is the type of element the subcategory can contain: POI, route or both.</p> </div> <div class="section" id="edition-moderation-of-items"> -<h2>Edition/moderation of items<a class="headerlink" href="#edition-moderation-of-items" title="Permalink to this headline">¶</a></h2> +<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> <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> @@ -189,10 +189,11 @@ one by one.</li> <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> +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 @@ -255,7 +256,7 @@ reference item.</li> title="previous chapter">Configuration</a></p> <h4>Next topic</h4> <p class="topless"><a href="import_export.html" - title="next chapter">Chimère import/export</a></p> + title="next chapter">Import/export</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="_sources/administration.txt" @@ -285,7 +286,7 @@ reference item.</li> <a href="genindex.html" title="General Index" >index</a></li> <li class="right" > - <a href="import_export.html" title="Chimère import/export" + <a href="import_export.html" title="Import/export" >next</a> |</li> <li class="right" > <a href="configuration.html" title="Configuration" diff --git a/docs/_build/html/customisation.html b/docs/_build/html/customisation.html index 1958ead..62f864c 100644 --- a/docs/_build/html/customisation.html +++ b/docs/_build/html/customisation.html @@ -7,7 +7,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Chimère customisation — Chimère v2.0 documentation</title> + <title>Customisation — 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"> @@ -23,7 +23,7 @@ <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="prev" title="Chimère import/export" href="import_export.html" /> + <link rel="prev" title="Import/export" href="import_export.html" /> </head> <body> <div class="related"> @@ -33,7 +33,7 @@ <a href="genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > - <a href="import_export.html" title="Chimère import/export" + <a href="import_export.html" title="Import/export" accesskey="P">previous</a> |</li> <li><a href="index.html">Chimère v2.0 documentation</a> »</li> </ul> @@ -44,15 +44,15 @@ <div class="bodywrapper"> <div class="body"> - <div class="section" id="chimere-customisation"> -<h1>Chimère customisation<a class="headerlink" href="#chimere-customisation" title="Permalink to this headline">¶</a></h1> + <div class="section" id="customisation"> +<h1>Customisation<a class="headerlink" href="#customisation" 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 class="field"><th class="field-name">date:</th><td class="field-body">2012-11-28</td> </tr> <tr class="field"><th class="field-name">Copyright:</th><td class="field-body">CC-BY 3.0</td> </tr> @@ -99,7 +99,7 @@ for more details.</p> <div class="sphinxsidebarwrapper"> <h3><a href="index.html">Table Of Contents</a></h3> <ul> -<li><a class="reference internal" href="#">Chimère customisation</a><ul> +<li><a class="reference internal" href="#">Customisation</a><ul> <li><a class="reference internal" href="#managing-layers">Managing layers</a></li> <li><a class="reference internal" href="#customizing-the-layout-and-the-design">Customizing the layout and the design</a></li> </ul> @@ -108,7 +108,7 @@ for more details.</p> <h4>Previous topic</h4> <p class="topless"><a href="import_export.html" - title="previous chapter">Chimère import/export</a></p> + title="previous chapter">Import/export</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="_sources/customisation.txt" @@ -138,7 +138,7 @@ for more details.</p> <a href="genindex.html" title="General Index" >index</a></li> <li class="right" > - <a href="import_export.html" title="Chimère import/export" + <a href="import_export.html" title="Import/export" >previous</a> |</li> <li><a href="index.html">Chimère v2.0 documentation</a> »</li> </ul> diff --git a/docs/_build/html/import_export.html b/docs/_build/html/import_export.html index d60e25f..acfb5eb 100644 --- a/docs/_build/html/import_export.html +++ b/docs/_build/html/import_export.html @@ -7,7 +7,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Chimère import/export — Chimère v2.0 documentation</title> + <title>Import/export — 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"> @@ -23,7 +23,7 @@ <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="Chimère customisation" href="customisation.html" /> + <link rel="next" title="Customisation" href="customisation.html" /> <link rel="prev" title="Administration" href="administration.html" /> </head> <body> @@ -34,7 +34,7 @@ <a href="genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > - <a href="customisation.html" title="Chimère customisation" + <a href="customisation.html" title="Customisation" accesskey="N">next</a> |</li> <li class="right" > <a href="administration.html" title="Administration" @@ -48,15 +48,15 @@ <div class="bodywrapper"> <div class="body"> - <div class="section" id="chimere-import-export"> -<h1>Chimère import/export<a class="headerlink" href="#chimere-import-export" title="Permalink to this headline">¶</a></h1> + <div class="section" id="import-export"> +<h1>Import/export<a class="headerlink" href="#import-export" 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 class="field"><th class="field-name">date:</th><td class="field-body">2012-11-28</td> </tr> <tr class="field"><th class="field-name">Copyright:</th><td class="field-body">CC-BY 3.0</td> </tr> @@ -66,6 +66,173 @@ It has been updated for version 2.0.0.</p> <div class="section" id="importing"> <span id="id1"></span><h2>Importing<a class="headerlink" href="#importing" title="Permalink to this headline">¶</a></h2> +<p>In Chimère the import mechanism is based on <strong>Import object</strong>. Theses objects +are stored in database to keep trace of imports and to facilitate the +re-importation from the same source. In fact if possible the update of data from +a same type of source is managed. The ability to do such updates depends on the +existence of a unique id for each object on your source.</p> +<p>To add an <strong>Import object</strong> you need to go to <em>Chimere > Imports</em> then <strong>Add</strong>.</p> +<p>After that you’ll have to select your source type and then the form depends on +the type of source.</p> +<div class="section" id="common-fields"> +<h3>Common fields<a class="headerlink" href="#common-fields" title="Permalink to this headline">¶</a></h3> +<ul class="simple"> +<li><strong>Name by default</strong>: if no name can be identified to the newly imported object +this is the name that will be used. If this field is empty the name of the +associated category will be use.</li> +<li><strong>SRID</strong>: Chimère will try to identify automatically the correct projection +from the given source. But sometimes the information is not present or cannot +be guessed (for instance a Shapefile that uses non standard proj file). In +this case Chimère will use WGS84 by default (the classic latitude/longitude) +but it is not always correct. If you experience problems with items +localisation you should put here the SRID associated to the projection of +your source.</li> +<li><strong>Origin</strong>: if not null this field will be associated to each item imported in +order to easily identify where the item came from. For OSM import the source +is automatically added.</li> +<li><strong>License</strong>: if not null this field will be associated to each item imported in +order to easily identify the license associated to the item. For OSM import +the license is automatically added.</li> +<li><strong>Associated subcategories (mandatory)</strong>: The selected subcategories will be +associated to newly imported items.</li> +</ul> +</div> +<div class="section" id="kml-import"> +<h3>KML import<a class="headerlink" href="#kml-import" title="Permalink to this headline">¶</a></h3> +<img alt="_images/chimere_admin_import_KML.png" src="_images/chimere_admin_import_KML.png" /> +<ul class="simple"> +<li><strong>Web address/source file (mandatory)</strong>: your KML could be distant or a local +file. You’ll have to fill one of the two fields.</li> +<li><strong>Filter</strong>: if you want to import only a specific <em>Folder</em> of your KML file +put his name on this field.</li> +<li><strong>Zipped file</strong>: if your source is a KMLZ file (a zipped KML) check this case.</li> +</ul> +</div> +<div class="section" id="shapefile-import"> +<h3>Shapefile import<a class="headerlink" href="#shapefile-import" title="Permalink to this headline">¶</a></h3> +<img alt="_images/chimere_admin_import_shapefile.png" src="_images/chimere_admin_import_shapefile.png" /> +<ul class="simple"> +<li><strong>Web address/source file (mandatory)</strong>: your KML could be distant or a local +file. You’ll have to fill one of the two fields.</li> +<li><strong>Zipped file</strong>: only zipped shapefile are accepted this checkbox have to be +checked.</li> +</ul> +</div> +<div class="section" id="georss-import"> +<h3>GeoRSS import<a class="headerlink" href="#georss-import" title="Permalink to this headline">¶</a></h3> +<p>Simple GeoRSS and W3C GeoRSS are managed.</p> +<img alt="_images/chimere_admin_import_georss.png" src="_images/chimere_admin_import_georss.png" /> +<ul class="simple"> +<li><strong>Web address (mandatory)</strong>: only distant GeoRSS are managed.</li> +</ul> +</div> +<div class="section" id="csv-import"> +<h3>CSV import<a class="headerlink" href="#csv-import" title="Permalink to this headline">¶</a></h3> +<p>As the format of the CSV file managed by Chimère could vary depending on the +property you have add on your Chimère instance we recommend you to first do +an export of some items in CSV with Chimère. The CSV format of the exported +file will meet Chimère requirements. By the way because of the geometry of +the item this format is not very convenient to add new content but could +be handy to update informations.</p> +<img alt="_images/chimere_admin_import_CSV.png" src="_images/chimere_admin_import_CSV.png" /> +<ul class="simple"> +<li><strong>Web address/source file (mandatory)</strong>: your CSV file could be distant or a +local file. You’ll have to fill one of the two fields.</li> +</ul> +</div> +<div class="section" id="openstreetmap-import"> +<span id="osm-import"></span><h3>OpenStreetMap import<a class="headerlink" href="#openstreetmap-import" title="Permalink to this headline">¶</a></h3> +<img alt="_images/chimere_admin_import_OSM.png" src="_images/chimere_admin_import_OSM.png" /> +<p>To import from OSM Chimère uses the XAPI API of OSM.</p> +<ul class="simple"> +<li><strong>Web address (mandatory)</strong>: XAPI url used to import data. This field should +be filled with a default address. By default the MapQuest server is used as it +seems to be the more robust. If you experience problems with OSM import check +the availability of the XAPI server used and eventually change it.</li> +<li><strong>Filter area (mandatory)</strong>: draw the bounding box you want to use for your +OSM import.</li> +<li><strong>Filter type (mandatory)</strong>: choose if you want to import way or nodes.</li> +<li><strong>Filter tag (mandatory)</strong>: choose the OSM key/value couple used to filter OSM +data. A link to the <a class="reference external" href="https://wiki.openstreetmap.org/wiki/Map_Features">OSM Map features page</a> is provided to help you +find appropriate values.</li> +<li><strong>Refresh button</strong>: this button convert your choices to appropriate XAPI args. +You have to hit this button before validating the form.</li> +</ul> +</div> +<div class="section" id="id2"> +<h3>Importing<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3> +<p>Once your new import item created. Select it in the import object list, select +the <strong>Import</strong> action and validated.</p> +<p>The import should be processing normally. If not an explicit error message +should be print in the state column of your import.</p> +</div> +<div class="section" id="managing-imported-data"> +<h3>Managing imported data<a class="headerlink" href="#managing-imported-data" title="Permalink to this headline">¶</a></h3> +<p>All new imported items have the state <strong>Imported</strong>. To make them available on +the map you’ll have to validate them. If you don’t want an item to be visible on +the map instead of delete them it is recommended to set them to the state +<strong>Disabled</strong>.</p> +<div class="admonition warning"> +<p class="first admonition-title">Warning</p> +<p class="last">Be careful with duplicates between your existing data and imported data. This +is particularly important if you want to export your data to OSM.</p> +</div> +</div> +</div> +<div class="section" id="exporting"> +<h2>Exporting<a class="headerlink" href="#exporting" title="Permalink to this headline">¶</a></h2> +<div class="section" id="export-to-csv-kml-shapefile"> +<h3>Export to CSV/KML/Shapefile<a class="headerlink" href="#export-to-csv-kml-shapefile" title="Permalink to this headline">¶</a></h3> +<p>Directly from the <a class="reference internal" href="administration.html#geographic-items-management"><em>geographic items list</em></a> you +can export to the choose format. All you have to do is to select the desired +items, choose the appropriate action in the action list and validate.</p> +</div> +<div class="section" id="export-to-osm"> +<h3>Export to OSM<a class="headerlink" href="#export-to-osm" title="Permalink to this headline">¶</a></h3> +<div class="admonition warning"> +<p class="first admonition-title">Warning</p> +<p class="last">If you are not sure of what you are doing with OSM export: don’t do it! It is +really important to not mess with others data.</p> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">Only export of OSM nodes are managed.</p> +</div> +<p>OSM export is not that easily managed. First (if not yet done) you’ll have to +define an import (<a class="reference internal" href="#osm-import"><em>see above</em></a> for details). This will permit +to determine:</p> +<ul class="simple"> +<li>the area concerned by your export.</li> +<li>the key/value tag to append to your new/updated items.</li> +<li>the subcategories concerned by your export. If you think that some items in +theses subcategories should not be in OSM database (because there are not +relevant or because of license issues) beforehand mark them as <strong>Not for OSM</strong> +in the <em>import fields</em> of the <a class="reference internal" href="administration.html#geographic-items-management"><em>geographic items forms</em></a>.</li> +</ul> +<p>The OSM export in Chimère is designed to be the more preservative possible in +regards to OSM database. That’s why before any export an import is done. If +the new import has updated data theses new data will overload data in your +Chimère (if you don’t want that: don’t do export). All pending imported items +should have been treated before doing an export.</p> +<p>To launch an export select the appropriate Import object in the imports list. +Then select the <strong>Export to OSM</strong> action and validate. +Then you’ll be asked for your OSM username and password and the API you want to +use. If you use regularly Chimère to do export it is recommended to create an +OSM specific account for that. +The test API is available to make export test. If you want to use the test +API you’ll have to create a specific account on the test platform.</p> +<div class="admonition warning"> +<p class="first admonition-title">Warning</p> +<p class="last">The data on the test platform are not synced with the main platform you are +not going to have the same data that you got with XAPI.</p> +</div> +<p>Once all this field filled you can (finally!) launch the export.</p> +<p>When exporting tags are automatically added/updated:</p> +<ul class="simple"> +<li><em>name</em>: get from the item name in Chimère.</li> +<li><em>source</em>: to identify Chimère as a source.</li> +</ul> +</div> </div> </div> @@ -77,8 +244,23 @@ It has been updated for version 2.0.0.</p> <div class="sphinxsidebarwrapper"> <h3><a href="index.html">Table Of Contents</a></h3> <ul> -<li><a class="reference internal" href="#">Chimère import/export</a><ul> -<li><a class="reference internal" href="#importing">Importing</a></li> +<li><a class="reference internal" href="#">Import/export</a><ul> +<li><a class="reference internal" href="#importing">Importing</a><ul> +<li><a class="reference internal" href="#common-fields">Common fields</a></li> +<li><a class="reference internal" href="#kml-import">KML import</a></li> +<li><a class="reference internal" href="#shapefile-import">Shapefile import</a></li> +<li><a class="reference internal" href="#georss-import">GeoRSS import</a></li> +<li><a class="reference internal" href="#csv-import">CSV import</a></li> +<li><a class="reference internal" href="#openstreetmap-import">OpenStreetMap import</a></li> +<li><a class="reference internal" href="#id2">Importing</a></li> +<li><a class="reference internal" href="#managing-imported-data">Managing imported data</a></li> +</ul> +</li> +<li><a class="reference internal" href="#exporting">Exporting</a><ul> +<li><a class="reference internal" href="#export-to-csv-kml-shapefile">Export to CSV/KML/Shapefile</a></li> +<li><a class="reference internal" href="#export-to-osm">Export to OSM</a></li> +</ul> +</li> </ul> </li> </ul> @@ -88,7 +270,7 @@ It has been updated for version 2.0.0.</p> title="previous chapter">Administration</a></p> <h4>Next topic</h4> <p class="topless"><a href="customisation.html" - title="next chapter">Chimère customisation</a></p> + title="next chapter">Customisation</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="_sources/import_export.txt" @@ -118,7 +300,7 @@ It has been updated for version 2.0.0.</p> <a href="genindex.html" title="General Index" >index</a></li> <li class="right" > - <a href="customisation.html" title="Chimère customisation" + <a href="customisation.html" title="Customisation" >next</a> |</li> <li class="right" > <a href="administration.html" title="Administration" diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html index adf3c68..216ee3f 100644 --- a/docs/_build/html/index.html +++ b/docs/_build/html/index.html @@ -81,11 +81,12 @@ <li class="toctree-l2"><a class="reference internal" href="administration.html#managing-end-user-amendment">Managing end user amendment</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="import_export.html">Chimère import/export</a><ul> +<li class="toctree-l1"><a class="reference internal" href="import_export.html">Import/export</a><ul> <li class="toctree-l2"><a class="reference internal" href="import_export.html#importing">Importing</a></li> +<li class="toctree-l2"><a class="reference internal" href="import_export.html#exporting">Exporting</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="customisation.html">Chimère customisation</a><ul> +<li class="toctree-l1"><a class="reference internal" href="customisation.html">Customisation</a><ul> <li class="toctree-l2"><a class="reference internal" href="customisation.html#managing-layers">Managing layers</a></li> <li class="toctree-l2"><a class="reference internal" href="customisation.html#customizing-the-layout-and-the-design">Customizing the layout and the design</a></li> </ul> diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv Binary files differindex d0161af..ef560f1 100644 --- a/docs/_build/html/objects.inv +++ b/docs/_build/html/objects.inv diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index 4019dfe..15f7cce 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({objects:{},terms:{all:[1,3,6],code:[0,1,3,4],forget:[1,3],yellow:3,signific:[1,4],osm:[0,6,3],follow:[1,6,4],feedpars:[1,4],row:3,categori:[2,6,3],hold:6,depend:[2,1,4],zone:4,readabl:[6,4],base_url:[],send:4,easiest:0,init:4,program:[],visitor:[2,1],sens:3,town:[],sourc:[2,1,3,4],string:[1,4],createsuperus:6,relev:[3,4],administr:[0,2,3,4,5,6],button:[6,3],list:[3,4],geograph:[6,3,4],item:[2,6,3],quick:[],initialis:[2,1,6,4],dir:4,pleas:4,base_us:[],direct:1,sign:4,second:3,design:[0,2],download:4,further:1,myusernam:4,click:[6,3],blue:3,index:[],appear:3,compar:[],section:[6,3],multimedia:[6,3],abl:6,beautifulsoup:4,access:[6,3],delet:[6,3],version:[0,1,2,3,4,5,6],"new":[0,1,2,3,4,6],net:[1,4],celeri:[1,4],chose:[],createdb:4,french:4,"005k":1,witch:6,address:[],path:[6,3,4],modifi:[0,6,3,4],sinc:4,interpret:[],leav:[],box:[6,3],search:3,epsg_project:[],larger:0,step:[1,3,6],prior:[],permit:[6,3],action:3,chang:[0,1,3,6,4],chanc:6,environn:1,chimere_tag:1,prerequisit:[2,4],extra:[0,3],father:[],modul:[],apt:[1,4],vim:[1,4],ask:6,authentifi:3,subcategori:[2,6,3],fake:1,marker:1,instal:[0,1,6,4,2],select:[6,3],from:[1,3,4],would:[1,4],univers:4,upgrad:[2,1],next:1,websit:[6,4],few:[6,3],handler:[],usr:[1,4],criteria:3,type:[0,6,3,4],more:[0,6,3,4],sort:[6,3],where_is_your_chimer:3,desir:4,share:4,relat:4,server_url:1,site:[2,6,3,4],phone:6,indic:[],particular:4,git:[1,4],recommand:4,unpack:4,cach:[2,1,6],must:[0,1,6,4],psql:4,account:[6,3,4],word:3,hour:6,prepar:1,work:[1,3,6],uniqu:[6,4],soup:4,paragraph:[1,6],below:4,can:[0,1,3,6,4],lc_messag:4,default_categori:[],root:4,control:6,prompt:4,tar:4,give:6,process:[1,3],sudo:[],smtp:4,templat:[0,1,4,2],tarbal:1,tag:[3,4],want:[0,6,3,4],default_cent:[],spe:[],mapnik:[0,6],lxml:[1,4],end:[0,6,3,2],freshli:3,anoth:4,perhap:1,write:[],pure:0,reject:3,verifi:1,simpl:[6,3],css:[0,6],updat:[0,1,2,3,4,5,6],map:[0,6,3],product:1,simpliest:4,rebas:1,stop:1,clone:[1,4],after:[1,3],superus:6,upload:[1,4],manuali:[],befor:[1,3],plane:1,beauti:4,pythondebug:[],mai:6,multipl:3,underscor:4,associ:[6,3],"short":4,practic:6,third:3,bind:1,bing:0,postgi:4,stash:1,django:[0,1,6,4],issu:[],inform:[6,3],environ:[1,6],allow:6,order:[6,3],oper:3,checkbox:3,creation:4,move:[1,4],becaus:[1,4],meter:1,through:[],effici:3,tinymce_url:4,still:4,mainli:[0,3],dynam:6,paramet:4,style:0,group:6,cli:[1,6],fit:[0,4],psycopg2:4,clickabl:[],better:4,window:[],restart:1,where_is_chimer:4,onc:[6,3],hidden:[6,3],main:3,extra_url:[],descend:3,them:[1,3,4],recal:[],thei:[6,3],python:[1,4],dai:6,initi:[1,6,4],framework:[2,6],facilit:3,nov:4,now:[1,3,4],vanilla:[],choic:[],name:[0,1,3,6,4],jquery_css_url:4,pyshar:[],gpsbabel:[1,4],drop:3,refresh:1,easili:3,xvjf:4,html2text:4,each:[0,6,3],found:4,unicod:4,email_host:4,mean:[6,3],compil:[2,4],domain:6,administration_:[],replac:[3,4],jquery_url:1,hard:[],procedur:4,realli:[],backport:[1,4],forgot:[6,3],extract:4,moder:[2,6,3],special:[1,3,4],out:3,variabl:[1,6,4],tinymc:4,newli:3,semi:0,publish:1,content:[6,3],adapt:[1,4],modpython:[],ref:[],correct:[1,4],red:3,integr:1,postgr:4,uncommit:1,migrat:[2,1,4],precaut:1,given:[1,4],free:4,like:[1,3,6,4],reason:6,base:[6,4],put:3,org:1,"9227c9":3,mychimer:[1,6],unpredict:4,gdal:[1,4],care:[3,4],spatial_ref_si:4,could:1,pictur:6,static_url:1,keep:3,filter:3,length:[1,4],isn:3,outsid:6,root_urlconf:[1,4],south:[1,4],first:[1,3,6,4],feed:[6,4],teh:3,major:1,suffix:[],render:6,feel:4,media_root:[],number:[1,3,6,4],yourself:3,restrict:6,date:[0,1,3,4,5,6],instruct:1,alreadi:4,done:[0,1,6,4],messag:6,mydjango:4,owner:4,stabl:[1,4],installed_app:1,optionali:4,size:3,differ:[0,6],district:[],script:1,data:[1,3,4],top:[],mkdir:[1,4],system:3,least:[1,6,4],attach:3,chimere_dynamic_categori:[],master:1,conveni:3,option:1,copi:[0,1,4],install_path:4,part:4,consult:3,detail_cont:[],haven:1,png:[],rss:6,serv:[1,6],kind:0,provid:[3,4],remov:[1,3],project:[2,1,6,4],pythoninterpret:[],ressourc:6,database_password:[],browser:[2,1],favorit:4,ani:[1,4],myproject:0,packag:[1,4],properli:6,manner:[],have:[1,3,6,4],tabl:[3,4],need:[0,6,3,4],element:3,pg_version:4,plpgsql:4,engin:[],bz2:4,min:1,rout:[6,3],port:[],note:3,also:[1,3],etienn:[],take:4,which:[],default_data:4,simplifi:1,map_lay:[],sethandl:[],usernam:6,english:3,createus:4,most:[6,3,4],letter:[1,4],deploi:[],geodjango:4,icon:[1,3,6],todo:4,time_zon:4,don:[1,3,6,4],url:[1,3,6,4],doc:[],clear:3,later:[1,6],flow:[],pwd:1,inde:3,database_port:[],pythonhandl:[],propos:[6,3],fact:3,wsgi:[1,4],show:6,german:[],text:6,database_us:[],directli:[6,3],session:6,loaddata:4,permiss:[6,4],line:[1,4],staff:6,chimer:[0,1,3,6,4],current:[1,3,6],onli:[0,1,3,6,4],submit:[3,4],locat:1,just:[1,4],copyright:[0,1,3,4,5,6],explain:3,configur:[2,1,6,4],apach:[1,4],should:[1,4],theme:6,cliquabl:3,local:[1,6,4],media_url:[],contribut:[1,4],get:[2,1,4],familiar:6,your_local_nam:1,pypi:[],blank:3,wheezi:[1,4],a2ensit:4,report:1,geo:4,requir:[1,6],layout:[0,2],enabl:1,specif:4,probabl:[1,6],chimere_localnam:[1,6],reload:[6,4],common:[1,4],contain:3,where:6,explainatori:[],view:6,user:[2,1,3,6,4],set:[1,3,6,4],project_nam:4,"chim\u00e8r":[0,1,2,3,4,5,6],knowledg:1,see:[6,3],mandatori:[6,3],rc3:1,epsg_display_project:[],concern:3,jqueri:[1,4],statu:[6,3],avaibl:[],correctli:3,databas:[2,1,6,4],someth:4,cours:4,label:[6,3],state:[6,3],won:1,between:1,"import":[2,1,3,4,5,6],experi:1,email:4,accord:4,postgresql_psycopg2:[],appreci:4,kei:[0,6,4],javascript:[1,4],job:[],here:4,otherwis:[6,3],purpl:3,valid:3,addit:4,cyclemap:[0,6],both:3,last:4,easi:1,admin:[1,3,4],gpsbabel_opt:1,etc:[6,4],instanc:[0,1,3,4],forgotten:6,freeli:3,login:3,com:6,database_engin:[],load:[],simpli:6,technic:6,point:[1,6],color:[6,3],arriv:6,chmod:4,header:3,colon:0,shortcut:3,poi:3,mapquest:[0,6],backend:[],quit:3,folow:1,come:3,due:6,empti:[],example_project:[0,1,4],json:4,valu:[1,3,4],interest:[6,3],modif:[6,3],popul:4,createlang:4,regroup:4,imag:4,understand:3,present:[0,2,3,4,5,6],"case":6,look:[6,3],amend:[2,3],secret_kei:4,properti:[2,1,3,6],harder:[],easier:6,trick:1,defin:[0,6],evolv:[],error:1,value_of_your_localnam:1,envvar:4,fixtur:4,compilemessag:[1,4],openstreetmap:[],bin:[1,4],layer:[0,6,2],customiz:6,applic:[6,3,4],chimere_hide_propertymodel:6,"\u00e9tienn":[0,1,3,4,5,6],customis:[0,1,2],destin:4,archiv:4,uncom:4,conf:4,mod:4,sever:1,gone:[],develop:3,welcom:[2,6],open:6,author:[0,1,3,4,5,6],media:[1,4],make:[1,3,6],exchang:[],same:[6,3,4],member:6,html:[0,3],changepassword:6,compat:0,document:[0,2,3,4,5,6],mod_wsgi:4,pan:6,complet:[6,4],http:[1,3,4],webserv:[2,1,4],logic:0,effect:3,solut:4,moment:[],auth:6,mani:[1,3,6],extern:[6,3],posgi:[],recent:3,pwprompt:4,task:6,off:[],center:[],chimere_app_path:[1,6],entri:3,well:[0,4],exampl:[6,4],thi:[0,1,3,4,5,6],choos:4,model:[2,1,6],self:3,left:[],explan:[],identifi:[6,3],execut:1,mypassword:[],obtain:4,activ:[1,6,4],insid:[6,3],sampl:[1,4],human:6,touch:[1,4],flavor:6,yet:1,languag:[0,4,2],web:[0,1,6,2],expos:3,particulari:[],"53k":4,littl:6,apache2:4,identif:3,add:[0,1,3,6],setenv:[],simplejson:[1,4],appli:[1,3,6],save:3,explanatori:3,match:[],kombu:1,real:3,libj:[1,4],format:3,read:3,piec:6,database_nam:[],password:[6,3],apart:[],linux:[1,4],insert:[],template_context_processor:[],lost:1,mychimere_project:4,unidecod:4,property_i_j:[],zoom:6,staticfil:1,server:[1,6,4],edit:[2,1,3,4],api:0,necessari:[1,6,4],"_static":[],django_settings_modul:[],resiz:3,page:[0,6,3,2],two:6,encount:4,www:[1,4],right:[6,3],chimere_display_area:[],manual:6,visibl:3,some:[0,1,3,4],begin:[1,4],revel:[],"export":[2,3,5],language_cod:4,home:[],transport:[0,6],distribut:4,lead:3,confirm:3,definit:[],per:6,whole:[],libapache2:4,jquery_js_url:4,larg:4,proj:4,slash:3,three:3,localhost:[],refer:[0,3,4],core:[],plu:3,previou:1,run:1,bold:3,chimere_default_cent:[],usag:6,host:[],squeez:[1,4],repositori:[1,4],wget:4,trustworthi:6,sub:3,postgresql:4,chimere_restricted_ext:[],column:3,eventuali:[],manag:[0,1,2,3,4,6],srv:[1,6],stand:4,discard:3,backup:1,disabl:[6,3],own:6,addus:4,additionn:[],pythonpath:[],submitt:3,encod:4,bound:6,automat:6,appropri:[0,6,4],been:[0,1,3,4,5,6],contrib:[1,4],openlay:0,your:[0,1,3,6,4],libgeo:4,accordingli:4,mod_python:[],lwpostgi:[],wai:[0,4],area:[0,6,2],lok:[0,1,3,4,5,6],secret:4,"long":6,custom:[0,6,4,2],avail:[0,1,3,6,4],interfac:6,"var":[1,4],submiss:[],treat:3,"function":6,chimere_path:[1,6],local_set:[1,6,4],form:[6,3],forc:[2,1],ascend:3,basic:[1,3,6],back:3,your_chimere_path:1,collectstat:[1,4],link:[0,3],translat:[2,1,4],pyexiv2:[1,4],cryptograph:4,"true":6,congratul:4,pull:1,made:[0,1,3],utf:4,possibl:[6,3],"default":[0,1,6,4],checkout:[1,4],chimere_default_categori:[],displai:[6,3],rc2:[],ratatouil:[],makemessag:4,limit:6,"static":[1,4],problem:[1,4],urn:6,crosstrack:1,rvb:3,root_path:[],aerial:0,creat:[2,1,3,6,4],classic:3,parser:4,"char":4,exist:4,dgango:[],file:[0,1,3,6,4],syncdb:[1,4],chimere_default_zoom:[],check:[6,3,4],fill:[],echo:4,encrypt:4,automaticali:[],titl:3,when:[6,3],detail:[0,6,3],gettext:4,field:[1,3,6,4],old:1,other:6,librari:4,branch:[1,4],chimere_admin_01:[],test:1,you:[0,1,3,6,4],draw:[6,3],repeat:1,peacefrog:[1,4],symbol:[],drag:[6,3],database_host:[],log:[1,3,6,4],consid:1,sql:4,debian:[1,4],longer:[],migrate_properti:1,directori:[0,1,4],bottom:3,descript:[1,6,4],rule:[1,4],chown:[1,4],time:[6,4]},objtypes:{},titles:["Chim\u00e8re customisation","Upgrade","Welcome to Chim\u00e8re’s documentation!","Administration","Installation","Chim\u00e8re import/export","Configuration"],objnames:{},filenames:["customisation","upgrade","index","administration","install","import_export","configuration"]})
\ No newline at end of file +Search.setIndex({objects:{},terms:{all:[2,1],code:[0,1],forget:1,yellow:1,osm:[0,1,2],abil:2,row:1,categori:[3,1,2],depend:[3,2],xapi:2,specif:2,cach:3,sens:1,sourc:[3,1,2],django:0,mechan:2,veri:2,relev:[2,1],administr:[0,1,2,3],button:[2,1],list:[2,1],geograph:[2,1],"try":2,item:[3,1,2],initialis:3,teh:1,sync:2,second:1,design:[0,2,3],click:1,append:2,blue:1,what:2,appear:1,section:1,multimedia:1,overload:2,current:1,delet:[2,1],version:[0,1,2,3],"new":[0,1,2,3],here:2,georss:2,modif:1,address:2,path:1,modifi:[0,1],valu:[2,1],box:[2,1],search:1,larger:0,permit:[2,1],action:[2,1],chang:[0,1,2],extra:[0,1],appli:1,put:[2,1],api:[0,2],subcategori:[3,1,2],visibl:[2,1],instal:[0,3],select:[2,1],from:[2,1],zip:2,two:2,few:1,criteria:1,type:[0,1,2],more:[0,1,2],sort:1,where_is_your_chimer:1,desir:2,site:[3,1],warn:2,templat:[0,3],given:2,easiest:0,must:0,account:[2,1],word:1,sometim:2,work:1,uniqu:2,can:[0,1,2],meet:2,process:[2,1],accept:2,tag:[2,1],want:[0,1,2],mapnik:0,alwai:2,end:[0,1,3],freshli:1,pure:0,reject:1,instead:2,csv:2,simpl:[2,1],css:0,updat:[0,1,2,3],map:[0,1,2],mess:2,after:[2,1],befor:[2,1],date:[0,1,2],multipl:1,associ:[2,1],third:1,bing:0,explicit:2,element:1,issu:2,inform:[2,1],order:[2,1],origin:2,checkbox:[2,1],help:2,becaus:2,mainli:[0,1],style:0,fit:0,platform:2,pend:2,hidden:1,main:[2,1],them:[2,1],thei:1,handi:2,framework:3,facilit:[2,1],now:1,choic:2,document:[0,1,2,3],name:[0,1,2],edit:[3,1],drop:1,refresh:2,easili:[2,1],localis:2,each:[0,1,2],mean:1,compil:3,recommend:2,replac:1,realli:2,forgot:1,http:1,special:1,out:1,newli:[2,1],content:[2,1],print:2,got:2,correct:2,red:1,insid:1,migrat:3,differ:0,standard:2,base:2,ask:2,"9227c9":1,care:[2,1],launch:2,could:2,keep:[2,1],filter:[2,1],isn:1,geometri:2,think:2,first:[2,1],oper:1,directli:[2,1],onc:[2,1],number:1,yourself:1,done:[0,2],blank:1,size:1,guess:2,data:[2,1],licens:2,system:1,messag:2,attach:1,conveni:[2,1],"final":2,store:2,copi:0,consult:1,kind:0,provid:[2,1],remov:1,project:[3,2],browser:3,latitud:2,beforehand:2,ani:2,myproject:0,have:[2,1],tabl:1,need:[0,1,2],seem:2,"null":2,self:1,note:[2,1],also:1,compat:0,sure:2,trace:2,normal:2,usernam:2,object:2,most:1,why:2,sub:1,don:[2,1],url:[2,1],clear:1,inde:1,determin:2,databas:[3,2],came:2,visitor:3,particularli:2,find:2,chimer:[0,1,2],access:1,onli:[0,1,2],layout:[0,3],copyright:[0,1,2],explain:1,configur:3,should:2,cliquabl:1,folder:2,local:2,hit:2,get:[3,2],regularli:2,cannot:2,requir:2,common:2,contain:1,where:2,set:[2,1],"chim\u00e8r":[0,1,2,3],see:[2,1],mandatori:[2,1],arg:2,concern:[2,1],statu:1,correctli:1,vari:2,label:1,state:[2,1],between:2,"import":[3,1,2],experi:2,kei:[0,2],purpl:1,cyclemap:0,both:1,shapefil:2,admin:1,instanc:[0,1,2],logic:0,freeli:1,login:1,color:1,header:1,colon:0,poi:1,mapquest:[0,2],duplic:2,quit:1,coupl:2,come:1,three:1,empti:2,example_project:0,treat:[2,1],interest:1,basic:1,convert:2,understand:1,present:[0,1,2,3],"case":2,look:1,amend:[3,1],properti:[3,1,2],defin:[0,2],abov:2,error:2,openstreetmap:2,layer:[0,3],kmlz:2,"\u00e9tienn":[0,1,2],customis:[0,3],develop:1,welcom:3,author:[0,1,2],make:[2,1],same:[2,1],read:1,html:[0,1],descend:1,eventu:2,wgs84:2,webserv:3,effect:1,user:[3,1],mani:1,extern:1,robust:2,recent:1,appropri:[0,2],moder:[3,1],choos:2,entri:1,well:0,non:2,thi:[0,1,2],english:1,model:3,rout:1,propos:1,identifi:[2,1],distant:2,yet:2,languag:[0,3],web:[0,2,3],expos:1,shortcut:1,identif:1,add:[0,1,2],valid:[2,1],save:1,explanatori:1,real:1,applic:1,format:[2,1],preserv:2,password:[2,1],like:1,semi:0,server:2,authentifi:1,resiz:1,page:[0,1,2,3],right:1,some:[0,1,2],back:1,"export":[3,1,2],transport:0,lead:1,confirm:1,kml:2,proj:2,slash:1,refer:[0,1],plu:1,bold:1,step:1,prerequisit:3,srid:2,column:[2,1],manag:[0,1,2,3],discard:1,disabl:[2,1],effici:1,submitt:1,bound:2,automat:2,upgrad:3,been:[0,1,2],openlay:0,mark:2,your:[0,1,2],w3c:2,log:1,wai:[0,2],area:[0,2,3],lok:[0,1,2],submit:1,custom:[0,3],avail:[0,1,2],icon:1,form:[2,1],forc:3,ascend:1,regard:2,link:[0,1,2],translat:3,made:[0,1],possibl:[2,1],"default":[0,2],displai:1,otherwis:1,problem:2,rvb:1,featur:2,aerial:0,creat:[3,1,2],classic:[2,1],exist:2,file:[0,1,2],check:[2,1],fill:2,titl:1,when:[2,1],detail:[0,1,2],field:[2,1],other:2,test:2,you:[0,1,2],node:2,draw:[2,1],drag:1,longitud:2,directori:0,bottom:1,fact:[2,1]},objtypes:{},titles:["Customisation","Administration","Import/export","Welcome to Chim\u00e8re’s documentation!"],objnames:{},filenames:["customisation","administration","import_export","index"]})
\ No newline at end of file diff --git a/docs/_static/chimere_admin_import_CSV.png b/docs/_static/chimere_admin_import_CSV.png Binary files differnew file mode 100644 index 0000000..e67a37b --- /dev/null +++ b/docs/_static/chimere_admin_import_CSV.png diff --git a/docs/_static/chimere_admin_import_KML.png b/docs/_static/chimere_admin_import_KML.png Binary files differnew file mode 100644 index 0000000..b48d69a --- /dev/null +++ b/docs/_static/chimere_admin_import_KML.png diff --git a/docs/_static/chimere_admin_import_OSM.png b/docs/_static/chimere_admin_import_OSM.png Binary files differnew file mode 100644 index 0000000..a599348 --- /dev/null +++ b/docs/_static/chimere_admin_import_OSM.png diff --git a/docs/_static/chimere_admin_import_georss.png b/docs/_static/chimere_admin_import_georss.png Binary files differnew file mode 100644 index 0000000..5278652 --- /dev/null +++ b/docs/_static/chimere_admin_import_georss.png diff --git a/docs/_static/chimere_admin_import_shapefile.png b/docs/_static/chimere_admin_import_shapefile.png Binary files differnew file mode 100644 index 0000000..ce612be --- /dev/null +++ b/docs/_static/chimere_admin_import_shapefile.png diff --git a/docs/administration.rst b/docs/administration.rst index 641e3a3..fa95012 100644 --- a/docs/administration.rst +++ b/docs/administration.rst @@ -6,7 +6,7 @@ Administration ============== :Author: Étienne Loks -:date: 2012-10-08 +:date: 2012-11-28 :Copyright: CC-BY 3.0 This document presents the administration of Chimère. @@ -130,6 +130,8 @@ basic color it can be set with the English name (for instance: *red*, *blue*, The element type is the type of element the subcategory can contain: POI, route or both. +.. _geographic-items-management: + Edition/moderation of items --------------------------- @@ -155,11 +157,12 @@ There is a some actions available in the action list. 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 *Import fields* only make sense with data imported from an external +fields. +- The *Import fields* only make sense with data imported from an external source or for data to be exported to OSM cf. to the :ref:`import section -<importing>` of this documentation. *Associated items fields* are read only -fields that list items associated to the current one (reference item of an -amendment, associated file of a route). +<importing>` of this documentation. +- *Associated items fields* are read only fields that list items associated to +the current one (reference item of an amendment, associated file of a route). Associated multimedia items are at the bottom of the form. You can freely add, change items and change their order with drag and drop. diff --git a/docs/customisation.rst b/docs/customisation.rst index 23e3902..e6615db 100644 --- a/docs/customisation.rst +++ b/docs/customisation.rst @@ -1,11 +1,11 @@ .. -*- coding: utf-8 -*- -===================== -Chimère customisation -===================== +============= +Customisation +============= :Author: Étienne Loks -:date: 2012-10-08 +:date: 2012-11-28 :Copyright: CC-BY 3.0 This document presents the installation of Chimère. diff --git a/docs/import_export.rst b/docs/import_export.rst index a65316d..e8d283b 100644 --- a/docs/import_export.rst +++ b/docs/import_export.rst @@ -1,11 +1,11 @@ .. -*- coding: utf-8 -*- -===================== -Chimère import/export -===================== +============= +Import/export +============= :Author: Étienne Loks -:date: 2012-10-08 +:date: 2012-11-28 :Copyright: CC-BY 3.0 This document presents the administration of Chimère. @@ -15,3 +15,186 @@ It has been updated for version 2.0.0. Importing --------- + +In Chimère the import mechanism is based on **Import object**. Theses objects +are stored in database to keep trace of imports and to facilitate the +re-importation from the same source. In fact if possible the update of data from +a same type of source is managed. The ability to do such updates depends on the +existence of a unique id for each object on your source. + +To add an **Import object** you need to go to *Chimere > Imports* then **Add**. + +After that you'll have to select your source type and then the form depends on +the type of source. + +Common fields +************* + +- **Name by default**: if no name can be identified to the newly imported object + this is the name that will be used. If this field is empty the name of the + associated category will be use. +- **SRID**: Chimère will try to identify automatically the correct projection + from the given source. But sometimes the information is not present or cannot + be guessed (for instance a Shapefile that uses non standard proj file). In + this case Chimère will use WGS84 by default (the classic latitude/longitude) + but it is not always correct. If you experience problems with items + localisation you should put here the SRID associated to the projection of + your source. +- **Origin**: if not null this field will be associated to each item imported in + order to easily identify where the item came from. For OSM import the source + is automatically added. +- **License**: if not null this field will be associated to each item imported in + order to easily identify the license associated to the item. For OSM import + the license is automatically added. +- **Associated subcategories (mandatory)**: The selected subcategories will be + associated to newly imported items. + + +KML import +********** + +.. image:: _static/chimere_admin_import_KML.png + + +- **Web address/source file (mandatory)**: your KML could be distant or a local + file. You'll have to fill one of the two fields. +- **Filter**: if you want to import only a specific *Folder* of your KML file + put his name on this field. +- **Zipped file**: if your source is a KMLZ file (a zipped KML) check this case. + +Shapefile import +**************** + +.. image:: _static/chimere_admin_import_shapefile.png + + +- **Web address/source file (mandatory)**: your KML could be distant or a local + file. You'll have to fill one of the two fields. +- **Zipped file**: only zipped shapefile are accepted this checkbox have to be + checked. + +GeoRSS import +************* + +Simple GeoRSS and W3C GeoRSS are managed. + +.. image:: _static/chimere_admin_import_georss.png + +- **Web address (mandatory)**: only distant GeoRSS are managed. + +CSV import +********** + +As the format of the CSV file managed by Chimère could vary depending on the +property you have add on your Chimère instance we recommend you to first do +an export of some items in CSV with Chimère. The CSV format of the exported +file will meet Chimère requirements. By the way because of the geometry of +the item this format is not very convenient to add new content but could +be handy to update informations. + +.. image:: _static/chimere_admin_import_CSV.png + +- **Web address/source file (mandatory)**: your CSV file could be distant or a + local file. You'll have to fill one of the two fields. + +.. _osm-import: + +OpenStreetMap import +******************** + +.. image:: _static/chimere_admin_import_OSM.png + +To import from OSM Chimère uses the XAPI API of OSM. + +- **Web address (mandatory)**: XAPI url used to import data. This field should + be filled with a default address. By default the MapQuest server is used as it + seems to be the more robust. If you experience problems with OSM import check + the availability of the XAPI server used and eventually change it. +- **Filter area (mandatory)**: draw the bounding box you want to use for your + OSM import. +- **Filter type (mandatory)**: choose if you want to import way or nodes. +- **Filter tag (mandatory)**: choose the OSM key/value couple used to filter OSM + data. A link to the `OSM Map features page + <https://wiki.openstreetmap.org/wiki/Map_Features>`_ is provided to help you + find appropriate values. +- **Refresh button**: this button convert your choices to appropriate XAPI args. + You have to hit this button before validating the form. + +Importing +********* + +Once your new import item created. Select it in the import object list, select +the **Import** action and validated. + +The import should be processing normally. If not an explicit error message +should be print in the state column of your import. + +Managing imported data +********************** + +All new imported items have the state **Imported**. To make them available on +the map you'll have to validate them. If you don't want an item to be visible on +the map instead of delete them it is recommended to set them to the state +**Disabled**. + +.. Warning:: + Be careful with duplicates between your existing data and imported data. This + is particularly important if you want to export your data to OSM. + +Exporting +--------- + +Export to CSV/KML/Shapefile +*************************** + +Directly from the :ref:`geographic items list <geographic-items-management>` you +can export to the choose format. All you have to do is to select the desired +items, choose the appropriate action in the action list and validate. + +Export to OSM +************* + +.. Warning:: + If you are not sure of what you are doing with OSM export: don't do it! It is + really important to not mess with others data. + +.. Note:: + Only export of OSM nodes are managed. + +OSM export is not that easily managed. First (if not yet done) you'll have to +define an import (:ref:`see above <osm-import>` for details). This will permit +to determine: + +- the area concerned by your export. +- the key/value tag to append to your new/updated items. +- the subcategories concerned by your export. If you think that some items in + theses subcategories should not be in OSM database (because there are not + relevant or because of license issues) beforehand mark them as **Not for OSM** + in the *import fields* of the :ref:`geographic items forms + <geographic-items-management>`. + + +The OSM export in Chimère is designed to be the more preservative possible in +regards to OSM database. That's why before any export an import is done. If +the new import has updated data theses new data will overload data in your +Chimère (if you don't want that: don't do export). All pending imported items +should have been treated before doing an export. + +To launch an export select the appropriate Import object in the imports list. +Then select the **Export to OSM** action and validate. +Then you'll be asked for your OSM username and password and the API you want to +use. If you use regularly Chimère to do export it is recommended to create an +OSM specific account for that. +The test API is available to make export test. If you want to use the test +API you'll have to create a specific account on the test platform. + +.. Warning:: + The data on the test platform are not synced with the main platform you are + not going to have the same data that you got with XAPI. + +Once all this field filled you can (finally!) launch the export. + +When exporting tags are automatically added/updated: + +- *name*: get from the item name in Chimère. +- *source*: to identify Chimère as a source. |
