The gallery provides various functionalities, e.g., a compact overview of items inside the gallery, a lightbox to show images and play media, as well as a sharing feature.
However, each functionality can only be used when the information is provided. Furthermore, it must be clear where the information is located inside the data.
The gallery mapping file enables diverse data structures to be converted to a predefined vocabulary, ensuring data compatibility within the gallery.
Thereby gallery keys are mapped to data keys, i.e., column names of the data layers.
All gallery keys are optional. If the data does not contain the necessary information and the key pair is not set in the mapping file, the corresponding functionality will not be enabled in the gallery.
Example
Gallery Mapping Keys
In the following, the keys are divided thematically via sections.
| Section | Gallery Key | Note |
|---|---|---|
Headline of gallery | ||
| event | ||
Icons on top of gallery | Values are based on the iFDO core icons. For a detailed overview, see SOP iFDO Creation Supplement. | |
acquisition | image-acquisition | |
marine-zone | image-marine-zone | |
deployment | image-deployment | |
navigation | image-navigation | |
illumination | image-illumination | |
scale-reference | image-scale-reference | |
quality | image-quality | |
pixel-magnitude | image-resolution / image-pixel-magnitude | |
spectral-resolution | image-spectral-resolution | |
capture-mode | image-capture-mode | |
license | image-license | |
Overview text on top of gallery |
| |
depth |
| |
citation |
| |
pi_name |
| |
Main gallery | ||
type | Type name used to distinguish between media in the gallery. Recommended to use MIME-Type, i.e., image/jpg. Based on source media, not web preview file (i.e., If not available, auto guessing based on presence of photo_src and video_src. | |
photo_src | URL to the web version of the photo file. Fallback if scrset is not given or not supported by the browser. | |
photo_srcset | HTML5 img srcset attribute. Recommended to use width descriptor. | |
video_src | String or list with strings containing URLs to media representations. Recommended to use a list for streams, where each list item is a fallback if the previous item was not supported in the browser. Example: [ | |
photo_width | Largest width of photo proxy (same orientation as web preview image). | |
photo_height | Largest height of photo proxy (same orientation as web preview image). | |
video_width | Largest width of video proxy (same orientation as web preview image). | |
video_height | Largest height of video proxy (same orientation as web preview image). | |
thumbnail_src | URL to the webvtt file. Thumbnails are shown when pointer hovers over video player seek bar. | |
cover_src | URL to the image that is representing the video in the gallery. | |
cover_srcset | HTML5 img srcset attribute. Recommended to use width descriptor. | |
poster_src | Background poster when loading video in player. | |
duration | Shown as overlay on video cover. | |
Sharing | ||
persistent_identifier | Media identifier used for the sharing feature in the media gallery. Fallback exist when not given. | |
name | Media file name. Assumption: Only once per gallery. Share media function: First fallback if no persistent identifier is given. | |
date_time | Share media function: Second fallback if no persistent identifier is given to calculate a share id (together with coordinates). |
Overview
Content Tools