jekyll-waxify 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06235b80d0b3b3c71a6cd10496561a8823bad187f02465bf4d68f0b738d7c365
-  data.tar.gz: d4c1e2990721bdd4745ca6b9390174f00f6c388ab613c7258bd9642a8cafc2aa
+  metadata.gz: 8140544121d61a2df531010ff3259b246ecdb44efbde498e233fdbb077f9f76d
+  data.tar.gz: 8d1fa893b50f5f0a5b6e8b23c461923794d6dbd2b5f101f6f8a275234e977ee2
 SHA512:
-  metadata.gz: e86964907ec3836709da76b96896cbea01bfa9c48e544ca006efd9bf7fbdbf213094463a41510f0a0aee46528e59253d407fd115ff22e6295263dab0ccf3e5a1
-  data.tar.gz: c7360294b078d908bba5d8e82b13f3385f07940d0d5f0bc4cc689923720103bce766c588aab0ac7c1763f7512f05049af2a499830d7fbec947a9f44d360b4cd3
+  metadata.gz: a20336f7dd049653ec1e7db0adad9fcedc164c73e360bcb091491cb1684050a3c5bc981fcd4f610d9adbfb9beb19e70b230cb8d55db8fa0f98df0c35ea5ecef5
+  data.tar.gz: c3daea5de81d6f4342658a22403183c05c273a98f8687100cb1301a935e348b27ab12331f64c1a8918bc0efabbf30bd90cd050eef5be1487f7c3861fa72e3788

data/README.md

@@ -7,13 +7,14 @@ This is a work in progress. If you try it on an existing Jekyll site, be sure yo
 
 TODOs:
 
-- [ ] deploy to RubyGems
+- [x] deploy to RubyGems
 - [x] provide scaffolding for Wax iiif images
 - [ ] enable import of images on collection creation
 - [x] refactoring
 - [ ] provide scaffolding for Wax indexing
 - [ ] test with mature Jekyll sites
 - [x] add specs
+- [ ] explain multi-image items
 
 A minimal demo site can be seen at [https://pbinkley.github.io/jekyll-waxify](https://pbinkley.github.io/jekyll-waxify). 
 
@@ -28,8 +29,8 @@ In order to make the site compatible with Github Pages, use the github pages gem
 And add these lines to the ```jekyll_plugins``` group:
 
 ```ruby
-gem 'github-pages', '~> 213'
-gem 'jekyll-waxify', '0.1.0'
+gem 'github-pages', '~> 214'
+gem 'jekyll-waxify', '~> 0.1'
 ```
 
 And add this section:
@@ -54,15 +55,31 @@ This creates all the scaffolding for your collection. To populate it, copy image
 
 Now you can generate the Wax artefacts for your collection:
 
-    $ bundle exec rake wax:pages <collection name>
     $ bundle exec rake wax:derivatives:iiif <collection name>
+    $ bundle exec rake wax:pages <collection name>
 
 And view the site in the normal Jekyll way:
 
     $ bundle exec jekyll serve
-    
+
 The "Collections" link in the tab bar will take you to your new collection.
 
+## What the Scaffolding Provides
+
+The scaffolding adds a [number of files](https://github.com/pbinkley/jekyll-waxify/tree/main/wax-framework) to your Jekyll site. These are copied from the Wax demo site. They include the Rakefile needed to run the Wax tasks, the various assets needed to provide Jekyll services (including OpenSeadragon etc.), a collections.markdown page to provide access to the IIIF collections, and the Jekyll includes and layouts needed to generate item-level pages. 
+
+The scaffolding assumes only two metadata fields: the required ```pid``` and a ```label```. You can add more fields by adding columns to your collection csv. The fields will be displayed by default on the item-level page under the image, and are available for use in the normal Jekyll way.
+
+The ```_includes``` files you will most likely want to modify are:
+
+- [osd\_iiif\_image\_viewer.html](https://github.com/pbinkley/jekyll-waxify/blob/main/wax-framework/_includes/osd_iiif_image_viewer.html): This provides the template for an OpenSeadragon display of a IIIF item. If you want to change the configuration of the OpenSeadragon display, this is where you do it.
+- [collection\_gallery.html]https://github.com/pbinkley/jekyll-waxify/blob/main/wax-framework/_includes/collection_gallery.html): This provides the ```div``` containing an item on the collections page.
+
+You might also want to tinker with these:
+
+- [item\_metadata.html](https://github.com/pbinkley/jekyll-waxify/blob/main/wax-framework/_includes/item_metadata.html): Controls the display of metadata in a table under the OpenSeadragon image.
+- [item\_pagination.html](https://github.com/pbinkley/jekyll-waxify/blob/main/wax-framework/_includes/item_metadata.html): Controls the pagination links to previous and next images in multi-image items.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/jekyll/waxify/jekyll_config.rb

@@ -38,7 +38,7 @@ module Jekyll
         add(
           {
             "webrick" => {
-              "header" => {
+              "headers" => {
                 "Access-Control-Allow-Origin" => "*"
               }
             }

data/lib/jekyll/waxify/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Waxify
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-waxify
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Peter Binkley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-19 00:00:00.000000000 Z
+date: 2021-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -274,7 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin that installs basic minicomp/wax components