User manual

📗 User manual table of contents

👤 Account, Login, and User Preferences
👥 User Groups
🖼 Medias
📜 Manifests
📁 Projects
📝 Annotations
🔗 API

---

👤 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 like illustrated in the following screenshot. The preference page includes the following:

• The token to use the API (see https://github.com/SCENE-CE/mirador-multi-user/wiki/API-Documentation)
• 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

👥 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 modal 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
4. Setup member rights regarding the group
5. Save modifications

🖼 Medias

The Media page allows you to manage media that where either added by you or shared with you. The following media types are supported:

• Images, uploaded and stored on the platform
• Images, exposed on the internet and added as URL links
• Videos, exposed 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 per say but can be added in Peertube or Youtube and treated as video
• Other document types like PDF should be added after V1

The following is accessible in the Media page:

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

📜 Manifests

📁 Projects

📝 Annotations

🔗 API