Plugin Reference 

Common Settings 

plugin.tx_dlf {
   view {
      templateRootPaths {
         10 = EXT:example/Resources/Private/Plugins/Kitodo/Templates
      }
      partialRootPaths {
         10 = EXT:example/Resources/Private/Plugins/Kitodo/Partials
      }
   }
}

EXT:example/Resources/Private/Plugins/Kitodo/Partials/Navigation/Main.html

Audio Player 

The audioplayer plugin is only active if the selected document has valid audio file use groups (useGroupsAudio).

Basket 

plugin.tx_dlf_basket.

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({$plugin.tx_dlf.persistence.storagePid}) === 'ephemera' or getDocumentType({$plugin.tx_dlf.persistence.storagePid}) === 'newspaper']
page.10.variables {
    isNewspaper = TEXT
    isNewspaper.value = newspaper_anchor
}
[END]

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

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

The {$plugin.tx_dlf.persistence.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.settings.

Collection 

The collection plugin shows one collection, all collections or selected collections. It can be used to display the list of collections or the contents of a single collection. The plugin is configured in the TypoScript and in the FlexForm.

Embedded 3D Viewer 

The embedded3dviewer plugin renders an iFrame in which the configured 3D viewer displays the model.

plugin.tx_dlf_embedded3dviewer.settings.

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.settings.

List View 

Media Player 

The MediaPlayer plugin is only active if the selected document has valid video file use groups (useGroupsVideo).

plugin.tx_dlf_mediaplayer.settings.

Metadata 

plugin.tx_dlf_metadata.settings.

Navigation 

This plugin adds a navigation to the page view for navigating through the pages of a document. The navigation buttons are displayed in the order included in configuration. Features pagesBackward and pagesForward offer adding multiple navigation buttons grouped together.

OAI-PMH 

Page Grid 

Page View 

Search 

Statistics 

Table Of Contents 

Table of Contents plugin renders a table of contents for the current document. The table of contents is generated based on the structure of the document.

Toolbox 

Toolbox Plugin is a plugin which can be used to display a selection of tools for the current page. The available tools are configured in the TypoScript.

'tools' is a required property which must contain at least one of the supported tools. The plugin will only be rendered if at least one tool is configured and supported for the current page.

plugin.tx_dlf_audiovideotool {
   settings {
      tools = audiovideotool
   }
}

plugin.tx_dlf_fulltexttool {
    settings {
        tools = fulltexttool
        activateFullTextInitially = 0
        fullTextScrollElement = html, body
    }
}

plugin.tx_dlf_modeldownloadtool {
    settings {
        tools = modeldownloadtool
    }
}

plugin.tx_dlf_scoretool {
    settings {
        tools = scoretool
        midiPlayerSoundFont = default
    }
}

plugin.tx_dlf_searchindocumenttool {
    settings {
        tools = searchindocumenttool
        idInputName = tx_dlf[id]
        pidInputName = tx_dlf[pid]
        queryInputName = tx_dlf[query]
        startInputName = tx_dlf[start]
        pageInputName = tx_dlf[page]
        highlightWordInputName = tx_dlf[highlight_word]
        encryptedInputName = tx_dlf[encrypted]
    }
}

plugin.tx_dlf_viewerselectiontool {
    settings {
        tools = viewerselectiontool
    }
}

Validation Form 

The plugin renders an input field where a METS URL can be entered. After submission, the document is loaded and validated against the DOMDocumentValidation Middleware. For the validation to work, a corresponding configuration (see Configuration) must be present in TypoScript, and the type of this configuration must be provided to the plugin as a required parameter.

plugin.tx_dlf_validationform.