TYPO3 extension to simplify work with and make adjustments to Kitodo.Presentation at DDB-Zeitungsportal.
The JavaScript build is based on 5.0.x of Kitodo.Presentation.
- TYPO3 CMS 10.4 ELTS to 11.5 LTS
- Kitodo.Presentation 5.0.x only (not compatible with version 5.1 or higher yet)
- PHP 7.4.x - 8.3.x
- Apache Solr 8.x
- See Kitodo.Presentation 5.0.x Requirements
Important: This extension requires exactly Kitodo.Presentation 5.0.x. It is not compatible with Kitodo.Presentation 5.1 or higher versions for now.
When building, ../dlf/
(i.e., a sibling folder of ddb_kitodo_zeitungsportal
) must point to the code of Kitodo.Presentation that you want to use.
cd Build/
nvm use # If you use NVM
npm ci
npm run build
npm run watch # (Alternative) Watch Mode
This builds:
Resources/Public/JavaScript/ddbKitodoZeitungsportal.js
Resources/Public/Css/ddbKitodoZeitungsportal.css
Select the "Includes" tab in Template module for your root page (clicking on "Edit the whole template record") In the "Include static (from extensions)" section:
- First select "Toolbox Default Tool Templates (dlf)"
- Then select "DDB: Kitodo Zeitungsportal (ddb_kitodo_zeitungsportal)"
Important: The order of inclusion matters. Make sure Kitodo.Presentation is included before DDB Kitodo Zeitungsportal.
Edit "Constants" field in the template editor and add these configuration values:
plugin.ddb_kitodo_zeitungsportal {
viewerPid = [UID of your viewer page]
configPid = [UID of your Kitodo.Presentation configuration page]
solrCore = [UID of your Solr core]
baseUrl = https://domain.com/ [page url on which the viewer will be visible with trailing slash]
}
Edit "Setup" field in the template editor and add these lines to your TypoScript setup:
# FrontendUrl + /newspaper/item
plugin.tx_dlf_searchindocumenttool.settings.searchUrl = https://domain.com/newspaper/item
# Backend-API-URL + path to source-record with *id*
plugin.tx_dlf_searchindocumenttool.settings.documentIdUrlSchema = https://api.com/items/*id*/source/record
After configure and including the template:
- Clear all TYPO3 caches
- Check if JavaScript and CSS files are properly loaded in frontend
Example of the dlf part of nested configuration from LocalConfiguration.php file is available here. It can be used as a template for plugin configuration after the installation.
- Upgrade package via Composer
- In
LocalConfiguration.php
:This could be set in command line:'FE' => [ 'cacheHash' => [ 'requireCacheHashPresenceParameters' => [ 'tx_dlf[id]', ], ], ],
vendor/bin/typo3cms configuration:set --json 'FE/cacheHash/requireCacheHashPresenceParameters' '["tx_dlf[id]"]'
- Update database:
vendor/bin/typo3cms database:updateschema
- Update setup of viewer template:
// Before plugin.tx_dlf_searchindocumenttool.documentIdUrlSchema = ... plugin.tx_dlf_searchindocumenttool.searchUrl = ... // After plugin.tx_dlf_searchindocumenttool.settings.documentIdUrlSchema = ... plugin.tx_dlf_searchindocumenttool.settings.searchUrl = ...