Merge branch 'master' into issue-85

source/applist.rst

@@ -30,7 +30,7 @@ an email contact and its status and we'll add it to the list.
 Production Stage Apps
 ---------------------
 
-* https://www.suedtirol.info.  This portal is the official
+* https://www.suedtirol.info/en This portal is the official
   touristic site of the South Tyrol region. It uses the data extracted
   from the :ref:`tourism-datasets` to display events in the region of
   South Tyrol and other useful information to help tourists organise
@@ -50,7 +50,7 @@ Production Stage Apps
   experiencing South Tyrol, available for both `Android
   <https://play.google.com/store/apps/details?id=com.suedtirol.android>`_
   and `iPhone
-  <https://itunes.apple.com/us/app/s%C3%BCdtirol-mobile-guide/id339011586?mt=8>`_
+  <https://apps.apple.com/us/app/s%C3%BCdtirol-mobile-guide/id339011586>`_
   mobile devices. This app offers all the functionalities of the
   above-mentioned web site, plus the ability to locate events, points
   of interest and the like near your current position.
@@ -60,7 +60,7 @@ Production Stage Apps
 Beta Stage Apps
 ---------------
 
-* https://mobility.meran.eu. This web site is the first example of a
+* https://mobility.meran.eu/ This web site is the first example of a
   Mobility-as-a-Service application; it includes real-time information
   of multiple mobility services, like public transportation, places of
   interests, car sharing services, parking lots, and more in the city
@@ -69,21 +69,21 @@ Beta Stage Apps
 * https://mobility.bz.it/ This web site is the counterpart of the
   previous one for the city of Bolzano/Bozen.
 
-* https://parking.bz.it. A web site that displays the real-time parking
+* https://parking.bz.it/ A web site that displays the real-time parking
   availability of off-street parking lots in South Tyrol. On mobile
   devices, it can also show directions from your current position to
   the chosen parking lot.
 
-* http://traffic.bz.it. Some streets in South Tyrol are monitored for
+* http://traffic.bz.it/ Some streets in South Tyrol are monitored for
   real-time vehicular travel times; the data collected are used by
   this web site to show traffic slowdowns or jams.
 
-* http://bus.bz.it. This web site shows the real-time positions of the
+* http://bus.bz.it/ This web site shows the real-time positions of the
   buses managed by the public transport operator SASA. Urban or
   suburban bus lines can be shown, and for each bus can be shown the
   next few stops and an estimate of the arrival time.
 
-* http://map.clean-roads.eu. One of the CLEAN-ROADS project outcomes,
+* https://map.clean-roads.eu/ One of the CLEAN-ROADS project outcomes,
   this web site shows real-time data of the meteorological stations
   that are situated along public streets.
 

source/apps/summerlido2018.rst

@@ -1,30 +1,29 @@
 Projects developed during the `Summer Lido Hackathon 2018
 <http://hackathon.bz.it/edition/summer-2018>`_
-
-* `South Tyrol Crime Scene (STCS)
-  <:hp:south-tyrol-crime-scene-stcs->`_ is an interactive thriller
-  combining traditional storytelling and augmented reality.
-
-* `SAMA - Smart Application Medical Appointment
-  <:hp:sama---smart-application-medical-appointment>`_ is a prototype
-  for the booking of appointments in the South Tyrolean hospitals.
+
+* :hp:`South Tyrol Crime Scene (STCS) <south-tyrol-crime-scene-stcs->`
+  is an interactive thriller combining traditional storytelling and
+  augmented reality.
 
-* `IFC Converter and AIVRTour
-  <https://hackathon.bz.it/project/ifc-converter-and-aivrtour>`_ is on
+* :hp:`SAMA - Smart Application Medical Appointment
+  <sama---smart-application-medical-appointment>` is a prototype for
+  the booking of appointments in the South Tyrolean hospitals.
+
+* :hp:`IFC Converter and AIVRTour <ifc-converter-and-aivrtour>` is on
   the one side a converter of 3D reality data formats (form ifc to
   dae/obj), while on the other side it applies AI to virtual reality
   for museums, real estates, and on tourism.
-	
-* `Travel & Win <:hp:travel-win>`_ is an app for South Tyrol tourists
+
+* :hp:`Travel & Win <travel-win>` is an app for South Tyrol tourists
   that can collect points to receive gifts.
-	
-* `Memorama <:hp:ugo>`_ Get your
-  pictures printed on paper and delivered to your hotel.
-	
-* `Sportmap.net <:hp:sportmap.net>`_ Creation of a OpenData map with
+
+* :hp:`Memorama <ugo>` Get your pictures printed on paper and
+  delivered to your hotel.
+
+* :hp:`Sportmap.net <sportmap.net>` Creation of a OpenData map with
   trendy sport locations, courses, & events.
-      
-* `Game of Alps <:hp:game-of-alps>`_ Get unique experiences by
+
+* :hp:`Game of Alps <game-of-alps>` Get unique experiences by
   completing challenges around South Tyrol. Gather crystals and
   collect rewards from local tourist offices. Additionally get
   discounts for restaurants and entrance tickets.

source/conf.py

@@ -94,9 +94,13 @@
 extlinks = { 'sasabus': ('http://sasabus.org/%s', None),
              'integreen':
              ('http://ipchannels.integreen-life.bz.it/%s', None),
+             'ig-swagger':
+             ('http://ipchannels.integreen-life.bz.it/%s/swagger-ui.html', None),
+
              'stinfo':
              ('http://tourism.opendatahub.bz.it/swagger/ui/index#%s', None),
-             'iterconcept': ('https://en.cppreference.com/w/cpp/experimental/ranges/iterator/%s', 'std::'), 
+             'iterconcept': ('https://en.cppreference.com/w/cpp/experimental/ranges/iterator/%s', 'std::'),
+             'hp': ('https://hackathon.bz.it/project/%s', None)
 }
 
 numfig = True
@@ -198,6 +202,17 @@
 #
 # man_show_urls = False
 
+# -- Options for linkcheck output -------------------------------------------
+
+linkcheck_anchors = False
+linkcheck_retries = 2
+linkcheck_ignore = [
+    'https://ci.opendatahub.bz.it',
+    'https://github.com/your-username/',
+    'http://localhost:\d+/',
+    'https://cert.provinz.bz.it/musport/services/MuseumsService.MuseumsServiceHttpSoap11Endpoint/',
+    'http://tourism.opendatahub.bz.it/token'
+]
 
 # -- Options for Texinfo output -------------------------------------------
 
@@ -222,5 +237,6 @@
 
 def setup(app):
     app.add_css_file('https://use.fontawesome.com/releases/v5.7.0/css/all.css')
+    app.add_js_file('searchtools.js')
     app.add_config_value('googleanalytics_id', '', 'html')
     app.add_config_value('googleanalytics_enabled', True, 'html')

source/contributors.rst

@@ -1,14 +1,15 @@
-GITHUB Quick Documentation for Contributors
-===========================================
+=============================================
+ GITHUB Quick Documentation for Contributors
+=============================================
 
 This section guides you in setting up on your local workstation the
 (forked) git repositories needed to contribute to the |odh| project,
 along with some troubleshooting concerning pull requests and merge
 conflicts. For more detailed help, please refer to the online Github
-help, at https://help.github.com/.
+help, at https://help.github.com/en.
 
 Prerequisites
--------------
+=============
 
 In the following documentation some example names are used. Please
 replace them with your names:
@@ -21,7 +22,7 @@ replace them with your names:
 
 
 Project Checkout
-----------------
+================
 
 Before starting the development, you need to fork the original
 (upstream) repository.
@@ -56,7 +57,7 @@ Before starting the development, you need to fork the original
       Clone the repository.
 
 Create a pull request
----------------------
+=====================
 
 In order to let your contribution be accepted in the |odh| code base,
 you need to follow the following steps.
@@ -119,7 +120,7 @@ you need to follow the following steps.
 .. _syncing-a-fork:
 
 Syncing a Fork
---------------
+==============
 
 Your forked repository does not receive the updates of the original
 repository automatically. To sync for example the
@@ -132,7 +133,8 @@ Before you can sync your fork with the original repository (an
 upstream repository), you must configure a remote that points to the
 upstream repository in Git. A more detailed description for the
 following steps can be found in the online Github help
-https://help.github.com/articles/configuring-a-remote-for-a-fork/.
+https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork
+
 
 1. List the current configured remote repository for your fork.
 
@@ -157,7 +159,7 @@ https://help.github.com/articles/configuring-a-remote-for-a-fork/.
 You need sync a fork of a repository to keep it up-to-date with the
 original repository (upstream repository). A more detailed description
 for the following steps can be found in the online Github help
-https://help.github.com/articles/syncing-a-fork/.
+https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork
 
 1. Fetch the branches and their respective commits from the upstream
    repository. Commits to :strong:`development` will be stored in a
@@ -183,7 +185,7 @@ https://help.github.com/articles/syncing-a-fork/.
       git merge upstream/development
     
 Resolving Merge Conflicts
--------------------------
+=========================
 
 When creating and working on a pull request, it could happen that the
 destination branch of the original repository will change. These
@@ -265,4 +267,5 @@ To resolve merge conflicts, the following steps must be performed.
 
       A solved merge conflict. 
 
-A more detailed description can be found in the online Github help: https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/.
+A more detailed description can be found in the online Github help:
+https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line.

source/datasets/bluetooth.rst

@@ -3,10 +3,18 @@
 -----------------
 
 The data for this datasets are collected by experimental
-Bluetooth-based sensors and detectors and represent traffic
-information, since the detectors scan available Bluetooth devices on
-board of vehicle that drive on.
+Bluetooth-based sensors and detectors currently located on various
+points of the streets of Bolzano and soon in other location of South
+Tyrol. Gathered data are then processed to obtain useful information
+about the traffic; therefore, data in this dataset are:
 
+* The total number of vehicles detected
+* An estimation of heavy and light vehicles
+
+Collected data are also split within intervals (of e.g.,15, 30
+minutes), for statistical and historical offline analysis. Moreover,
+the data gathered by the Bluetooth devices are used in the
+:ref:`linkstation-dataset`.
 
 ==============  ========================================================
 Output          JSON, mime-type application/json

source/datasets/linkstation.rst

@@ -2,9 +2,23 @@
 |idgb|\ linkstation
 -------------------
 
-Similar to the :ref:`Bluetooth dataset <bluetooth-dataset>`, data
-available in this dataset are collected by Bluetooth-based sensors to
-measure the level of traffic on the strech of a road.
+The data for this dataset are collected by the same Bluetooth-based
+sensors that are used to produce the :ref:`Bluetooth dataset
+<bluetooth-dataset>`. Indeed, the data gathered by the sensors will be
+used to produce statistics about a LinkStation, which is defined as
+the path between an ordered pair of bluetooth stations.
+
+* the :strong:`valid matches` between pairs of Bluetooth sensors (also
+  called Bluetooth stations).
+* The :strong:`number of matches per predefined time interval` (e.g.,
+  30 or 60 minutes), like in the Bluetooth dataset
+* The :strong:`estimated travel time and speed` of the vehicle, computed for
+  every 15 minutes interval only.
+
+The definitions and algorithm used in the computations are extensively
+described in Section `Data analysis complexity` of `this pdf article
+<https://www.integreen-life.bz.it/it/c/document_library/get_file?uuid=f1702bf2-5ed9-42a5-a85b-42a3d97a3e6b&groupId=17369>`_.
+
 
 ==============  ========================================================
 Output          JSON, mime-type application/json

source/glossary.rst

@@ -133,3 +133,7 @@ Glossary
      composed of a URI, a collection of methods to interact with the
      resources offered by the Web Service, and a media type defining
      the accepted data formats.
+
+   Web Component
+     A Web Component is a set of API that allows the creation of
+     interoperable HTML widgets that can be shared and reused.

source/guidelines/database.rst

@@ -5,7 +5,8 @@ Database Guidelines - Full Version
 
 .. topic:: Changelog
 
-   * :strong:`2018-05-28 version 1.0`
+   * :strong:`2020-01-20 version 1.1` -- fixed outgoing links
+   * 2018-05-28 version 1.0
 
 +++++
 
@@ -46,7 +47,7 @@ Specifically, the following methodologies are well known and acceptable:
    :command:`CREATE` statements are written by the developer.  The
    JSON data column must use the PostgreSQL native data type
    :strong:`jsonb` (see `binary stored JSON
-   <https://www.postgresql.org/docs/10/static/datatype-json.html#JSON-DOC-DESIGN>`_
+   <https://www.postgresql.org/docs/10/datatype-json.html#JSON-DOC-DESIGN>`_
    in PostgreSQL documentation).
 
 PostgreSQL supports all three methodologies well. It is also possible
@@ -150,7 +151,7 @@ Contributors can expect their database design to be stored into a
 schema whose name is determined by the |odh| team and executed as a
 non-privileged user account that has the given schema in its default
 :strong:`search_path` (see `DDL schema path
-<https://www.postgresql.org/docs/10/static/ddl-schemas.html#DDL-SCHEMAS-PATH>`_
+<https://www.postgresql.org/docs/10/ddl-schemas.html#DDL-SCHEMAS-PATH>`_
 in PostgreSQL documentation).
 
 Unless there is a specific reason, contributed designs must use
@@ -181,15 +182,15 @@ Hence, the general rule is that database designs submitted to the
 However, (small) utility procedures and functions, especially with
 respect to triggers, are allowed. When used, these procedures and
 functions must be written in `PL/PgSQL
-<https://www.postgresql.org/docs/10/static/plpgsql.html>`_. Other
+<https://www.postgresql.org/docs/10/plpgsql.html>`_. Other
 server-side languages, even the trusted ones, are neither allowed, nor
 can they be expected to be available.
 
 An example of such an allowed instance of a procedure is an audit
 trigger that, for any changes made to :strong:`Table A` generates a
 log entry that is stored in :strong:`Table B`.
 
-Foreign data wrappers (`SQL/MED <https://www.postgresql.org/docs/10/static/sql-createforeigndatawrapper.html>`_) :strong:`must not` be used.
+Foreign data wrappers (`SQL/MED <https://www.postgresql.org/docs/10/sql-createforeigndatawrapper.html>`_) :strong:`must not` be used.
 
 Indices and Partioning
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -207,7 +208,7 @@ columns will benefit from indices, when the number of records grows.
 In particular, if methodology 3 (JSON) is chosen, PostgreSQL provides
 specialized multi-dimensional indices of type GIN to index the `jsonb
 data type
-<https://www.postgresql.org/docs/10/static/datatype-json.html#JSON-INDEXING>`_.
+<https://www.postgresql.org/docs/10/datatype-json.html#JSON-INDEXING>`_.
 
 If the contributor anticipates designs with large tables (say more
 than 100M records or more than 5 GB on disk) and expects queries
@@ -243,7 +244,7 @@ and Italian::
 A contributor is free to add a custom collation such as
 :envvar:`de_DE` or :envvar:`it_IT`, either at the DDL level or the
 query level (see `PostgreSQL documentation on collation
-<https://www.postgresql.org/docs/10/static/collation.html>`_),
+<https://www.postgresql.org/docs/10/collation.html>`_),
 although there is most likely no need to apply other collations.
 
 
@@ -310,7 +311,7 @@ Sometimes developers need to convert to and from text. In case a
 contributing developer wishes to do this using PostgreSQL functions,
 they must use functions :strong:`to_date()` and :strong:`to_char()`
 (see `PostgreSQL documentation on function formatting
-<https://www.postgresql.org/docs/10/static/functions-formatting.html>`_).
+<https://www.postgresql.org/docs/10/functions-formatting.html>`_).
 
 For example:
 

source/guidelines/introduction.rst

@@ -4,7 +4,7 @@ Guidelines for Developers
 =========================
 
 |odh| is a collection of software, databases, and services coordinated
-and hosted by `NOI techpark <https://noi.bz.it/>`_ in Bolzano/Bozen,
+and hosted by `NOI techpark <https://noi.bz.it/en>`_ in Bolzano/Bozen,
 South Tyrol. Currently, |odh| systems are related to mobility and
 tourism. In the future |odh| might diversify into more fields.
 

source/guidelines/platform.rst

@@ -6,8 +6,9 @@ Platform Guidelines - Full Version
 
 
 .. topic:: Changelog
-
-   * :strong:`2018-05-28 version 1.0`
+
+   * :strong:`2020-01-20 version 1.1` -- fixed outgoing links
+   * 2018-05-28 version 1.0
    * 2018-03-30 version 1.0-beta
 
 +++++

source/howto.rst

@@ -49,6 +49,9 @@ available here:
 	 #. :doc:`/howto/noievents` Create and modify NOI events
 	    directly from the |odh| portal.
 
+	 #. :doc:`howto/webcomponents` share your Web Components with
+	    |odh| team
+
 
 .. only:: latex or latexpdf or epub
 
@@ -86,7 +89,8 @@ available here:
    #. :doc:`/howto/noievents` Create and modify NOI events directly
       from the |odh| portal.
 
-
+   #. :doc:`howto/webcomponents` share your webcomponents with
+      |odh| team
 
 .. toctree::
    :maxdepth: 1
@@ -101,3 +105,4 @@ available here:
    howto/postman
    howto/noievents
    howto/tourism/tips
+   howto/webcomponents