• TypoScript Reference
    master (10-dev)
  • Sitemap
  • Introduction
    • About this document
    • Credits
    • Feedback and Fixing
    • General information
      • Case sensitivity
      • Version numbers
  • Using and setting TypoScript
    • Usage
    • Entering and structuring TypoScript templates
      • Inclusions
      • Template Analyzer
    • Constants
      • Defining constants
        • Example
      • Using constants
        • Example
    • The Constant Editor
      • Default values
      • Comment Syntax
      • cat
        • Predefined categories
        • Custom categories
        • Subcategories
        • Predefined subcategories
        • Custom subcategories
        • Ordering
      • type
      • label
    • Register
      • Defining registers
      • Example
    • Debugging / Analyzing
      • Analyzing defined constants
      • Finding errors
      • Debugging
  • Data types
    • align
    • boolean
    • case
    • Object types
      • cObject
      • frameObj
      • Gifbuilder Object
      • menu object
    • date-conf
    • degree
    • dir
    • function name
    • getText
      • cObj
      • context
      • current
      • date
      • DB
      • debug
      • field
      • file
      • flexform
      • fullRootLine
      • getenv
      • getIndpEnv
      • global
      • GP
      • level
      • levelfield
      • leveltitle, leveluid, levelmedia
      • LLL
      • page
      • pagelayout
      • parameters
      • path
      • register
      • session
    • site
    • siteLanguage
      • TSFE
    • GraphicColor
    • HTML code
    • HTML-color
    • imageExtension
    • imgResource
    • integer
    • linkWrap
    • list
    • margins
    • page_id
    • path
    • pixels
    • positive integer
    • resource
    • rotation
    • space
    • strftime-conf
    • string
    • <tag>
    • <tag>-data
    • <tag>-params
    • target
    • UNIX-time
    • VHalign
    • wrap
    • x,y,w,h
  • Objects and properties
    • Introduction
      • Reference to objects
    • Calc
      • Calculating values (+calc)
        • calc example:
    • optionSplit
      • Introduction
      • PHP-Code
      • Terminology
        • Mainparts
        • Subparts
      • Full example to see how it works
        • Three by three items
      • The optionSplit ruleset
      • More Examples
        • Three by two items
        • Three by one items
        • Two by three items
        • Two by two items
        • Two by one items
        • One by one items
        • One by two items
        • One by three items
        • One by four items
      • More examples: Tricky stuff
        • Three items A, no item R, three items Z
        • One item A, no item R, one items Z
        • One item A, one (unexpected!?) item R, one item Z
        • More
      • Test Code 1 (TypoScript)
      • Test Code 1 Result
      • Test Code 2 (TypoScript)
      • Test Code 2 Result
    • Objects and stdWrap
      • stdWrap example:
  • Conditions
    • Description
    • Upgrading
    • Reference
      • Variables
        • applicationContext
        • page
        • Constant
        • tree
          • tree.level
          • tree.rootLine
          • tree.rootLineIds
        • backend
          • backend.user
          • backend.user.admin
          • backend.user.isLoggedIn
          • backend.user.userId
          • backend.user.userGroupList
        • frontend
          • frontend.user
          • frontend.user.isLoggedIn
          • frontend.user.userId
          • frontend.user.userGroupList
        • typo3
          • typo3.version
          • typo3.branch
          • typo3.devIpMask
      • Functions in all contexts
        • request
          • request.getQueryParams()
          • request.getParsedBody()
          • request.getHeaders()
          • request.getCookieParams()
          • request.getNormalizedParams()
        • date
        • like
        • ip
        • compatVersion
        • loginUser
        • getTSFE
        • getenv
        • feature
        • usergroup
      • Functions in frontend context
        • session
        • site
        • siteLanguage
  • Functions
    • addParams
      • _offset
      • (array of strings)
      • Example
    • cache
      • key
      • lifetime
      • tags
      • Examples
      • cache as first-class function
    • encapsLines
      • encapsTagList
      • remapTag.[ tagname ]
      • addAttributes.[ tagname ]
      • removeWrapping
      • wrapNonWrappedLines
      • innerStdWrap_all
      • encapsLinesStdWrap.[ tagname ]
      • defaultAlign
      • nonWrappedTag
      • Example
      • Example
    • filelink
      • altText
      • ATagBeforeWrap
      • ATagParams
      • emptyTitleHandling
      • file
      • icon
      • icon_link
      • icon_image_ext_list
      • icon_thumbSize
      • iconCObject
      • labelStdWrap
      • longdescURL
      • path
      • removePrependedNumbers
      • size
      • stdWrap
      • target
      • titleText
      • typolinkConfiguration
      • wrap
      • Filelink Example
    • getEnv
      • Example
    • HTMLparser
      • allowTags
      • stripEmptyTags
      • stripEmptyTags.keepTags
      • tags.[tagname]
      • localNesting
      • globalNesting
      • rmTagIfNoAttrib
      • noAttrib
      • removeTags
      • keepNonMatchedTags
      • htmlSpecialChars
    • HTMLparser_tags
      • overrideAttribs
      • allowedAttribs
      • fixAttrib.[attribute].set
      • fixAttrib.[attribute].unset
      • fixAttrib.[attribute].default
      • fixAttrib.[attribute].always
      • fixAttrib.[attribute].range
      • fixAttrib.[attribute].list
      • fixAttrib.[attribute].removeIfFalse
      • fixAttrib.[attribute].removeIfEquals
      • fixAttrib.[attribute].casesensitiveComp
      • fixAttrib.[attribute].prefixLocalAnchors
      • fixAttrib.[attribute].prefixRelPathWith
      • fixAttrib.[attribute].userFunc
      • protect
      • remap
      • rmTagIfNoAttrib
      • nesting
    • if
      • directReturn
      • isNull
      • isTrue
      • isFalse
      • isPositive
      • isGreaterThan
      • isLessThan
      • equals
      • isInList
      • value
      • negate
      • Explanation
      • Examples
    • Properties
    • enable
    • file
    • width
    • height
    • effects
      • Example for effects
    • sample
    • alternativeTempPath
    • title
    • bodyTag
    • wrap
    • target
    • JSwindow
    • JSwindow.expand
    • JSwindow.newWindow
    • JSwindow.altUrl
    • JSwindow.altUrl_noDefaultParams
    • typolink
    • directImageLink
    • linkParams
    • stdWrap
    • What it does
    • Implementation
    • Examples for imageLinkWrap
      • Basic example: Create a link to the showpic script
      • Basic example: Link directly to the original image
      • Example: Larger display in a popup window
      • Example: Printlink
      • Example: Images in lightbox “fancybox”
      • Example: Images in lightbox “TopUp”
    • imgResource
      • ext
      • width
      • height
      • params
      • sample
      • noScale
      • crop
      • cropVariant
      • alternativeTempPath
      • frame
      • import
      • treatIdAsReference
      • maxW
      • maxH
      • minW
      • minH
      • stripProfile
      • Examples
    • makelinks
      • http.extTarget
      • http.wrap
      • http.ATagBeforeWrap
      • http.keep
      • http.ATagParams
      • mailto.wrap
      • mailto.ATagBeforeWrap
      • mailto.ATagParams
    • numberFormat
      • decimals
      • dec_point
      • thousands_sep
        • Examples
    • numRows
      • table
      • select
    • parseFunc
      • externalBlocks
      • constants
      • short
      • plainTextStdWrap
      • userFunc
      • nonTypoTagStdWrap
      • nonTypoTagUserFunc
      • sword
      • makelinks
      • tags
      • allowTags
      • denyTags
      • if
      • Example
    • replacement
      • search
      • replace
      • useRegExp
      • useOptionSplitReplace
      • Examples
    • round
      • roundType
      • decimals
      • round
        • Examples
    • select
      • Comprehensive example
      • uidInList
      • pidInList
      • recursive
      • orderBy
      • groupBy
      • max
      • begin
      • where
      • languageField
      • includeRecordsWithoutDefaultTranslation
      • selectFields
      • join, leftjoin, rightjoin
      • markers
    • split
      • token
      • max
      • min
      • returnKey
      • returnCount
      • cObjNum
      • 1,2,3,4
      • wrap
      • Example
    • stdWrap
      • Content-supplying properties of stdWrap
      • Getting data
        • setContentToCurrent
        • addPageCacheTags
        • setCurrent
        • lang
        • data
        • field
        • current
        • cObject
        • numRows
        • preUserFunc
      • Override and conditions
        • override
        • preIfEmptyListNum
        • ifNull
        • ifEmpty
        • ifBlank
        • listNum
        • trim
        • strPad
        • stdWrap
        • required
        • if
        • fieldRequired
      • Parsing data
        • csConv
        • parseFunc
        • HTMLparser
        • split
        • replacement
        • prioriCalc
        • char
        • intval
        • hash
        • round
        • numberFormat
        • date
        • strftime
        • strtotime
        • age
        • case
        • bytes
        • substring
        • cropHTML
        • stripHtml
        • crop
        • rawUrlEncode
        • htmlSpecialChars
        • encodeForJavaScriptValue
        • doubleBrTag
        • br
        • brTag
        • encapsLines
        • keywords
        • innerWrap
        • innerWrap2
        • addParams
        • filelink
        • preCObject
        • postCObject
        • wrapAlign
        • typolink
        • wrap
        • noTrimWrap
        • wrap2
        • dataWrap
        • prepend
        • append
        • wrap3
        • orderedStdWrap
        • outerWrap
        • insertData
        • postUserFunc
        • postUserFuncInt
        • prefixComment
        • editIcons
        • editPanel
        • cache
        • debug
        • debugFunc
        • debugData
    • strPad
      • length
      • padWith
      • type
      • Examples
    • tags
      • (array of strings)
      • Example
    • typolink
      • extTarget
      • fileTarget
      • language
      • target
      • no_cache
      • useCacheHash
      • additionalParams
      • addQueryString
      • wrap
      • ATagBeforeWrap
      • parameter
      • forceAbsoluteUrl
      • title
      • JSwindow_params
      • returnLast
      • section
      • ATagParams
      • linkAccessRestrictedPages
      • userFunc
      • Resource references
      • Handler syntax
        • page
        • file
        • folder
        • email
        • url
        • record
      • Using link handlers
  • Setup
    • Top-level objects
      • ((abc …?))
      • ((bcd …?))
      • config
      • constants
      • Other reserved TLO’s:
      • resources
      • sitetitle
      • types
    • plugin
      • Properties
      • userFunc
      • _CSS_DEFAULT_STYLE
      • _CSS_PAGE_STYLE
      • _DEFAULT_PI_VARS.[piVar-key]
      • _LOCAL_LANG.[lang-key].[label-key]
    • config
      • Properties
      • absRefPrefix
      • additionalHeaders
      • admPanel
      • ATagParams
      • baseURL
      • cache
      • cache_clearAtMidnight
      • cache_period
      • compressCss
      • compressJs
      • concatenateCss
      • concatenateJs
      • concatenateJsAndCss
      • content_from_pid_allowOutsideDomain
      • contentObjectExceptionHandler
      • debug
      • defaultGetVars
      • disableAllHeaderCode
      • disableBodyTag
      • disableCharsetHeader
      • disableImgBorderAttr
      • disablePageExternalUrl
      • disablePrefixComment
      • disablePreviewNotification
      • disableLanguageHeader
      • doctype
      • doctypeSwitch
      • enableContentLengthHeader
      • extTarget
      • fileTarget
      • forceTypeValue
      • formMailCharset
        • ftu
      • headerComment
      • htmlTag_dir
      • htmlTag_langKey
      • htmlTag_setParams
      • htmlTag.attributes
      • htmlTag_stdWrap
      • index_descrLgd
      • index_enable
      • index_externals
      • index_metatags
      • inlineStyle2TempFile
      • intTarget
      • language
      • language_alt
      • linkVars
      • locale_all
      • message_page_is_being_generated
      • message_preview
      • message_preview_workspace
      • metaCharset
      • moveJsFromHeaderToFooter
      • MP_defaults
      • MP_disableTypolinkClosestMPvalue
      • MP_mapRootPoints
      • namespaces
      • no_cache
      • noPageTitle
      • pageRendererTemplateFile
      • pageTitle
      • pageTitleFirst
      • pageTitleSeparator
      • removeDefaultCss
      • removeDefaultJS
      • removePageCss
      • sendCacheHeaders
      • sendCacheHeaders_onlyWhenLoginDeniedInBranch
      • spamProtectEmailAddresses
      • spamProtectEmailAddresses_atSubst
      • spamProtectEmailAddresses_lastDotSubst
      • sword_noMixedCase
      • sword_standAlone
      • sys_language_isocode
      • sys_language_isocode_default
      • sys_language_mode
      • sys_language_overlay
      • sys_language_uid
      • titleTagFunction
      • tx_[extension key with no underscores]_[*]
      • typolinkCheckRootline
      • typolinkEnableLinksAcrossDomains
      • typolinkLinkAccessRestrictedPages
      • typolinkLinkAccessRestrictedPages_addParams
      • USERNAME_substToken
      • USERUID_substToken
      • xhtmlDoctype
      • xmlprologue
    • constants
      • Properties
      • (array of keys)
    • PAGE
      • Properties
      • 1,2,3,4…
      • bodyTag
      • bodyTagAdd
      • bodyTagCObject
      • config
      • CSS_inlineStyle
      • cssInline
      • footerData
      • headerData
      • headTag
      • includeCSS.[array]
      • includeCSSLibs.[array]
      • includeJS.[array]
      • includeJSFooter.[array]
      • includeJSFooterlibs.[array]
      • includeJSLibs.[array]
      • inlineLanguageLabelFiles
      • inlineSettings
      • jsFooterInline
      • jsInline
      • meta
      • shortcutIcon
      • stdWrap
      • typeNum
      • wrap
    • meta
      • Properties
        • array of key names
    • carray
      • Properties
      • Property details
        • (stdWrap properties…)
        • (TDParams)
        • 1,2,3,4…
  • Content Objects
    • General information
      • PHP information
      • REUSING cOBJECTS
        • Note:
        • Example:
    • CASE
      • Example:
    • COA, COA_INT
      • Examples:
    • CONTENT
      • Comprehensive example
      • select
      • table
      • renderObj
      • slide
      • wrap
      • stdWrap
      • CONTENT object example 1
      • CONTENT object example 2
    • EDITPANEL
      • Example:
    • FILE
      • Example:
    • FILES
      • Special key: “references”
      • Examples:
        • Usage with files
        • Usage with references
        • Usage with sliding
    • FLUIDTEMPLATE
      • Properties
        • templateName
        • template
        • file
        • templateRootPaths
        • layoutRootPath
        • layoutRootPaths
        • partialRootPath
        • partialRootPaths
        • format
        • extbase.pluginName
        • extbase.controllerExtensionName
        • extbase.controllerName
        • extbase.controllerActionName
        • variables
        • settings
        • dataProcessing
        • stdWrap
      • Example
    • HMENU
      • Example:
      • The .special property
        • special = directory
        • special = list
        • special = updated
          • Example for special = updated:
        • special = rootline
          • Example for special = rootline:
        • special = browse
        • special = keywords
        • special = categories
        • special = language
          • Example:
        • special = userfunction
          • Example: Creating hierarchical menus of custom links
    • IMAGE
      • layoutKey
      • layout
      • layout.layoutKey
      • layout.layoutKey.element
      • layout.layoutKey.source
      • sourceCollection
      • dataKey
      • dataKey.if
      • dataKey.pixelDensity
      • dataKey.width
      • dataKey.height
      • dataKey.maxW
      • dataKey.maxH
      • dataKey.minW
      • dataKey.minH
      • dataKey.quality
      • dataKey.*
      • Examples:
        • Standard rendering
        • Responsive/adaptive rendering
    • IMG_RESOURCE
    • LOAD_REGISTER
      • Example:
    • RECORDS
      • Properties
      • Introduction
      • Property details
        • source
        • categories
        • tables
        • conf
        • dontCheckPid
        • wrap
        • stdWrap
      • Examples
        • Selection with source
        • Selection with source II
        • Selection with categories
    • RESTORE_REGISTER
      • Example:
    • SVG
      • Example:
    • TEMPLATE
      • Example:
    • TEXT
      • Examples:
    • USER and USER_INT
      • userFunc
      • (properties you define)
      • stdWrap
      • Examples:
        • Example 1
        • Example 2
        • Example 3
        • Example 4
  • GIFBUILDER
    • GIFBUILDER
      • Note on (+calc)
      • The “_GIFBUILDER” Top Level Object
    • Object names in this section
      • TEXT
      • SHADOW
      • EMBOSS
      • OUTLINE
      • BOX
      • ELLIPSE
        • Example:
      • IMAGE
      • EFFECT
        • Syntax:
        • Example:
      • WORKAREA
      • CROP
      • SCALE
      • ADJUST
        • Example:
    • NON-Gifbuilder Objects
      • IMGMAP
  • MENU Objects
    • Common properties
      • showAccessRestrictedPages
    • Common item states for TMENU, GMENU and IMGMENU
    • [menu object].sectionIndex
      • The data-record /Behind the scene
    • GMENU
    • TMENU
    • TMENUITEM
    • IMGMENU
    • IMGMENUITEM
  • Appendix A – PHP include scripts
    • Including your script
      • $content
      • $conf
      • White spaces
      • $GLOBALS[‘TSFE’]->set_no_cache()
        • Example:
      • $this->cObjGetSingle(value, properties)
        • Example:
      • $this->stdWrap(value, properties)
        • Example:
      • Internal variables in the main frontend object, TSFE
      • Global variables
  • Linktargets
    • Targets For Cross-Referencing
TypoScript Reference
  • Docs »
  • Setup
  • Edit me on GitHub
Next Previous

Setup ¶

  • Top-level objects
  • plugin
  • config
  • constants
  • PAGE
  • meta
  • carray
Next Previous

View page source

© Copyright since 2000 by the TYPO3 Documentation Team

Last rendered on Aug 21, 2019 13:51

Built with Sphinx and t3SphinxThemeRtd. Report theme issues here.

Legal Info

Versions
Project
Home
Contact
Discussions
Issues
Repository
Downloads
Related Links v: master (10-dev)