slub / slub-web-sachsendigital
Templates, Styles and Configuration for Sachsen.Digital
Installs: 1
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 10
Forks: 5
Open Issues: 7
Language:JavaScript
Type:typo3-cms-extension
Requires
- kitodo/presentation: ^4.0|dev-master
- slub/slub-digitalcollections: ^3.0|dev-master
- typo3/cms-core: ~9.5.26|^10.4
This package is auto-updated.
Last update: 2024-11-06 11:29:23 UTC
README
This TYPO3 extension provides the configuration and setup for the new implementation of SACHSEN.digital by the SLUB Dresden.
Installation
This extension needs to reside in a folder called slub_web_sachsendigital
in TYPO3 extension folder ('typoconf/ext').
After activate the extension in the TYPO3 extension manager you need to include a static template called SLUB: Portal Sachsen.Digital
in the template settings of the source page of the SACHSEN.digtal branch.
Upgrade to Kitodo.Presentation 4
To upgrade an existing installation:
- Follow the steps described in the upgrade guide of Kitodo.Presentation, in particular:
- Set storage PID in template
- Run the upgrade wizards and database update
- Update CSP
- In the List View plugin of the search page, set the target PID
Configuration
The player is configured in media.typoscript.
settings.shareButtons
may be used to configure which sharing buttons are
available in the bookmarks modal:
- Button icon: Use
- either
type = material
andicon = ...
to use the specified Material Icon, - or
type = image
andsrc =
to use an image at the specified URL.
- either
- Tooltips: Set
titleTranslationKey
to a translation key that is defined in theplayerTranslations
file. - Share target: Enter a link URL in
hrefTemplate
- The placeholder
{url}
will be replaced by the URL to be shared. - The special value
dlf:qr_code
may be used to generate a QR code.
- The placeholder
constants
may be used to configure the video player:
prevChapterTolerance
: Number of seconds in which to still rewind to previous chaptervolumeStep
: Fractional value of volume increase/decrease when pressing up/down arrow keysseekStep
: Number of seconds for seek/rewindtrickPlayFactor
: Trick play factor for continuous rewind/seekforceLandscapeOnFullscreen
: Whether or not to switch to landscape in fullscreen mode
Frontend Development
Anything related to building the JavaScript and Less code is located in Build/
, which is the working directory for all commands listed in this section.
In general, Resources/Private/{JavaScript,Less}
contain the written code, while Resources/Public/{JavaScript,Css}
contain the compiled code as generated by the build process.
Getting Started
For selecting the proper Node version, you may either use NVM or check Build/.nvmrc
.
nvm install # If you use NVM
npm install
Development
You may use the following command to build the code in development mode and watch for file changes:
nvm use # If you use NVM
npm run watch
Production
Before committing, please run the following command to build the code in production mode:
nvm use # If you use NVM
npm run build
Running Tests
npm test # (Alternative) Watch mode npm test -- --watch # With coverage report npm test -- --coverage xdg-open coverage/lcov-report/index.html
Typings
npm run typecheck
# (Alternative) Watch mode
npm run tsc-watch
Browser Compatibility
npm run compat npm run compat-build
Remarks
- jQuery is marked as external in Webpack config
Dependencies
- TYPO3 CMS Frontend (cms)
- Extbase Framework (Extbase)
- Fluid Templating Engine (fluid)
- Kitodo.Presentation (dlf)
- News system (news)