Update the documentation for fluid template rendering
This commit is contained in:
Alexander Bigga
parent
889b22217d
commit
1d0d3a14b4
|
|
@ -75,6 +75,7 @@ class NavigationController extends AbstractController
|
|||
$this->view->assign('pageOptions', $pageOptions);
|
||||
|
||||
// prepare feature array for fluid
|
||||
$features = [];
|
||||
foreach (explode(',', $this->settings['features']) as $key => $value) {
|
||||
$features[$value] = true;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -25,10 +25,31 @@ pages
|
|||
^^^^^
|
||||
Startingpoint of this plugin. This is the Kitodo.Presentation data folder.
|
||||
|
||||
templateFile
|
||||
^^^^^^^^^^^^
|
||||
The used template file of this plugin.
|
||||
Fluid Template Configuration
|
||||
----------------------------
|
||||
|
||||
As of Kitodo.Presentation 4.0 the Fluid rendering engine is used. The former
|
||||
marker templates for plugins are not supported anymore.
|
||||
|
||||
Now, all HTML markup is done in Fluid. To use different templates, you have
|
||||
to overload the templates by the common TYPO3 way.
|
||||
|
||||
The following TypoScript defines addition paths inside a "example" extenion::
|
||||
|
||||
plugin.tx_dlf {
|
||||
view {
|
||||
templateRootPaths {
|
||||
10 = EXT:example/Resources/Private/Plugins/Kitodo/Templates
|
||||
}
|
||||
partialRootPaths {
|
||||
10 = EXT:example/Resources/Private/Plugins/Kitodo/Partials
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
In this example, you place the customized fluid template into this file::
|
||||
|
||||
EXT:example/Resources/Private/Plugins/Kitodo/Partials/Navigation/Main.html
|
||||
|
||||
|
||||
Audioplayer
|
||||
|
|
@ -70,14 +91,6 @@ Properties
|
|||
:Default:
|
||||
tx-dlf-audio
|
||||
|
||||
- :Property:
|
||||
templateFile_
|
||||
:Data Type:
|
||||
:ref:`t3tsref:data-type-resource`
|
||||
:Default:
|
||||
AudioPlayer.tmpl
|
||||
|
||||
|
||||
|
||||
excludeOther
|
||||
""""""""""""
|
||||
|
|
@ -160,13 +173,6 @@ Basket
|
|||
:ref:`t3tsref:data-type-page-id`
|
||||
:Default:
|
||||
|
||||
- :Property:
|
||||
templateFile_
|
||||
:Data Type:
|
||||
:ref:`t3tsref:data-type-resource`
|
||||
:Default:
|
||||
Basket.tmpl
|
||||
|
||||
|
||||
Calendar
|
||||
---------
|
||||
|
|
@ -239,12 +245,6 @@ now.
|
|||
:Default:
|
||||
1
|
||||
|
||||
- :Property:
|
||||
templateFile_
|
||||
:Data Type:
|
||||
:ref:`t3tsref:data-type-resource`
|
||||
:Default:
|
||||
Calendar.tmpl
|
||||
|
||||
Collection
|
||||
----------
|
||||
|
|
@ -307,13 +307,6 @@ The collection plugin shows one collection, all collections or selected collecti
|
|||
:ref:`t3tsref:data-type-page-id`
|
||||
:Default:
|
||||
|
||||
- :Property:
|
||||
templateFile_
|
||||
:Data Type:
|
||||
:ref:`t3tsref:data-type-resource`
|
||||
:Default:
|
||||
Collection.tmpl
|
||||
|
||||
|
||||
Feeds
|
||||
-----
|
||||
|
|
@ -452,13 +445,6 @@ List View
|
|||
:ref:`t3tsref:data-type-page-id`
|
||||
:Default:
|
||||
|
||||
- :Property:
|
||||
templateFile_
|
||||
:Data Type:
|
||||
:ref:`t3tsref:data-type-resource`
|
||||
:Default:
|
||||
ListView.tmpl
|
||||
|
||||
|
||||
Metadata
|
||||
--------
|
||||
|
|
@ -529,13 +515,6 @@ Metadata
|
|||
:Default:
|
||||
`#`
|
||||
|
||||
- :Property:
|
||||
templateFile_
|
||||
:Data Type:
|
||||
:ref:`t3tsref:data-type-resource`
|
||||
:Default:
|
||||
Metadata.tmpl
|
||||
|
||||
Navigation
|
||||
----------
|
||||
|
||||
|
|
@ -557,6 +536,15 @@ Navigation
|
|||
:ref:`t3tsref:data-type-page-id`
|
||||
:Default:
|
||||
|
||||
- :Property:
|
||||
features
|
||||
:Data Type:
|
||||
:ref:`t3tsref:data-type-string`
|
||||
:Default:
|
||||
By default all features are activated. The selection is stored as comma separated list.
|
||||
|
||||
doublepage,pageFirst,pageBack,pageStepBack,pageselect,pageForward,pageStepForward,pageLast,listview,zoom,rotation
|
||||
|
||||
- :Property:
|
||||
pageStep
|
||||
:Data Type:
|
||||
|
|
@ -570,12 +558,6 @@ Navigation
|
|||
:ref:`t3tsref:data-type-page-id`
|
||||
:Default:
|
||||
|
||||
- :Property:
|
||||
templateFile_
|
||||
:Data Type:
|
||||
:ref:`t3tsref:data-type-resource`
|
||||
:Default:
|
||||
Navigation.tmpl
|
||||
|
||||
OAI-PMH
|
||||
-------
|
||||
|
|
@ -674,13 +656,6 @@ Page Grid
|
|||
:ref:`t3tsref:data-type-page-id`
|
||||
:Default:
|
||||
|
||||
- :Property:
|
||||
templateFile_
|
||||
:Data Type:
|
||||
:ref:`t3tsref:data-type-resource`
|
||||
:Default:
|
||||
PageGrid.tmpl
|
||||
|
||||
Page View
|
||||
---------
|
||||
|
||||
|
|
@ -757,13 +732,6 @@ Page View
|
|||
:ref:`t3tsref:data-type-page-id`
|
||||
:Default:
|
||||
|
||||
- :Property:
|
||||
templateFile_
|
||||
:Data Type:
|
||||
:ref:`t3tsref:data-type-resource`
|
||||
:Default:
|
||||
PageView.tmpl
|
||||
|
||||
Search
|
||||
------
|
||||
|
||||
|
|
@ -881,14 +849,6 @@ Search
|
|||
:ref:`t3tsref:data-type-page-id`
|
||||
:Default:
|
||||
|
||||
- :Property:
|
||||
templateFile_
|
||||
:Data Type:
|
||||
:ref:`t3tsref:data-type-resource`
|
||||
:Default:
|
||||
Search.tmpl
|
||||
|
||||
|
||||
Statistics
|
||||
----------
|
||||
|
||||
|
|
@ -970,14 +930,6 @@ Table Of Contents
|
|||
:ref:`t3tsref:data-type-page-id`
|
||||
:Default:
|
||||
|
||||
- :Property:
|
||||
templateFile_
|
||||
:Data Type:
|
||||
:ref:`t3tsref:data-type-resource`
|
||||
:Default:
|
||||
TableOfContents.tmpl
|
||||
|
||||
|
||||
Toolbox
|
||||
-------
|
||||
|
||||
|
|
@ -1029,14 +981,6 @@ Toolbox
|
|||
:Default:
|
||||
MIN,DEFAULT,MAX
|
||||
|
||||
- :Property:
|
||||
templateFile_
|
||||
:Data Type:
|
||||
:ref:`t3tsref:data-type-resource`
|
||||
:Default:
|
||||
Toolbox.tmpl
|
||||
|
||||
|
||||
Fulltext Tool
|
||||
^^^^^^^^^^^^^
|
||||
This plugin adds an activation link for fulltext to the toolbox. If no fulltext is available for the current page, a span-tag is rendered instead.
|
||||
|
|
|
|||
Loading…
Reference in New Issue