O2A Media Layer - Gallery Mapping

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

Gallery Mapping Keys

In the following, the keys are divided thematically.

Notes:

(featurePropertiesHarmonized)|(properties#harmonized)

Headline of gallery

Required gallery key:

event

Icons on top of gallery

Values are based on the iFDO core icons. For a detailed overview, see SOP iFDO Creation Supplement.

gallery key	iFDO vocabulary
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
spectral-resolution	image-spectral-resolution
capture-mode	image-capture-mode
license	image-license

Overview text on top of gallery

Required gallery keys:

depth
citation
pi_name

Media representation (main gallery)

Key	Description	Usage in gallery	Fallback
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., `video/mp4`). Must start with 'image' or 'video'. Capitalization does not matter.	Load media in lightbox or video player	Auto guessing based on presence of photo_src and video_src
photo_src	URL to photo file
photo_srcset
video_src	List? containing [ "hidden.url_stream.dash", "hidden.url_stream.hls", "hidden.url_stream.video" ]
photo_width	orientation	maximum width in pswp	1000 px
photo_height			1000 px
video_width			1000 px
video_height			1000 px
thumbnail_src		Shown when pointer hovers over video player seek bar
cover_src		Image representing video in gallery
cover_srcset
poster_src	Background poster when loading video in player
duration		Overlay on video cover

Technical stuff

gallery key
persistent_identifier		Identifier to share media items	Own identifier is calculated
name	Media file name. Assumption: Only once in dataset	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)