User manual

📗 User manual

👤 Account, Login, and User Preferences
⚙️ Admin page
👥 User Groups
🖼 Media
📜 Manifests
📁 Projects
📝 Annotations

---

👤 Account, login and user preferences

To create an account, you need a valid email address. A confirmation mail is sent to validate your account before your first login.

Once logged in you can edit your user preferences illustrated in the following screenshot. The preference page includes the following:

• The token to use the API (see https://github.com/TETRAS-IIIF/mirador-multi-user/wiki/API-manual)
• Your preferred language (defaults to your browser language, except if specified otherwise)
• Your user informations (name, email and password)
• The button to delete your account

⚙️ Admin page

A user promoted to admin (see here how to promote) has an admin section at the bottom left of the screen. It gives informations on the platform and allows for various admin tasks detailed below.

Create users

Follow the steps below:

1. Click the Admin section at the bottom left of the screen
2. Click CREATE USER at the bottom (might need to scroll down a bit)
3. Fill in the form
4. SUBMIT

💡 You might tell your users to use the "FORGOT PASSWORD" link before login so they can setup their own password.

👥 User groups

You can create groups of users in order to ease the sharing of your content. The group list contains all groups that contain you as member. The following is accessible in the Group page:

1. Access the group list in the left menu
2. Create new groups
3. Edit existing groups
4. If are member of a group without editing rights, you still can leave it by clicking on the cross
5. Sort the group list
6. Filter the group list

When editing or creating a group, you are prompted with a window containing:

1. A General tab for basic informations (title, description, etc.)
2. A Member tab to manage members of the group where you can:
3. Search and add users as members ( ‼️ beware that you must start typing so the system displays matching users)
4. Setup member rights regarding the group
5. Save modifications

🖼 Media

The Media library allows you to manage media that you added or that are shared with you. The following media types are supported:

• Images, uploaded and stored on the platform
• Images, on the internet and added as URL links
• Videos, on the internet (storing videos directly on the platform is not allowed) with either:
  • A direct link to the video file
  • A Peertube link
  • A Youtube link (if setup by the platform admin)
• Audio is not supported as a first class citizen but can be added in Peertube or Youtube and treated as video
• All other document types can be uploaded and are available in the OTHER tab.

You can use your media library as follows:

1. Access the Media list in the left menu
2. Tabs to filter media types (All, Video, Images)
3. Filter by title and sort
4. Edit an existing media
5. Copy a media URL
6. Open a media in an external tab
7. Add a new media (either by link or upload)

A media tray is available on the right in relevant pages. It allows a quick access to your media library and to copy media URLs to use them in manifests or annotations:

HTML files as documents in the media library

You can upload HTML files as documents in the media library. They can be opened in a dedicated viewer and annotations can point to specific HTML tags in the document, as long as it has an id.

When you upload an HTML document in the media library, the platform automatically adds unique ids to tags containing text and missing an id. The platform also checks for duplicate ids in the document and alerts the user if some are found.

Once your HTML document is uploaded, you will find it in your media tray and have the ability to parse and preview identified parts of the document, as well as copy direct links to those parts to use in annotations. This is illustrated in the following screenshot:

1. Open the side tray
2. Select the media tray
3. Click the OPEN PREVIEW button available for HTML documents
4. It open a previewer in a popover window
5. You can preview parts of the document by hovering on the title and copy a direct link with the clipboard icon.

When you use the link to a specific part of the document, it opens a viewer with only the targeted part unfold and highlighted:

📜 Manifests

In the IIIF standard, resources can be gathered in composite documents called manifests. A manifest is composed of one or several canvases. A typical use case is to reconstitute a manuscript from the scans of its pages. The "pages" in a manifest are called canvases. It is also possible to compose video contents in manifests.

The Manifest library allows you to manage manifests that you added or that are shared with you. :

You can use your Manifest library as follows:

1. Access the Manifest page in the left menu
2. Filter by title and sort
3. Edit an existing Manifest
4. Copy a Manifest URL
5. Open a Manifest in an external Mirador instance
6. Add a new Manifest (either paste a link, upload a file or create it in an online editor)

A Manifest tray is available on the right in every page where you need it. It allows to quicly access your Manifest library and to copy Manifest URLs to use them in manifests (collections) or annotations:

📁 Projects

Generalities

A Project allows users to present and annotate one or several manifests. Behind the scene, a Project is composed of:

1. A Mirador workspace (a list of manifests and a set of arranged windows),
2. A set of annotations on manifest canvases,
3. A set of settings, like predefined tags or note templates.

The Project library allows you to manage manifests that you added or that are shared with you. :

You can use your Project library as follows:

1. Access the Project page in the left menu
2. Filter by title and sort
3. Configure an existing Project
4. Open the Mirador workspace of a Project
5. Create a new Project

Adding manifests to a project is done using the Mirador interface. After opening the Mirador workspace of a Project, click on "START HERE", and then "ADD RESOURCE"

Sharing and snapshots

You can share a project with registered users and create publicly available snapshots of a project:

‼️ beware that to share with users/groups you must start typing so the system displays matching users/groups.

Configure a project for annotations (tags and note templates)

It is possible to define tags that will be proposed to the user at annotation time, as well as note templates that user can chose from when adding a note to an annotation. A typical use case is to provide annotation guidelines.

💡 If there exist a tag with the same name as a note template, the tag will be added automatically when a user chose this note template at annotation time.

📝 Annotations

You can annotate manifests inside a project. First open your project and a manifest in Mirador. Then, you can toggle the annotation pannel with the following steps:

You see that different types of annotation are available. They are note the same for video and image contents. In particular, overlay annotations are not available for images.