ODM Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Creating geo-referenced article collections using JEO's content API ======

===== Who is this guide for =====

  * Editors
  * Contributors willing to add geo-referenced contents to the CKAN database

===== What this guide teaches =====

  * How to use JEO's Content API for filtering related content and compile a collection of Wordpress posts into a GEOJSON file.
  * How to upload the GEOJSON file into the CKAN database

===== Things to know in forehand =====

  * JEO parent theme comes with a great range of useful tools for creating data-driven journalism-oriented websites. One of them is called the **content API**.
  * Parent themes can be customized by implementing a child theme, which inherits the functionality of its parent adding graphical customization elements on top of it.
  * At http://www.opendevelopmentmekong.net we are using both JEO parent and child themes.

===== Using the Content API to filter out relevant information =====

Users can access this functionality by navigaing to the following URL http://opendevelopmentmekong.net/?s=Energy (replacing Energy with whatever search term) or by clicking the "GO TO ADVANCED SEARCH" button that appears after inputting some text in the main search bar.

{{ ::bildschirmfoto_2015-03-05_um_14.19.20.png?600 |}}

In that particular screen, Editors can filter out the contents of the whole country site by means of the following fields:

  * **Text search**: Textual search.
  * **Categories**: Only show posts belonging to the selected categories.
  * **Content type**: Only show posts belonging to the selected Post types.
  * **Date range**: Filter posts by publication date.

{{ ::bildschirmfoto_2015-03-05_um_14.45.14.png?600 |}}

Once the filter criteria has been specified and the Filter button clicked, a list of result will be presented on the screen. Now editors have the possibility to compile the resulting posts into a single geojson file, that will include information such as the title or description accompaigned by geographic information (latitude, longitude). The virtue of this way of collecting data is that the geojson format is machine-readable and provides structured data, which can facilitate the work to developers, researchers or journalists willing to integrate in their workflow contents provided on opendevelopmentmekong.net.

<WRAP center round important 90%>
Please notice that, in order to be filtered by this tool, posts need to be geo-referenced. This means that editors need to pay particular attention on using JEO's geo-tagging features for all the posts they create.
</WRAP>

===== Compiling filtered contents into a GEOJSON file =====

On the same screen, but also in several elements across the platform, User will notice the following buttons:

{{ ::bildschirmfoto_2015-03-05_um_14.33.50.png?600 |}}

These buttons provide following functionality:

  * **RSS Feed**: Generates a RSS-compliant XML formatted feed with the contents of the articles filtered.
  * **Get geojson**: Outputs the contents of the filtered articles in geojson format. The interesting aspect of this feature is that the content is dynamic, meaning that if new contents get added to the platform which meet the specified criteria, they will be exposed through the same URL.
  * **Download**: Generates a geojson file that can be downloaded by the user.

===== Exposing the compiled articles on CKAN =====

After filtering out relevant information and compiling it into a geojson files, editors can follow the [[content_generation|Content generation guide]] for uploading it to CKAN and expose it to users. 

<WRAP center round important 90%>
It is very important that editors specify as much information as possible in order to make this information discoverable. Please read the guidelines related to [[metadata|Metadata]].
</WRAP>
ODM Wiki

User Tools

Site Tools

Page Tools
