DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

Plugin Reference

Kitodo Plugin Reference

Common Settings

pages

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

templateFile

The used template file of this plugin.

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 template.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 template.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 template.tmpl

Feeds

plugin.tx_dlf_feed.

Listview

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 template.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 template.tmpl

Newspaper

plugin.tx_dlf_newspaper.

Property Data type Default
pages page_id  
templateFile resource template.tmpl

OAI

plugin.tx_dlf_oai.

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

Pagegrid

plugin.tx_dlf_pagegrid.

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

Pageview

plugin.tx_dlf_pageview.

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

Statistics

plugin.tx_dlf_statistics.

Property Data type Default
pages page_id  
collections list  
description string  

TOC

plugin.tx_dlf_toc.

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

Toolbox

plugin.tx_dlf_toolbox.

Property Data type Default
pages page_id  
tools list  
fileGrpsImageDownload list MIN,DEFAULT,MAX
templateFile resource template.tmpl