geoblacklight 2.1.2 → 2.2.0

data/app/assets/stylesheets/geoblacklight/modules/icon-customization.scss

@@ -1,60 +1,50 @@
-// Additional customizations beyond generated FontCustom styles
-
-.geoblacklight-icon {
-  color: $gray-600;
-  font-size: 1.2em;
-}
-
-.geoblacklight-stanford {
-  color: #8c1515;
-}
-
-.geoblacklight-public {
-  @extend .fa, .fa-unlock, .text-muted;
-}
-
-.geoblacklight-restricted {
-  @extend .fa, .fa-lock, .text-muted;
-  width: 17px;
-}
-
-.geoblacklight-citation {
-  @extend .fa, .fa-bookmark;
-}
-
-.geoblacklight-data-dictionary {
-  @extend .fa, .fa-book;
-}
-
-.geoblacklight-sms {
-  @extend .fa, .fa-mobile;
-}
-
-.geoblacklight-email {
-  @extend .fa, .fa-envelope;
-}
-
-.geoblacklight-relations-ancestor {
-  @extend .fa, .fa-pagelines;
-}
-
-.geoblacklight-relations-descendant {
-  @extend .fa, .fa-leaf;
-}
-
-.geoblacklight-web_services {
-  @extend .fa, .fa-external-link;
-}
-
-.geoblacklight-metadata {
-  @extend .fa, .fa-file-text-o;
-}
-
-.geoblacklight-carto {
-  @extend .fa, .fa-map-marker;
-}
-
-// DEPRECATED: Will be removed in GeoBlacklight v2.0
-.geoblacklight-cartodb {
-  @extend .geoblacklight-cartodb;
+// SVG icons via FontAwesome and IcoMoon, see geoblacklight-icons.json for project data
+
+span.icon-missing {
+  display: inline-block;
+  height: 1em;
+  width: 1em;
+}
+
+// CatalogController#index - Home
+.category-icon {
+  .blacklight-icons {
+    height: 6rem;
+    width: auto;
+  }
+
+  .blacklight-icons svg {
+    width:  100%;
+    height: 100%;
+    top: 2rem;
+  }
+}
+
+// CatalogController#show
+.document {
+  h2 {
+    .blacklight-icons {
+      height: 1.5rem;
+      width: auto;
+    }
+
+    .blacklight-icons svg {
+      width:  auto;
+      height: 100%;
+    }
+  }
+}
+
+// CatalogController#index - search results
+.facet-label {
+  .blacklight-icons, span.icon-missing {
+    margin-right:0.5em;
+  }
+}
+
+.blacklight-icons {
+  svg * {
+    width:  100%;
+    height: 100%;
+  }
 }

data/app/assets/stylesheets/geoblacklight/modules/item.scss

@@ -19,4 +19,8 @@
       }
     }
   }
+
+  .help-text {
+    cursor: pointer;
+  }
 }

data/app/assets/stylesheets/geoblacklight/modules/results.scss

@@ -44,3 +44,25 @@
     @extend .fa, .fa-caret-down;
   }
 }
+
+#main-container {
+  .category-block {
+    min-height: 240px;
+
+    .category-icon {
+      font-size: 6em;
+    }
+  }
+
+  [data-map="index"] {
+    height: 400px;
+
+    .leaflet-control-container {
+      .search-control {
+        a {
+          color: $white;
+        }
+      }
+    }
+  }
+}

data/app/assets/stylesheets/geoblacklight/modules/toolbar.scss

@@ -3,6 +3,10 @@
 
   .list-group {
 
+    .list-group-item.exports {
+      margin-top:0px;
+    }
+
     .list-group-item {
 
       form {

data/app/helpers/geoblacklight_helper.rb

@@ -81,12 +81,58 @@ module GeoblacklightHelper
                        layout: 'facet_tag_layout')
   end
 
+  ##
+  # Returns an SVG icon or empty HTML span element
+  # @return [SVG or HTML tag]
   def geoblacklight_icon(name)
-    icon_name = name ? name.parameterize : 'none'
-    content_tag :span,
-                '',
-                class: "geoblacklight-icon geoblacklight-#{icon_name}",
-                title: name
+    icon_name = name ? name.to_s.parameterize : 'none'
+    if asset_exists?(icon_name)
+      queue_icon_aria_label(icon_name)
+      blacklight_icon(icon_name)
+    else
+      render_empty_span('icon-missing geoblacklight-none')
+    end
+  end
+
+  ##
+  # Checks if an asset file exists
+  # @return [Boolean]
+  def asset_exists?(path)
+    Rails.application.assets.resolve("blacklight/#{path}").present?
+  end
+
+  ##
+  # Render an empty span
+  # @return [HTML tag]
+  def render_empty_span(classname)
+    tag.span class: classname
+  end
+
+  ##
+  # Capture SVG icon aria labels to describe
+  def queue_icon_aria_label(feature_name)
+    @aria_labels ||= Set.new
+    @aria_labels << feature_name
+  end
+
+  ##
+  # Render a div of divs describing aria-labelledby values
+  # @return [HTML tag]
+  def render_aria_labels(aria_labels)
+    return unless aria_labels
+    content_tag :div, id: 'aria-labels', class: 'sr-only sr-only-focusable' do
+      aria_labels.each do |label|
+        concat(render_aria_label(label))
+      end
+    end
+  end
+
+  # Render a div describing a aria-labelledby value
+  # @return [HTML tag]
+  def render_aria_label(label)
+    content_tag :div, id: "aria-label-#{label}" do
+      I18n.t("geoblacklight.aria-labels.#{label}")
+    end
   end
 
   ##
@@ -139,6 +185,29 @@ module GeoblacklightHelper
     value.html_safe
   end
 
+  ##
+  # Deteremines if a feature should include help text popover
+  # @return [Boolean]
+  def show_help_text?(feature, key)
+    Settings&.HELP_TEXT&.send(feature)&.include?(key)
+  end
+
+  ##
+  # Render help text popover for a given feature and translation key
+  # @return [HTML tag]
+  def render_help_text_entry(feature, key)
+    if I18n.exists?("geoblacklight.help_text.#{feature}.#{key}", locale)
+      help_text = I18n.t("geoblacklight.help_text.#{feature}.#{key}")
+      content_tag :h3, class: 'help-text viewer_protocol h6' do
+        content_tag :a, 'data': { toggle: 'popover', title: help_text[:title], content: help_text[:content] } do
+          help_text[:title]
+        end
+      end
+    else
+      tag.span class: 'help-text translation-missing'
+    end
+  end
+
   ##
   # Deteremines if item view should include attribute table
   # @return [Boolean]
@@ -164,6 +233,23 @@ module GeoblacklightHelper
     blacklight_config.basemap_provider || 'positron'
   end
 
+  def display_carto
+    return link_to(
+      content_tag(:span, '', class: 'geoblacklight geoblacklight-carto') +
+      t('geoblacklight.tools.open_carto'),
+      carto_link(@document.carto_reference),
+      target: '_blank'
+    ) if @document.carto_reference.present? && !Settings.CARTO_HIDE
+  end
+
+  def display_arcgis
+    return link_to(
+      blacklight_icon('esri-globe') + ' ' +
+      t('geoblacklight.tools.open_arcgis'),
+      arcgis_link(@document.arcgis_urls)
+    ) if @document.arcgis_urls.present? && !Settings.ARCGIS_HIDE
+  end
+
   ##
   # Creates a Carto OneClick link link, using the configuration link
   # @param [String] file_link

data/app/models/concerns/geoblacklight/solr_document.rb

@@ -40,6 +40,10 @@ module Geoblacklight
       references.hgl.to_hash unless references.hgl.blank?
     end
 
+    def oembed
+      references.oembed.endpoint unless references.oembed.blank?
+    end
+
     def same_institution?
       fetch(Settings.FIELDS.PROVENANCE).casecmp(Settings.INSTITUTION.downcase).zero?
     end

data/app/models/concerns/geoblacklight/spatial_search_behavior.rb

@@ -57,6 +57,11 @@ module Geoblacklight
     def hide_suppressed_records(solr_params)
       # Show child records if searching for a specific source parent
       return unless blacklight_params.fetch(:f, {})[Settings.FIELDS.SOURCE.to_sym].nil?
+
+      # Do not suppress action_documents method calls for individual documents
+      # ex. CatalogController#web_services (exportable views)
+      return if solr_params[:q]&.include?('{!lucene}layer_slug_s:')
+
       solr_params[:fq] ||= []
       solr_params[:fq] << '-suppressed_b: true'
     end

data/app/views/catalog/_data_dictionary.html.erb

@@ -1,5 +1,6 @@
 <% if document.data_dictionary_download.present? %>
     <%= link_to document.data_dictionary_download[:data_dictionary] do %>
-        <span class='geoblacklight geoblacklight-data-dictionary'></span><%= t('geoblacklight.references.data_dictionary') %>
+        <%= geoblacklight_icon('book') %>
+        <%= t('geoblacklight.references.data_dictionary') %>
     <% end %>
-<% end %>
+<% end %>

data/app/views/catalog/_document_action.html.erb

@@ -1,6 +1,6 @@
 <%= link_to document_action_path(document_action_config, (local_assigns.has_key?(:url_opts) ? url_opts : {}).merge(({id: document} if document) || {})),
             id: document_action_config.fetch(:id, "#{document_action_config.key}Link"),
             data: {}.merge(({blacklight_modal: "trigger"} if document_action_config.modal != false) || {}) do %>
-    <%= content_tag :span, '', class: "geoblacklight geoblacklight-#{document_action_config.key}" %>
+    <%= geoblacklight_icon(document_action_config.key) %>
     <%= document_action_label(document_action_config.key, document_action_config) %>
 <% end %>

data/app/views/catalog/_exports.html.erb

@@ -1,11 +1,3 @@
 <% document ||= @document %>
-<% if document.carto_reference.present? %>
-    <%= link_to(carto_link(document.carto_reference), target: '_blank') do %>
-    <span class='geoblacklight geoblacklight-carto'></span><%= t('geoblacklight.tools.open_carto') %>
-    <% end %>
-<% end %>
-<% if document.arcgis_urls.present? %>
-  <%= link_to(arcgis_link(document.arcgis_urls))  do %>
-    <%= blacklight_icon('esri-globe') %> <%= t('geoblacklight.tools.open_arcgis') %>
-  <% end %>
-<% end %>
+<%= display_carto %>
+<%= display_arcgis %>

data/app/views/catalog/_home_text.html.erb

@@ -5,14 +5,14 @@
       <div class='row'>
         <div class='category-block col-sm'>
           <div class='category-icon'>
-            <span class='fa fa-home'></span>
+            <%= geoblacklight_icon('home') %>
           </div>
           <%= content_tag :h4, t('geoblacklight.home.institution') %>
           <%= render_facet_tags [Settings.FIELDS.PROVENANCE] %>
         </div>
         <div class='category-block col-sm'>
           <div class='category-icon'>
-            <span class='fa fa-arrow-circle-down'></span>
+            <%= geoblacklight_icon('arrow-circle-down') %>
           </div>
           <%= content_tag :h4, t('geoblacklight.home.data_type') %>
           <%= render_facet_tags [Settings.FIELDS.GEOM_TYPE] %>
@@ -21,14 +21,14 @@
       <div class='row'>
         <div class='category-block col-sm'>
           <div class='category-icon'>
-            <span class='fa fa-globe'></span>
+            <%= geoblacklight_icon('globe') %>
           </div>
           <%= content_tag :h4, t('geoblacklight.home.placename') %>
           <%= render_facet_tags [Settings.FIELDS.SPATIAL_COVERAGE] %>
         </div>
         <div class='category-block col-sm'>
           <div class='category-icon'>
-            <span class='fa fa-tags'></span>
+            <%= geoblacklight_icon('tags') %>
           </div>
           <%= content_tag :h4, t('geoblacklight.home.subject') %>
           <%= render_facet_tags [Settings.FIELDS.SUBJECT] %>

data/app/views/catalog/_show_default_viewer_container.html.erb

@@ -1,6 +1,11 @@
 <% document ||= @document %>
 <div class='row'>
   <div id='viewer-container' class="col-md-12">
+
+    <% if show_help_text?('viewer_protocol', document.viewer_protocol) %>
+      <%= render_help_text_entry('viewer_protocol', document.viewer_protocol) %>
+    <% end %>
+
     <%= content_tag :div, id: 'map', data: { map: 'item', protocol: document.viewer_protocol.camelize, url: document.viewer_endpoint, 'layer-id' => document.wxs_identifier, 'map-bbox' => document.bounding_box_as_wsen, 'catalog-path'=> search_catalog_path, available: document_available?, inspect: show_attribute_table?, basemap: geoblacklight_basemap, leaflet_options: leaflet_options } do %>
     <% end %>
   </div>

data/app/views/catalog/_show_header_default.html.erb

@@ -1,6 +1,4 @@
 <h2>
   <span itemprop="name"><%= document_heading(document) %></span>
-  <small>
-    <%= render partial: 'header_icons', locals: { document: document } %>
-  </small>
-</h2>
+  <%= render partial: 'header_icons', locals: { document: document } %>
+</h2>

data/app/views/relation/_ancestors.html.erb

@@ -4,7 +4,8 @@
 <% @relations.ancestors['docs'].each do |ancestor| %>
   <li class="list-group-item">
     <%= link_to solr_document_path(ancestor['layer_slug_s']) do %>
-      <span class='geoblacklight geoblacklight-relations-ancestor'></span> <%= ancestor['dc_title_s'] %>
+      <%= geoblacklight_icon('pagelines-brands') %>
+      <%= ancestor['dc_title_s'] %>
     <% end %>
   </li>
 <% end %>

data/app/views/relation/_descendants.html.erb

@@ -4,7 +4,8 @@
 <% @relations.descendants['docs'][0..2].each do |descendant| %>
   <li class="list-group-item">
     <%= link_to solr_document_path(descendant['layer_slug_s']) do %>
-      <span class='geoblacklight geoblacklight-relations-descendant'></span> <%= descendant['dc_title_s'] %>
+      <%= geoblacklight_icon('leaf') %>
+      <%= descendant['dc_title_s'] %>
     <% end %>
   </li>
 <% end %>

data/app/views/shared/_header_navbar.html.erb

@@ -1,3 +1,5 @@
+<%= render_aria_labels(@aria_labels) %>
+
 <nav class="navbar navbar-expand-md navbar-dark bg-dark topbar" role="navigation">
   <div class="<%= container_classes %>">
     <%= link_to application_name, root_path, class: 'mb-0 navbar-brand' %>

data/config/locales/geoblacklight.en.yml

@@ -73,3 +73,91 @@ en:
       attribute: 'Attribute'
       value: 'Value'
       click_map: 'Click on map to inspect values'
+    help_text:
+      viewer_protocol:
+        dynamic_map_layer:
+          title: ArcGIS Dynamic Map Layer
+          content: An ArcGIS Dynamic Map Layer represents vector data (points, lines, and polygons). Map image layers are dynamically rendered image tiles.
+        feature_layer:
+          title: ArcGIS Feature Layer
+          content: An ArcGIS Feature Layer Service displays vector data (points, lines, and polygons) as individual or collected features.
+        iiif:
+          title: IIIF Service
+          content: The International Image Interoperability Framework (IIIF) web service API displays an image from a server. This image can be panned and zoomed.
+        iiif_manifest:
+          title: IIIF Service
+          content: The International Image Interoperability Framework (IIIF) web service API displays an image from a server. This image can be panned and zoomed.
+        image_map_layer:
+          title: ArcGIS Image Map Layer
+          content: An ArcGIS Image Map Layer displays raster data (a grid of cells used to store imagery).
+        index_map:
+          title: Index Map
+          content: Index maps are a "table of contents" that allow users to select a specific map or item within a larger set and navigate to it for viewing or downloading.
+        oembed:
+          title: Embedded Content
+          content: This content is embedded through a third-party viewer.
+        tiled_map_layer:
+          title: ArcGIS Tiled Map Layer
+          content: An ArcGIS Tiled Map Layer Service displays set of web-accessible tiles that reside on a server.
+        wms:
+          title: Web Map Service (WMS)
+          content: A Web Map Service displays a geospatial dataset as map images.
+    aria-labels:
+      arrow-circle-down: Arrow within a circle, pointing down (icon)
+      baruch-cuny: Baruch College (logo)
+      berkeley: University of California, Berkeley (logo)
+      book: Book (icon)
+      bookmark: Bookmark (icon)
+      cd-rom: CD-Rom (icon)
+      chicago: The University of Chicago (logo)
+      columbia: Columbia University (logo)
+      cornell: Cornell University (logo)
+      dvd-rom: DVD-Rom (icon)
+      email: Email (icon)
+      esri-globe: Esri Global (logo)
+      globe: Globe (icon)
+      harvard: Harvard University (logo)
+      home: Home (icon)
+      illinois: University of Illinois (logo)
+      image: Image (icon)
+      indiana: Indiana University (logo)
+      iowa: University of Iowa (logo)
+      leaf: Leaf (icon)
+      lewis-clark: Lewis & Clark (logo)
+      line: Line (icon)
+      map-marker: Map marker (icon)
+      map: Map (icon)
+      maryland: University of Maryland (logo)
+      massgis: MassGIS (logo)
+      metadata: Metadata (icon)
+      michigan-state: Michigan State University (logo)
+      michigan: University of Michigan (logo)
+      minnesota: University of Minnesota (logo)
+      mit: Massachusetts Institute of Technology (logo)
+      mixed: Mixed (icon)
+      multilinestring: Multi-line string  (icon)
+      multipoint: Multi-point (icon)
+      multipolygon: Multi-polygon (icon)
+      nyu: New York University (logo)
+      ohio-state: The Ohio State University (logo)
+      pagelines-brands: Pagelines brands (icon)
+      paper-map: Paper map (icon)
+      penn-state: Penn State University (logo)
+      point: Point (icon)
+      polygon: Polygon (icon)
+      polyline: Polyline (icon)
+      princeton: Princeton University (logo)
+      public: Public content (icon)
+      purdue: Purdue University (logo)
+      raster: Raster (icon)
+      restricted: Restricted content (icon)
+      sms: SMS (icon)
+      stanford: Stanford University (logo)
+      table: Table (icon)
+      tags: Tags (icon)
+      texas: The University of Texas at Austin (logo)
+      tufts: Tufts University (logo)
+      ucla: University of California, Los Angeles (logo)
+      uva: University of Virginia (logo)
+      web_services: Web services (icon)
+      wisconsin: University of Wisconsin (logo)