Goobi viewer (English)
Documentation homeGoobi viewer Digests
  • Goobi viewer manual
  • Documentation overview
  • What is the Goobi viewer?
  • Configuration
    • 1. Goobi viewer Core
      • 1.1 Local settings
      • 1.2 Translations
      • 1.3 Folder configuration
      • 1.4 URL configuration
      • 1.5 User accounts
        • 1.5.1 Authentication Provider
        • 1.5.2 Sending e-mails
        • 1.5.3 Further settings
      • 1.6 Performance
      • 1.7 Access conditions and images
      • 1.8 Captcha
      • 1.9 PDF download
        • 1.9.1 Variants
        • 1.9.2 Download Links
        • 1.9.3 Individual PDF title page
      • 1.10 ePub download
      • 1.11 Image options
        • 1.11.1 Extended scrolling in the image view
        • 1.11.2 Navigation between structure types
        • 1.11.3 Image view configuration
        • 1.11.4 Maintaining zoom and rotation while browsing in the image view
        • 1.11.5 External images
        • 1.11.6 Restriction of image scaling
        • 1.11.7 Thumbnail settings
        • 1.11.8 Image Footer
      • 1.12 Individual page types
      • 1.13 Opening certain document types in alternative page views
      • 1.14 Full text hints
      • 1.15. Language settings
      • 1.16 Theme
        • 1.16.1 External themes
      • 1.17 Search
        • 1.17.1 Sorting
        • 1.17.2 Faceting
        • 1.17.3 Advanced search
        • 1.17.4 Timeline
        • 1.17.5 Calendar
        • 1.17.6 Save search
        • 1.17.7 Expand query for search sub-results
        • 1.17.8 Aggregated search hit display
        • 1.17.9 Versioning of records
        • 1.17.10 Exporting search results
        • 1.17.11 Search hit metadata
      • 1.18 Digital collections
        • 1.18.1 Collection hierarchy
        • 1.18.2 Sorting of records
        • 1.18.3 Sorting of collections
        • 1.18.4 Blacklist
        • 1.18.5 Collection size
        • 1.18.6 Further settings
        • 1.18.7 Structure element whitelist
      • 1.19 Metadata
        • 1.19.1 Main metadata
        • 1.19.2 Sidebar metadata
        • 1.19.3 Search hit metadata
        • 1.19.4 Archive metadata
        • 1.19.5 Image metadata
        • 1.19.6 Display of authority data
        • 1.19.7 Calendar structure elements
        • 1.19.8 Browsing
        • 1.19.9 Multilingual metadata
        • 1.19.10 Licenses
      • 1.20 Tables of contents
        • 1.20.1 Main table of contents
        • 1.20.2 Sidebar table of contents
        • 1.20.3 Download tables of content as PDF file
      • 1.21 Tag clouds
      • 1.22 Resolver
      • 1.23 Sidebar
      • 1.24 Navigation and display
      • 1.25 RSS feed
      • 1.26 Reading lists
      • 1.27 User comments
      • 1.28 CMS
      • 1.29 Transkribus
      • 1.30 Original content
      • 1.31 Piwik/Matomo
      • 1.32 Sitelinks
      • 1.33 API
        • 1.33.1 JSON
        • 1.33.2 IIIF
        • 1.33.3 Authentication
        • 1.33.4 CORS
      • 1.34 OpenSearch
      • 1.35 Embedding
      • 1.36 Maps
      • 1.37 Translations
      • 1.38 Archive
      • 1.39 Campaigns
      • 1.40 Add content
      • 1.41 Usage figures
      • 1.42 Config Editor
      • 1.43 Proxy
      • 1.44 ActiveMQ
      • 1.45 Developer
      • 1.46 External Ressources
    • 2. Goobi viewer Indexer
      • 2.1 Main configuration
      • 2.2 Directories
      • 2.3 Proxy
      • 2.4 Performance
      • 2.5 Structure types
      • 2.6 Metadata
      • 2.7 Starting and Exiting
      • 2.8 Indexing records
      • 2.9 Updating individual page documents
      • 2.10 Deleting records
      • 2.11 Solr scheme
      • 2.12 Further settings
    • 3. Goobi viewer Connector
      • 3.1 OAI interface
        • 3.1.1 Main Configuration
        • 3.1.2 Dublin Core
        • 3.1.3 Europeana
        • 3.1.4 METS
        • 3.1.5 LIDO
        • 3.1.6 MARCXML
        • 3.1.7 Xepicur
        • 3.1.8 Goobi viewer overview pages
        • 3.1.9 Goobi viewer crowdsourcing
        • 3.1.10 TEI
        • 3.1.11 CMDI
        • 3.1.12 Sets
      • 3.2 SRU interface
  • User interface
    • 1. Frontend
    • 2. Backend
      • 2.1 Dashboard
      • 2.2 Administration
        • 2.2.1 User
        • 2.2.2 Groups
        • 2.2.3 IP-Ranges
        • 2.2.4 Access licenses
        • 2.2.5 Rights
        • 2.2.6 Comments
        • 2.2.7 Terms of use
        • 2.2.8 New record
      • 2.3 Crowdsourcing
        • 2.3.1 Campaigns
        • 2.3.2 Annotations
      • 2.4 CMS
        • 2.4.1 Pages
        • 2.4.2 Categories
        • 2.4.3 Static pages
        • 2.4.4 Media
        • 5.4.5 Menus
        • 5.4.6 Collections
        • 5.4.7 Maps
  • Misc
    • 1. Use cases
      • 1.1 Series and convolutes
      • 1.2 Access restrictions
      • 1.3 Subthemes
      • 1.4 Authority data
      • 1.5 Multilingualism
      • 1.6 Maps
      • 1.7 Sub collections
      • 1.8 Multiple Goobi viewer
      • 1.9 Crowdsourcing module
      • 1.10 Archival documents
      • 1.11 Solr Queries
      • 1.12 Linking from METS file groups
      • 1.13 Add content
      • 1.14 Shibboleth
      • 1.15 Access restricted metadata
    • 2. FAQ
    • 3. Glossary
  • Devs & Ops
    • 1. Core Changelog
    • 2. Theme Changelog
    • 3. Installation guide
      • 3.1 Classical
      • 3.2 Docker
    • 4. Development environment
    • 5. API
    • 6. Explained!
Powered by GitBook
On this page

Was this helpful?

  1. Configuration
  2. 1. Goobi viewer Core
  3. 1.11 Image options

1.11.8 Image Footer

Previous1.11.7 Thumbnail settingsNext1.12 Individual page types

Last updated 2 years ago

Was this helpful?

An optional footer can be displayed below the image.

The text it contains is configured as follows:

<viewer>
     <watermarkTextConfiguration enabled="true">
           <text>SOLR:MD_COPYRIGHT</text>
           <text>urn</text>
           <text>purl</text>
     </watermarkTextConfiguration>
</viewer>

The enabled attribute must be set to true for this functionality to be used. Default is true.

The values urn and purl for <text> are reserved words (case insensitive).

Values that begin with SOLR: followed by the name of an existing Solr metadata field cause the corresponding field in the main document of the record to be evaluated - if present, its value is written to the watermark. All other values are written 1:1 into the watermark. In the latter case you should take care that the entered text is not too long for the watermark.

The text elements will be checked for feasibility in the given order. In the above example, the system first checks whether the MDIGHT field contains a value. If yes, this value is rendered into the footer, all other possibilities are skipped. If no, the next element is evaluated (URN). If this is also not available, the PURL, which can be generated in any case, is passed.

Depending on the value of a field in the Solr search index, alternative footers can be rendered. The entry <watermarkIdField> can occur multiple times. Used for the image footer ID is the value from the first field that is not empty. The field name is defined as follows:

<viewer>
    <watermarkIdField>MD_OTHEROWNERINSTITUTION</watermarkIdField>
    <watermarkIdField>DC</watermarkIdField>
</viewer>

The content of the field can then be read in the config_imageFooter.xml. The following structure must be present:

<watermarks>
    <watermark id="Wert1" height="50" width="500" color="CCCCCC">
        <!-- [...] -->
    </watermark>
    <watermark id="Wert2" height="50" width="500" color="CCCCCC">
        <!-- [...] -->
    </watermark>
    <watermark id="Wert3" height="50" width="500" color="CCCCCC">
        <!-- [...] -->
    </watermark>
    <watermark id="default" height="50" width="500" color="CCCCCC">
        <!-- [...] -->
    </watermark>
</watermarks>

The content of the attribute id=""" corresponds to the value of the index field, otherwise the configuration will use id="default".

Footers that have a value of 0 for height or width are not rendered.

If different footers are to be generated in portals based on different sources in the METS file, it is best to differentiate during indexing.

Example of a configuration based on the setup name and a collection

<MD_FOOTERTEMPLATE>
    <list>
        <item>
            <xpath>
                <list>
                    <item>mets:amdSec/mets:rightsMD/mets:mdWrap/mets:xmlData/dv:rights/dv:owner[text() = 'Example Library']</item>
                    <item>mets:xmlData/mods:mods/mods:classification[@authority='ivdcc'][text() = 'example#subcollection#project']</item>
                </list>
            </xpath>
            <addToDefault>false</addToDefault>
            <onetoken>true</onetoken>
        </item>
    </list>
</MD_FOOTERTEMPLATE>
Footer below the image