summaryrefslogtreecommitdiff
path: root/docs/_build/html/_sources
diff options
context:
space:
mode:
Diffstat (limited to 'docs/_build/html/_sources')
-rw-r--r--docs/_build/html/_sources/administration.txt13
-rw-r--r--docs/_build/html/_sources/customisation.txt8
-rw-r--r--docs/_build/html/_sources/import_export.txt191
3 files changed, 199 insertions, 13 deletions
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.