biiif - npm Package Compare versions

Comparing version 0.3.8 to 0.3.9

config.json

@@ -50,2 +50,8 @@ {
                 ],
+                ".mp3": [
+                    {
+                        "type": "Sound",
+                        "format": "audio/mp3"
+                    }
+                ],
                 ".mp4": [
@@ -52,0 +58,0 @@ {

Directory.js

@@ -161,9 +161,6 @@ "use strict";
             }
-            // sort items              
+            // sort items 
+            const collator = new Intl.Collator(undefined, { numeric: true, sensitivity: 'base' });
             this.indexJson.items.sort((a, b) => {
-                if (a.label['@none'][0].toLowerCase() < b.label['@none'][0].toLowerCase())
-                    return -1;
-                if (a.label['@none'][0].toLowerCase() > b.label['@none'][0].toLowerCase())
-                    return 1;
-                return 0;
+                return collator.compare(a.label['@none'][0].toLowerCase(), b.label['@none'][0].toLowerCase());
             });
@@ -182,8 +179,5 @@ }
             }));
+            const collator = new Intl.Collator(undefined, { numeric: true, sensitivity: 'base' });
             this.indexJson.items.sort((a, b) => {
-                if (a.id < b.id)
-                    return -1;
-                if (a.id > b.id)
-                    return 1;
-                return 0;
+                return collator.compare(a.id, b.id);
             });
@@ -190,0 +184,0 @@ }

package.json

 {
   "name": "biiif",
-  "version": "0.3.8",
+  "version": "0.3.9",
   "description": "A CLI to build IIIF collections",
@@ -12,3 +12,3 @@ "main": "index.js",
     "test": "tsc && mocha",
-    "testbuild": "node --nolazy --inspect-brk=5858 -e \"require('./index').build('collection', 'https://edsilv.github.io/biiif-test-manifests/tetons')\""
+    "testbuild": "node --nolazy --inspect-brk=5858 -e \"require('./index').build('collection', 'https://edsilv.github.io/biiif-test-manifests/sound-manifest')\""
   },
@@ -32,4 +32,4 @@ "engines": {
     "chalk": "^2.3.0",
+    "glob": "^7.1.2",
     "glob-promise": "^3.4.0",
-    "glob": "^7.1.2",
     "jimp": "^0.2.28",
@@ -36,0 +36,0 @@ "js-yaml": "^3.10.0",

README.md

@@ -27,2 +27,11 @@ # biiif (build iiif) 👷✨📃
 
+## Parameters
+
+| Parameter | Type | Description |
+| :--- | :--- | :--- |
+| `folder` | string | The source folder of your IIIF collection/manifest on disk |
+| `url` | string | The Url to use as the root for all generated manifest, asset identifiers |
+| `generateThumbs` | boolean | Generate thumbnails for images (100 x 100px) |
+| `virtualName` | string | Overrides the source folder name when generating identifiers e.g. a dat archive id you need to appear in Urls instead of the source folder name
+
 ## Conventions
@@ -71,2 +80,16 @@
 
+## Image Services
+
+Here is an example of how to use an image service to describe your [IIIF Level 0](https://iiif.io/api/image/3.0/compliance/#5-level-0-compliance) static tileset as a custom annotation:
+
+https://github.com/edsilv/biiif-test-manifests/tree/gh-pages/tetons
+
+In `_tetons/tiles.yml`, `value` is set to the relative path to the `info.json` and a `type` of `Image` is used so that biiif knows to treat the `info.json` file as an image service.
+
+The tiles and `info.json` are located in `_tetons/assets/tiles`. These can be generated using [this python script](https://github.com/zimeon/iiif/tree/master/demo-static#regerating-tiles).
+
+Ensure that the `@id` property in your `info.json` matches the absolute URL where you will be hosting the tiles, e.g.
+
+https://github.com/edsilv/biiif-test-manifests/blob/gh-pages/tetons/_tetons/assets/tiles/info.json#L3
+
 ## Metadata
@@ -90,3 +113,3 @@
 
-If no thumb image is found in a canvas directory, biiif checks to see if an image is being annotated onto the canvas with a painting motivation. If so, a thumb is generated (100 x 100px) from that.
+If no thumb image is found in a canvas directory, and the `generateThumbs` parameter is set to `true`, biiif checks to see if an image is being annotated onto the canvas with a painting motivation. If so, a thumb is generated (100 x 100px) from that.
 
@@ -93,0 +116,0 @@ ## Linked Manifests

No alert changes

Improved metrics

Total package byte prevSize

51255

increased by3.08%

Number of lines in readme file

167

increased by15.97%

No dependency changes