Modified howtos titles and structure - #41

source/conf.py

@@ -92,7 +92,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['replace.rst', 'dtp.rst', 'datasets', 'domains.rst', 'architecture.rst'] 
+exclude_patterns = ['replace.rst', 'dtp.rst', 'datasets', 'domains.rst', 'architecture.rst', 'howto/tourism/access.rst'] 
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -144,6 +144,7 @@
              ('http://ipchannels.integreen-life.bz.it/%s', None),
              'stinfo':
              ('http://tourism.opendatahub.bz.it/swagger/ui/index#%s', None),
+             'iterconcept': ('https://en.cppreference.com/w/cpp/experimental/ranges/iterator/%s', 'std::'), 
 }
 
 numfig = True

source/howto.rst

@@ -13,7 +13,7 @@ information about each of them is provided.
 
    howto/mobility
    howto/tourism/getstarted
-   howto/tourism/access
+   howto/tourism/browse
    howto/tourism/tips
    howto/authentication
    howto/development
@@ -34,7 +34,7 @@ information about each of them is provided.
 
 #. :doc:`/howto/tourism/getstarted`. This howto describes the various
    filters available in the Tourism domain
-#. :doc:`/howto/tourism/access`. This howto provides information about
+#. :doc:`/howto/tourism/browse`. This howto provides information about
    accessing the data originating from the Tourism domain.
 #. :doc:`/howto/tourism/tips`. This howto provides some simple use cases/API
    calls and various tricks&tips for the Tourism domain.

source/howto/mobility.rst

@@ -1,6 +1,6 @@
 
-Echarging Stations Howto
-------------------------
+HOWTO access e-Charging Stations Data
+-------------------------------------
 
 This howto uses the :ref:`E-charging stations dataset <echarging-dataset>`
 to showcase a few basic API calls, whose output will be needed in most

source/howto/postman.rst

@@ -1,7 +1,7 @@
 .. role:: orange
 
-Setting Up Postman (API Development Environment)
-------------------------------------------------
+How to Sett Up Postman (API Development Environment)
+-----------------------------------------------------
 
 Postman is a popular API development environment, that is, a tool that
 is used (among other useful features) to ease the interaction with API

source/howto/tourism/access.rst

@@ -1,18 +1,6 @@
-Tourism API Howto
-=================
-
-This howto explains how to use the Tourism API developed by the |odh|
-team.
-
-There are two possibilities to interact with the data exposed by the
-|odh|'s Tourism API: You can simply browse the data using the
-dedicated portal or you can retrieve data and manipulate them within
-your application. The former method is described in
-:ref:`data-explore-tourismAPI`, while the latter is described in the
-next section.
-
+
 .. _data-access-tourismAPI:
-
+   
 Data Access and Manipulation
 ----------------------------
 
@@ -98,60 +86,3 @@ process and manipulate them with a tool like `jq
 
 .. seealso:: More detailed documentation of the exposed API methods
    can be found on http://tourism.opendatahub.bz.it/Help.
-
-
-.. _data-explore-tourismAPI:
-
-Data Browsing and Exploring
----------------------------
-
-If you need to only browse data, you can do so by pointing a browser
-to http://tourism.opendatahub.bz.it/. On the right-hand side of the
-page, you can see a box that shows the permissions to access data that
-you have as a (non-logged in) user, while the remainder of the page
-provides an overview of the various component of the project and its
-architecture.
-
-If you try to access the :strong:`ODH Data` item in the top menu, you
-will see that it is empty. In order to access data, you need to click
-on the :strong:`Login` button on the top right corner of the page.
-
-.. _tourism-login-web:
-
-.. figure:: /images/tourism-04.png
-
-   Logging in to the CMS portal.
-
-Write the username (email address) and password that was provided to
-you and click on the :button:`Log in`. You will be redirected to the
-home page as a logged in user and from here, you will see the box with
-the permissions you have to access the various types of data.
-
-If you now try to access the :strong:`ODH Data` item in the top menu,
-you will be able to select some dataset. As an example,
-:numref:`tourism-data-filter` shows what is available in the
-:menuselection:`ODH Data --> Activities & Pois --> Winter` filter - in
-this case a list of activities that can be done during the winter on
-the snow.
-
-The page allows to further filter the results, by using search strings
-and/or the list of tags underneath, to move between pages of results,
-and to change language of the interface (although at the moment the
-page is not fully translated in all languages!)
-
-.. _tourism-data-filter:
-
-.. figure:: /images/tourism-05.png
-
-   Accessing the data through filters or menu item.
-
-If you click on one of the images in the list will pop up an overlay
-with more detailed information about that activity.
-
-.. _tourism-data-detail:
-
-.. figure:: /images/tourism-06.png
-
-   Detailed view of a :abbr:`POI (Point Of Interest)`.
-
-

source/howto/tourism/browse.rst

@@ -0,0 +1,60 @@
+HOWTO use the Open Data Hub's Tourism Data Browser
+==================================================
+
+This how to explains the necessary steps to access and retrieve data
+from the |odh|'s tourism domain.
+
+
+Data Browsing and Exploring
+---------------------------
+
+In order to access the data in the tourism domain, launch a browser
+and point it to http://tourism.opendatahub.bz.it/. On the right-hand
+side of the page, you can see a box that shows the permissions to
+access data that you have as a (non-logged in) user, while the
+remainder of the page provides an overview of the various component of
+the project and its architecture.
+
+If you try to access the :strong:`ODH Data` item in the top menu, you
+will see that it is empty. In order to access data, you need to click
+on the :strong:`Login` button on the top right corner of the page.
+
+.. _tourism-login-web:
+
+.. figure:: /images/tourism-04.png
+
+   Logging in to the CMS portal.
+
+Write the username (email address) and password that was provided to
+you and click on the :button:`Log in`. You will be redirected to the
+home page as a logged in user and from here, you will see the box with
+the permissions you have to access the various types of data.
+
+If you now try to access the :strong:`ODH Data` item in the top menu,
+you will be able to select some dataset. As an example,
+:numref:`tourism-data-filter` shows what is available in the
+:menuselection:`ODH Data --> Activities & Pois --> Winter` filter - in
+this case a list of activities that can be done during the winter on
+the snow.
+
+The page allows to further filter the results, by using search strings
+and/or the list of tags underneath, to move between pages of results,
+and to change language of the interface (although at the moment the
+page is not fully translated in all languages!)
+
+.. _tourism-data-filter:
+
+.. figure:: /images/tourism-05.png
+
+   Accessing the data through filters or menu item.
+
+If you click on one of the images in the list will pop up an overlay
+with more detailed information about that activity.
+
+.. _tourism-data-detail:
+
+.. figure:: /images/tourism-06.png
+
+   Detailed view of a :abbr:`POI (Point Of Interest)`.
+
+

source/howto/tourism/getstarted.rst

@@ -1,7 +1,8 @@
 .. |li| replace:: :literal:`{Id}`
 
-Getting Started Guide For Tourism Domain
-========================================
+
+HOWTO access Tourism Data
+=========================
 
 
 .. note:: Information in this page might change in the next future.
@@ -10,8 +11,7 @@ The purpose of this howto is to quickly introduce the structure of the
 API calls, the available filters for the datasets in the Tourism
 domain, and give some general and useful information about the Tourism
 API.
-
-
+
 .. structure of the API Calls
 
 .. _tourism-api-call-structure:
@@ -147,3 +147,6 @@ strings, dates, and integers.
    Italian, German, and English. To retrieve values only in one
    language, enter :strong:`it`, :strong:`de`, or :strong:`en`,
    respectively.
+
+
+.. include:: /howto/tourism/access.rst