Documentation¶
The following document holds information about the installation of the TYPO3 dfgviewer extension. In case of further question please contact the release management.
Installation¶
The following documentation was tested with TYPO3 6.2.x and 7.6.x. The extension is based on Kitodo.Presentation (dlf). Before you can start to use the DFG Viewer (dfgviewer) in your TYPO3 installation, you have to install both extensions.
You can install the extension automatically via extension manager or semiautomatically via GitHub. The automatic way is straight forward so in the following the GitHub process is explained. At first checkout the repository:
git clone https://github.com/slub/dfg-viewer.git dfgviewer
The extension key is “dfgviewer”. Thus the following directory must keep the DFG-Viewer and Kitodo.Presentation in your document root:
typo3conf/ext/dfgviewer/ typo3conf/ext/dlf/
Repeat this process for the Kitodo.Presentation (dlf) (https://github.com/kitodo/kitodo-presentation.git) extension.
Now install both extensions via the extension manager within TYPO3. Also check if you have installed the necessary dependencies (e.g. static_info_tables). If the installation was successful, the category KITODO with a subitem DFG Viewer will appear in the navigation tree on the left side of your TYPO3 backend.
Create a Page-Item in the category WEB as well as a configuration folder as a subitem of this page. The title of the page as well as the configuration file is arbitrary.
Go to the subitem DFG Viewer of the KITODO category, choose the configuration folder and click both buttons (Create structures, Create metadata). This adds some basic configuration records in the configuration folder, which define METS structure type and MODS metadata fields.
Go to the Template tool, choose the page item, set the page to Rootlevel and add the DFG Viewer (dfgviewer) item to your Selected Items under Includes. Then select the Constants editor and set the storagePid and baseURL`according to your setup (`storagePid should be the page ID of the configuration folder).
Now your installation should work. You can test this with the following url (replace host and id with the parameters of your installation):
Known Problems¶
You should use the following configuration in typo3confLocalConfiguration.php:
- ‘FE’ => array(
… ‘cHashRequiredParameters’ => ‘tx_dlf[id],’,
‘pageNotFoundOnCHashError’ => ‘0’, ‘pageNotFound_handling’ => ‘’, …),