A collection of plugins for the IIIF viewer Mirador (see http://projectmirador.org/)
JavaScript CSS Shell
Switch branches/tags
@dbmdz/mirador-viewfromurl@1.1.0 @dbmdz/mirador-viewfromurl@1.0.0 @dbmdz/mirador-sharebuttons@1.0.1 @dbmdz/mirador-sharebuttons@1.0.0 @dbmdz/mirador-piwiktracking@1.1.2 @dbmdz/mirador-piwiktracking@1.1.1 @dbmdz/mirador-piwiktracking@1.1.0 @dbmdz/mirador-piwiktracking@1.0.0 @dbmdz/mirador-physicalruler@1.3.4 @dbmdz/mirador-physicalruler@1.3.3 @dbmdz/mirador-physicalruler@1.3.2 @dbmdz/mirador-physicalruler@1.3.1 @dbmdz/mirador-physicalruler@1.3.0 @dbmdz/mirador-physicalruler@1.2.1 @dbmdz/mirador-physicalruler@1.2.0 @dbmdz/mirador-physicalruler@1.1.0 @dbmdz/mirador-physicalruler@1.0.0 @dbmdz/mirador-multipagenavigation@1.1.1 @dbmdz/mirador-multipagenavigation@1.1.0 @dbmdz/mirador-multipagenavigation@1.0.0 @dbmdz/mirador-manifestbutton@1.1.1 @dbmdz/mirador-manifestbutton@1.1.0 @dbmdz/mirador-manifestbutton@1.0.0 @dbmdz/mirador-keyboardnavigation@1.1.0 @dbmdz/mirador-keyboardnavigation@1.0.0 @dbmdz/mirador-imagecropper@2.4.5 @dbmdz/mirador-imagecropper@2.4.4 @dbmdz/mirador-imagecropper@2.4.3 @dbmdz/mirador-imagecropper@2.4.2 @dbmdz/mirador-imagecropper@2.4.1 @dbmdz/mirador-imagecropper@2.4.0 @dbmdz/mirador-imagecropper@2.3.1 @dbmdz/mirador-imagecropper@2.3.0 @dbmdz/mirador-imagecropper@2.2.1 @dbmdz/mirador-imagecropper@2.2.0 @dbmdz/mirador-imagecropper@2.1.0 @dbmdz/mirador-imagecropper@2.0.0 @dbmdz/mirador-imagecropper@1.3.0 @dbmdz/mirador-imagecropper@1.2.0 @dbmdz/mirador-imagecropper@1.1.2 @dbmdz/mirador-imagecropper@1.1.1 @dbmdz/mirador-imagecropper@1.1.0 @dbmdz/mirador-imagecropper@1.0.0 @dbmdz/mirador-downloadmenu@1.0.0 @dbmdz/mirador-canvaslink@1.2.2 @dbmdz/mirador-canvaslink@1.2.1 @dbmdz/mirador-canvaslink@1.2.0 @dbmdz/mirador-canvaslink@1.1.1 @dbmdz/mirador-canvaslink@1.1.0 @dbmdz/mirador-canvaslink@1.0.0
Nothing to show
Clone or download
jbaiter Merge pull request #4 from nakamura196/right2left
fix bug for right-to-left direction.
Latest commit 221ea99 Jul 31, 2018

README.md

Mirador plugins

This repository contains multiple extensions for the IIIF viewer Mirador (see http://projectmirador.org/).

Physical Document Ruler

Adds a vertical and a horizontal ruler with metric or imperial units to the canvas display if the canvas has a physical dimensions service set.

Demo

To enable it, simply include the JavaScript (after loading Mirador):

<script src="<url to the plugin>/physicalRuler.js"></script>

You can configure the ruler with the physicalRuler configuration attribute in your Mirador configuration:

var mirador = Mirador({
  physicalRuler: {
    color: "#ffffff",         // The color for the rulers and labels
    location: "bottom-left",  // Location of the reference point of the rulers
    smallDashSize: 10,        // Size of the small dashes in pixels
    largeDashSize: 15,        // Size of the large dashes in pixels
    labelsEvery: 5,           // Draw ruler labels every n centimeters/inches
    imperialUnits: false      // Use imperial units instead of metric
  }
});

Manifest button

Adds an extra button to every window that links to the loaded manifest.

To enable it, include the CSS and the JavaScript (after loading Mirador).

It's possible to define the icon class of the button in the Mirador configuration with the attribute iconClass in the section manifestButton:

var mirador = Mirador({
  manifestButton: {
    iconClass: 'fa-file' // Define the icon class of the button
  }
});

The value has to be one of the Font Awesome Icon classes, the default is fa-file-text-o.

Multi-Page Navigation

Adds a small additional navigation bar to the top of the viewport that allows faster seeking through a manifest.

To enable it, include the CSS and the JavaScript (after loading Mirador).

<link rel="stylesheet" type="text/css" href="<url to the plugin>/multiPageNavigation.css" />
...
<script src="<url to the plugin>/multiPageNavigation.js"></script>

Bookmarkable Viewer State

Modifies Mirador to dynamically update the URL to reflect the currently selected view type (image, book, etc), manifest and canvas and to reconstruct a Mirador session from such an URL hash. This allows users to bookmark the (partial) state of Mirador and restore it at a later time.

The syntax of the URL is compatible with the work-in-progress IIIF Drag-and-Drop pattern.

This plugins comes with a major caveat, namely that the URL is only updated if there is a single slot in the viewer. This is due to the fact that more complicated workspace layouts carry a lot more state that would be too unwieldy to store in the URL hash. Use Mirador's built-in bookmarking functionality (via JSONBlob) for these use cases.

To enable it, just include the JavaScript after loading Mirador.

Keyboard Navigation

Adds keyboard nagivation features to Mirador. If there are multiple windows, the action are applied to all of them.

Key Action
Go to previous page.
or SPACE Go to next page.
ctrl + Go to first page.
ctrl + Go to last page.
i Show or hide information/metadata.
Toggle fullscreen using the largest possible option.

Installation:

<script src="build/mirador/mirador.js"></script>
<script src="path/to/keyboardNavigation.js"></script>
<script>
// Creating Mirador instance
// ...
</script>

Piwik Tracking of Mirador Events

This plugin records user interactions with Mirador to a Piwik instance.

You can configure the plugin with the piwikTracking configuration Key:

{
    // Only set trackerUrl and siteId if you did not use the Piwik
    // JavaScript snippet
    trackerUrl: undefined,
    siteId: undefined,

    // Can be 'event' or 'content', what kind of interaction to record
    // in Piwik. 'event' will trigger an Event, 'content' a Content Interaction.
    method: 'event',
    events: [
      'change-page',
      'zoom',
      'enable-annotations',
      'add-annotation',
      'add-window'
    ]
}