System Setup¶
TYPO3 Setup¶
Extension Configuration¶
This step is obligatory!
- go to the Extension Configuration (
ADMIN TOOLS -> Settings -> Extension Configuration
). - open dlf
- check and save the configuration
After this step, the require tx_dlf_formats records are created on the root page (uid=0).
TYPO3 Configuration¶
The navigation plugin provides a page selection dropdown input field. The resulting action url cannot contain a valid cHash value.
The default behaviour of TYPO3 is to call the pageNotFound handler and/or to show an exception:
This is not the desired behaviour. You should configure in
ADMIN TOOLS -> Settings -> Configure Installation-Wide Options
$TYPO3_CONF_VARS['FE']['pageNotFoundOnCHashError']=0
to show the requested page
instead. The caching will be disabled in this case. This was the default
behaviour before TYPO3 6.x.
This configuration is written to typo3conf/LocalConfiguration.php:
'FE' => [
'pageNotFoundOnCHashError' => '0',
'pageNotFound_handling' => '',
],
TypoScript Basic Configuration¶
Please include the Template “Basic Configuration (dlf)”. This template adds jQuery to your page by setting the following typoscript:
page.includeJSlibs.jQuery
Slug Configuration¶
With TYPO3 9.5 it is possible to make speaking urls with the builtin advanced routing feature (“Slug”). This may be used for extensions too.
TYPO3 documentation about Advanced Routing Configuration.
The following code is an example of an routeEnhancer for the workview page on uid=14.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | routeEnhancers:
KitodoWorkview:
type: Plugin
namespace: tx_dlf
limitToPages:
- 14
routePath: '/{id}/{page}'
requirements:
id: '(\d+)|(http.*xml)'
page: \d+
KitodoWorkviewDouble:
type: Plugin
namespace: tx_dlf
limitToPages:
- 14
routePath: '/{id}/{page}/{double}'
requirements:
id: '(\d+)|(http.*xml)'
page: \d+
double: '[0-1]'
|
Solr Installation¶
This extension doesn’t include Solr, but just a prepared configuration set. To setup Apache Solr, perform the following steps:
- Make sure you have Apache Solr 7.7 or 8.8 and running.
- Download Solr from https://solr.apache.org/downloads.html. Other versions may work but are not tested.
- Copy the lib/ApacheSolr/configsets/dlf to $SOLR_HOME/configsets/dlf.
- Using basic authentication is optional but recommended.
- The documentation is available here: https://lucene.apache.org/solr/guide/7_4/basic-authentication-plugin.html