Verfügbare Keywords

  1. Manual
  2. Goobi workflow
  3. Goobi viewer

Browse

  1. Overview of documentation
    All the official documentation relating to Goobi has been produced by intranda GmbH. It is divided into three main areas, each with a different focus on the same application, and aimed respectively at...
  2. What is Goobi?
    Goobi is the most popular open-source workflow management software for use in digitisation projects. It covers the entire spectrum of tasks involved in the digitisation process – from book to online p...
  3. Overview
    ...
  4. Goobi for Users
    Basically, Goobi is a web-based application. To a very large extent, the way it is used and operated will be familiar to you from numerous websites. On the user side, all you need to be able to use Go...
  5. Logging in
    To work with Goobi you will need a valid user name and password. You will usually receive these from your system administrator. In most case, they will be the same as those you were given for access t...
  6. Menu
    As is usually the case for web applications, you will find a navigation menu. After logging in, users can select from a number of options depending on their level of authorisation. The diagrams below ...
  7. Logging out
    For security reasons, you should always log out of Goobi whenever you leave your work station. Depending on the configuration, Goobi will automatically log you out after a period of inactivity. To log...
  8. Switch between available languages
    In the top right corner you can switch between several available languages. Goobi is supplied and installed by intranda in German, English and Spanish. Adding other languages is straightforward, and t...
  9. Help function
    Towards the right-hand edge of the menu bar there is an option to call the integrated Help function. This can be used for many of the input boxes in Goobi and shows you which information is required a...
  10. Personal settings
    Once you have logged in, you can choose a number of settings to create your own user profile. To do this, click on your user name in the menu bar and then on the sub-menu item User configuration. Goob...
  11. Changing your password
    As with any other technical system, you should change your password from time to time for security reasons. To do so, click on your user name in the menu bar and then select the Change password option...
  12. My tasks
    After logging in, most users continue with the menu option My tasks in the menu bar. This will display a screen similar to the one shown below: In the My tasks list, you will only find those process t...
  13. Processes
    All the processes that you or other users create will remain in Goobi’s database. To display an overview of these processes, select the option Workflow - Processes in the menu bar. Goobi will display ...
  14. How to find a process
    If you want to search for a particular process, you can use Goobi’s straightforward search box. To do so, select the Workflow - Search for volume option from the menu bar. The input box used to search...
  15. How to create a new process
    There is a specific screen for adding new processes to Goobi’s store of data. Select the option Workflow - Production templates from the menu bar. You will be shown a list containing all the productio...
  16. Edit task details
    On the page shown here, the details and plugins for tasks can be configured. The page does not differ significantly between tasks of process templates and those of existing processes. Differences are ...
  17. The basics
    Before we look in detail at the methodology of specific user groups, let us take a look at some basics. Any of the terms used in this section that may not be familiar to you can be found together with...
  18. Scanning
    The methods used by scan operators working with Goobi on a daily basis do not vary substantially from those of other users with different qualifications or responsibilities. All users must first log i...
  19. Quality control
    At many sites that work with Goobi, a manual check is made on the quality of the scanning work performed in earlier steps of the workflow. The methods used by the staff who conduct these quality check...
  20. Manual script steps and plugin steps
    In addition to the tasks we have already described, it is possible to configure Goobi so that users can call up any external programs, scripts or plugins for specific purposes from within Goobi. To th...
  21. Automatic script-run steps
    As well as the manual scripts described in the last section, Goobi can also be configured to execute individual workflow steps automatically if they have been configured to call up scripts. To do this...
  22. Metadata processing
    One of the main areas of work for those users with library training in the field of digitisation projects involves the comprehensive indexing of digitised objects. Basically, this covers pagination, s...
  23. Export to the DMS
    One of the workflow steps frequently included in a wide range of digitisation projects at numerous establishments involves making the digitised material available to the public together with the corre...
  24. How different user groups work with Goobi
    The next section examines some typical user groups in order to illustrate their structure as part of digitisation projects at numerous establishments and the way they work with Goobi on a daily basis....
  25. Structure tree
    The grey-shaded area on the left of the screen contains the structure tree, where you can see in hierarchical form all the structure elements that have already been obtained from the source material. ...
  26. Page display
    The right-hand side of the Metadata Editor gives you an overview of the individual digital images that form part of the current process together with the number of pages, the current magnification lev...
  27. Menu options
    Goobi offers a wide range of functions that simplify the task of working with structure data and metadata. These options can be found in the top menu bar and at the right-hand edge of the structure tr...
  28. User interface
    Once you have opened the Metadata Editor, you have full access to all the editing options relating to the pagination, structure data and metadata of the digitised material. The Metadata Editor is divi...
  29. Pagination
    Pagination is a key element of digitisation projects. It involves matching page labels (printed page numbers in the source material) to the scanned images. In older works, the page numbering often cha...
  30. Create new structure element
    The list of elements from which you can select in the New structure element box will vary depending on which structure element has been activated. You can choose the position where you want to insert ...
  31. Moving structure elements
    There are several ways in which you can subsequently modify the structure of a document. One of these involves moving structure elements to a different position. To do this, first select the structure...
  32. Copying structure elements from other processes
    Within Goobi, it is also possible to copy structural elements from the METS file of a process to another process. To do this, click on the Import structural element from another process function in th...
  33. Structuring
    When you have completed the task of pagination, the next step in the workflow involves structuring. Working again in the Metadata Editor, the aim is to identify and record all the relevant structure e...
  34. Metadata indexing
    The main area of the Metadata Editor also contains a navigation bar to perform a range of steps during metadata indexing. Selecting Pagination, Structure data, Metadata and File replacement allows you...
  35. Subsequent changes to pagination
    If you wish, you can modify previously created pagination sequences. Goobi allows you to move or delete individual pages or several pages at the same time. To do this, you first need to select the req...
  36. Uploading files
    This function can be used to upload a file from the user’s computer to a selected process folder. The user will need to specify a file and choose the position within the pagination sequence where the ...
  37. Downloading files
    This function can be used to download a file from the current process folder to the user’s own computer. The user can select the file to be stored locally using the computer’s file browser....
  38. Server-based exports
    A subfolder entitled fileupload is automatically generated on the Goobi server in the configured folder named tempfolder. This subfolder is used to exchange files between processes on the server. In t...
  39. Server-based imports
    Provided that the server-based target folder is not empty, you can use the Server-based import box to select a folder from which previously exported images can now be imported into the current process...
  40. Modifying and verifying data
    This section explains a number of additional functions in the METS Editor that involve directly modifying the file system for the images. For this reason you should take great care when using the func...
  41. Edit OCR results
    The metadata editor has an editor for OCR results with which the ALTO XML files in the process can be edited. This editor can be accessed via a button in the upper menu bar: The ALTO editor overlays t...
  42. Overview of the keyboard combinations
    There are various keyboard combinations available in the metadata editor. These are summarised here once again: | Keyboard combination | Description of function | | :--- | :--- | | Ctrl + Shift + Curs...
  43. Metadata Editor
    Goobi’s Metadata Editor is one of the core elements of digitisation projects. Most work involving the Metadata Editor is performed by trained librarians. There are two ways to open the Metadata Editor...
  44. Users
    ...
  45. Structure of the extended user interface
    Goobi users with a higher level of authorisation will find a number of additional options in the menu bar. These allow you to amend data that may relate to an entire project or to different users and ...
  46. Rulesets
    One of the fundamental aspects of Goobi is that all structure data and metadata to be recorded as part of a digitisation project can be specified on the basis of a flexible system of rulesets. Before ...
  47. LDAP groups
    One of Goobi’s key features is the integration of both Goobi and the additional services linked to it to a central authentication system. In most cases, the authentication process is conducted via a c...
  48. Users
    In order to specify and manage the users that you want to be able to work with your Goobi installation, first select the menu item Administration - Users from the menu. This will display a list of all...
  49. User groups
    In order to ensure flexibility in the handling of freely configurable workflows and the corresponding users, you will need to define a number of user groups. These user groups can be understood as the...
  50. Searching processes
    If you want to search for specific processes, you can use Goobi’s extended search function. To do this, select the menu bar option Workflow – Search for volume. In order to conduct a finely tuned sear...
  51. Activity
    If you need even more detailed information about a process, click on the first symbol in the Actions column for that process. This will open the detailed view window for that process with a number of ...
  52. Activities for hit lists
    As well as the options described above allowing users to edit or amend each volume independently of the current status of the workflow and to process its structure data or metadata or re-export the da...
  53. GoobiScript
    When you apply an action to a group of processes, you also have an option to run Goobi scripts within that action. To do so, click on the button Execute GoobiScript in the Possible actions box. Goobi ...
  54. Processes
    All objects that are processed in Goobi as part of the whole range of digitisation workflows, and that as such have their own individual progress status, can be viewed in the Processes area. First, cl...
  55. Variables
    Goobi can also use variables when performing certain actions. Some of these variables can be used only in specific contexts, e.g. the variables {login} and {user full name} when configuring the LDAP. ...
  56. Harvester
    The harvester can be used to automatically import data from external repositories. Overview To be able to access the harvester, the user must have the Edit harvester repositories right. The Harvester ...
  57. Config Editor
    This editor allows direct editing of the Goobi workflow configuration files from within the user interface in the web browser. Overview The editor can be found as a separate entry in the Administratio...
  58. Ruleset editor
    This editor is used to directly edit the ruleset files of Goobi workflow directly from the user interface within the web browser. Overview The editor can be found in its own entry in the Administratio...
  59. Management
    ...
  60. ‘config’ sub-directory
    The config directory contains all the Goobi configuration files that do not have to be located within the application itself. These are listed below: bash=configcontentServer.xml goobiactivemq.xml goo...
  61. ‘import’ sub-directory
    Depending on the way Goobi has been installed, the import directory will contain a range of data, mostly on a temporary basis. By way of example, import plug-ins use this directory to enter metadata a...
  62. ‘metadata’ sub-directory
    The metadata directory is the central directory for storing Goobi metadata and digital content. Within this directory there is a directory with the name of the Goobi process ID for each Goobi process....
  63. ‘plugins’ sub-directory
    Depending on the way Goobi has been installed, the plugins directory may contain a number of plug-ins that perform imports or call Web API commands. Depending on the task, the compiled plug-ins are lo...
  64. ‘rulesets’ sub-directory
    Within Goobi, the UGH class library is used to process metadata, map PICA imports and generate METS files. In order to manage the huge variety of configuration options, UGH uses a mechanism known as r...
  65. ‘scripts’ sub-directory
    A range of scripts can be made available centrally in the scripts directory. These scripts can be used within the workflow to automate certain tasks....
  66. ‘xslt’ sub-directory
    Goobi uses a mechanism called XSLT transformation to generate dockets as PDF files. This involves generating PDF documents from existing xml files. This is done on the basis of xslt files located cent...
  67. Global directory structure
    As a web-based application, Goobi has its own structure and is located on a defined path in the file system independently of the servlet container being used. This section explains how to organise the...
  68. Directory structure of the application
    The Goobi installation path may vary depending on your installation. Typically, the base path for web applications on an Ubuntu Linux system within an Apache Tomcat servlet container is shown below: b...
  69. Integrating external storage
    General Most digitisation projects involve handling very large volumes of data. In most cases, this makes it necessary to link external storage capacity to the server. This can be done in a number of ...
  70. Integration of S3 as storage
    Goobi workflow allows operation with S3-compatible storage. It should be noted that a local file system is still required to store the metadata. This means that the files meta.xml, metaanchor.xml and ...
  71. File system
    As a workflow management application for the library environment, Goobi has to be able to deal with a wide range of specific configurations and project-specific requirements. To this end, it has been ...
  72. MySQL database
    General Goobi saves information using a database. As a rule, the preferred option is MySQL. Ideally, the latest stable version of this database engine is installed from the operating system’s standard...
  73. Apache Tomcat servlet container
    General Goobi is a web-based Java application. The Java code needs to be translated to ensure that Goobi can be called from your web browser. This job is done by a servlet container. Some examples are...
  74. User authentication using LDAP
    General Goobi usually uses an LDAP server to authenticate users. This makes it possible to connect to the provided network drive with the same user name and password as in Goobi. In the configuration ...
  75. File system access using Samba
    General Goobi uses Samba to provide users with directory authorisations to read and write image data. The latest stable version of Samba should be installed from the operating system’s standard reposi...
  76. Services
    To let Goobi run several services are required as dependency. These services get explained on the following pages....
  77. Technical data
    The following screenshot shows the Technical data tab from Goobi’s project settings: The configuration settings are explained below: List of project configuration parameters used to generate METS file...
  78. Mets parameters
    The following screenshot shows the Mets parameters tab from Goobi’s project settings: The configuration settings are explained below: List of METS parameters for use when configuring the project | Nam...
  79. Mets file groups
    In addition to the configuration parameters listed above, the METS file groups can also be specified. The screenshot shows five defined file groups: Min Max Thumbs Default Presentation The file groups...
  80. Export configuration in the Goobi configuration file
    A further export setting can be configured in goobiconfig.properties. The corresponding parameter is shown below: ini=goobiconfig.properties exportWithoutTimeLimit=true|false If this value is set to t...
  81. Exporting to digital libraries
    Goobi allows users to export processes (together with all their digitised objects) to digital libraries. As a rule, the XML file (METS) is exported last. It is generally preceded by any images, OCR re...
  82. Working with the intranda Task Manager
    Goobi communicates with the intranda Task Manager via the TaskClient. In Goobi, this command line program is configured as part of a workflow step. It can accept and process a number of parameters. Th...
  83. Example combination for an automatic script task
    In most cases, an automatic task is combined with a script task. Goobi then responds to the script output. Goobi will treat any messages issued on the default output console as simple status reports a...
  84. Migration of technical data to METS files
    Goobi automatically exports METS files to a pre-defined folder. This is usually the directory shown below: bash /opt/digiverso/viewer/hotfolder/ A sub-folder is created in this directory for each proc...
  85. Automatic image deletion
    Since version 1.9.2, Goobi has allowed users to fully automate workflow tasks using plug-ins, e.g. to delete images that are no longer required. This ImageDeletion plug-in should be the last step in t...
  86. Automatic workflow steps
    Goobi allows you to mark individual tasks as automatic. These tasks are opened and performed automatically once the preceding workflow task has been completed. Whenever an error occurs in such an auto...
  87. goobi_activemq.xml
    The goobiactivemq.xml configuration file specifies the settings for the org.apache.activemq Java library used by Goobi Workflow. Goobi Workflow does not use the file itself, but passes it directly to ...
  88. goobi_config.properties
    In the configuration file goobiconfig.properties, some fundamental settings are done for Goobi Workflow. The file is usually located at the following file system path: bash /opt/digiverso/goobi/config...
  89. goobi_digitalCollections.xml
    The configuration file goobidigitalCollections.xml is responsible for controlling the selection list of digital collections. It is usually located at the following path in the file system: bash /opt/d...
  90. goobi_exportXml.xml
    The goobiexportXml.xml file specifies technical details about the properties and associated XML namespaces used when generating docket files. The file is usually located at the following location: bas...
  91. goobi_mail.xml
    The configuration file goobimail.xml is used to configure mail dispatch for Goobi. The file is usually located here: bash /opt/digiverso/goobi/config/goobimail.xml For example, this configuration file...
  92. goobi_metadataDisplayRules.xml
    The goobimetadataDisplayRules.xml configuration file specifies how the metadata is to be displayed within Goobi's metadata editor. It is usually located at the following path in the file system. bash ...
  93. goobi_normdata.xml
    In the configuration file goobinormdata.xml links to databases are specified, which can be used for universal purposes. A main application is to obtain metadata to digitized objects. The file is usual...
  94. goobi_opac.xml
    The configuration file goobiopac.xml defines the communication between Goobi workflow and external data sources. This usually applies to systems such as library catalogs. The file is usually located a...
  95. goobi_opacUmlaut.txt
    In the configuration file goobiopacUmlaut.txt umlauts are specified which should be replaced when automatically generating process titles. The file is usually located at the following location: bash /...
  96. goobi_processProperties.xml
    In the configuration file goobiprocessProperties.xml further properties for projects, processes and steps can be specified. The file is usually located at the following memory path: bash /opt/digivers...
  97. goobi_projects.xml
    The file goobiprojects.xml configures the mask for creating processes. Here it is defined per project which metadata and properties are allowed for certain publication types. The file is usually locat...
  98. goobi_rest.xml
    In the goobirest.xml configuration file, the REST API endpoints used by Goobi Workflow are shared based on the respective path (as part of the URL). For each endpoint, the allowed HTTP methods and var...
  99. goobi_webapi.xml
    The goobiwebapi.xml configuration file is used to enable certain API endpoints of the Goobi Workflow Server for other servers or clients. The file is usually located at the following location: bash /o...
  100. messages_xx.properties
    In the translation files messagesxx.properties translations for texts in the user interface are specified. The xx mentioned here must be replaced by the corresponding language abbreviation depending o...
  101. config_contentServer.xml
    In the file configcontentServer.xml, technical details about the content server used in Goobi are provided. The configuration file can be used for Goobi Workflow and Goobi Viewer in the same way. The ...
  102. goobi_configeditor.xml
    The file goobiconfigeditor.xml defines which directories the integrated configuration editor of Goobi workflow is allowed to display and edit. In addition, backup settings for the edited configuration...
  103. goobi_ruleseteditor.xml
    The file goobiruleseteditor.xml configures the integrated ruleset editor of Goobi workflow. It defines where backup files of edited rulesets are stored and how many backups per ruleset file should be ...
  104. Configuration files
    At various points, Goobi workflow is controlled via several configuration files. These are usually located in the directory /opt/digiverso/goobi/config/. At this point, the most important configuratio...
  105. Installation guide - Ubuntu 20.04
    Introduction The following installation guide for Goobi workflow refers to Ubuntu Linux 20.04. It is written as a step-by-step guide from top to bottom, meaning that settings and configurations build ...
  106. Installation guide - Ubuntu 24.04
    Introduction The following installation guide for Goobi workflow refers to Ubuntu Linux 24.04. It is written as a step-by-step guide from top to bottom, meaning that settings and configurations build ...
  107. Installation guide
    Installation instructions for Goobi workflow are provided here. The following installation instructions are already available: [Ubuntu 20.04 (deprecated)](/en/workflow/manual/admin/installationguide/u...
  108. Preparation of an update
    General information When you update Goobi workflow, all plug-ins should also be updated. You should also check the page Installed plug-ins in Goobi workflow. If this page does not yet exist, the relev...
  109. 2020
    2020-09-17 In the ImageQA plugin, the configuration of the rotation and deletion commands has changed. These have to be adapted. This is the old configuration: xml /opt/digiverso/goobi/scripts/deleteI...
  110. 2021
    2021-12-16 The statistics plugin now exports XLSX instead of XLS, therefore the template file was changed. /opt/digiverso/goobi/plugins/statistics/statisticstemplate.xls needs to be replaced with http...
  111. 2022
    22.12 Config file change for the plugin Generic XML Import This point can be ignored if the plugin is not in use and thus the output of this command is empty: bash xmlstarlet sel -t -c '//catalogue/co...
  112. 2023
    23.10 Änderung der Konfigurationsdatei des Plugins goobipluginworkflowfileuploadprocesscreation The naming scheme has changed with the update. In the config file pluginintrandaworkflowfileUploadProces...
  113. 2024
    24.11 Artist Dictionary If the following plugins are used, manual steps must be carried out after the update: bash plugin-dashboard-entity plugin-export-luxembourg-artist-dictionary plugin-workflow-en...
  114. 2025
    25.08 Config update for the plugin goobi-plugin-step-mixed-ocr The callback URL for the Mixed OCR plugin changes from goobi/plugins to goobi/api/plugins. Example for the adjustment in pluginintrandast...
  115. 2026
    26.02 Archive Management: Icon migration Font Awesome → Tabler The icon attributes in elements of the Archive Management plugin configuration must be updated from Font Awesome class names to Tabler ic...
  116. Update steps
    The individual update steps that must be carried out to update a Goobi workflow installation to the required version are explained below. Please note that before carrying out the work documented here,...
  117. Update guide
    This section contains detailed documentation on how to carry out updates to Goobi workflow. An update should always be carried out in such a way that a backup of the important data is made beforehand....
  118. Authentication via the database
    With database authentication, users are managed entirely by Goobi workflow itself. The user name and password are stored in the Goobi database. Within the database, only a hash (sha256 & salt) of the ...
  119. Authentication via HTTP header
    HTTP header authentication reads an HTTP header in the request and checks if there is a user whose SSO-ID matches the content of the header. If there is a user, he will be logged in. As HTTP headers c...
  120. Authentication via OpenID Connect
    OpenID Connect 1.0 is an authentication layer based on the OAuth 2.0 protocol. It enables clients to obtain the end user's identity from an authentication provider in a REST-like manner. Goobi workflo...
  121. Authentication
    Some of the typical authentication options offered by Goobi workflow are documented below. In addition to authentication using the user passwords stored in the database, you can also use LDAP, Active ...
  122. 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...
  123. Handling of 3D Objects
    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: bash=.obj .ply .stl .fbx .gltf .g...
  124. 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 ins...
  125. Administration
    ...
  126. Preparatory work
    Installing the database server and other requirements Goobi workflow uses the database MariaDB to manage data. This must be installed on the system accordingly. Installation on Linux Installation on U...
  127. Download source code and demo data
    Initial setup A script has been created to check out the source code and download it, which performs the following tasks: - Create a database if one does not already exist - Download the demo data - C...
  128. Setting up the development environment
    The setup of a development environment is described here for Eclipse and Visual Studio Code: Eclipse Installation - Eclipse can be downloaded from [here](https://www.eclipse.org/downloads/packages/rel...
  129. Best practice for developing Goobi and working with Eclipse
    1.4.1 Useful software packages In order to work with the repositories and source code in a meaningful way, additional packages should be installed. These have proven to be useful: Linux bash sudo apt ...
  130. Development environment
    For the development of Goobi workflow, we usually work with the Eclipse development environment or with Visual Studio Code. The following pages explain how to set up a development environment and impo...
  131. Using the REST API
    Goobi workflow has a very comprehensive REST API that can be used to connect external applications and services to Goobi workflow. Configuring the REST API This configuration of the REST API is alread...
  132. Development
    ...
  133. Manual
    About this manual Welcome to the Goobi Manual. This is the official documentation produced by intranda GmbH as the core developer of the open-source workflow management application known as Goobi. The...
  134. Documentation areas
    The documentation for the Goobi viewer was created by intranda GmbH. It is divided into four different sections, each with a different focus on the same software. Configuration In the Configuration se...
  135. About the Goobi viewer
    The Goobi viewer is the central basis for your digital library. It handles the entire visualisation of your digital content. In order to provide you with a clear overview and a smooth use of the Goobi...
  136. Overview
    ...
  137. Local settings
    Note The semicolon is a reserved delimiter character in the configuration file and must be explicitly masked with a backslash if necessary! The following files can be created in the [local configurati...
  138. Translations
    The majority of text elements in the Goobi viewer are available in multilingual messages.properties files. These individual text elements can be overwritten via local messages.properties files (one fi...
  139. Folder configuration
    The Goobi viewer contains various folder configurations, which are explained in more detail below xml=configviewer.xml /opt/digiverso/viewer/config/ ‌/opt/digiverso/viewer/ ‌/opt/digiverso/viewer/data...
  140. URL configuration
    The Goobi viewer offers the possibility of linking to external systems in several places. The parameters that are responsible for these links are explained here. xml=configviewer.xml https://viewer.ex...
  141. Authentication Provider
    Various providers are available for registration. These are configured in a list under : xml=configviewer.xml my first group my secondgroup The attributes in Elements have the following meaning: | Att...
  142. Sending e-mails
    For the registration of a local user account, as well as for other mail dispatch, a mail server must be configured. The configuration for this is as follows: xml=config_viewer.xml localhost do-not-rep...
  143. Further settings
    Regardless of the selected authentication type, the registration of new accounts or the reset password can be deactivated. The following switch is used for this purpose: xml=configviewer.xml A securit...
  144. User accounts
    The Goobi viewer has a user area that is only accessible after prior authentication. How to configure access to this area is described in the sub-chapters....
  145. Performance
    The following setting allows you to specify the size (number of pages) of a record from which an alternative page loading mechanism is used to avoid memory overflows for very large records. The defaul...
  146. Access conditions and images
    If necessary, the display of images of some records can be blocked by means of an access licence. However, it may be desired to display small thumbnails of the images anyway. For this purpose, a maxim...
  147. Captcha
    To restrict the sending of automatic e-mails from bots via the feedback form, or when generating PDF documents externally, a Captcha query can be used. The reCaptcha service is integrated into the Goo...
  148. Variants
    Overview There are two versions of the PDF download: 1. Real-time generation, which directly triggers a download of the requested PDF during which the PDF itself is generated. 2. The external generati...
  149. Download Links
    PDF download links can be displayed in several places. These can be configured individually. xml=configviewer.xml false true true true false The parameters are explained individually in the following ...
  150. Individual PDF title page
    PDF documents created in the Goobi viewer can have additional upstream pages containing optional metadata on the complete record and on individual structure elements. The metadata is read exclusively ...
  151. PDF download
    PDF files can be generated for the entire work as well as for individual structural elements or images. The options are available in the widget "Cite and repurpose" or partially in the table of conten...
  152. ePub download
    Records for which OCR results are available in ABBYYXML or ALTO format can be downloaded as ePub. The prerequisite for this is the use of external PDF generation. The download links are provided analo...
  153. Extended scrolling in the image view
    In the image display, it is possible to adjust the navigation above the image. In addition to the usual scroll functions in the image display, additional buttons can be added by configuration to scrol...
  154. Navigation between structure types
    Via , structure types can be defined between which it is possible to navigate quickly in full screen mode (such as "next chapter or next figure"). For this, the attribute enabled="true" must be set. T...
  155. Image view configuration
    For the image display OpenSeadragon based on the IIIF Image API is used. A separate configuration block exists for the display, in the section. The configuration block has the following form: xml=conf...
  156. Maintaining zoom and rotation while browsing in the image view
    Optionally, the last used zoom level and rotation of the image display can be retained when scrolling within a record. This then applies to all types of zoomed image display within a record and a user...
  157. External images
    External images are normally passed directly to the client in the image display. Sometimes, however, it makes sense to retrieve them from the intranda ContentServer and have them delivered by the Goob...
  158. Restriction of image scaling
    The intranda ContentServer, i.e. the component that loads the requested image data and delivers it to the Goobi viewer, has the ability to scale any image as desired. This is quite positive in theory....
  159. Thumbnail settings
    The Goobi viewer offers the option of displaying all pages of a record in a preview view in the form of thumbnails. The following option specifies the maximum number of thumbnails that can be displaye...
  160. Image Footer
    An optional footer can be displayed below the image. The text it contains is configured as follows: xml=configviewer.xml SOLR:MDCOPYRIGHT urn purl The enabled attribute must be set to true for this fu...
  161. Image options
    This section explains the options available for restricting or manipulating the image display in the Goobi viewer. With the element, it is possible to add an additional CSS class to the #viewObject el...
  162. Individual page types
    In the URL schema of the Goobi viewer's links, there are fixed names for different page types. For example, the image display is always under /image/ and the search under /search/. To assign your own ...
  163. Opening certain document types in alternative page views
    It is possible to open certain document types in alternative page views. If, for example, newspapers and newspaper volumes should always be opened in the calendar view (instead of the image view), thi...
  164. Full text hints
    If a record contains only a few selected full-text pages, the search for them can be very difficult. This may be the case, for example, if only individual pages of a manuscript have been transcribed s...
  165. Language settings
    Formats for dates in different languages can be entered in the / area. If this area is missing, the standard formats specified in the code example are used. For each language for which a different for...
  166. Themes
    General If your Goobi viewer has been installed with its own theme, the corresponding name is contained in the following configuration element: xml=configviewer.xml The mainTheme attribute contains th...
  167. Sorting
    The sorting of the search hit list can be configured as follows: xml=configviewer.xml RANDOM RELEVANCE SORTCREATOR SORTTITLE SORTYEARPUBLISH\\;SORTTITLE !BOOLPRIORITIZE With the Attribute enabled the ...
  168. Faceting
    The search hits are automatically faceted. The configuration is as follows: xml=configviewer.xml YEAR WKTCOORDS DC DOCSTRCTTOP DOCSTRCTSUB MDCREATOR MDPLACEPUBLISH MDLOCATION MDOTHERVALUE MDTITLE MDLA...
  169. Advanced search
    There is an advanced search, where you can search specifically in individual metadata fields. In the first line, the search areas from the section are offered, see also chapter [1.17](./). Different t...
  170. Timeline
    The Goobi viewer offers an entry point to the content with the timeline. It can be configured in the following section: xml=config_viewer.xml 1500 2013 36 The attribute enabled switches the timeline o...
  171. Calendar
    A calendar is available for search entry. It lists all records that contain the field YEARMONTHDAY in the Solr search index. The calendar entry is activated with the following setting: xml=config_view...
  172. Save search
    Logged in users have the possibility to save search queries and retrieve them later. This functionality can be switched off with the following switch. The default value is true. xml=config_viewer.xml...
  173. Expand query for search sub-results
    With this switch, an expand query can be built for search sub-results from current faceting, even if no concrete search terms have been entered. For example, sub-elements of a record can also be liste...
  174. Aggregated search hit display
    The Goobi viewer lists records in the search hit list with associated subhits. The display of the sub hits can be further controlled. With the attribute enabled the sub hits can be switched on and off...
  175. Versioning of records
    If several versions of certain record exist, you can display a version history for the user in the sidebar. To do this, the records must each contain the identifier of the predecessor or successor ver...
  176. Exporting search results
    Search results can be exported to an Excel file or in RIS format. The Excel export functions can be turned on and off with the enabled attribute. The fields that are transferred to the generated Excel...
  177. Search hit metadata
    xml true 1 40 For the metadata of the search results, there are the following configuration elements: | Setting | Description | | --------------------- | ----------------------------------------------...
  178. Search
    The search in the Goobi viewer allows a combined search both in the metadata and in the full texts. Depending on the selection, a search can also be restricted to the metadata or the full texts of the...
  179. Collection hierarchy
    A digital collection can contain several hierarchy levels of subcollections. Each record can belong to any number of collections. It is also possible for a record not to belong to any collection. If a...
  180. Sorting of records
    If a collection has been opened, the records contained in it are listed in the standard sort (by relevance) for search hits. This sorting can be overridden individually for each collection, if require...
  181. Sorting of collections
    By default, your collections are sorted alphabetically by their names in the collection overview (that is, not by the names in messages.properties). However, it is possible to define your own sequence...
  182. Blacklist
    It sometimes happens that certain digital collections are already present in the Solr search index but should not yet be displayed. In this case, you can use the collection blacklist: xml=configviewer...
  183. Collection size
    The size of a collection is the number of records it contains. In the collection overview, this number is displayed in parentheses after the name of the individual hierarchy level of the collection. T...
  184. Further settings
    The following is a list of additional collection settings. xml=configviewer.xml -1 images/collections/collectiontiled_default.jpg true true | Setting | Description | | --------------------------------...
  185. Structure element whitelist
    By default, independent records and complete records (anchor) are delivered for search queries without specific search terms (such as collection listing, RSS generation, etc.). This is configured by t...
  186. Digital collections
    This section explains how to configure the collection listing....
  187. Main metadata
    The main metadata are displayed on the "Bibliographic data" page. They can be configured as follows: xml=configviewer.xml 2019 MESSAGELICENCEINFORMATION Any number of elements can be defined. Each ele...
  188. Sidebar metadata
    The metadata in the sidebar must be distinguished between two display locations: 1. the display in full screen mode 2. the display within the record view When displayed in full screen mode, the metada...
  189. Search hit metadata
    The metadata for the search hits is configured in the same way as the main metadata. In addition, the optional separator attribute can be used to control whether multiple values should be displayed se...
  190. Archive metadata
    Metadata in the archive view is configured in the same way as the main metadata. The is available for this purpose: xml=configviewer.xml The sections marked with the type attribute have the following ...
  191. Image metadata
    Technical metadata can be indexed for images, for example from a corresponding MIX block within the METS file. This is always displayed for the current image in a separate ‘Technical metadata’ widget ...
  192. Display of authority data
    The configuration of authority data in the authority data popup can be configured in the following section: xml=configviewer.xml NORMIDENTIFIER NORMNAME NORMIDENTIFIER NORMNAME NORM_ALTNAME The templa...
  193. Browsing
    The Browse function makes it possible to get a list of the entire dataset over a certain metadata, for example the title or name of the author. If you click on a link, all values in the database will ...
  194. Multilingual metadata
    The Goobi viewer supports multilingual metadata. This is indicated by the suffix LANGXX in the index field, where XX must be replaced by the language abbreviation. Here is an example of a trilingual t...
  195. Licenses
    When new records are created in the backend, a list of licenses is available. This list can be configured in the following place: xml=config_viewer.xml Each license has a label and a URL. The label is...
  196. Metadata
    In this section, you will learn how to deal with metadata in detail....
  197. Main table of contents
    The table of contents is configured in the section: xml=configviewer.xml CURRENTNOSORT CURRENTNOSORT list false true 10 GROUPIDSERIES GROUPIDCONVOLUTE PIPARENT false 20 | Setting | Description | | ---...
  198. Sidebar table of contents
    The sidebar table of contents is configured as the toc widget under : xml=config_viewer.xml true false 60 true 2 0 | Setting | Description | | --------------------------- | ---------------------------...
  199. Download tables of content as PDF file
    See chapter [1.9](../9/)...
  200. Tables of contents
    The Goobi viewer provides two views for displaying the logical document structure: the content view and the sidebar content view. The content view is a separate page, the sidebar content view is displ...
  201. Tag clouds
    Large amounts of data in the index can significantly reduce the speed of tag cloud generation. In such cases, it is possible to reduce the sample size for individual tag cloud fields. For this purpose...
  202. Resolver
    Records The Goobi viewer offers resolvers to open records via an identifier (PI), an URN or a custom identifier. | Name | URL | | -------------- | -----------------------------------------------------...
  203. Sidebar
    The sidebar in the Goobi viewer is divided into two configuration areas: controls which widgets appear in which view. contains the detailed configuration of each individual widget. xml=configviewer.xm...
  204. Navigation and display
    The following elements switch different elements or functions of the Goobi viewer on or off: xml=config_viewer.xml true true true true true true 50 false true true true false false false false true | ...
  205. RSS feed
    The Goobi viewer offers the option of making the latest imports available in an RSS feed. In addition, an overview of the last five new entries can be displayed in the sidebar. The following section i...
  206. Reading lists
    The Goobi viewer has the functionality of the reading lists. Non-registered users can save records on a list within their session and send them by e-mail if required. Authenticated users can maintain ...
  207. User comments
    The comment functionality is completely configured via the backend....
  208. CMS
    The CMS module of the Goobi viewer is configured in the element block . xml=config_viewer.xml 400 The parameters are explained in detail in the following table: | Setting | Description | | -----------...
  209. Transkribus
    The Goobi viewer is able to transfer records from METS documents to Transkribus for the purpose of handwriting recognition. Any user with a Transkribus account can log into the Goobi viewer and add th...
  210. Original content
    Your Goobi viewer offers you the option of making files on a record available as direct downloads. These can be, for example, original versions of Born-Digital documents. To do this, the folder for or...
  211. Piwik/Matomo
    With the help of Piwik/Matomo statistics about the visitors can be collected. This functionality is configured in the following section: xml=config_viewer.xml example.org/piwik/ 1 The parameters are e...
  212. Sitelinks
    For search engines, for example, an overview of the records exported after years is generated. The configuration is done in the element xml=config_viewer.xml YEAR ISWORK:true The sitelinks are availab...
  213. JSON
    Attention The API described here is outdated. We recommend switching to the REST API. General The Goobi viewer has the option of providing metadata and images for selected records in a JSON document v...
  214. IIIF
    The Goobi viewer implements the IIIF Presentation API in version 2.1.1. This is configured in the following block: xml=configviewer.xml MDTITLE MDCREATOR MDPURL Production/MDEVENTACTOR Use/MDEVENTACTO...
  215. Authentication
    Some REST commands require authentication via a token. The token is defined in the configuration file in the following section: xml=configviewer.xml 6326390c-b19f-11e8-a99c-08606e6a464a For authentica...
  216. CORS
    Whether CORS headers should be written can be defined in the following section: xml=config_viewer.xml * Attention This value is false by default because the CORS headers are usually written in the ups...
  217. API
    Two WebAPIs are available within the Goobi viewer. One delivers configurable fields as JSON, the other implements the IIIF Presentation API....
  218. OpenSearch
    The OpenSearch standard is supported for a direct search in the Goobi viewer database. A name and description must be defined in the viewer section: xml=config_viewer.xml Goobi viewer Open source soft...
  219. Embedding
    The Goobi viewer automatically generates tags for [oEmbed](https://oembed.com/), [OpenGraph](http://ogp.me/) and [Twitter Cards](https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overvi...
  220. Maps
    The following block exists in the configuration file for maps used in the Goobi viewer xml=configviewer.xml mapsmarker1 maps_marker7 markercircle MDGEOJSONPOINT NORMCOORDSGEOJSON 5 11.073397 49.451993...
  221. Translations
    For the configuration of the translation groups offered in the backend, the following block exists in the configuration file: xml=configviewer.xml DC ACCESSCONDITION BOOLIMAGEAVAILABLE FULLTEXTAVAILAB...
  222. Archive
    A separate area in the configuration file is available for configuring the display of archival material. The metadata is configured in the archive metadata list. See chapter [Archive metadata](/en/vie...
  223. Campaigns
    Within the campaigns, various options can be configured globally: xml=config_viewer.xml fixed 7 5 11.073397, 49.451993 mapbox The parameters are explained in detail in the following table: | Setting |...
  224. Add content
    For the configuration of the content contributing functionality, the following section exists in the configuration file: Note In addition to this configuration, it is also necessary to store a URL to ...
  225. Usage figures
    The Goobi viewer can automatically collect usage figures for individual data sets. The following can be collected: the absolute number of page views (each time a page of a work is called up) unique pa...
  226. Config Editor
    The Goobi viewer can provide access to your own configuration files via the backend. .xml and .properties files can be displayed. The following section within configviewer.xml can be used to configure...
  227. Proxy
    For outgoing connections, the Goobi viewer Core can optionally use a proxy server. xml=config_viewer.xml http://proxy.example.org 8080 127.0.0.1 The parameters are explained in the following table: | ...
  228. ActiveMQ
    There is a queue in the Goobi viewer for background tasks. ActiveMQ is used for this. The queue can be switched on and off with the following configuration. It is also possible to define the number of...
  229. Developer
    A separate page is available for developers in the backend under the URL /admin/developer/. A ZIP file with configuration settings for commissioning in a local development environment can be downloade...
  230. External Ressources
    The Goobi viewer can retrieve external content from Born Digital documents and process it live. This makes it possible to export only the metadata for Born Digital documents to the Goobi viewer and to...
  231. Goobi viewer Core
    In this section you will learn some basic details of the general configuration, how to set the corporate design, how to overwrite default configuration files and some more....
  232. Main configuration
    The main configuration looks as follows by default: xml=configindexer.xml 1000 2048 http://localhost:8983/solr/collection1 http://localhost:808/viewer/ CHANGEME true false true 1 true true NORMIDENTIF...
  233. Directories
    For operation, a number of folders must be configured for the Goobi viewer Indexer from which files can be read or in which files can be stored. If certain folders do not exist, they are created autom...
  234. Proxy
    For outgoing connections, the Goobi viewer Indexer can optionally use a proxy server. xml=config_viewer.xml 127.0.0.1 The parameters are explained in the following table: | Option | Description | | --...
  235. Performance
    The performance can be influenced by some parameters: xml=config_indexer.xml 10485760 157286400 1000 false 4 true true 24 1000 true The parameters are explained in detail in the following table: | Set...
  236. Structure types
    Structure types can be automatically replaced by others in the index, if desired. To do this, these structure elements are entered in the following configuration list: xml=configindexer.xml false Othe...
  237. Metadata
    Each metadata field to be used in the Goobi viewer must be configured in the Goobi viewer Indexer in the fields configuration element. The following schema is used for this: xml=configindexer.xml mets...
  238. Starting and Exiting
    A shell script has been set up on your machine for the Goobi viewer Indexer. Only this script should be used for starting and stopping. Starting the Indexer Use the following command to start the Goob...
  239. Indexing records
    In order to index a record, the desired XML file (for example in METS/MODS, LIDO or TEI format) must be saved in the [hotfolder](/en/viewer/manual/configuration/indexer/folders). A separate XML file i...
  240. Updating individual page documents
    In order to avoid unnecessary loads on the Solr index in connection with updates from crowdsourcing, which can also affect the performance of the Goobi viewer, it is possible to overwrite individual f...
  241. Deleting records
    To delete a record, a file with the name pattern .delete must be placed in the hotfolder \(for example PPN123456789.delete\). As soon as the file has been captured by the Goobi viewer indexer, the cor...
  242. Solr scheme
    General The Solr schema used by the Goobi viewer Indexer and Goobi viewer Core is located in the Git repository of the Goobi viewer Indexer: [Link to schema.xml from the Goobi viewers](https://github....
  243. Further settings
    If more than one Goobi viewer Indexer process is installed on a server, both processes log to the same file. However, the file name can be adjusted via the environment variable LOGFILENAME. This is pr...
  244. Goobi viewer Indexer
    The Goobi viewer relies on Apache Solr to search metadata and full texts. To make new records known to the Goobi viewer, they must first be indexed. This task is performed by the Goobi viewer Indexer....
  245. Main Configuration
    The main configuration is done in the following sections Section: identifyTags xml=configoai.xml OAI Frontend http://localhost:8080/viewer/oai/ support@intranda.com transient YYYY-MM-DDThh:mm:ssZ OAI-...
  246. Dublin Core
    xml=configoai.xml true 100 DC DOCSTRCT info:eu-repo/semantics/openAccess Depending on the structure type displayed, different configurations can be used here, analogous to the viewer metadata. The con...
  247. Europeana
    xml=configoai.xml true 100 MDACCESSCONDITIONCOPYRIGHT MDACCESSCONDITIONCOPYRIGHT Instutution XYZ https://www.example.org/rights https://www.example.org/rights DC DOCSTRCT The individual parameters at ...
  248. METS
    xml=config_oai.xml true 10 DC DOCSTRCT Note Only records that were available in METS/MODS format during indexing can be delivered as METS. | Setting | Description | | ---------------- | --------------...
  249. LIDO
    xml=config_oai.xml true 10 DC DOCSTRCT Note Only records that were available in LIDO format during indexing can be delivered as LIDO. | Setting | Description | | ---------------- | -------------------...
  250. MARCXML
    xml=config_oai.xml true 10 /opt/digiverso/viewer/oai/MODS2MARC21slim.xsl DC DOCSTRCT Note Only records that were available in METS/MODS format during indexing can be delivered as MARCXML. | Setting | ...
  251. Xepicur
    xml=config_oai.xml true 100 Article urn:nbn:de:restricted:123- DC DOCSTRCT The parameters are explained in detail in the following table: | Setting | Description | | ----------------- | --------------...
  252. Goobi viewer overview pages
    xml=configoai.xml true 100 The parameters are explained in detail in the following table: | Setting | Description | | ---------------- | ---------------------------------------------------------------...
  253. Goobi viewer crowdsourcing
    xml=configoai.xml true 100 The parameters are explained in detail in the following table: | Setting | Description | | ---------------- | ---------------------------------------------------------------...
  254. TEI
    xml=config_oai.xml true 10 LANGUAGE The parameters are explained in detail in the following table: | Setting | Description | | ----------------------------- | -----------------------------------------...
  255. CMDI
    xml=config_oai.xml true 10 LANGUAGE The parameters are explained in detail in the following table: | Setting | Description | | ----------------------------- | -----------------------------------------...
  256. Sets
    It is possible to define your own sets using a Solr query. xml=config_oai.xml DC A set always consists of setName, setSpec and setQuery. setName is a label for the set. This value is also displayed in...
  257. OAI interface
    ...
  258. SRU interface
    The Goobi viewer has an SRU interface. This can be found at the following URL \(change base URL accordingly\): text https://viewer.example.org/viewer/sru Configuration of the interface is not possible...
  259. Goobi viewer Connector
    The Goobi viewer has an OAI and an SRU interface. Their configuration is described in the following sub-chapters....
  260. Configuration
    ...
  261. Series and convolutes
    General The Goobi viewer can depict groups of several independent records of art - regardless of the overall record and collection to which they belong - and present them as a logical, navigable unit....
  262. Access restrictions
    General The Goobi viewer can interpret access restrictions. For this, they must exist as metadata. The following application scenario describes how to capture and configure an access licence using a m...
  263. Subthemes
    This section shows you how to use subthemes in the Goobi viewer. Goobi workflow A new metadata ViewerSubTheme must be added to the ruleset. This is then also added to DocStructs that have the CatalogI...
  264. Authority data
    Goobi workflow In the rule set, the attribute normdata="true" must be activated for the desired metadata so that the norm data can be entered in the metadata editor: xml=ruleset.xml Author Autor Autho...
  265. Multilingualism
    The Goobi viewer Core is available in German, English, Spanish, French and Arabic. If available, the interface is automatically displayed in the language that the browser has defined as the default la...
  266. Maps
    General The Goobi viewer supports the display of coordinates on a map. There are different possibilities for the acquisition, the indexing and the display. These are listed on this page. Acquisition a...
  267. Sub collections
    General The Goobi viewer can display digital collections with a hierarchy. The functionality is described in chapter [Collection hierarchy](/de/viewer/manual/configuration/core/collections/subcollecti...
  268. Multiple Goobi viewer
    General If two or more Goobi viewer instances are to be supplied from one Goobi workflow, various requirements must be met. This section describes how to configure common questions for Goobi workflow ...
  269. Crowdsourcing module
    The configuration file configviewer-module-crowdsourcing.xml is located in the local configuration folder next to the other configuration files. The path to it is defined in configviewer.xml and must ...
  270. Archival documents
    General The Goobi viewer can display an archive record in a tree view. If a record is linked to an archive, a widget is also displayed in the record view that shows the record in the archives hierarch...
  271. Solr Queries
    General Again and again the backend of the Goobi viewer refers to the necessity of formulating solr queries when it comes to providing a functionality only for certain records. This page will answer s...
  272. Linking from METS file groups
    General The Goobi viewer is often used in combination with Goobi workflow. In the Goobi workflow project configuration, various so-called METS file groups can be configured. The file groups then conta...
  273. Add content
    If active, users can contribute their own content. The Goobi viewer provides an upload form that can be used to create a process within Goobi workflow. The status of the process is checked regularly a...
  274. Shibboleth
    General The implementation of authentication is basically similar in Goobi viewer and Goobi workflow. Nevertheless, there are the following differences: In Goobi workflow the entire application is sec...
  275. Access restricted metadata
    General From version 24.12, the Goobi viewer also supports access-restricted metadata within a METS/MODS file. To configure this from start to finish, it is documented here as a use case. Goobi workfl...
  276. 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 the entire Goobi viewe...
  277. FAQ
    How old is my Goobi viewer? In the source code of the page there are various meta tags at the very beginning, which provide information about the age and code base of the version used: xml "Goobi view...
  278. Glossary
    A Adminbackend The admin backend describes an interface through which parts of the content and functionality of the Goobi viewer can be controlled web-based. The interface is only available to user ac...
  279. Miscellaneous
    ...
  280. 2025
    This page is currently only available in the German documentation....
  281. 2024
    This page is currently only available in the German documentation....
  282. 2023
    This page is currently only available in the German documentation....
  283. 2022
    This page is currently only available in the German documentation....
  284. 2021
    This page is currently only available in the German documentation....
  285. 2020
    This page is currently only available in the German documentation....
  286. 2019
    This page is currently only available in the German documentation....
  287. 2018
    This page is currently only available in the German documentation....
  288. Core Changelog
    This page is currently only available in the German documentation....
  289. 2025
    General The files affected by changes are usually visualized as a task list and begin with the theme name. In this guide, boilerplate/ is used as an example and must be adjusted to match the correspon...
  290. 2024
    General The files referenced in changes are usually displayed as a task list and begin with the theme name. In this guide, boilerplate/ was chosen and must be adapted to the corresponding theme. 24.12...
  291. 2023
    General The files to which changes relate are usually visualized as a task list and begin with the theme name. In this guide boilerplate/ was chosen and must be adapted to the corresponding theme. 23....
  292. 2022
    General The files referenced by changes are usually visualized as a task list and begin with the theme name. In this guide, boilerplate/ was chosen and must be adapted to the corresponding theme. 22.1...
  293. 2021
    General The files to which changes relate are typically visualized as a task list and begin with the theme name. In this guide boilerplate/ has been chosen and must be adapted to the corresponding the...
  294. 2020
    4.13.1 In the customJS.xhtml the following line must be replaced. [ ] boilerplate/includes/customJS.xhtml Old: javascript var mapBoxToken = "#{configurationBean.mapBoxToken}"; New: javascript viewerJS...
  295. 2019
    2019-12-02 The following components have been removed from the core: resources/components/widgets/widgetbookshelves.xhtml resources/components/widgets/widgetbookshelfList.xhtml resources/components/wi...
  296. 2018
    2018-12-21 Refactoring LESS template. /boilerplate/css/less/viewer/widgets/widgetToc.less 2018-12-17 Changes to LESS template. /boilerplate/css/less/viewer/components/buttons.less 2018-12-07 Changes t...
  297. Theme Changelog
    The following subpages list - in chronological order and organised by release - the points that need to be checked, adapted and implemented when updating Goobi viewer from a web designer's perspective...
  298. Classical
    Introduction The following installation guide for the Goobi viewer refers to Ubuntu Linux 24.04. It is written as a step-by-step guide from top to bottom, meaning that settings and configurations buil...
  299. Docker
    Introduction The following installation guide for the Goobi viewer refers to Ubuntu Linux 20.04. It is written as a step-by-step guide from top to bottom, meaning that settings and configurations buil...
  300. Installation guide
    ...
  301. Preparatory work
    Installing the database server Goobi viewer uses the database MariaDB to manage data. This must be installed on the system accordingly. Installation on Linux Installation on Ubuntu Linux is carried ou...
  302. Download source code and demo data
    Initial setup A script has been created to check out the source code and download it, which performs the following tasks: - Create a database if one does not already exist - Download the demo data - C...
  303. Setting up the development environment
    The setup of a development environment is described here for Eclipse, IntelliJ and Visual Studio Code. Build tooling (Gulp, Grunt, etc.) is documented under [Build tools](../04buildtools/). Tomcat Ser...
  304. Gulp build process
    Overview This page describes the Gulp-based build process in the Goobi viewer. The goobi-viewer-core-config repository, every theme repository, and the core repository each ship their own Gulpfile.js....
  305. Grunt build notes
    Overview Older Goobi viewer releases use Grunt to build and mirror front-end assets. The goal matches the modern Gulp workflow: keep configuration files in sync, compile CSS/JS bundles, and copy resul...
  306. Best Practice & Troubleshooting
    Adjust circular dependencies To prevent errors from occurring when building the Goobi viewer, the following setting must be made. Preferences Java Compiler Building Build path problems Circular depend...
  307. Obsolete development environment from 2022
    This page is currently only available in the German documentation....
  308. Development environment
    For the development of the Goobi viewer, we usually work with the Eclipse development environment or with Visual Studio Code. The following pages explain how to set up a development environment and im...
  309. API
    JavaDoc With each release, Javadoc is automatically generated and published on Github pages. The documentation is available at the following URL: [https://intranda.github.io/goobi-viewer-core/index.ht...
  310. File structure
    This page is currently only available in the German documentation....
  311. Contents of the files
    This page is currently only available in the German documentation....
  312. Contents types
    This page is currently only available in the German documentation....
  313. CMS templates
    The Goobi viewer has CMS functionality. This is based on the prior creation of freely configurable templates, which can then be used as often as required within the CMS area....
  314. Overwrite standard XHTML pages with your own customised pages
    This page is currently only available in the German documentation....
  315. Theme conversion to Maven
    This page is currently only available in the German documentation....
  316. Release creation
    This page is currently only available in the German documentation....
  317. Theme adaptations
    Inserting customised graphics for the image controls The graphics for the image controls in the object and full screen view can be replaced for a customised design in the theme. To do this, the .svg f...
  318. Java
    This page is currently only available in the German documentation....
  319. CSS and Javascript
    This page is currently only available in the German documentation....
  320. Tests
    This page is currently only available in the German documentation....
  321. Updates of dependencies
    The following pages describe how to manage and update Goobi viewer dependencies....
  322. Explained!
    This section contains instructions and explanations for developers and administrators....
  323. Devs & Ops
    ...
  324. Manual
    About this manual The Goobi viewer documentation consists of several parts. The configuration options of the [Core](/en/viewer/manual/configuration/core), [Indexer](/en/viewer/manual/configuration/ind...