Strawberryfield Formatters

Archipelago's Strawberryfield Formatters provide specialty media and other data processing formatters for StrawberryField (JSON) fields. These speciality Formatters power different parts of the display outputs for Archipelago Digital Objects (ADOs).

Archipelago Provided Formatters

The following Strawberryfield Formatters are shipped and configured with corresponding View Modes in Archipelago.

1. Strawberry Field 3D Model Formatter
2. Strawberry Field Audio Formatter
3. Strawberry Field Simple Citation Formatter
4. Strawberry Field Simple Image Formatter using IlIF
5. Strawberry Field Map Formatter using the Leaflet and GeoJson*
6. Strawberry Field Media Formatter using OpenSeadragon for IIIF media
7. Strawberry Field Formatter for Custom Metadata Templates
8. Strawberry Field Media Formatter using the Mirador * IIIF Viewer plugin
9. Strawberry Field Paged Formatter using IABook Readerplugin
10. Strawberry Field Panorama Formatter using Pannellum * and IIIF
11. Strawberry Field PDF Formatter for IIIF served PDFs
12. Strawberry Field Media Formatter using the Universal (UV) * IIIF Viewer plugin
13. Strawberry Field Video Formatter
14. Strawberry Warc Formatter using replay.web embedded player
15. Strawberry Default Formatter
16. Strawberry Field Pretty Formatter

Overview and Example Walkthrough

The rest of this documentation guide will provide an overview of Archipelago's Strawberryfield Formatters and how they work using the default View Mode Digital Object Full View as an example.

At a glance

When taking a look at your First Digital Object note that multiple formatters are working together to create this Display ( or View mode). Since "My First Digital Object" is a Photograph the Display being used is Digital Object Full View which, by default, uses formatters to:

• (Red) Create the image viewer where users can zoom in, zoom out, fullscreen and rotate all the images associated with the ADO.
• (Blue) Display the Object Description and Type of Resource.
• (Green) Display the Raw JSON Metadata and IIIF Presentation Manifest.

In Greater Detail

When editing an ADO, at the top of the Webform page there is a tab titled Manage display which will take us to where all the Formatters live. Take note that the DISPLAY SETTINGS shown in the screenshot below are using the Default View mode.

Once the page loads the Default View mode is automatically selected. However, because we are editing an object with the Media type Photograph, we need to edit the View mode Digital Object Full View since it is the Default View mode for this Media type.

ADO Type to View Mode Mapping Form

The ADO Type to View Mode Mapping form tells the ADOs which View mode to use by default per Media type. You can find the ADO Type to View Mode Mapping Form at ~yoursite/admin/config/archipelago/viewmode_mapping

You can see the full list of Default View Modes included in Archipelago here.

Reviewing a View Mode in Depth

There are two sections in Manage display for Digital Object Full View: 1) Content and 2) Disabled. Moving a field into Content means this formatter will be used to the display the ADO in some way. The formatters moved to Disabled are inactive and are subsequently not being used for displaying the ADO.

There are four fields named 🍓Strawberry and each one is a copy of the field 🍓Strawberry (Descriptive Metadata source). Since the names of the fields do not imply their function, they have been named Strawberry in four different ways (Italiano, Deutsch, Diné Bizaad, and English) in order to organize and help users visually remember which field is doing what for the Display.

Recall My First Digital Object at beginning of this document where there were 3 sections highlighted in Red, Blue, and Green.

• In Red (🍓Fragola) there is the Strawberry Field Formatter for IIIF media which takes the image stored in S3 to display the photograph with the image viewer.
• In Blue (🍓Erdbeere) there is the Strawberry Field Formatter for Custom Metadata Templates which displays the raw JSON metadata using configurable Twig templates. In this example, the default Twig template uses the JSON key type to display the Type of Resource.
• In Green (🍓Strawberry (Descriptive Metadata)) there is the Strawberry Default Formatter which is used to display the Raw JSON Metadata.

At the end of the day

The decision for how your metadata is displayed is totally in your control.

Under the WIDGET column, there is a quick description/overview of what the formatter is doing.

And by clicking on the gear icon under the OPERATIONS column, all of the options for configuring the formatter are revealed. To use 🍓Fragola as an example (the Formatter for IIIF media), we can choose which JSON Key is being used to fetch the IIIF Media URLs (found inside the raw JSON being played with Strawberry Default Formatter), the maximum height and width of the viewer, etc.

And then with 🍓Erdbeere (the Formatter for Custom Metadata Templates) there is the option, among many others, to configure which Twig template the formatter will use for displaying your Metadata.

More information about Managing Metadata Displays with Twig Templates can be found here.

---

Thank you for reading! Please contact us on our Archipelago Commons Google Group with any questions or feedback.

Return to the Archipelago Documentation main page.