Administrator Manual

Upgrade-Wizards

There are two upgrade wizards available. If you upgrade an existing installation, you should use them. Without, you have to configure all plugins from scratch and the collection record images won't be visible.

Database Upgrade

Run the database upgrade (Maintenance > Analyze Database Structure) and delete the columns metadata and metadata_sorting. (These columns are not used anymore by Kitodo.Presentation 4. If they are not removed, indexing new documents may fail.)

Set the Storage Pid

The Kitodo.Presentation configuration folder must be set by TypoScript constant plugin.tx_dlf.persistence.storagePid now. This setting is available for all plugins in the page tree. The plugin specific pages has been removed.

Migrate Plugin Settings

When plugins are configured in TypoScript, the values must now be wrapped in a settings key.

// Before
plugin.tx_dlf_pageview {
  features = OverviewMap
}

// After
plugin.tx_dlf_pageview {
  settings {
    features = OverviewMap
  }
}

Fluid Rendering

All plugins now use the Fluid Template Engine instead of marker templates for outputting HTML.

• If you override a .tmpl file, it needs to be migrated to an HTML/Fluid template.
• The TypoScript setting templateFile has been removed.

See the Plugin Reference for more information.

Plugin Feeds

The plugin feeds uses the fluid template engine to render XML now. To enable this output format, you must create a TypoScript extension template on the page with the feed plugin and include the template "RSS Feed Plugin Configuration".

Plugin OAI-PMH

The plugin oai-pmh uses the fluid template engine to render XML now. To enable this output format, you must create a TypoScript extension template on the page with the oai-pmh plugin and include the template "OAI-PMH Plugin Configuration".

Plugin Page Grid

The plugin use the fluid widget.paginate viewhelper now. The markup has changed. You need to check and adopt your design.

The pagination can be configured by TypoScript. The flexform setting limit is changed to default paginate.itemsPerPage.

Plugin ListView

The ListView plugin works in a different manner now. It still can be used to render results from the Search plugin or the Collection plugin. Both plugins have their own "listview" which basically uses the same Fluid partials.

With the ListView plugin, you still achieve the following situation:

page 1: Search Plugin (main column)
   |
   v
   +--> page 2: ListView Plugin (main column) | Search Plugin (sidebar) e.g with forceAbsoluteUrlHttps
   ^
   |
page 3: Collection Plugin (main column)

The setting targetPid has been renamed to targetPidPageView.

Toolbox Plugins

Previously, the toolbox plugins (located in namespace Kitodo\Dlf\Plugin\Tools) could be used directly. This is not possible anymore, but instead they must be included via the overarching Toolbox plugin.

// Before
lib.imagemanipulation < tt_content.list.20.dlf_imagemanipulationtool

// After
lib.imagemanipulation < tt_content.list.20.dlf_toolbox {
  settings {
    tool = imagemanipulationtool
  }
}

Update CSP

In Kitodo.Presentation 4.0, the way how static images are loaded has changed. Please make sure that blob: URLs are not forbidden by your Content Security Policy.

Other Changes

• jQuery and OpenLayers have been updated. If you manually include them, update the paths.

Steps to Upgrade

a. Get the latest release ("jar"-file) from https://github.com/dbmdz/solr-ocrhighlighting/releases. Version 0.8.0 is the minimum version number. Make sure to pick the right file for Solr 7/8. b. Copy the jar-file (e.g. "solr-ocrhighlighting-0.8.0-solr78.jar") to the contrib/ocrsearch/lib/ directory of your Solr. c. Copy the updated schema.xml to your Solr configsets in $SOLR_HOME/configsets/dlf/ d. Copy the schema.xml from EXT:dlf/Configuration/ApacheSolr/configsets/dlf/conf/ to all of your Solr cores. E.g. $SOLR_HOME/data/dlfCore0/conf/ e. Restart Solr. f. Reindex all documents. This can be done by the kitodo:reindex CLI command with the '-a' (all) flag. See: Reindex collections.

Steps to Upgrade to Solr 9.4+

a. Get the latest release ("jar"-file) from https://github.com/dbmdz/solr-ocrhighlighting/releases. Version 0.9.1 is the minimum version number. Make sure to pick the right file for Solr 9. b. Copy the jar-file (e.g. "solr-ocrhighlighting-0.9.1.jar") to the modules/ocrsearch/lib/ directory of your Solr. c. Copy the updated schema.xml and solrconfig.xml to your Solr configsets in $SOLR_HOME/configsets/dlf/ d. Restart Solr. e. Reindex all documents. This can be done by the kitodo:reindex CLI command with the '-a' (all) flag. See: Reindex collections.

Steps to Upgrade to Solr 8.11+

a. Copy the updated schema.xml and solrconfig_8.11.2.xml to your Solr configsets in $SOLR_HOME/configsets/dlf/ b. Rename solrconfig_8.11.2.xml in $SOLR_HOME/configsets/dlf/ to solrconfig.xml c. Restart Solr. d. Reindex all documents. This can be done by the kitodo:reindex CLI command with the '-a' (all) flag. See: Reindex collections.

Furthermore version 5.1 supports the use of Solr Managed Schemas to update the schemas automatically during the update of the extension. To use this feature you have to change the schemaFactory within solrconfig.xml from "ClassicIndexSchemaFactory" to "ManagedIndexSchemaFactory".