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

Example

gallery.mapping.json

Gallery Mapping Keys - Version 1.3

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

Note:

  • All gallery keys are optional. If the data does not contain certain information and the key pair (gallery key: data key)  is not set in the mapping file, the corresponding functionality will not be enabled in the gallery.
  • All data keys that are identical to the gallery keys can be omitted - the entry in the gallery mapping file is only required for key names that differ.
  • If the data key is unknown, i.e. the WFS response does not contain it, it is set as a constant parameter during mapping.
SectionGallery KeyNote

Title




event

iFDO icons


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

image-acquisition



image-marine-zone



image-deployment



image-navigation



image-illumination



image-scale-reference



image-quality



image-pixel-magnitude

'image-resolution' in formerly iFDOs


image-spectral-resolution



image-capture-mode



image-license


Overview text


 


z_value

For definition, see O2A specification for GeoCSV (.sdi.csv)


z_type

For definition, see O2A specification for GeoCSV (.sdi.csv)


citation

 


pi_name

 

Main gallery




mime_type

The MIME-Type used to distinguish between media in the gallery. It is based on the source media, not the web preview file (e.g, video/mp4). Consequently, it starts 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. Observe: if an orientation parameter is present in the exif metadata of a proxy, it will not be considered. Consequently, photo_width must be larger than photo_height to show a proxy in landscape mode.

photo_height

Largest height of photo proxy. Observe: if an orientation parameter is present in the exif metadata of a proxy, it will not be considered. Consequently, photo_width must be smaller than photo_height to show a proxy in portrait mode.

video_width

Largest width of video proxy (same orientation as proxy).

video_height

Largest height of video proxy (same orientation as proxy).

thumbnail_src

URL to the webvtt file. Thumbnails are shown when pointer hovers over video player seek bar. 


cover_src

URL to the video cover.

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. Fallbacks exist when not given.

name

File name of the source media file. Assumption: Only once per gallery.

Sharing feature: First fallback if no persistent identifier is given.


date_time

Sharing feature: Second fallback if no persistent identifier is given to calculate a share id (together with coordinates).
  • No labels