Plugin Reference

Kitodo Plugin Reference

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

The audioplayer plugin is only active if the selected document has a valid audio filegroup (fileGrpAudio).

Properties

plugin.tx_dlf_audioplayer.

Property

Data type

Default

excludeOther

t3tsref:data-type-boolean

1

elementId

t3tsref:data-type-string

tx-dlf-audio
excludeOther

Show only documents from the selected page.

elementId

ID value of the HTML element for the audio player.

Basket

plugin.tx_dlf_basket.

Property

Data type

Default

pregeneration

t3tsref:data-type-boolean

0

pdfgenerate

t3tsref:data-type-string

pdfdownload

t3tsref:data-type-string

pdfprint

t3tsref:data-type-string

pdfparams

t3tsref:data-type-string

##docId##,##startpage##,##endpage##,##startx##,##starty##,##endx##,##endy##,##rotation##

pdfparamseparator

t3tsref:data-type-string

*

basketGoToButton

t3tsref:data-type-boolean

0

targetBasket

t3tsref:data-type-page-id

Calendar

The calendar plugin may be used with newspaper and ephemeras (periodical published media). The plugin shows itself an overview of all available years or all issues in a calendar view of a selected year.

You can't place the plugin together with the pageview plugin on one page. But you can use TypoScript conditions on this page to select the proper plugin e.g by setting some specific FLUID variables.

This is an example usage of the TypoScript condition ("getDocumentType"):

[getDocumentType({$config.storagePid}) === 'ephemera' or getDocumentType({$config.storagePid}) === 'newspaper']
page.10.variables {
    isNewspaper = TEXT
    isNewspaper.value = newspaper_anchor
}
[END]

[getDocumentType({$config.storagePid}) === 'year']
page.10.variables {
    isNewspaper = TEXT
    isNewspaper.value = newspaper_year
}
[END]

[getDocumentType({$config.storagePid}) === 'issue']
page.10.variables {
    isNewspaper = TEXT
    isNewspaper.value = newspaper_issue
}
[END]

The {$config.storagePid} is a TypoScript constant holding the Kitodo.Presentation storage pid.

This way, the FLUID variable "isNewspaper" is set according to the given value. Inside the FLUID template it's possible to switch to the right plugin now.

plugin.tx_dlf_calendar.

Property

Data type

Default

initialDocument

t3tsref:data-type-integer

showEmptyYears

t3tsref:data-type-boolean

0

showEmptyMonths

t3tsref:data-type-boolean

1

Collection

The collection plugin shows one collection, all collections or selected collections.

plugin.tx_dlf_collection.

Property

Data type

Default

Description

collections

t3tsref:data-type-list

childrenRows

t3tsref:data-type-integer

It defines for how many children documents metadata should be fetched

show_userdefined

t3tsref:data-type-integer

dont_show_single

t3tsref:data-type-boolean

0

randomize

t3tsref:data-type-boolean

0

targetPid

t3tsref:data-type-page-id

targetFeed

t3tsref:data-type-page-id

Feeds

The feeds plugin renders a RSS 2.0 feed of last updated documents of all or a specific collection.

The following steps are necessary to activate the plugin:

  1. Create a new page "Feed" with slug "feed".

  2. Create an extension template on this page and include the TypoScript template of the feeds plugin.

  3. Place the "Kitodo Feeds" plugin on it and configure it for your needs.

The TypoScript part is necessary to switch the page rendering to a different page object.

plugin.tx_dlf_feeds.

Property

Data type

Default

collections

t3tsref:data-type-list

excludeOtherCollections

t3tsref:data-type-boolean

0

library

t3tsref:data-type-integer

limit

t3tsref:data-type-integer

50

prependSuperiorTitle

t3tsref:data-type-boolean

0

targetPid

t3tsref:data-type-page-id

title

t3tsref:data-type-string

description

t3tsref:data-type-string

List View

plugin.tx_dlf_listview.

Property

Data type

Default

limit

t3tsref:data-type-integer

25

targetPid

t3tsref:data-type-page-id

getTitle

t3tsref:data-type-boolean

0

basketButton

t3tsref:data-type-boolean

0

targetBasket

t3tsref:data-type-page-id

Metadata

plugin.tx_dlf_metadata.

Property

Data type

Default

excludeOther

t3tsref:data-type-boolean

1

linkTitle

t3tsref:data-type-boolean

1

targetPid

t3tsref:data-type-page-id

getTitle

t3tsref:data-type-boolean

1

showFull

t3tsref:data-type-boolean

1

rootline

t3tsref:data-type-integer

0

separator

t3tsref:data-type-string

#

OAI-PMH

plugin.tx_dlf_oaipmh.

Property

Data type

Default

library

t3tsref:data-type-integer

limit

t3tsref:data-type-integer

5

expired

t3tsref:data-type-integer

1800

show_userdefined

t3tsref:data-type-boolean

0

stylesheet

t3tsref:data-type-resource

0

Page Grid

plugin.tx_dlf_pagegrid.

Property

Data type

Default

paginate.itemsPerPage

t3tsref:data-type-integer

24

placeholder

t3tsref:data-type-resource

Navigation.tmpl

targetPid

t3tsref:data-type-page-id

Page View

plugin.tx_dlf_pageview.

Property

Data type

Default

excludeOther

t3tsref:data-type-boolean

1

features

t3tsref:data-type-list

1

elementId

t3tsref:data-type-string

tx-dlf-map

progressElementId

t3tsref:data-type-string

tx-dlf-page-progress

crop

t3tsref:data-type-boolean

0

useInternalProxy

t3tsref:data-type-boolean

0

magnifier

t3tsref:data-type-boolean

0

basketButton

t3tsref:data-type-boolean

0

targetBasket

t3tsref:data-type-page-id

Statistics

plugin.tx_dlf_statistics.

Property

Data type

Default

collections

t3tsref:data-type-list

description

t3tsref:data-type-string

Table Of Contents

plugin.tx_dlf_tableofcontents.

Property

Data type

Default

Description

excludeOther

t3tsref:data-type-boolean

1

basketButton

t3tsref:data-type-boolean

0

targetBasket

t3tsref:data-type-page-id

targetPid

t3tsref:data-type-page-id

titleReplacement

t3tsref:data-type-list

List containing types for which title should be replaced when the label is empty. The defined fields are used for replacement. Example data:

0 {

type = issue fields = type,year

} 1 {

type = volume fields = type,volume

}

Toolbox

plugin.tx_dlf_toolbox.

Property

Data type

Default

Values

tools

t3tsref:data-type-list

  • tx_dlf_annotationtool

  • tx_dlf_fulltexttool

  • tx_dlf_imagedownloadtool

  • tx_dlf_imagemanipulationtool

  • tx_dlf_pdfdownloadtool

  • tx_dlf_fulltextdownloadtool

  • tx_dlf_searchindocumenttool

solrcore

t3tsref:data-type-integer

fileGrpsImageDownload

t3tsref:data-type-list

MIN,DEFAULT,MAX

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.

The default behavior is to show the fulltext after click on the toggle link. There is a TypoScript configuration to show the fulltext initially.

plugin.tx_dlf_fulltexttool.

Property

Data type

Default

Values

activateFullTextInitially

t3tsref:data-type-boolean

0

0: show fulltext after click on toggle link

1: show fulltext on document load

fullTextScrollElement

t3tsref:data-type-string

html, body

The fulltext is fetched and rendered by JavaScript into the <div id="tx-dlf-fulltextselection"> of the pageview plugin.

Please note: To allow JavaScript fetching the fulltext, the CORS headers must be configured appropriate on the providing webserver.

Search in Document Tool

This plugin adds an possibility to search all appearances of the phrase in currently displayed document

plugin.tx_dlf_searchindocumenttool.

Property

Data type

Default

Values

searchUrl

t3tsref:data-type-string

documentIdUrlSchema

t3tsref:data-type-string

empty

https://host.de/items/id/record - example value

idInputName

t3tsref:data-type-string

tx_dlf[id]

queryInputName

t3tsref:data-type-string

tx_dlf[query]

startInputName

t3tsref:data-type-string

tx_dlf[start]

pageInputName

t3tsref:data-type-string

tx_dlf[page]

highlightWordInputName

t3tsref:data-type-string

tx_dlf[highlight_word]

encryptedInputName

t3tsref:data-type-string

tx_dlf[encrypted]