Skip to content

User Manual

Rafael Schwemmer edited this page Oct 31, 2016 · 33 revisions

What is the IIIF Manifest Editor

The aim of the IIIF Manifest Editor is to reduce the guess work and pure JSON editing when creating and/or manipulating manifests. It features a simple and easy-to-use interface with forms to edit the JSON value-pairs and drag-and-drop of images/canvases to facilitate the ordering and editing of the manifest without JSON knowledge. It will let you validate and download the created/modified IIIF manifest.

Installation

See installation instructions of the README file on Github: https://github.com/bodleian/iiif-manifest-editor/

Open and modify an existing IIIF manifest

The start page of the application allows you to choose between creating a new manifest from scratch or open an existing manifest. Click on the "Open Manifest" button:

Start Page

Open a remote or local manifest

To load a remote manifest, insert the URL for the remote manifest to load and click on the "Open" button.

Alternatively, click on the "Choose File" button in the "From Computer" form field, this will let you choose a local file from your computer. Select a IIIF manifest (JSON) file from your computer and click on the "Open" button:

Open remote manifest or upload local manifest

You can also drag & drop a manifest file onto the gray area to load it.

Modify an existing manifest

Once the remote or local manifest is loaded you will see the "Edit Manifest" page:

Edit Manifest Page

The "Edit Manifest" page contains the following main sections:

  • Main viewer (top left): view, zoom and pan current canvas, navigate through sequence, toggle metadata sidebar
  • Thumbnail strip (bottom left): view canvases and navigate through sequence. Drag canvases to reorder sequence
  • Action buttons (top right): create new manifest, open another manifest, download and validate current manifest (save) and close current manifest, import canvases from other manifests
  • Metadata sidebar: view and edit manifest metadata. Add, remove and edit metadata for the manifest level, the sequence level and the canvas level

The Manifest Metadata Panel

The "Manifest Metadata" panel has two tabs:

  • Predefined fields and
  • Custom fields

Manifest Metadata Panel - Predefined Fields

Predefined fields are top-level manifest metadata properties such as label, description, attribution etc. To remove a property, click on the "x" button to the right of each property box. To add a property, click on the "Add metadata field" button. This will open a drop-down menu that lets you choose from a number of predefined fields. Only fields that are not yet added to the current manifest will be available for selection.

Custom fields are value/label pairs that will be stored in the "metadata" section of the manifest. Click the "Add metadata field button" to add a custom field. This will add a new box with "Label" for the label of the new property and "Value" for the value:

Manifest Metadata - Custom fields

To edit Canvas metadata, click on the "Canvas" panel header in the metadata sidebar to open it:

Canvas metadata

Editing Sequence and Canvases

Right-click on any canvas in the thumbnail strip. This will pop up a context menu that let's you:

  • Add an empty canvas to the left of the current canvas
  • Add an empty canvas to the right of the current canvas
  • Duplicate the current canvas
  • Delete the current canvas

Context Menu on Canvases

Creating a new manifest

Click on the "New" button. You will be prompted if you would like to proceed (or cancel to download your modified manifest first). After confirming, you will be presented with an empty "skeleton" manifest with 0 canvases and placeholder metadata:

New Manifest

Edit the metadata for the new manifest in the metadata sidebar by clicking on the placeholder text or adding a new metadata field. Add a new canvas by clicking on the "Add Canvas" button in the thumbnail strip. This will add an empty canvas that can then be updated with a label or image annotation in the canvas panel of the metadata sidebar:

Adding an empty canvas

Clone this wiki locally