jekyll-theme-open-project 1.1.23 → 1.1.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 743ef6f6997140f43beb6d9735795c56fee28d897bcb80e081f10a5921625d36
-  data.tar.gz: bdd6142500f0b231311451a231c1cbd89a40d63288d1a20a603a20e38d2e975b
+  metadata.gz: e8fce901d2f3924596242e699f0e9719a86a9cb071a3e854489475ac5c650529
+  data.tar.gz: 8fb7ff15b83a37d4c6faf071bce7d30cc8be6b2ce6535550f1ee39d1ea23e07b
 SHA512:
-  metadata.gz: 733f3a2dcc8e506dc07d8c7830e91b57ba06417554edcd11e77158e9a59fca3a900ca91597bc4e55bced039f119feee23ab05a763b71ebafb0608f2da4a70ada
-  data.tar.gz: bfd487f407634ee6bddafe018256d1f0f61dd8a4b81d51c1809f87237637d82d4e7dfc536fb149532c86fff0813753cc49c31da9359022567daa5ecbdc2f87bd
+  metadata.gz: f4600c9320dc30fea748bc24ddf95ef2b9db966d6c933088669716fa36edd3df8c244a4bc51f8a34a26fd0f90fbc36348faa186de4c938597e2c4fd92f654d57
+  data.tar.gz: cc18435994f4d649b31febddc894ad7b1a92ad9bcc68884c444fa53e5deb22248b237bca3dfe81dec7a6125dbffe2ac51edc89574c4fbb7caa61d13e37c08969

data/README.md

@@ -236,6 +236,14 @@ is_hub: true
 # to individual, this would make sense:
 seo:
   type: Organization
+
+tag_namespaces:
+  software:
+    namespace_id: "Human-readable namespace name"
+    # E.g.:
+    # writtenin: "Written in"
+  specs:
+    namespace_id: "Human-readable namespace name"
 ```
 
 ### Project, spec and software data
@@ -262,7 +270,11 @@ home_url: <URL to standalone project site>
 # percent-encode the tag in URLs. Replace " " (a regular space)
 # with "_" (underline); underlines will be rewritten as spaces when tags
 # are presented to site users.
-tags: [Ruby, Python, RFC]
+# Tag can be prepended with a namespace to signify the type,
+# e.g. chosen programming language or target viewer audience
+# (see hub site configuration for tag namespace setup).
+# Avoid long namespace/tag combos as they can overflow item’s card widget.
+tags: [Ruby, Python, RFC, "<some_namespace_id>:<appropriate_tag>"]
 ```
 
 ### Project index page

data/_includes/index-page-item-filter.html

@@ -3,27 +3,81 @@
 {% assign tags = rawtags | split: " " | uniq %}
 {% assign num_tags = tags | size %}
 
+{% if include.tag %}
+  {% if include.tag contains ":" %}
+    {% assign tag_namespace = include.tag | split: ":" | first %}
+  {% else %}
+    {% assign tag_namespace = "" %}
+  {% endif %}
+{% endif %}
+
 {% if num_tags > 0 %}
   <nav class="item-filter">
+    {% comment %}Non-namespaced tags{% endcomment %}
     <ul class="tags">
-      <li>
-        {% if include.tag %}
-          <a href="{{ include.url_tag_prefix }}">All</a>
+      {% for tag in tags %}
+        {% if tag contains ":" %}
+          {% assign _namespace = tag | split: ":" | first %}
         {% else %}
-          <span>All</span>
+          {% assign _namespace = "" %}
         {% endif %}
-      </li>
 
-      {% for tag in tags %}
-        {% assign tag_human = tag | replace: "_", " " %}
-        <li>
-          {% if tag == include.tag %}
-            <span>{{ tag_human }}</span>
-          {% else %}
-            <a href="{{ include.url_tag_prefix }}{{ tag }}">{{ tag_human }}</a>
-          {% endif %}
-        </li>
+        {% if _namespace == "" %}
+          <li>
+            {% assign tag_human = tag | replace: "_", " " %}
+            {% if tag == include.tag %}
+              <span>{{ tag_human }}</span>
+            {% else %}
+              <a href="{{ include.url_tag_prefix }}{{ tag }}">{{ tag_human }}</a>
+            {% endif %}
+          </li>
+        {% endif %}
       {% endfor %}
     </ul>
+
+    {% comment %}Namespaced tags{% endcomment %}
+    {% for namespace in site.tag_namespaces[include.tag_namespaces] %}
+      {% assign namespace_human = namespace[1] %}
+      {% assign namespace_id = namespace[0] %}
+
+      <div class="namespace">
+        <span class="namespace-title">{{ namespace_human }}: </span>
+
+        <ul class="tags">
+          {% for tag in tags %}
+            {% if tag contains ":" %}
+              {% assign _namespace = tag | split: ":" | first %}
+            {% else %}
+              {% assign _namespace = "" %}
+            {% endif %}
+
+            {% if _namespace == namespace_id %}
+              <li>
+                {% assign tag_human = tag | split: ":" | last | replace: "_", " " %}
+                {% if tag == include.tag %}
+                  <span>{{ tag_human }}</span>
+                {% else %}
+                  <a href="{{ include.url_tag_prefix }}{{ tag }}">{{ tag_human }}</a>
+                {% endif %}
+              </li>
+            {% endif %}
+          {% endfor %}
+        </ul>
+      </div>
+    {% endfor %}
   </nav>
 {% endif %}
+
+{% if include.tag %}
+  {% assign tag_human = include.tag | split: ":" | last | replace: "_", " " %}
+  {% if tag_namespace != "" %}
+    {% assign namespace = site.tag_namespaces[include.tag_namespaces][tag_namespace] %}
+  {% endif %}
+  <header class="filter-header">
+    <h3 class="title">
+      Showing items matching
+      <span class="tag">{% if namespace %}<span class="namespace">{{ namespace }}:</span> {% endif %}{{ tag_human }}</span>
+      <a class="show-all" href="{{ include.url_tag_prefix }}">(show all)</a>
+    </h3>
+  </header>
+{% endif %}

data/_includes/software-card-hub.html

@@ -34,7 +34,7 @@
   </p>
 
   <footer class="meta">
-    {% include tag-list.html tags=include.item.tags %}
+    {% include tag-list.html tags=include.item.tags item_type=include.item_type %}
 
     {% if include.item.last_update %}
       <section class="last-update">

data/_includes/tag-list.html

@@ -2,8 +2,16 @@
 {% if num_tags > 0 %}
   <ul class="tags">
     {% for tag in include.tags %}
-      {% assign tag_human = tag | replace: "_", " " %}
-      <li>{{ tag_human }}</li>
+      {% if tag contains ":" %}
+        {% assign namespace_id = tag | split: ":" | first %}
+        {% assign namespace = site.tag_namespaces[include.item_type][namespace_id] %}
+        {% assign tag_human = tag | split: ":" | last | replace: "_", " " %}
+      {% else %}
+        {% assign tag_human = tag | replace: "_", " " %}
+        {% assign namespace = "" %}
+      {% endif %}
+
+      <li>{% if namespace != "" %}<span class="namespace">{{ namespace }}:</span> {% endif %}{{ tag_human }}</li>
     {% endfor %}
   </ul>
 {% endif %}

data/_layouts/software-index.html

@@ -2,7 +2,7 @@
 layout: default
 ---
 
-{% include index-page-item-filter.html url_tag_prefix="/software/" items=site.all_software tag=page.tag %}
+{% include index-page-item-filter.html url_tag_prefix="/software/" tag_namespaces="software" items=site.all_software tag=page.tag %}
 
 <section class="items">
   {% if site.is_hub %}

data/_layouts/spec-index.html

@@ -2,7 +2,7 @@
 layout: default
 ---
 
-{% include index-page-item-filter.html url_tag_prefix="/specs/" items=site.all_specs tag=page.tag %}
+{% include index-page-item-filter.html url_tag_prefix="/specs/" tag_namespaces="specs" items=site.all_specs tag=page.tag %}
 
 <section class="items">
   {% if site.is_hub %}

data/_sass/jekyll-theme-open-project.scss

@@ -142,17 +142,75 @@ main {
 
   .layout--spec-index > &,
   .layout--software-index > & {
+    > .filter-header {
+      // Shown when a tag is selected.
+      background-color: #fafafa;
+      font-size: 80%;
+      box-shadow: 0 4px 40px -14px rgba(0, 0, 0, 0.4);
+      border-radius: .5em;
+      margin-top: -.5em;
+
+      .title {
+        font-weight: normal;
+        text-align: center;
+
+        .tag {
+          white-space: nowrap;
+          font-weight: bold;
+
+          .namespace {
+            font-weight: normal;
+          }
+
+          &:before { content: "“"; font-weight: normal; }
+          &:after { content: "”"; font-weight: normal; }
+        }
+        a.show-all {
+          white-space: nowrap;
+        }
+      }
+    }
     > .item-filter {
-      padding: 18px 40px;
+      padding: 18px 2em;
       background-color: #F3F3F3;
       align-self: stretch;
-      text-align: center;
+      text-align: left;
+
+      .namespace, ul.tags {
+        font-size: 14px;
+      }
+
+      .namespace {
+        display: flex;
+        flex-flow: row nowrap;
+        align-items: flex-start;
+        margin-top: .5em;
+
+        .namespace-title {
+          margin-right: 14px;
+        }
+
+        &.empty {
+          display: none;
+        }
+
+        &:first-child {
+          margin-top: 0;
+        }
+      }
 
       ul.tags {
+        flex: 1;
+
         list-style: none;
         margin: 0;
         padding: 0;
-        font-size: 14px;
+
+        white-space: nowrap;
+        overflow-x: scroll;
+        overflow-y: hidden;
+
+        text-overflow: ellipsis;
 
         > li {
           display: inline;
@@ -164,22 +222,30 @@ main {
             margin: 0 4px;
             padding: 3px 10px 3px 10px;
             white-space: nowrap;
+
+            &:first-child {
+              margin-left: -10px;
+            }
           }
           > a {
             color: grey;
           }
         }
+
+        &.scrolled {
+          text-overflow: unset;
+        }
       }
     }
   }
   // Item filter: color override for selected tags
   > .item-filter ul.tags li > span {
     .layout--software-index > & {
-      color: $hub-software--primary-color;
+      color: $hub-software--primary-dark-color;
       background-color: rgba($hub-software--primary-color, 0.1);
     }
     .layout--spec-index > & {
-      color: $hub-specs--primary-color;
+      color: $hub-specs--primary-dark-color;
       background-color: rgba($hub-specs--primary-color, 0.1);
     }
   }

data/_sass/open-project-base.scss

@@ -48,6 +48,7 @@ a {
 
 .index-item-grid {
   margin-top: 40px;
+  padding: 0;  // Override padding set by main section
 
   @media screen and (min-width: $bigscreen-breakpoint) {
     margin-top: 80px;
@@ -210,13 +211,22 @@ a {
         margin: 0;
         padding: 0;
 
+        white-space: nowrap;
+
+        .namespace {
+          color: lighten($main-font-color, 50%);
+          font-weight: normal;
+        }
+
         &::after {
-          content: ", ";
+          content: " • ";
+          margin: 0 4px;
           color: grey;
           font-weight: normal;
         }
         &:last-child::after {
           content: "";
+          margin: 0;
         }
 
         color: $primary-color;

data/assets/js/opf.js

@@ -4,6 +4,9 @@
 
   var body = document.querySelector('body');
 
+  // TODO: Best way (preferably w/o Node) to split these across files 
+  // and concatenate/minify the result on Jekyll build?
+
 
 
   /* Search box in top bar */
@@ -206,6 +209,36 @@
 
 
 
+  /* Software/spec index filter bar */
+
+  var initIndexFilter = function(filterBar) {
+    var namespaces = filterBar.querySelectorAll('.namespace');
+
+    var updateScrolledStatus = function (evt) {
+      if (!evt.target.classList) { return; }
+
+      if (evt.target.scrollLeft > 0) {
+        evt.target.classList.add('scrolled');
+      } else {
+        evt.target.classList.remove('scrolled');
+      }
+    };
+
+    // Mark empty namespaces
+    for (let nsEl of namespaces) {
+      if (nsEl.querySelector('ul.tags > li') === null) {
+        nsEl.classList.add('empty');
+      }
+    }
+
+    // Update styling on tag bar on scroll
+    for (let tags of filterBar.querySelectorAll('ul.tags')) {
+      tags.addEventListener('scroll', updateScrolledStatus);
+    }
+  };
+
+
+
   // Initializing stuff
   var hamburgerMenu = initCollapsibleMenu(
     document.querySelector('header nav.top-menu'),
@@ -235,6 +268,11 @@
     if (el) { el.addEventListener('click', collapsibleDocsNav.toggle); }
   }
 
-  initSearchWidget(topMenuEl, triggerEl, inputEl);
+  if (triggerEl !== null && inputEl !== null && topMenuEl !== null) {
+    initSearchWidget(topMenuEl, triggerEl, inputEl);
+  }
+
+  var indexFilterEl = document.querySelector('nav.item-filter');
+  initIndexFilter(indexFilterEl);
 
 }());

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project
 version: !ruby/object:Gem::Version
-  version: 1.1.23
+  version: 1.1.24
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-11 00:00:00.000000000 Z
+date: 2018-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.23
+        version: 1.1.24
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.23
+        version: 1.1.24
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement