Skip to content
Snippets Groups Projects

Changes

Page history
  • New page
  • Templates
    • Create Interface authored by Jacob Hart's avatar Jacob Hart
    Show whitespace changes
    Inline Side-by-side
    Showing
    with 92 additions and 0 deletions
    Interface.md 0 → 100644
    View page @ b03eca99
    # Interface
    You may already be familiar with the IIIF manifest viewer [Mirador](https://projectmirador.org/) – if this is the case, you shouldn’t be lost in the MemoRekall-IIIF interface. That being said, there are a few additions which you should be aware of. First, we shall recap the main functionalities of Mirador, then we shall explain what has been added as part of the MemoRekall-IIIF interface.
    1. [Mirador Base Interface](#mirador-base-interface)
    - [Main Toolbar](#main-toolbar)
    - [Add Resource](#add-resource)
    - [Manifest Window](#manifest-window)
    2. [MemoRekall-IIIF](#memorekall-iiif)
    - [Annotation Toolbar](#annotation-toolbar)
    - [Annotation](#annotation)
    - [Add Annotation](#add-annotation)
    ## Mirador Base Interface
    ### Main Toolbar
    The main Mirador toolbar is found on the right of the screen.
    - The first button is the [Add Resource](#add-resource) button – this will allow you to open different manifests as windows in Mirador, and add new manifests to the workspace.
    - The next button is Jump to Window. Here you can see all of the windows you have open in Mirador and highlight the one you wish to navigate to.
    - Next are Workspace Settings. Here you can:
    - Toggle Zoom Controls (three buttons that allow you to Zoom In, Zoom Out and Reset the zoom will appear at the bottom of each Window)
    - Select a Workspace Type. Switch between Mosaic (each Window is anchored in place and the screen will be fully occupied) and Elastic (you can freely move and resize Windows in the workspace).
    - Select a Language for the workspace.
    - Change the theme (by default, you can switch between Light and Dark modes).
    - Next, Workspace Options – you can Export and Import the entire workspace as a JSON file.
    - Finally, Full Screen mode.
    ### Add Resource
    In the Add Resource screen, you are presented with a list of different IIIF manifests which can be opened in a Window in the Mirador workspace. In both of our demos, there are a number of manifests that come preloaded in the workspace.
    At the bottom of the screen is a button for adding a new manifest. If you click on this, you will need to provide the URL to an existing IIIF manifest. Once this is done, it will be added to the list of manifests you can open.
    ### Manifest Window
    A manifest is opened as a Window in the Mirador workspace. Depending if you are in Elastic or Mosaic workspace type (see [Main Toolbar](#main-toolbar) you can resize and reposition the window.
    The Window is divided into four main sections:
    - Central Workspace
    - This is where everything will be shown, be it video, image, annotations.
    - Top Toolbar: here you can:
    - Toggle the visibility of the Window’s Side Toolbar.
    - See the manifest’s title.
    - Set different Views for the manifest (Single: see each of the manifest’s canvases one by one; Gallery: see a list of all of the different canvases), and turn Thumbnails on or off.
    - You can Maximize the Window to get it to occupy the entire workspace.
    - You can Close the window.
    - Side Toolbar: here you can:
    - View typical Dublin Core information associated with the manifest and open the manifest’s JSON file.
    - View information pertaining to the manifest’s Rights.
    - View the manifest’s Index. This will show a list of the different canvases.
    - Navigate the manifest’s Annotations (see [MemoRekall-IIIF](#memorekall-iiif)).
    - Note that on each bar, you can Open in Separate Panel. Clicking here will place an instance of the toolbar on the right of the Window. You can also place it on the bottom of the Window from here.
    - The Bottom Toolbar
    - The buttons here will depend on the type of manifest.
    - If the manifest has several canvases (thought of as different pages) you can navigate them here.
    - If the main resource is a video, you can control playback and audio here.
    - If the zoom controls are activated (see [Main Toolbar](#main-toolbar)) you can control Zoom here.
    ## MemoRekall-IIIF
    The following pertains to the functionalities we have added to Mirador, notably in the Annotations section of a Window’s Side Toolbar.
    ### Annotation Toolbar
    At the top of the Annotation List you will find the following commands:
    - Highlight: if you click here, if there are annotations that are pained directly in the Window, they will all be selected.
    - Add Annotation: This will open a new toolbar for adding a new annotation (see [Add Annotation](#add-annotation)).
    At the top of the list of annotations, you will find functionality for Filtering the list of annotations. Type a search term and only annotations including this term in the title will be shown.
    ### Annotation
    The list is populated with different annotations. In MemoRekall-IIIF, an annotation can be directly linked to an IIIF manifest. If this is the case, under the annotation’s title, a collapsible accordion will appear called Details. Clicking on this will display the associated manifest’s title, the manifest’s thumbnail, and an option for Opening the manifest in a new Mirador window.
    When you hover over each annotation, you have the option to either Edit it (this will open a toolbar on the right of the Window) or Delete it.
    ### Add Annotation
    To add a new annotation, click on the Add Annotation button at the top of the Annotation Toolbar. This will open a new toolbar on the right of the Window. Here you have several functionalities for creating annotations.
    - Target:
    - Shapes: paint different shapes directly onto the resource (square, circle, line, freehand).
    - Style: set the style for the shapes to draw (colour, line width and fill colour).
    - Timing: if the main resource is a video, you can set a Start and End point to the annotation. This will default to the current playback point as the start, and 10 seconds later.
    - Image Content: provide the link to an image that will be painted in the last Square Shape you have drawn on the screen.
    - Text Content: This is the content that will be used in the list of annotations.
    Note that we have not yet implemented Setting a Manifest for the annotation when creating new annotations as featured in the COESO demo content. This will be added soon.
    \ No newline at end of file