Plugin Reference¶

Kitodo Plugin Reference ¶

Common Settings ¶

pages ¶

Startingpoint of this plugin. This is the Kitodo.Presentation data folder.

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
pages	page_id
excludeOther	boolean	1
elementId	string	tx-dlf-audio
templateFile	resource	AudioPlayer.tmpl

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
pages	page_id
pregeneration	boolean	0
pdfgenerate	string
pdfdownload	string
pdfprint	string
pdfparams	string	##docId##,##startpage##,##endpage##,##startx##,##starty##,##endx##,##endy##,##rotation##
pdfparamseparator	string	*
basketGoToButton	boolean	0
targetBasket	page_id
templateFile	resource	Basket.tmpl

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"] || [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
pages	page_id
initialDocument	integer
showEmptyMonths	boolean	1
templateFile	resource	Calendar.tmpl

Collection ¶

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

plugin.tx_dlf_collection.

Property	Data type	Default
pages	page_id
collections	list
show_userdefined	integer
dont_show_single	boolean	0
randomize	boolean	0
targetPid	page_id
targetFeed	page_id
templateFile	resource	Collection.tmpl

Feeds ¶

plugin.tx_dlf_feeds.

Property	Data type	Default
pages	page_id
collections	list
excludeOther	boolean	0
library	integer
limit	integer	50
prependSuperiorTitle	boolean	0
targetPid	page_id
title	string
description	string

List View ¶

plugin.tx_dlf_listview.

Property	Data type	Default
pages	page_id
limit	integer	25
targetPid	page_id
getTitle	boolean	0
basketButton	boolean	0
targetBasket	page_id
templateFile	resource	ListView.tmpl

Metadata ¶

plugin.tx_dlf_metadata.

Property	Data type	Default
pages	page_id
excludeOther	boolean	1
linkTitle	boolean	1
targetPid	page_id
getTitle	boolean	1
showFull	boolean	1
rootline	integer	0
separator	string	#
templateFile	resource	Metadata.tmpl

OAI-PMH ¶

plugin.tx_dlf_oaipmh.

Property	Data type	Default
pages	page_id
library	integer
limit	integer	5
expired	integer	1800
show_userdefined	boolean	0
stylesheet	resource	0
unqualified_epicur	boolean	0

Page Grid ¶

plugin.tx_dlf_pagegrid.

Property	Data type	Default
pages	page_id
limit	integer	24
placeholder	resource	Navigation.tmpl
targetPid	page_id
templateFile	resource	PageGrid.tmpl

Page View ¶

plugin.tx_dlf_pageview.

Property	Data type	Default
pages	page_id
excludeOther	boolean	1
features	list	1
elementId	string	tx-dlf-map
crop	boolean	0
useInternalProxy	boolean	0
magnifier	boolean	0
basketButton	boolean	0
targetBasket	page_id
templateFile	resource	PageView.tmpl

Search ¶

plugin.tx_dlf_search.

Property	Data type	Default
pages	page_id
fulltext	boolean
solrcore	integer
limit	integer	50000
extendedSlotCount	integer	0
extendedFields	integer	0
searchIn	string
collections	list
facets	list
limitFacets	integer	15
resetFacets	boolean
sortingFacets	string
suggest	boolean	1
showSingleResult	boolean	0
targetPid	page_id
targetPidPageView	page_id
templateFile	resource	Search.tmpl

Statistics ¶

plugin.tx_dlf_statistics.

Property	Data type	Default
pages	page_id
collections	list
description	string

Table Of Contents ¶

plugin.tx_dlf_tableofcontents.

Property	Data type	Default
pages	page_id
excludeOther	boolean	1
basketButton	boolean	0
targetBasket	page_id
targetPid	page_id
templateFile	resource	TableOfContents.tmpl

Toolbox ¶

plugin.tx_dlf_toolbox.

Property	Data type	Default	Values
pages	page_id
tools	list		tx_dlf_annotationtool tx_dlf_fulltexttool tx_dlf_imagedownloadtool tx_dlf_imagemanipulationtool tx_dlf_pdfdownloadtool tx_dlf_fulltextdownloadtool tx_dlf_searchindocumenttool
solrcore	integer
fileGrpsImageDownload	list	MIN,DEFAULT,MAX
templateFile	resource	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.

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 allows also to configure (searchHlParameters) by which URL parameters words will be highlighted in the image. The first defined parameter on the configuration has highest priority, if not found it checks the next ones.

plugin.tx_dlf_fulltexttool.

Property

Data type

Default

Values

activateFullTextInitially

boolean

0

0: show fulltext after click on toggle link

1: show fulltext on document load

fullTextScrollElement

string

html, body

searchHlParameters