De:TSref/PLUGIN

From TYPO3Wiki

Jump to: navigation, search
TypoScript Referenz - Plugin
Translations info
An english page for every translation.
All pagenames in english.

  en       de   nl   fr   jp  

This page is document in progress. TypoScript (Liste TypoScript)

[edit] The “plugin” TLO

This is used for extensions in TYPO3 set up as frontend plugins. Typically you can set configuration properties of the plugin here. Say you have an extension with the key “tx_myext” and it has a frontend plugin named “tx_myext_pi1” then you would find the TypoScript configuration at the position “plugin.tx_myext_pi1” in the object tree!

Most plugins are USER or USER_INT objects which means that they have at least 1 or 2 reserved properties. Furthermore this table outlines some other default properties. Generally system properties are prefixed with an underscore:

Eigenschaft Datentyp Kommentar Standardwert


userFunc Property setting up the USER / USER_INT object of the plugin
includeLibs Property setting up the USER / USER_INT object of the plugin
_CSS_DEFAULT_STYLE string Use this to have some default CSS styles inserted in the header section of the document. Most likely this will provide a default acceptable display from the plugin, but should ideally be cleared and moved to an external stylesheet.

This value is for all plugins read by the pagegen script when making the header of the document.

_DEFAULT_PI_VARS.[piVar-key] string Allows you to set default values of the piVars array which most plugins are using (and should use) for data exchange with themselves.

This works only if the plugin calls $this->pi_setPiVarDefaults().

_LOCAL_LANG.[lang-key].[label-key] string Kann verwendet werden um die locallang-labels für das Plugin zu überschreiben.

[tsref:plugin]

Beispiel:
plugin.tx_meineext_pi1._LOCAL_LANG.de.list_mode_1 = Der erste Modus

Alle Variablen die innerhalb einer Extension via $this->pi_getLL('list_mode_1','Text, falls kein Eintrag in locallang.xml',true); verwendet werden, können somit via TYPOScript überschrieben werden.

In der Regel liegt in dem Verzeichnis in dem das Plugin liegt (z.B. pi1/) auch eine Datei locallang.xml. Dort kann ein Überblick über die möglichen Einträge gefunden werden. Wenn die Anpassung via TYPOScript überschrieben werden, dann bleiben diese auch nach einem Update erhalten.

Personal tools