From 96675af97014b7abd5712130caedfae43fddc11e Mon Sep 17 00:00:00 2001
From: paul van genuchten <paul.vangenuchten@geocat.net>
Date: Thu, 18 Feb 2021 12:12:40 +0100
Subject: [PATCH] a proposal for #133 (#608)

indicate which field to use as label for the item
---
 docs/source/configuration.rst                 |  3 +-
 pygeoapi-config.yml                           |  1 +
 pygeoapi/api.py                               | 13 +++++++
 .../templates/collections/items/index.html    | 21 ++++++++----
 .../templates/collections/items/item.html     | 34 ++++++++++---------
 5 files changed, 48 insertions(+), 24 deletions(-)

diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst
index 3735bda..ee2de85 100644
--- a/docs/source/configuration.rst
+++ b/docs/source/configuration.rst
@@ -175,7 +175,8 @@ default.
                 name: CSV
                 data: tests/data/obs.csv  # required: the data filesystem path or URL, depending on plugin setup
                 id_field: id  # required for vector data, the field corresponding to the ID
-                time_field: datetimestamp  # optional field corresponding to the temporal propert of the dataset
+                time_field: datetimestamp  # optional field corresponding to the temporal property of the dataset
+                title_field: foo # optional field of which property to display as title/label on HTML pages
                 format:  # optional default format
                     name: GeoJSON  # required: format name
                     mimetype: application/json  # required: format mimetype
diff --git a/pygeoapi-config.yml b/pygeoapi-config.yml
index 5eb7bc6..b493393 100644
--- a/pygeoapi-config.yml
+++ b/pygeoapi-config.yml
@@ -151,6 +151,7 @@ resources:
               name: GeoJSON
               data: tests/data/ne_110m_lakes.geojson
               id_field: id
+              title_field: name
 
     gdps-temperature:
         type: collection
diff --git a/pygeoapi/api.py b/pygeoapi/api.py
index 18e8e71..bb5dd6b 100644
--- a/pygeoapi/api.py
+++ b/pygeoapi/api.py
@@ -837,6 +837,7 @@ class API:
             return headers_, 400, to_json(exception, self.pretty_print)
 
         LOGGER.debug('Loading provider')
+
         try:
             p = load_plugin('provider', get_provider_by_type(
                 collections[dataset]['providers'], 'feature'))
@@ -1053,6 +1054,11 @@ class API:
             content['dataset_path'] = '/'.join(path_info.split('/')[:-1])
             content['collections_path'] = '/'.join(path_info.split('/')[:-2])
             content['startindex'] = startindex
+            prv = get_provider_by_type(collections[dataset]['providers'],
+                                       'feature')
+            if 'title_field' in prv:
+                content['title_field'] = prv['title_field']
+            content['id_field'] = prv['id_field']
 
             content = render_j2_template(self.config,
                                          'collections/items/index.html',
@@ -1120,6 +1126,7 @@ class API:
             return headers_, 400, to_json(exception, self.pretty_print)
 
         LOGGER.debug('Loading provider')
+
         try:
             p = load_plugin('provider', get_provider_by_type(
                 collections[dataset]['providers'], 'feature'))
@@ -1211,6 +1218,12 @@ class API:
             headers_['Content-Type'] = 'text/html'
 
             content['title'] = collections[dataset]['title']
+            prv = get_provider_by_type(collections[dataset]['providers'],
+                                       'feature')
+            content['id_field'] = prv['id_field']
+            if 'title_field' in prv:
+                content['title_field'] = prv['title_field']
+
             content = render_j2_template(self.config,
                                          'collections/items/item.html',
                                          content)
diff --git a/pygeoapi/templates/collections/items/index.html b/pygeoapi/templates/collections/items/index.html
index e55bbb1..97ffbcf 100644
--- a/pygeoapi/templates/collections/items/index.html
+++ b/pygeoapi/templates/collections/items/index.html
@@ -74,10 +74,14 @@
             <thead>
             <tr>
                 <th>id</th>
-                {% for k, v in data['features'][0]['properties'].items() %}
-                {% if loop.index < 5 %}
-                <td>{{ k }}</td>
+                {% if data['title_field'] %}
+                  <th>{{ data['title_field'] }}</th>
                 {% endif %}
+                {% for k, v in data['features'][0]['properties'].items() %}
+                  {# start with id & title then take first 5 columns for table #}
+                  {% if loop.index < 5 and k != data['id_field'] and k != data['title_field'] %}
+                  <th>{{ k }}</th>
+                  {% endif %}
                 {% endfor %}
             </tr>
           </thead>
@@ -85,11 +89,14 @@
             {% for ft in data['features'] %}
               <tr>
                 <td data-label="id"><a href="{{ data['items_path']}}/{{ ft.id }}">{{ ft.id }}</a></td>
-                  {% for k, v in ft['properties'].items() %}
-                  {% if loop.index < 5 %}
+                {% if data['title_field'] %}
+                  <td data-label="name"><a href="{{ data['items_path']}}/{{ ft['id'] }}">{{ ft['properties'][data['title_field']] }}</a></td>
+                {% endif %}
+                {% for k, v in ft['properties'].items() %}
+                  {% if loop.index < 5 and k != data['id_field'] and k != data['title_field'] %}
                   <td data-label="{{ k }}">{{ v | urlize(20) }}</td>
                   {% endif %}
-                  {% endfor %}
+                {% endfor %}
               </tr>
             {% endfor %}
           </tbody>
@@ -118,7 +125,7 @@
     var items = new L.GeoJSON(geojson_data, {
         onEachFeature: function (feature, layer) {
             var url = '{{ data['items_path'] }}/' + feature.id + '?f=html';
-            var html = '<span><a href="' + url + '">' + feature.id + '</a></span>';
+            var html = '<span><a href="' + url + '">' + feature.id + '. ' + feature['properties']['{{ data['title_field'] }}'] + '</a></span>';
             layer.bindPopup(html);
         }
     });
diff --git a/pygeoapi/templates/collections/items/item.html b/pygeoapi/templates/collections/items/item.html
index eaeacae..aa3637a 100644
--- a/pygeoapi/templates/collections/items/item.html
+++ b/pygeoapi/templates/collections/items/item.html
@@ -10,7 +10,7 @@
         {{ v | urlize() }}
     {% endif %}
 {%- endmacro %}
-{% block title %}{{ super() }} {{ data['title'] }} - {{ data['id'] }}{% endblock %}
+{% block title %}{{ super() }} {{ data['title'] }} - {{ data['id'] }}. {{ data['properties'][data['title_field']] }}{% endblock %}
 {% block crumbs %}{{ super() }}
 / <a href="../../../collections">Collections</a>
 {% for link in data['links'] %}
@@ -19,7 +19,7 @@
   {% endif %}
 {% endfor %}
 / <a href="../items">Items</a>
-/ <a href="./{{ data['id'] }}">Item {{ data['id'] }}</a>
+/ <a href="./{{ data['id'] }}">{{ data['id'] }}. {{ data['properties'][data['title_field']] }}</a>
 {% endblock %}
 {% block extrahead %}
     <link rel="stylesheet" href="https://unpkg.com/leaflet@1.3.1/dist/leaflet.css"/>
@@ -30,7 +30,7 @@
     <section id="item">
       <div class="row">
         <div class="col-sm">
-          <h2>Item {{ data['id'] }}</h2>
+          <h1>{{ data['id'] }}. {{ data['properties'][data['title_field']] }}</h1>
         </div>
       </div>
       <div class="row">
@@ -72,20 +72,22 @@
                 <td>{{ data.id }}</td>
               </tr>
               {% for k, v in data['properties'].items() %}
-              <tr>
-                <td>{{ k }}</td>
-                {% if k == 'links' %}
-                <td>
-                    <ul>
-                        {% for l in v %}
-                        <li><a href="{{ l['href'] }}">{{ l['title'] }}</a></li>
-                        {% endfor %}
-                    </ul>
-                </td>
-                {% else %}
-                  <td>{{ render_item_value(v, 80) }}</td>
+                {% if k != data['id_field'] %}
+                <tr>
+                  <td>{{ k }}</td>
+                  {% if k == 'links' %}
+                  <td>
+                      <ul>
+                          {% for l in v %}
+                          <li><a href="{{ l['href'] }}">{{ l['title'] }}</a></li>
+                          {% endfor %}
+                      </ul>
+                  </td>
+                  {% else %}
+                    <td>{{ render_item_value(v, 80) }}</td>
+                  {% endif %}
+                </tr>
                 {% endif %}
-              </tr>
               {% endfor %}
             </tbody>
             </table>