1 von 4

Use cases

In the following sections, some concrete application scenarios are explained in detail. Some of the configurations are customer-specific and may therefore not be transferable to all Goobi workflow installations without modification.

Create thumbnails for accelerated image display

For some time now, it has been possible to create a thumbs/ folder in Goobi workflow process folders. In this folder, thumbnails for the images in the folders in the images/ folder can be stored. When doing this, you must follow a naming convention that is evaluated by Goobi workflow and used to display images efficiently.

The thumbs folder

A folder below the thumbs/ folder may only contain jpg images and must follow the following naming scheme to be used by Goobi:

<images-folder-name>_<size-of-longest-side-in-pixels>

For example, if you now have the following folder in the images/ folder:

images/myexampleprocess_master

For thumbnails with a maximum page length of 1000 pixels you would have to create the following folder in the thumbs/ folder and fill it with matching images:

thumbs/myexampleprocess_master_1000

Example configuration

The folders and images in them can be created using a script step in Goobi workflow. The script step may contain multiple scripts to create thumbnails in multiple sizes. The following scripts create thumbnails for the master images in 800, 1600 and 3200 pixel sizes:

/bin/bash /opt/digiverso/goobi/scripts/gm-convert.sh -s {origpath} -d {processpath}/thumbs/master_{processtitle}_media_800 -D .jpg -o "-thumbnail 800x800"
/bin/bash /opt/digiverso/goobi/scripts/gm-convert.sh -s {origpath} -d {processpath}/thumbs/master_{processtitle}_media_1600 -D .jpg -o "-thumbnail 1600x1600"
/bin/bash /opt/digiverso/goobi/scripts/gm-convert.sh -s {origpath} -d {processpath}/thumbs/master_{processtitle}_media_3200 -D .jpg -o "-thumbnail 3200x3200"

For the derivatives, the calls are made in the same way:

/bin/bash /opt/digiverso/goobi/scripts/gm-convert.sh -s {tifpath} -d {processpath}/thumbs/{processtitle}_media_800 -D .jpg -o "-thumbnail 800x800"
/bin/bash /opt/digiverso/goobi/scripts/gm-convert.sh -s {tifpath} -d {processpath}/thumbs/{processtitle}_media_1600 -D .jpg -o "-thumbnail 1600x1600"
/bin/bash /opt/digiverso/goobi/scripts/gm-convert.sh -s {tifpath} -d {processpath}/thumbs/{processtitle}_media_3200 -D .jpg -o "-thumbnail 3200x3200"

The script gm-convert.sh used here can be downloaded here and should be placed in the folder /opt/digiverso/goobi/scripts/:

gm-convert.sh

#!/bin/bash

PATH=${PATH}:/usr/local/bin

set -e
set -u

USAGE="
$0 - wrapper script for GraphicsMagick's convert command.

Mandatory options:
    -s SOURCEDIR            Source folder with images to convert
    -d DESTDIR              Output folder
    -D DEST_EXTENSION       Output file extension

Other options:
    -S SOURCE_EXTENSION     Only convert source files with these extensions
    -o GMOPTION [ -o ... ]  GM Options

    Calling from Goobi - example script command (be careful with spaces within \"\"):
    /path/to/$(basename $0) \"-s{origpath}\" \"-d{tifpath}\" \"-D.tif\" \"-o+matte -depth 8 -compress JPEG\"
"


## check if the called tools exists
type -P gm &>/dev/null || { echo "ERROR: GraphicsMagick is required but seems not to be installed." >&2; exit 1; }


## check for the given arguments
[ "$#" -ge "3" ] || { echo "$USAGE"; exit 1; }    # at least
SOURCE_EXTENSION=".*"                             # if none specified use .* as source file type
GMOPTIONS=""                                      # if none specified use none
while getopts "s:d:S:D:o:"  OPCOES; do
  case $OPCOES in
    s ) SOURCEDIR="$OPTARG";;
    d ) DESTDIR="$OPTARG";;
    S ) SOURCE_EXTENSION="$OPTARG";;
    D ) DEST_EXTENSION="$OPTARG";;
    o ) GMOPTIONS="$GMOPTIONS $OPTARG";;
    ? ) echo "$USAGE"; exit 1;;
    esac
done

# check arguments
[ -d "${SOURCEDIR}" ] || { echo "ERROR: Input folder ${SOURCEDIR} does not exist." >&2; exit 1; }
[ -d "${DESTDIR}" ]   || mkdir -p "${DESTDIR}" || { echo "ERROR: Could not create destination folder ${DESTDIR}." >&2; exit 1; }
stat -t "${SOURCEDIR}/"*${SOURCE_EXTENSION} >/dev/null || { echo "ERROR: No *${SOURCE_EXTENSION} input files found in ${SOURCEDIR}" >&2; exit 1; }


# convert
cd "${SOURCEDIR}"
CTR=0
for i in *${SOURCE_EXTENSION}; do
  CTR=$((CTR+1))
  nice gm convert "$i" ${GMOPTIONS} "${DESTDIR}/${i%${SOURCE_EXTENSION}}${DEST_EXTENSION}" || { echo "ERROR: GM command failed: gm convert $i ${GMOPTIONS} ${DESTDIR}/${i%${SOURCE_EXTENSION}}${DEST_EXTENSION}" >&2; exit 1; }
done


# Success
echo "
Done converting $CTR images to $DEST_EXTENSION with GraphicsMagick.
Options used:          $GMOPTIONS
Source directory:      $SOURCEDIR
Destination directory: $DESTDIR
"

exit 0

# Notizen
# nice gm mogrify -depth 8 +matte -compress JPEG "${i}"
# if [ "$(tiffinfo ${i} 2>&1 | grep Bits | awk {'print $2'})" != "1" ]; then
# prepare !

Handling of 3D Objects

Help with displaying 3D objects in Goobi instead of images

Instead of two-dimensional images, 3D objects can also be saved in the images folder and displayed in the Goobi interface. Goobi can display the following 3D formats:

.obj
.ply
.stl
.fbx
.gltf
.glt
.x3d

However, full support for textures exists only for the .obj, .gltf and .glb formats, so use one of these formats if possible. DRACO compression is supported for .gltf and .glb formats.

Additional resources

Often a 3D object needs additional resource files to be displayed correctly. These are usually image files for surface textures and .mtl files with material definitions for .obj files. These files should always be saved in a separate file folder next to the object file, with the same name as the object file without file extension. .mtl files can be given any name, whereas the naming of the image files is determined by the 3D object file or the .mtl file.

1234/images/myObject.obj
1234/images/myObject/materials.mtl
1234/images/myObject/textures01.jpg
1234/images/myObject/textures02.jpg
1234/images/anotherObject.glb
1234/images/andYetAnotherObject.gltf
1234/images/andYetAnotherObject/textures.jpg

Known problems

Very large 3D objects with over a million edges can often not be displayed by browsers or only very slowly. It is advisable to use only smaller files in Goobi.
If you use an .mtl file, sometimes no image is displayed. This may be due to the content of the .mtl file itself if it contains the following line: Tr 1.0 or d 0.0 This sets the transparency of the object to 100%, which means it is not displayed at all. Instead, the line must read Tr 0.0 or d 1.0
The display of the object can also be influenced by the following line: illum 1 or illum 2 The illum 1 option enhances specular reflections on the object, illum 2 makes them possible. Mirroring reflections can make an object appear overexposed, but they can also emphasise the three-dimensional shape.

Export of 3D-Objects into the Goobi viewer

In order to correctly export processes with 3D objects to the Goobi viewer or other presentation systems, some additional precautions are necessary.

Installing the 3D export plugin for Goobi

For the export of 3D objects with auxiliary files (mtl, surface images, ...) the export must be done with the following Goobi export plugin:

plugin_intranda_export_object3d.jar

The plugin must be entered in the export step as Step Plugin.

Configuration of the METS file groups

To ensure that 3D objects are also written to the METS file when exporting with the 3D export plugin, an additional METS file group must be created in the project configuration with the following properties:

Name

Value

The value in Suffix must always correspond exactly to the file extension of the 3D objects to be exported.