Merge pull request #235 from cvvergara/refining-un-chapters

Refining UN chapters

Author: cvvergara

Readme.md

@@ -21,31 +21,26 @@
 ### Build the workshop:
 
 ```bash
-cd docs
+dropdb city_routing
+mkdir build
+cd build
+cmake ..
 make html
+cd ..
 ```
+
 ### Building PDF
 
 Install prerequisite:
 ```bash
 sudo apt-get install texlive-latex-extra
 ```
 
-To build the documentation as PDF:
-
-```bash
-cd docs
-make latexpdf
-cd _build/latex/
-pdflatex -interaction=nonstopmode pgRoutingWorkshop.tex
-```
-
 ## License
 
 This workshop is licensed under a [Creative Commons Attribution-Share Alike 3.0 License](http://creativecommons.org/licenses/by-sa/3.0/).
 
 ## Supported by
 
-* [Georepublic](https://georepublic.info)
-* [iMaptools](http://imaptools.com)
 * [Paragon Corporation](https://www.paragoncorporation.com)
+* [erosion](https://www.erosion.dev)

docs/basic/graph_views.rst

@@ -23,10 +23,10 @@ discard disconnected segments and different approaches to create graphs.
 The graph requirements
 ===============================================================================
 
-In this chapter there are three graph requirements. It consists on three **fully
-connected** graphs: two for different types of vehicles and one for pedestrian,
-the source and the target in all of them are based on the ``source_osm`` and
-``target_osm``.
+In this chapter there are three graph requirements. It consists on three graphs
+based on a **fully connected** graph derived from ways: two for different types
+of vehicles and one for pedestrian, the source and the target in all of them are
+based on the ``source_osm`` and ``target_osm``.
 
 The description of the graphs:
 
@@ -142,7 +142,7 @@ Count the number of rows that need to be filled up.
 
   .. literalinclude:: ../scripts/basic/chapter_7/fill_columns_1.txt
 
-* Update the ``geom`` columns based on the ``sourse_osm`` column
+* Update the ``geom`` columns based on the ``source_osm`` column
   from ``ways`` table.
 * Use the start point of the geometry.
 
@@ -542,7 +542,7 @@ Exercise 8: Testing the views for routing
 
 .. image:: images/chapter7/ch7-e3.png
   :scale: 25%
-  :alt:   From the Venue to the hotel using the osm_id.
+  :alt: From the "|ch7_place_1|" to the "|ch7_place_2|"
 
 .. rubric:: Problem
 
@@ -594,7 +594,7 @@ For ``vehicle_net``:
 For ``taxi_net``:
 
 * Similar as the previous one but with ``taxi_net``. (line **3**)
-* The results give the same route as with ``vehicle_net`` but ``cost`` is lower
+* The results give the same route as with ``vehicle_net`` but ``cost`` is higher
 
 .. literalinclude:: ../scripts/basic/chapter_7/all_sections.sql
   :language: sql

docs/basic/plpgsql_function.rst

@@ -15,7 +15,7 @@ pl/pgsql function
   :align: center
 
 Other kind of functions are `pl/pgsql
-<https://www.postgresql.org/docs/current/plpgsql.html>`__.  As the applications
+<https://www.postgresql.org/docs/current/plpgsql.html>`__. As the applications
 requirements become more complex, using wrappers of previously defined functions
 becomes necessary for clarity.
 
@@ -155,7 +155,7 @@ For ways_vertices:
 
 For ``vehicle_net_vertices``:
 
-Modify the previous query
+Modify the previous query.
 
 .. literalinclude:: ../scripts/basic/chapter_8/all-sections-8.sql
   :language: sql
@@ -245,7 +245,7 @@ Exercise 5: Test nearest vertex function
 
 .. image:: images/chapter8/ch8-taxinet.png
   :scale: 15%
-  :alt: Nearest Vertex in taki network
+  :alt: Nearest Vertex in taxi network
 
 .. image:: images/chapter8/ch8-walknet.png
   :scale: 15%
@@ -335,7 +335,7 @@ Exercise 6: Creating the main function
     * It receives the point in natural language format.
     * Obtains the OSM identifier needed by ``wrk_dijkstra``.
 
-  * ``wrk_dijkstra`` created on :ref:`basic/sql_function:Exercise 6: Function for an application`.
+  * ``wrk_dijkstra`` created in :doc:`sql_function`
 
 .. rubric:: Solution
 
@@ -371,7 +371,7 @@ Call to the function ``wrk_dijkstra``
     * The vertices table name is formed with ``%1$I_vertices``.
 
   * ``lat1``, ``lon1`` values will replace ``%2$s, %3$s`` respectively.
-  * ``lat2``, ``lon2`` values will replace ``%2$s, %3$s`` respectively.
+  * ``lat2``, ``lon2`` values will replace ``%4$s, %5$s`` respectively.
 
 * To get the constructed query in form of a warning:
 

docs/basic/sql_function.rst

@@ -30,14 +30,14 @@ The application requirements
 ===============================================================================
 
 A front end needs the following routing information:
-  - seq - A unique identifier of the rows
-  - id - The segment's identifier
-  - name - The segment's name
-  - length - The segment's length
-  - seconds - Number of seconds to traverse the segment
-  - azimuth - The azimuth of the segment
-  - route_geom - The routing geometry
-  - route_readable - The geometry in human readable form.
+  - ``seq`` - A unique identifier of the rows
+  - ``id`` - The segment's identifier
+  - ``name`` - The segment's name
+  - ``length`` - The segment's length
+  - ``seconds`` - Number of seconds to traverse the segment
+  - ``azimuth`` - The azimuth of the segment
+  - ``route_geom`` - The routing geometry
+  - ``route_readable`` - The geometry in human readable form.
 
 .. rubric:: Design of the function
 
@@ -46,28 +46,28 @@ output columns:
 
 .. rubric:: Input parameters
 
-============= ========= =================
-Name          Type      Description
-============= ========= =================
-edges_subset  REGCLASS  The table/view that is going to be used for processing
-source_osm    BIGINT    The OSM identifier of the `departure` location.
-target_osm    BIGINT    The OSM identifier of the `destination` location.
-============= ========= =================
+================= ========= =================
+Name              Type      Description
+================= ========= =================
+``edges_subset``  REGCLASS  The table/view that is going to be used for processing
+``source_osm``    BIGINT    The OSM identifier of the `departure` location.
+``target_osm``    BIGINT    The OSM identifier of the `destination` location.
+================= ========= =================
 
 .. rubric:: output columns
 
-=============== ========= =================
-Name            Type      Description
-=============== ========= =================
-seq             INTEGER   A unique number for each result row.
-id              BIGINT    The edge identifier.
-name            TEXT      The name of the segment.
-seconds         FLOAT     The number of seconds it takes to traverse the segment.
-azimuth         FLOAT     The azimuth of the segment.
-length          FLOAT     The leng in meters of the segment.
-route_readable  TEXT      The geometry in human readable form.
-route_geom      geometry  The geometry of the segment in the correct direction.
-=============== ========= =================
+================== ========= =================
+Name               Type      Description
+================== ========= =================
+``seq``             INTEGER   A unique number for each result row.
+``id``              BIGINT    The edge identifier.
+``name``            TEXT      The name of the segment.
+``seconds``         FLOAT     The number of seconds it takes to traverse the segment.
+``azimuth``         FLOAT     The azimuth of the segment.
+``length``          FLOAT     The leng in meters of the segment.
+``route_readable``  TEXT      The geometry in human readable form.
+``route_geom``      geometry  The geometry of the segment in the correct direction.
+================== ========= =================
 
 
 .. note:: For the following exercises only ``vehicle_net`` will be used, but
@@ -122,9 +122,9 @@ Geometry handling
 ===============================================================================
 
 From pgRouting point of view, the geometry is part of the additional
-information, needed on the results for an application.  Therefore ``JOIN`` the
-results with other tables that contain the geometry, but for further processing
-use PostGIS functions.
+information, needed on the results for an application. Therefore ``JOIN`` the
+results with other tables that contain the geometry and for further processing
+with PostGIS functions.
 
 Exercise 2: Route geometry (human readable)
 -------------------------------------------------------------------------------
@@ -157,7 +157,7 @@ Route from the |ch7_place_1| to |ch7_place_2|
 * The ``geom`` processed with ``ST_AsText`` to get the human readable form.
   (line **12**)
 
-  * Renaming the result to  ``route_readable``
+  * Renaming the result to ``route_readable``
 
 * The ``LEFT JOIN`` with ``vehicle_net``. (line **14**)
 
@@ -246,8 +246,8 @@ Route from the |ch7_place_1| to |ch7_place_2|
 
 * Fix the directionality of the geometries of the previous exercise
 
-  * ``geom`` in human readable form named as  ``route_readable``
-  * ``geom`` in binary format  with the name ``route_geom``
+  * ``geom`` in human readable form named as ``route_readable``
+  * ``geom`` in binary format with the name ``route_geom``
   * Both columns must have the geometry fixed for directionality.
 
 .. rubric:: Solution

docs/basic/vehicle.rst

@@ -121,7 +121,8 @@ Exercise 2: Vehicle routing - returning
 
 .. rubric:: Solution:
 
-* Use ``cost`` (line **6**) and ``reverse_cost`` (line **7**) columns, in units ``seconds``.
+* Use ``cost_s`` (line **6**) and ``reverse_cost_s`` (line **7**) columns, in
+  units ``seconds``.
 * The vehicle is going from vertex |id_3| (line **10**) to |id_1| (line **11**).
 
 .. literalinclude:: ../scripts/basic/chapter_6/all_exercises.sql
@@ -163,7 +164,7 @@ Exercise 3: Vehicle routing when time is money
   :start-after: section-6.1.3
   :end-before: section-6.2-1
   :language: sql
-  :emphasize-lines: 6-11
+  :emphasize-lines: 6-7,10-11
 
 .. collapse:: Query results
 

docs/conf.py

@@ -104,29 +104,49 @@
 
 # -- Options for HTML output ---------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  Major themes that come with
-# Sphinx are currently 'default' and 'sphinxdoc'.
-#html_theme = 'default'
-#html_theme = 'workshop-theme'
-#html_theme_path = ['.'] # make sphinx search for themes in current dir
 
 ################## bootstrap
 # Activate the theme.
 html_theme = 'bootstrap'
 html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
 
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
+
+# Theme options are theme-specific and customize the look and feel of a
+# theme further.
+# https://github.com/ryan-roemer/sphinx-bootstrap-theme/blob/master/demo/source/conf.py#L105
 html_theme_options = {
-  'navbar_site_name': "Chapters",
-  'globaltoc_depth': 2,
-  'navbar_fixed_top': "true",
-  'bootstrap_version': "3",
+    # Navigation bar title. (Default: ``project`` value)
+    #'navbar_title': "Demo",
+
+    # Tab name for entire site. (Default: "Site")
+    'navbar_site_name': "Chapters",
+
+    'navbar_links': [
+        ("Documentation", "https://docs.pgrouting.org/latest/en/index.html", True),
+    ],
+
+    # Render the next and previous page links in navbar. (Default: true)
+    'navbar_sidebarrel': True,
+
+    'navbar_pagenav': True,
+    'navbar_pagenav_name': "Page",
+    'globaltoc_depth': 1,
+    'globaltoc_includehidden': "true",
+    'navbar_class': "navbar",
+    'navbar_fixed_top': "true",
+    #'source_link_position': "nav",
+
+    # Currently, the supported themes are:
+    # - Bootstrap 2: https://bootswatch.com/2
+    # - Bootstrap 3: https://bootswatch.com/3
+    #'bootswatch_theme': "united",
+
+    # Choose Bootstrap version.
+    # Values: "3" (default) or "2" (in quotes)
+    'bootstrap_version': "2",
 }
 
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+html_logo = "my_logo.png"
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -203,7 +223,7 @@ def setup(app):
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
   ('latex', 'pgRoutingWorkshop.tex', u'Workshop - FOSS4G routing with pgRouting',
-   u'Daniel Kastl, Vicky Vergara', 'manual', False),
+   u'Vicky Vergara', 'workshop', False),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -233,8 +253,7 @@ def setup(app):
         r'http://localhost:\d+/',  r'http://localhost:\d+', r'http://localhost/', r'http://127.0.0.1:\d+/',
         r'https://localhost:\d+/',  r'https://localhost:\d+', r'https://localhost/', r'https://127.0.0.1:\d+/',
 
-        # TODO remove when 15 is located
-        'https://sourceforge.net/projects/osgeo-live/files/15.0/',
+        r'https://sourceforge.net/projects/osgeo-live/files',
         ]
 linkcheck_anchors = False
 
@@ -259,8 +278,8 @@ def setup(app):
 .. |osm2pgrouting-web| replace:: https://pgrouting.org/docs/tools/osm2pgrouting.html
 .. |osm2pgrouting-wiki| replace:: https://github.com/pgRouting/osm2pgrouting/wiki/Documentation-for-osm2pgrouting-v2.2
 .. |osm2pgrouting-ver| replace:: 2.3
-.. |georepublic| replace:: `GeoRepublic <https://georepublic.info/>`__
 .. |paragon| replace:: `Paragon Corporation <https://www.paragoncorporation.com/>`__
+.. |erosion| replace:: `Erosion <https://www.erosion.dev/>`__
 .. |osgeo| replace:: `OSGeo <https://www.osgeo.org/>`__
 .. |id_1| replace:: ``@ID_1@``
 .. |id_2| replace:: ``@ID_2@``

docs/general-intro/introduction.rst

@@ -58,7 +58,13 @@ Aknowledments
 
 .. image:: /images/logos/paragon.png
   :alt: Paragon Corporation
-  :target: https://www.paragoncorporation.com/
+  :width: 200
+  :target: |paragon|
+
+.. image:: /images/logos/erosion.png
+  :alt: Paragon Corporation
+  :width: 200
+  :target: |erosion|
 
 .. rubric:: Developers & presenters of @WORKSHOP_AREA@ workshop: