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.

Configuration Reference

Technical information: Installation, Reference of TypoScript options, configuration options on system level, how to extend it, the technical details, how to debug it and so on.

Language should be technical, assuming developer knowledge of TYPO3. Small examples/visuals are always encouraged.

Target group: Developers

TypoScript Reference

Possible subsections: Reference of TypoScript options. The construct below show the recommended structure for TypoScript properties listing and description.

Properties should be listed in the order in which they are executed by your extension, but the first should be alphabetical for easier access.

When detailing data types or standard TypoScript features, don't hesitate to cross-link to the TypoScript Reference as shown below. See the Settings.yml file for the declaration of cross-linking keys.

Properties

Property Data type stdWrap Default
allWrap wrap yes <div>|</div>
subst_elementUid boolean no 0
wrapItemAndSub wrap    

Property details

allWrap

plugin.tx_extensionkey.allWrap = wrap

Wraps the whole item.

wrapItemAndSub

plugin.tx_extensionkey.wrapItemAndSub = wrap

Wraps the whole item and any submenu concatenated to it.

subst_elementUid

plugin.tx_extensionkey.subst_elementUid = boolean

If set, all appearances of the string {elementUid} in the total element html-code (after wrapped in allWrap) are substituted with the uid number of the menu item. This is useful if you want to insert an identification code in the HTML in order to manipulate properties with JavaScript.

FAQ

Possible subsection: FAQ