wax_theme 0.1.0.beta → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa9a6857649cb23dbdc23fb3c4b0be7460d3920c385564a0aa6cc9c80ad6311e
-  data.tar.gz: 47c614ad3a62b4275902e874b7de5dced1891ff5758108397595f6985ecb31d7
+  metadata.gz: 516a59cfab9cee3da58ed4cfc82630e5ee7bdb5a66cede77cee0badf808ac585
+  data.tar.gz: 35f97e51d47292e9f99060373c7894c5073b05e10edea7e9dc8d5b815ee91c37
 SHA512:
-  metadata.gz: 2f0f4cd7ff7d4b6eb9e71a37b424e63d92c286d750eb80e019a3eae22d59d0baaae145e9e1aff85a4b9ea10dd2856b28608d730e2a7e6a7263a70f5cfb1d8a8a
-  data.tar.gz: 2a8fd84ade4a899d465eca761233c008075db82e1aa4ae21491d54e0ac16dcc6cd5dd0839bac651ed52cdb13c66b9aa69fbe71c24fe6e4a13780f77392060f04
+  metadata.gz: 78557a185755d0fba96104485708437ef3525fb4fdc2a65a34227fe5e8d2e136105914bd5440b65346764327a412671dff81bc97057d142067f0ba859d7a30ae
+  data.tar.gz: d590934c69b0a4c5ecfe66fbbea2abf7f3ae9835c859bb79ab8bfaf093f478d84126438c3f6ac595e0bc89b95e7630689f3316ded1046a893147fa888773c020

data/LICENSE.txt

@@ -1,3 +1,4 @@
+
 The MIT License (MIT)
 
 Copyright (c) 2018 mnyrop

data/README.md

@@ -1,50 +1,99 @@
-# wax_theme 🐝
+# minicomp/wax 🐝
+[![Gem Version](https://badge.fury.io/rb/wax_theme.svg)](https://badge.fury.io/rb/wax_tasks) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![Build Status](https://travis-ci.org/mnyrop/wax.svg?branch=master)](https://travis-ci.org/minicomp/wax) [![Gem Downloads](https://img.shields.io/gem/dt/wax_theme.svg?color=046d0b)](https://badge.fury.io/rb/wax_theme) [![Join the chat at https://gitter.im/minicomp/wax](https://badges.gitter.im/minicomp/wax.svg)](https://gitter.im/minicomp/wax?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) ![License](https://img.shields.io/github/license/minicomp/wax_tasks.svg?color=c6a1e0) 
 
-[![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/.
+__Wax is an extensible workflow for producing scholarly exhibitions with minimal computing principles.__<br>
+It's comprised of: __a few Ruby gems__ for processing image data and associated metadata ([wax_tasks](https://github.com/minicomp/wax_tasks/), [wax_iiif](https://github.com/minicomp/wax_iiif/)), __a Jekyll theme__ ([wax_theme](https://github.com/minicomp/wax/)), and (hopefully soon!) a lot of __documentation and recipes__ for creating, deploying, and maintaining digital exhibitions.
 
-<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`:
+- [Prerequisites](#Prerequisites)
+- [Getting Started](#Getting-Started)
 
-```ruby
-gem "wax_theme"
-```
-
-And add this line to your Jekyll site's `_config.yml`:
+<br>
 
-```yaml
-theme: wax_theme
-```
+<a href="https://minicomp.github.io/wax/">
+  <img src="https://raw.githubusercontent.com/minicomp/wiki/master/assets/wax_screen.gif"/>
+</a>
 
-And then execute:
+<br>
 
-    $ bundle
+# Prerequisites
 
-Or install it yourself as:
 
-    $ gem install wax_theme
+You'll need `Ruby >= 2.4` with `bundler` installed. Check your versions with:
 
-## Usage
+```bash
+$ ruby -v
+  ruby 2.4.5p335 (2018-10-18 revision 65137) [x86_64-darwin18]
 
-TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+$ bundler -v
+  Bundler version 2.0.1
+```
 
-## Contributing
+To process images, you will also need to have ImageMagick and Ghostscript installed and functional. You can check to see if you have ImageMagick by running:
 
-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.
+```bash
+$ convert -version
+  Version: ImageMagick 6.9.9-20 Q16 x86_64 2017-10-15 http://www.imagemagick.org
+  Copyright: (c) 1999-2017 ImageMagick Studio LLC
+```
 
-## License
+... and check Ghostscript with:
+```bash
+$ gs -version
+  GPL Ghostscript 9.21 (2017-03-16)
+  Copyright (C) 2017 Artifex Software, Inc.  All rights reserved.
+```
 
-The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
+# Getting Started
+
+__There are a few ways to get started with Wax, depending on your needs.__ Cloning the demo is suggested for new users so you can see how a full Wax site would work. __Advanced Jekyllers__ can start from a clean Jekyll install.
+
+### Option 1: Clone the demo
+
+1. Change directory into where you'd like your site, e.g., your Desktop:
+    ```sh
+    cd ~/Desktop
+    ```
+2. Clone this repository
+    ```sh
+    git clone https://github.com/minicomp/wax.git
+    ```
+3. Change directory into the site repository and install the dependencies:
+    ```sh
+    cd wax
+    bundle install
+    ```
+4. Serve the site locally
+    ```sh
+    bundle exec jekyll serve
+    ```
+#### Option 2: Start from scratch (Advanced)
+
+1. Make a new Jekyll site and cd into it:
+  ```sh
+  jekyll new ~/Desktop/wax_site
+  cd ~/Desktop/wax_site
+  ```
+2. Add this line to your Jekyll site's Gemfile:
+  ```sh
+  gem "wax_theme"
+  ```
+3. And add this line to your Jekyll site's \_config.yml:
+  ```sh
+  theme: wax_theme
+  ```
+4. Install the dependencies:
+  ```sh
+  bundle install
+  ```
+5. Serve the site locally
+  ```sh
+  bundle exec jekyll serve
+  ```
+
+ When the demo site is serving correctly you're ready to swap in your own content and configuration to make your own exhibition site.

data/_includes/collection_gallery.html

@@ -0,0 +1,58 @@
+{% assign collection = site[include.collection] %}
+
+{% if include.only and include.facet_by %}
+  {% assign subset = collection | where: include.facet_by, include.only %}
+{% endif %}
+
+<div id='wax-gallery-{{ include.collection }}-container' class='wax-gallery-container full-width'>
+  <div class='wax-inline-container'>
+    <div id="{{ include.collection }}-facet-buttons" class="facet-buttons"></div>
+    <div id="wax-gallery-{{ include.collection }}" class="wax-gallery"></div>
+  </div>
+</div>
+
+
+<script type="text/javascript">
+  $( document ).ready(function() {
+    var container = $('#wax-gallery-{{ include.collection }}-container');
+    var gallery = $('#wax-gallery-{{ include.collection }}');
+    var buttonDiv = $('#{{ include.collection }}-facet-buttons');
+
+    {% if subset %}
+      {% for item in subset %}
+        {%- 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 %}
+    {% else %}
+      {% 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 }}' alt='{{ item.label }}'/><div class='overlay'><p class='info'>{{ item.label }}</p></div></div></a></div>"
+        {%- endcapture -%}
+        gallery.append({{ item_html | strip_newlines }});
+      {% endfor %}
+    {% endif %}
+
+    {% if include.facet_by %}
+      {% unless subset %}
+        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'); }
+          });
+        });
+      {% endunless %}
+    {% endif %}
+  });
+</script>

data/_includes/{wax/footer.html → footer.html}

@@ -1,7 +1,6 @@
 <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>
@@ -10,7 +9,6 @@
           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'>
@@ -24,8 +22,8 @@
         <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 href="{{ link | absolute_url }}" aria-label="Logo link to resource">
+            <img src='{{ item.img | absolute_url }}' alt="logo"/>
           </a>
           {% endfor %}
         </p>

data/_includes/head.html

@@ -0,0 +1,13 @@
+<head>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>
+    {{ site.title }}{% if page.label %} | {{ page.label }}{% elsif page.title %} | {{ page.title }}{% endif %}
+  </title>
+
+  <link rel='canonical' href='{{ page.url | absolute_url }}'/>
+  <link rel='icon' type='image/png' href="{{ 'img/logo.png' | absolute_url }}">
+  <link rel='stylesheet' href="{{ '/assets/styles.css' | absolute_url }}"/>
+
+  <script type='text/javascript' src="{{ '/assets/jquery-3.2.1.min.js' | absolute_url }}"></script>
+  <noscript>Please enable JavaScript in your browser.</noscript>
+</head>

data/_includes/{wax/header.html → header.html}

@@ -1,7 +1,6 @@
 <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>
 
@@ -31,5 +30,5 @@
         {% endfor %}
       </ul>
     </div>
-   </div>
+  </div>
  </nav>

data/_includes/{wax/inline_image.html → inline_image.html}

@@ -6,7 +6,7 @@
   </a>
   {% if item.label %}
   <p class='image-caption'>
-    &#9432; Above: <a href='{{ item.url | absolute_url }}'>{{ item.label }}</a>
+    Above: <a href='{{ item.url | absolute_url }}'>{{ item.label }}</a>
   </p>
   {% endif %}
 </div>

data/_includes/{wax/collection/interactive_metadata.html → interactive_metadata_table.html}

@@ -1,8 +1,41 @@
-<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>
+<link rel="stylesheet" type="text/css" href="{{ '/assets/datatables/datatables.css' | absolute_url }}" />
+<script type="text/javascript" src="{{ 'assets/datatables/datatables.min.js' | absolute_url }}"></script>
 
-<table id='{{ include.collection }}-datatable' class='datatable display'>
-  {% assign first_item = site.data[include.collection].first %}
+<table id='{{ include.collection }}-datatable' class='datatable display'></table>
+{% assign data = site.data[include.collection] %}
+{%- capture columns -%}
+  {%- for field in data.first -%}
+    {
+      "title": "{{ field[0] }}",
+      "data": "{{ field[0] }}"
+    }{% unless forloop.last %}, {% endunless %}
+  {%- endfor -%}
+{%- endcapture -%}
+
+<script>
+  $(document).ready(function () {
+    $('#{{ include.collection }}-datatable').DataTable({
+      data: {{ data | jsonify }},
+      columns: [{{ columns }}],
+      scrollY: 600,
+      scrollX: 600,
+      paging: false,
+      fixedHeader: false,
+      searching: false,
+      ordering:  false,
+      dom: 'Bfrtip',
+      buttons: [
+        'csvHtml5'
+      ]
+    });
+  });
+</script>
+
+
+
+
+{% comment %}
+{% assign first_item = site.data[include.collection].first %}
   <thead>
     <tr>
       {% for field in first_item %}
@@ -34,20 +67,4 @@
   {% 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>
+{% endcomment %}

data/_includes/item_metadata.html

@@ -0,0 +1,26 @@
+<dl class='metadata-block'>
+  {% 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 item.type == 'link' %}
+      {% if key == 'manifest' %}
+        {%- capture value -%}
+          <a href="{{ value | absolute_url }}" target="_blank" rel="noreferrer">{{ value | absolute_url }}</a>
+        {%- endcapture -%}
+      {% else %}
+        {%- capture value -%}
+          <a href="{{ value | absolute_url }}" target="_blank" rel="noreferrer">
+            {{ value | absolute_url | remove: 'https://' | remove: 'http://' | split: "/" | first }}
+          </a>
+        {%- endcapture -%}
+      {% endif %}
+    {% endif %}
+      <dt>{{ item.label }}</dt>
+      <dd>{{ value | strip }}</dd>
+  {% endfor %}
+</dl>

data/_includes/osd_iiif_image_viewer.html

@@ -0,0 +1,22 @@
+<div id="osd" class="image-viewer"></div>
+<script async defer src="{{ '/assets/openseadragon/openseadragon.min.js' | absolute_url }}"></script>
+
+<script>
+  $(document).ready(function () {
+    var manifestUrl = "{{ include.manifest | absolute_url }}";
+    $.getJSON(manifestUrl, function(data) {
+      var tileSources = [];
+      $.each(data.sequences[0].canvases, function(k, val) {
+        tileSources.push(val.images[0].resource.service['@id'] + '/info.json');
+      });
+      OpenSeadragon({
+        id: "osd",
+        sequenceMode: true,
+        prefixUrl: "{{ '/assets/openseadragon/images/' | absolute_url }}",
+        tileSources: tileSources,
+        homeFillsViewer: false,
+        showReferenceStrip: true
+      });
+    });
+  });
+</script>

data/_includes/{wax/parallax.html → parallax_image.html}

@@ -1,22 +1,26 @@
 {% if include.image %}
-  {% assign image = image | absolute_url %}
+  {% assign image = image %}
 {% else %}
   {% assign item  = site[include.collection] | where: 'pid', include.pid | first %}
-  {% assign image = item.full | absolute_url %}
+  {% assign image = item.full %}
 {% endif %}
 
-{% capture style %}
+{%- capture style -%}
   background-image: url('{{ image | absolute_url }}');
   background-position: 0% {{ include.y | default: '15%' }};
-{% endcapture %}
 
-<div class='wax-parallax full-width'>
+  {% if include.height %}
+  height: {{ include.height }} !important;
+  {% endif %}
+{%- endcapture -%}
+
+<div class='wax-parallax full-width {% if page.banner %}top-banner{% else %}inline-parallax{% endif %}'>
   <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>
+      Above: <a href='{{ item.url | absolute_url }}'>{{ item.label }}</a>
     </div>
   </div>
   {% endif %}

data/_includes/search_box.html

@@ -0,0 +1,31 @@
+{% assign placeholder = include.placeholder | default: 'Search... ' %}
+{% assign key = include.search | default: 'main' %}
+{% assign config = site.search[key] %}
+{% assign index = config.index | absolute_url %}
+{%- capture fields -%}
+  {%- for collection in config.collections -%}
+    {%- for field in collection[1].fields -%}
+      {{ field }}{% unless forloop.last %}|||{% endunless %}
+    {%- endfor -%}
+  {%- endfor -%}
+{%- endcapture -%}
+{% assign fields = fields | split: '|||' | uniq %}
+
+<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>
+
+<script type='text/javascript' src="{{ '/assets/elasticlunr.min.js' | absolute_url }}"></script>
+<script type='text/javascript' src="{{ '/assets/search-ui.js' | absolute_url }}"></script>
+<script type='text/javascript'>
+  var fields    = {{ fields | jsonify }};
+  var indexFile = "{{ index }}";
+  var url       = "{{ '' | absolute_url }}";
+
+  $(document).ready(function() {
+    startSearchUI(fields, indexFile, url);
+  });
+</script>