wax_theme 0.1.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa9a6857649cb23dbdc23fb3c4b0be7460d3920c385564a0aa6cc9c80ad6311e
+  data.tar.gz: 47c614ad3a62b4275902e874b7de5dced1891ff5758108397595f6985ecb31d7
+SHA512:
+  metadata.gz: 2f0f4cd7ff7d4b6eb9e71a37b424e63d92c286d750eb80e019a3eae22d59d0baaae145e9e1aff85a4b9ea10dd2856b28608d730e2a7e6a7263a70f5cfb1d8a8a
+  data.tar.gz: 2a8fd84ade4a899d465eca761233c008075db82e1aa4ae21491d54e0ac16dcc6cd5dd0839bac651ed52cdb13c66b9aa69fbe71c24fe6e4a13780f77392060f04

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 mnyrop
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# wax_theme 🐝
+
+[![Gem Version](https://badge.fury.io/rb/wax_theme.svg)](https://badge.fury.io/rb/wax_tasks) ![License](https://img.shields.io/badge/license-MIT-yellowgreen.svg) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![docs](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/github/mnyrop/wax_tasks/)
+
+[![Build Status](https://travis-ci.org/mnyrop/wax_theme.svg?branch=rubocop)](https://travis-ci.org/mnyrop/wax_theme) [![](https://img.shields.io/librariesio/github/mnyrop/wax_theme.svg)](https://libraries.io/github/mnyrop/wax_theme)
+
+__wax_theme__ is a gem packaged [Jekyll](https://jekyllrb.com/) theme for [Minicomp/Wax](https://github.com/minicomp/wax/).
+
+It includes components specifically tailored for minimal scholarly exhibition sites, including IIIF and flat image viewers, faceted galleries, parallax banners, dynamic search boxes, data tables, and more.
+
+For a demo, visit https://minicomp.github.io/wax/.
+
+<a href="https://minicomp.github.io/wax/">
+  <img src="https://raw.githubusercontent.com/minicomp/wiki/master/docs/assets/wax_screen.gif"/>
+</a>
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "wax_theme"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: wax_theme
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wax_theme
+
+## Usage
+
+TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/minicomp/wax_theme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/_includes/wax/collection/gallery.html

@@ -0,0 +1,33 @@
+{% assign collection = site[include.collection] %}
+
+<div id='wax-gallery-{{ include.collection }}-container' class='wax-gallery-container'></div>
+<script type="text/javascript">
+  var container= $('#wax-gallery-{{ include.collection }}-container');
+  container.prepend("<div id='wax-gallery-{{ include.collection }}' class='wax-gallery'></div>");
+  var gallery = $('#wax-gallery-{{ include.collection }}');
+  {% for item in collection %}
+    {%- capture item_html -%}
+      "<div class='gallery-item {{ item[include.facet_by] | slugify }} all'><a href='{{ item.url | absolute_url }}'><div class='hovereffect'><img class='img-responsive gallery-thumb' src='{{ item.thumbnail | absolute_url }}'/><div class='overlay'><p class='info'>{{ item.label }}</p></div></div></a></div>"
+    {%- endcapture -%}
+    gallery.append({{ item_html | strip_newlines }});
+  {% endfor %}
+
+  {% if include.facet_by %}
+    container.prepend('<div id="{{ include.collection }}-facet-buttons" class="facet-buttons"></div>');
+    var buttonDiv = $('#{{ include.collection }}-facet-buttons');
+    var facets = Array.from(new Set([{%- for item in collection -%}'{{ item[include.facet_by] | slugify }}'{% unless forloop.last %}, {% endunless %}{%- endfor -%}]));
+    buttonDiv.append("<button class='btn facet active' data-filter='all'>show all</button>");
+    for (i in facets) {
+      buttonDiv.append(`<button class='btn facet' data-filter='${facets[i]}'>${facets[i]}</button>`);
+    }
+    $(document).ready(function(){
+      $(".facet").click(function(){
+        var filterValue = $(this).attr('data-filter');
+        $('.facet').removeClass('active');
+        $(this).addClass('active');
+        if(filterValue == 'all') { $('.all').show('slow'); }
+        else { $('.all').hide('slow'); $(`.${filterValue}`).show('slow'); }
+      });
+    });
+  {% endif %}
+</script>

data/_includes/wax/collection/interactive_metadata.html

@@ -0,0 +1,53 @@
+<link rel="stylesheet" type="text/css" href="{{ '/assets/css/datatables.css' | absolute_url }}">
+<script type="text/javascript" src="{{ 'assets/js/datatables.min.js' | absolute_url }}"></script>
+
+<table id='{{ include.collection }}-datatable' class='datatable display'>
+  {% assign first_item = site.data[include.collection].first %}
+  <thead>
+    <tr>
+      {% for field in first_item %}
+        <th>{{ field[0] }}</th>
+      {% endfor %}
+    </tr>
+  </thead>
+  <tbody>
+  {% for item in site.data[include.collection] %}
+    <tr>
+      {% for value in item %}
+        {% if value[0] == 'pid' %}
+          <td>
+            <a href='{{ "" | absolute_url }}/{{ include.collection }}/{{ item.pid }}/'>
+              {{ value[1] }}
+            </a>
+          </td>
+        {% elsif value[1] contains '/img/derivatives/' %}
+          <td>
+            <a href='{{ value[1] | absolute_url }}'>
+              {{ value[1] | absolute_url }}
+            </a>
+          </td>
+        {% else %}
+          <td>{{ value[1] }}</td>
+        {% endif %}
+      {% endfor %}
+    </tr>
+  {% endfor %}
+  </tbody>
+</table>
+
+<script>
+  $(document).ready(function () {
+    $('#{{ include.collection }}-datatable').DataTable({
+      scrollY: 600,
+      scrollX: 600,
+      paging: false,
+      fixedHeader: false,
+      searching: false,
+      dom: 'Bfrtip',
+      buttons: [
+        'csvHtml5',
+        'copyHtml5'
+      ]
+    });
+  });
+</script>

data/_includes/wax/footer.html

@@ -0,0 +1,35 @@
+<footer id='wax-footer' class='page-footer container-fluid'>
+  <div class='wax-inline-container'>
+    <div class='row'>
+      <!-- column 1-->
+      <div class='col'>
+        <p class='footer-title'>{{ site.title }}</p>
+        <p class='footer-description'>{{ site.description }}</p>
+        <p class='footer-copyright'>
+          &copy; {{ site.copyright }}<br>
+          Built with <a href='https://github.com/minicomp/wax/'>Minicomp/Wax</a>
+        </p>
+      </div>
+      <!-- column 2-->
+      <div class='col'>
+        <p class='footer-title'>Links</p>
+        <p class='footer-links'>
+          {% for item in site.footer.links %}
+            <a href='{{ item.link | absolute_url }}'>
+              {{ item.label }}
+            </a>
+          {% unless forloop.last %} / {% endunless %}
+          {% endfor %}
+        </p>
+        <p class='footer-logos'>
+          {% for item in site.footer.logos %}
+          {% assign link = item.link | default: '#' %}
+          <a href="{{ link | absolute_url }}">
+            <img src='{{ item.img | absolute_url }}' />
+          </a>
+          {% endfor %}
+        </p>
+      </div>
+    </div>
+  </div>
+</footer>

data/_includes/wax/head.html

@@ -0,0 +1,16 @@
+<head>
+  <link rel='canonical' href='{{ page.url | absolute_url }}'/>
+  <link rel='icon' type='image/png' href="{{ '/assets/logo.png' | absolute_url }}">
+
+  <meta http-equiv='X-UA-Compatible' content='IE=edge'/>
+  <meta http-equiv='content-type' content='text/html; charset=utf-8'/>
+  <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'/>
+
+  <title>
+    {{ site.title }}{% if page.label %} | {{ page.label }}{% elsif page.title %} | {{ page.title }}{% endif %}
+  </title>
+
+  <link rel='stylesheet' href="{{ '/assets/styles.css' | absolute_url }}"/>
+  <script type='text/javascript' src="{{ '/assets/js/jquery-3.2.1.min.js' | absolute_url }}"></script>
+  <script type='text/javascript' src="{{ '/assets/js/wax.js' | absolute_url }}"></script>
+</head>

data/_includes/wax/header.html

@@ -0,0 +1,35 @@
+<nav id='wax-header' class='navbar navbar-expand-lg navbar-light'>
+ <div class='wax-inline-container'>
+    <a class='navbar-brand' href="{{ '/' | absolute_url }}" title='Home'>
+      <img src="{{ '/assets/logo.png' | absolute_url }}" width='30' height='30' class='d-inline-block align-top' alt='logo'>
+      {{ site.title | newline_to_br }}
+    </a>
+
+    <button class='navbar-toggler' type='button' data-toggle='collapse' data-target='#wax-header-navbar' aria-controls='wax-header-navbar' aria-expanded='false' aria-label='navigation'>
+      <span class='navbar-toggler-icon'></span>
+    </button>
+
+    <div class='collapse navbar-collapse' id="wax-header-navbar">
+      <ul class='nav navbar-nav ml-auto justify-content-end'>
+        {% for item in site.menu %}
+          {% if item.sub %}
+            <li class='nav-item dropdown'>
+              <a class='nav-link dropdown-toggle' href='#' id='wax-{{ item.label }}-dropdown' data-toggle='dropdown' aria-haspopup='true' aria-expanded='false'>
+                {{ item.label }}
+              </a>
+              <div class='dropdown-menu' aria-labelledby='wax-{{ item.label }}-dropdown'>
+                {% for sub in item.sub %}
+                  <a class='dropdown-item' href='{{ sub.link | absolute_url }}'>{{ sub.label }}</a>
+                {% endfor %}
+              </div>
+            </li>
+          {% else %}
+            <li class='nav-item'>
+              <a class='nav-link' href='{{ item.link | absolute_url }}'>{{ item.label }}</a>
+            </li>
+          {% endif %}
+        {% endfor %}
+      </ul>
+    </div>
+   </div>
+ </nav>

data/_includes/wax/image_viewer/leaflet.html

@@ -0,0 +1,11 @@
+<link rel='stylesheet' type='text/css' href="{{ '/assets/css/leaflet.css' | absolute_url }}">
+<script type='text/javascript' src="{{ '/assets/js/leaflet.js' | absolute_url }}"></script>
+<script type='text/javascript' src="{{ '/assets/js/leaflet-iiif.min.js' | absolute_url }}"></script>
+
+<div id='iiif-viewer-leaflet' class='image-viewer'></div>
+
+<script>
+  $(document).ready(function() {
+    IIIFViewerLeaflet('{{ include.manifest | absolute_url }}');
+  });
+</script>

data/_includes/wax/image_viewer/mirador.html

@@ -0,0 +1,8 @@
+<link rel='stylesheet' type='text/css' href="{{ '/assets/mirador/css/mirador-combined.css' | absolute_url }}">
+<script src="{{ '/assets/mirador/mirador.js' | absolute_url }}"></script>
+
+<div id='mirador-iiif-viewer' class='image-viewer mirador' allowfullscreen='allowfullscreen'></div>
+
+<script type='text/javascript'>
+  miradorManifestViewer('{{ include.manifest | absolute_url }}');
+</script>

data/_includes/wax/image_viewer/simple.html

@@ -0,0 +1,5 @@
+<div class='image-viewer'>
+  <a href='{{ include.full_image | absolute_url }}'>
+    <img class='item-full-image' src='{{ include.full_image | absolute_url }}' alt='{{ page.label | slugify }}'/>
+  </a>
+</div>

data/_includes/wax/inline_image.html

@@ -0,0 +1,12 @@
+{% assign item  = site[include.collection] | where: 'pid', include.pid | first %}
+
+<div class='inline-image-reference'>
+  <a href='{{ item.url | absolute_url }}'>
+    <img src='{{ item.full | absolute_url }}'/>
+  </a>
+  {% if item.label %}
+  <p class='image-caption'>
+    &#9432; Above: <a href='{{ item.url | absolute_url }}'>{{ item.label }}</a>
+  </p>
+  {% endif %}
+</div>

data/_includes/wax/item/metadata.html

@@ -0,0 +1,23 @@
+<div class='metadata-block wax-inline-container'>
+  <table id='metadata-table' class='table table-striped table-responsive'>
+    {% for item in include.meta %}
+      {% if item.value contains 'page.' %}
+        {% assign key = item.value | remove: 'page.' %}
+        {% assign value = page[key] %}
+      {% else %}
+        {% assign value = item.value %}
+      {% endif %}
+
+      {% if value contains 'http' %}
+        {%- capture value -%}
+          <a href="{{ value }}">{{ value }}</a>
+        {%- endcapture -%}
+      {% endif %}
+
+      <tr class='meta {{ item.label | slugify}}'>
+        <td class='label'>{{ item.label }}</td>
+        <td class='value'>{{ value | strip }}</td>
+      </tr>
+    {% endfor %}
+  </table>
+</div>

data/_includes/wax/item/pagination.html

@@ -0,0 +1,23 @@
+{% assign links = site[page.collection] | sort: 'order' | map: 'url' %}
+{% for link in links %}
+  {% if link == page.url %}
+    {% if forloop.first %}
+      {% assign prevlink = links | last %}
+      {% assign nextlink = links[forloop.index] %}
+    {% elsif forloop.last %}
+      {% assign prevlink = prev %}
+      {% assign nextlink = links | first %}
+    {% else %}
+      {% assign prevlink = prev %}
+      {% assign nextlink = links[forloop.index] %}
+    {% endif %}
+  {% endif %}
+  {% assign prev = link %}
+{% endfor %}
+
+{% if prevlink and nextlink %}
+  <script type='text/javascript'>
+    $('#prevlink').append(`<a href='{{ prevlink | absolute_url }}' display='none'>&#8249;</a>`);
+    $('#nextlink').append(`<a href='{{ nextlink | absolute_url }}' display='none'>&#8250;</a>`);
+  </script>
+{% endif %}

data/_includes/wax/mirador_compare.html

@@ -0,0 +1,11 @@
+{%- assign m1 = include.m1 | absolute_url -%}
+{%- assign m2 = include.m2 | absolute_url -%}
+
+<link rel='stylesheet' type='text/css' href='{{ "/assets/mirador/css/mirador-combined.css" | absolute_url }}'>
+<script src="{{ '/assets/mirador/mirador.js' | absolute_url }}"></script>
+
+<div id='mirador-iiif-viewer' class='image-viewer mirador' allowfullscreen='allowfullscreen'></div>
+
+<script type='text/javascript'>
+  miradorComparisonViewer('{{ m1 }}', '{{ m2 }}' );
+</script>

data/_includes/wax/parallax.html

@@ -0,0 +1,23 @@
+{% if include.image %}
+  {% assign image = image | absolute_url %}
+{% else %}
+  {% assign item  = site[include.collection] | where: 'pid', include.pid | first %}
+  {% assign image = item.full | absolute_url %}
+{% endif %}
+
+{% capture style %}
+  background-image: url('{{ image | absolute_url }}');
+  background-position: 0% {{ include.y | default: '15%' }};
+{% endcapture %}
+
+<div class='wax-parallax full-width'>
+  <div class='parallax-image' style="{{ style | strip }}"></div>
+
+  {% if item.label %}
+  <div class='parallax-caption'>
+    <div class='wax-inline-container'>
+      &#9432; Above: <a href='{{ item.url | absolute_url }}'>{{ item.label }}</a>
+    </div>
+  </div>
+  {% endif %}
+</div>

data/_includes/wax/search.html

@@ -0,0 +1,12 @@
+{% assign ui = include.ui | default: '/js/lunr-ui.js' %}
+{% assign placeholder = include.placeholder | default: 'Search... ' %}
+
+<script src="{{ '/assets/js/elasticlunr.min.js' | absolute_url }}"></script>
+<script src='{{ ui | absolute_url }}'></script>
+
+<div class='search-block'>
+  <div class='input-group'>
+    <input type='text' class='form-control' id='search' name='x' placeholder='{{ placeholder }}'>
+  </div>
+  <div id='results'></div>
+</div>

data/_layouts/wax/collection_item.html

@@ -0,0 +1,41 @@
+---
+layout: wax/default
+---
+
+{% comment %}
+  The block below controls the image viewer
+{% endcomment %}
+
+{% if page.image_viewer %}
+  {% assign viewer = page.image_viewer %}
+{% elsif layout.image_viewer %}
+  {% assign viewer = layout.image_viewer %}
+{% endif %}
+
+{% if viewer %}
+  <div class='item-view'>
+    <span class='pagination-link' id='prevlink'></span>
+    {% if viewer == 'leaflet' %}
+      {% include wax/image_viewer/leaflet.html manifest=page.manifest prevlink=prevlink nextlink=nextlink %}
+    {% elsif viewer == 'mirador' %}
+       {% include wax/image_viewer/mirador.html manifest=page.manifest prevlink=prevlink nextlink=nextlink %}
+    {% else %}
+       {% include wax/image_viewer/simple.html full_image=page.full prevlink=prevlink nextlink=nextlink %}
+    {% endif %}
+    <span class='pagination-link' id='nextlink'></span>
+  </div>
+  {% unless layout.pagination == false %}{% include wax/item/pagination.html %}{% endunless %}
+{% endif %}
+
+{% comment %}
+  The block below controls the item metadata table
+{% endcomment %}
+
+{% if layout.meta.size %}
+  {% assign metadata = layout.meta %}
+{% elsif page.meta.size %}
+  {% assign metadata = page.meta %}
+{% endif %}
+{% if metadata.size %}
+  {% include wax/item/metadata.html meta=metadata %}
+{% endif %}