diff options
Diffstat (limited to 'docs/_build/html/import_export.html')
| -rw-r--r-- | docs/_build/html/import_export.html | 202 |
1 files changed, 192 insertions, 10 deletions
diff --git a/docs/_build/html/import_export.html b/docs/_build/html/import_export.html index 2772c8e..00b696c 100644 --- a/docs/_build/html/import_export.html +++ b/docs/_build/html/import_export.html @@ -8,7 +8,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Chimère import/export — Chimère 2.0 documentation</title> + <title>Import/export — Chimère 2.0 documentation</title> <link rel="stylesheet" href="_static/default.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -26,7 +26,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 2.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> @@ -37,7 +37,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" @@ -51,15 +51,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-odd field"><th class="field-name">Author:</th><td class="field-body">Étienne Loks</td> </tr> -<tr class="field-even field"><th class="field-name">date:</th><td class="field-body">2012-10-08</td> +<tr class="field-even field"><th class="field-name">date:</th><td class="field-body">2012-11-28</td> </tr> <tr class="field-odd field"><th class="field-name">Copyright:</th><td class="field-body">CC-BY 3.0</td> </tr> @@ -69,6 +69,173 @@ The version 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> @@ -80,8 +247,23 @@ The version 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> @@ -91,7 +273,7 @@ The version 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" @@ -121,7 +303,7 @@ The version 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" |