Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The gallery provides various functionalities, e.g., a compact overview of items inside the gallery, a lightbox to show images and play mediavideos, 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 allows diverse data structures to be converted mapped to a predefined vocabulary, ensuring data compatibility within the gallery.

...

All gallery keys are optional. If the data does not contain the necessary certain information and the key pair is not set in the mapping file, the corresponding functionality will not be enabled in the gallery.

...

View file
namegallery.mapping.json
height150

Gallery Mapping Keys - Version 1.1

In the following, the keys are divided thematically via sections, where each section groups specific functionalities in the gallery.

Headline of galleryIcons on top of gallery on top of gallery
SectionGallery KeyNote

Title




event

iFDO icons


Values are based on the iFDO core icons. For a detailed overview, see SOP iFDO Creation Supplement. In the following the names of the iFDO keys:

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


 


depth

 


citation

 


pi_name

 

Main gallery




mime_type

The MIME-Type name used to distinguish between media in the gallery. Recommended to use MIME-Type, i.e., image/jpg. Based It is based on source media, not web preview file (i.e.g,   video/mp4).  Must Hence, it must start with 'image' or 'video' (e.g., image/jpg, video/octet-stream). Capitalization does not matter.

If not available, auto guessing based on acquisition - if defined, else 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: [
                "hidden.url_stream.dash",
                "hidden.url_stream.hls",
                "hidden.url_stream.video"
            ]


photo_width

Largest width of photo proxy (same orientation as web preview imageproxy).

photo_height

Largest height of photo proxy (same orientation as web preview imageproxy).

video_width

Largest width of video proxy (same orientation as web preview imageproxy).

video_height

Largest height of video proxy (same orientation as web preview imageproxy).

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 gallerycover.

cover_srcset

HTML5 img srcset attribute. Recommended to use width descriptor.

poster_src

Background poster when loading video in player. If skipped, default viewer based posters are shown.

duration

Video duration in human readable format, i.e., 00:16:45. Shown as overlay on video cover.

Sharing Feature




persistent_identifier

Media identifier used for the sharing feature in the media gallery. Fallback exist when not given.

name

Media file nameFile name of the source media file. 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).