Search
TypoScript Reference
Release:
11.5
Loading data.
Menu
Introduction
Using and setting TypoScript
Add TypoScript in the backend
Add TypoScript in your extension
Constants
The constant editor
Register
Debugging / analyzing
Simple data types
Top-level objects
CONFIG & config
constants
_GIFBUILDER
module
PAGE
PAGE Examples
plugin
temp, styles & lib
tt_*
resources
sitetitle
types
Content Objects (cObject)
Content objects (general information)
CASE
Content object array - COA, COA_INT
CONTENT
EDITPANEL
FILES
FLUIDTEMPLATE
dataProcessing
CommaSeparatedValueProcessor
DatabaseQueryProcessor
FilesProcessor
FlexFormProcessor
GalleryProcessor
LanguageMenuProcessor
MenuProcessor
SiteProcessor
SplitProcessor
Custom data processors
HMENU
Browse - previous and next links
Categories HMENU
Directory menu - menu of subpages
Keywords - menu of related pages
Language menu
List menu
Rootline - breadcrumb menu
Updated HMENU
Userfunction menu
IMAGE
IMG_RESOURCE
LOAD_REGISTER
RECORDS
RESTORE_REGISTER
SVG
TEXT
USER and USER_INT
MENU
TMENU
TMENUITEM
GIFBUILDER
GIFBUILDER
Object names in this section
Examples
NON-Gifbuilder Objects
Functions
cache
Calc
Data / getText
encapsLines
getEnv
HTMLparser
HTMLparser_tags
if
imageLinkWrap
imgResource
makelinks
numberFormat
numRows
optionSplit
parseFunc
replacement
round
select
split
stdWrap
strPad
tags
typolink
Conditions
Appendix A – PHP include scripts
Glossary
About This Manual
Sitemap
Index
Start
Index
How to edit
Edit on GitHub
Display settings
Use full width
Color scheme of code blocks:
dark
light
Make settings permanent
Index
Symbols
|
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
Symbols
(properties you define)
Content object USER
1, 2, 3, ...
Content object HMENU
1,2,3,4...
Content object COA
_
_numRows
Properties
A
absRefPrefix
Top level object 'config'
additionalHeaders
Top level object 'config'
addQueryString
Content object HMENU
addQueryString.exclude
Data processor LanguageMenuProcessor
align
Data type
altText
Content object IMAGE
alwaysActivePIDlist
Content object HMENU
array of cObjects
Content object CASE
array of field names
Content object LOAD_REGISTER
as
Data processor CommaSeparatedValueProcessor
Data processor DatabaseQueryProcessor
Data processor FilesProcessor
Data processor FlexFormProcessor
Data processor GalleryProcessor
Data processor LanguageMenuProcessor
Data processor MenuProcessor
Data processor SiteProcessor
Data processor SplitProcessor
B
begin
Content object FILES
Content object HMENU
boolean
Data type
borderEnabled
Data processor GalleryProcessor
borderPadding
Data processor GalleryProcessor
borderWidth
Data processor GalleryProcessor
C
cache
Content object CASE
Content object COA
Content object CONTENT
Content object HMENU
Content object RECORDS
Content object TEXT
Content object USER
cache_period
Content object HMENU
Call a PHP function
PHP
Call a PHP method
PHP
case
Data type
categories
Content object RECORDS
categories.relation
Content object RECORDS
cObject
see Content Objects
collections
Content object FILES
Data processor FilesProcessor
columnSpacing
Data processor GalleryProcessor
Conditions
Admin logged in
applicationContext
backend
backend.user
backend.user.isAdmin
backend.user.isLoggedIn
backend.user.userGroupIds
backend.user.userGroupList
backend.user.userId
compatVersion
Constant
date
feature
frontend
frontend.user
frontend.user.isLoggedIn
frontend.user.userGroupIds
frontend.user.userGroupList
frontend.user.userId
Functions
Functions frontend
getenv
getTSFE
ip
like
loginUser
page
Page level
Pid in rootline
Pid up in rootline
request
request.getCookieParams()
request.getHeaders()
request.getNormalizedParams()
request.getPageArguments()
request.getParsedBody()
request.getQueryParams()
session
site
siteLanguage
traverse
tree
tree.level
tree.pagelayout
tree.rootLine
tree.rootLineIds
tree.rootLineParentIds
typo3
typo3.branch
typo3.devIpMask
typo3.version
usergroup
Variables
workspace
workspace.isLive
workspace.isOffline
workspace.workspaceId
conf.[*table name*]
Content object RECORDS
config
admPanel
ATagParams
baseURL
cache
cache_clearAtMidnight
cache_period
compressCss
compressJs
concatenateCss
concatenateJs
contentObjectExceptionHandler
debug
disableAllHeaderCode
disableBodyTag
disableCanonical
disableCharsetHeader
disableHrefLang
disableImgBorderAttr
disableLanguageHeader
disablePageExternalUrl
disablePrefixComment
disablePreviewNotification
doctype
enableContentLengthHeader
endCacheHeaders_onlyWhenLoginDeniedInBranch
Extension configuration
extTarget
fileTarget
forceTypeValue
headerComment
htmlTag.attributes
htmlTag_setParams
htmlTag_stdWrap
index_descrLgd
index_enable
index_externals
index_metatags
inlineStyle2TempFile
intTarget
linkVars
message_preview
message_preview_workspace
moveJsFromHeaderToFooter
MP_defaults
MP_disableTypolinkClosestMPvalue
MP_mapRootPoints
namespaces
no_cache
noPageTitle
pageRendererTemplateFile
pageTitle
pageTitleFirst
pageTitleProviders
pageTitleSeparator
Properties
removeDefaultCss
removeDefaultJS
removePageCss
sendCacheHeaders
spamProtectEmailAddresses
spamProtectEmailAddresses_atSubst
spamProtectEmailAddresses_lastDotSubst
sword_noMixedCase
sword_standAlone
typolinkLinkAccessRestrictedPages
typolinkLinkAccessRestrictedPages_addParams
xhtmlDoctype
xmlprologue
Constants
debugging
Definition
Usage
CONTENT
Content object CASE
array of cObjects
cache
default
if
key
setCurrent
stdWrap
Content object COA
1,2,3,4...
cache
if
stdWrap
wrap
Content object CONTENT
cache
renderObj
select
slide
slide.collect
slide.collectFuzzy
slide.collectReverse
stdWrap
table
wrap
Content object FILES
begin
collections
files
folders
maxItems
references
references.fieldName
references.table
references.uid
renderObj
sorting
sorting.direction
stdWrap
Content object FLUIDTEMPLATE
dataProcessing
extbase.controllerActionName
extbase.controllerExtensionName
extbase.controllerName
extbase.pluginName
file
format
layoutRootPath
layoutRootPaths
partialRootPath
partialRootPaths
settings
stdWrap
template
templateName
templateRootPath
templateRootPaths
variables
Content object HMENU
1, 2, 3, ...
addQueryString
alwaysActivePIDlist
begin
cache
cache_period
entryLevel
excludeDoktypes
excludeUidList
if
includeNotInMenu
maxItems
minItems
protectLvar
special
special.value
stdWrap
wrap
Content object IMAGE
altText
emptyTitleHandling
file
if
imageLinkWrap
layout
layout.layoutKey
layout.layoutKey.element
layout.layoutKey.source
layoutKey
linkWrap
params
,
[1]
sourceCollection
sourceCollection.dataKey
sourceCollection.dataKey.*
sourceCollection.dataKey.height
sourceCollection.dataKey.if
sourceCollection.dataKey.maxH
sourceCollection.dataKey.maxW
sourceCollection.dataKey.minH
sourceCollection.dataKey.minW
sourceCollection.dataKey.pixelDensity
sourceCollection.dataKey.quality
sourceCollection.dataKey.width
stdWrap
titleText
wrap
Content object IMG_RESOURCE
file
stdWrap
Content object LOAD_REGISTER
array of field names
Content object RECORDS
cache
categories
categories.relation
conf.[*table name*]
dontCheckPid
source
stdWrap
tables
wrap
Content object SVG
height
renderMode
src
stdWrap
width
Content object TEXT
cache
stdWrap
value
Content object USER
(properties you define)
cache
stdWrap
userFunc
Content Objects
Content objects
Array
CASE
COA
COA_INT
CONTENT
Content object array
Database
EDITPANEL
FILES
FLUIDTEMPLATE
General
HMENU
IMAGE
IMAGE_RESOURCE
LOAD_REGISTER
Menu without Data Processor
PHP
RECORDS
RESTORE_REGISTER
Reusing
SQL
SVG
TEXT
USER
USER_INT
cropVariant
Data processor GalleryProcessor
D
Data processor CommaSeparatedValueProcessor
as
fieldDelimiter
fieldEnclosure
fieldName
if
maximumColumns
Data processor DatabaseQueryProcessor
as
dataProcessing
if
table
Data processor FilesProcessor
as
collections
files
folders
folders.recursive
if
references
references.fieldName
references.table
sorting
sorting.direction
Data processor FlexFormProcessor
as
fieldname
Data processor GalleryProcessor
as
borderEnabled
borderPadding
borderWidth
columnSpacing
cropVariant
dataProcessing
equalMediaHeight, equalMediaWidth
filesProcessedDataKey
if
maxGalleryWidth
maxGalleryWidthInText
mediaOrientation
numberOfColumns
Data processor LanguageMenuProcessor
addQueryString.exclude
as
if
languages
Data processor MenuProcessor
as
expandAll
includeSpacer
levels
titleField
Data processor SiteProcessor
as
Data processor SplitProcessor
as
delimiter
fieldName
filterIntegers
filterUnique
if
removeEmptyEntries
Data type
align
boolean
case
date-conf
degree
dir
function name
GraphicColor
imageExtension
imgResource
integer
path
pixels
positive integer
resource
strftime-conf
string
tag
tag-params
target
wrap
Database
count
select
DataProcessing
dataProcessing
Content object FLUIDTEMPLATE
Data processor DatabaseQueryProcessor
Data processor GalleryProcessor
date-conf
Data type
default
Content object CASE
degree
Data type
delimiter
Data processor SplitProcessor
dir
Data type
dontCheckPid
Content object RECORDS
E
emptyTitleHandling
Content object IMAGE
encapsLines
addAttributes
defaultAlign
encapsLinesStdWrap
encapsTagList
innerStdWrap_all
nonWrappedTag
remapTag
removeWrapping
stdWrap
wrapNonWrappedLines
entryLevel
Content object HMENU
equalMediaHeight, equalMediaWidth
Data processor GalleryProcessor
excludeDoktypes
Content object HMENU
excludeUidList
Content object HMENU
expandAll
Data processor MenuProcessor
extbase.controllerActionName
Content object FLUIDTEMPLATE
extbase.controllerExtensionName
Content object FLUIDTEMPLATE
extbase.controllerName
Content object FLUIDTEMPLATE
extbase.pluginName
Content object FLUIDTEMPLATE
F
fieldDelimiter
Data processor CommaSeparatedValueProcessor
fieldEnclosure
Data processor CommaSeparatedValueProcessor
fieldName
Data processor CommaSeparatedValueProcessor
Data processor SplitProcessor
fieldname
Data processor FlexFormProcessor
file
Content object FLUIDTEMPLATE
Content object IMAGE
Content object IMG_RESOURCE
FILES
references
files
Content object FILES
Data processor FilesProcessor
filesProcessedDataKey
Data processor GalleryProcessor
filterIntegers
Data processor SplitProcessor
filterUnique
Data processor SplitProcessor
FlexForm
FLUIDTEMPLATE
dataProcessing
Properties
folders
Content object FILES
Data processor FilesProcessor
folders.recursive
Data processor FilesProcessor
format
Content object FLUIDTEMPLATE
Function
getText
function name
Data type
Functions
cache
Calc
encapsLines
getEnv
HTMLparser
HTMLparser_tags
if
imageLinkWrap
imgResource
makelinks
numberFormat
numRows
optionSplit
parseFunc
replacement
round
select
split
stdWrap
strPad
tags
typolink
G
GIFBUILDER
ADJUST
BOX
CROP
EFFECT
ELLIPSE
EMBOSS
Examples
IMAGE
IMGMAP
Objects
OUTLINE
SCALE
SHADOW
TEXT
Top level object
WORKAREA
GraphicColor
Data type
H
height
Content object SVG
HMENU
,
[1]
special
special = browse
special = categories
,
[1]
special = directory
special = keywords
special = list
special = rootline
special = updated
special = userfunction
HTMLparser
allowTags
globalNesting
htmlSpecialChars
keepNonMatchedTags
localNesting
noAttrib
removeTags
rmTagIfNoAttrib
stdWrap
stripEmptyTags
stripEmptyTags.keepTags
tags
HTMLparser_tags
allowedAttribs
fixAttrib.[attribute].always
fixAttrib.[attribute].casesensitiveComp
fixAttrib.[attribute].default
fixAttrib.[attribute].list
fixAttrib.[attribute].prefixLocalAnchors
fixAttrib.[attribute].prefixRelPathWith
fixAttrib.[attribute].range
fixAttrib.[attribute].removeIfEquals
fixAttrib.[attribute].removeIfFalse
fixAttrib.[attribute].set
fixAttrib.[attribute].unset
fixAttrib.[attribute].userFunc
nesting
overrideAttribs
protect
remap
rmTagIfNoAttrib
I
if
bitAnd
Content object CASE
Content object COA
Content object HMENU
Content object IMAGE
Data processor CommaSeparatedValueProcessor
Data processor DatabaseQueryProcessor
Data processor FilesProcessor
Data processor GalleryProcessor
Data processor LanguageMenuProcessor
Data processor SplitProcessor
directReturn
equals
Explanation
isFalse
isGreaterThan
isInList
isLessThan
isNull
isPositive
isTrue
negate
value
IMAGE
layout
layout.layoutKey
layout.layoutKey.element
layout.layoutKey.source
layoutKey
Responsive rendering example
sourceCollection
sourceCollection.dataKey
sourceCollection.dataKey.*
sourceCollection.dataKey.height
sourceCollection.dataKey.if
sourceCollection.dataKey.maxH
sourceCollection.dataKey.maxW
sourceCollection.dataKey.minH
sourceCollection.dataKey.minW
sourceCollection.dataKey.pixelDensity
sourceCollection.dataKey.quality
sourceCollection.dataKey.width
Standard rendering example
imageExtension
Data type
imageLinkWrap
Content object IMAGE
effects
JSwindow
Properties
sample
imgResource
crop
Data type
import
params
Properties
stripProfile
treatIdAsReference
imgResource;
includeNotInMenu
Content object HMENU
includeSpacer
Data processor MenuProcessor
integer
Data type
K
key
Content object CASE
L
languages
Data processor LanguageMenuProcessor
layout
Content object IMAGE
layout.layoutKey
Content object IMAGE
layout.layoutKey.element
Content object IMAGE
layout.layoutKey.source
Content object IMAGE
layoutKey
Content object IMAGE
layoutRootPath
Content object FLUIDTEMPLATE
layoutRootPaths
Content object FLUIDTEMPLATE
levels
Data processor MenuProcessor
Link handler
email
file
folder
page
record
url
linkWrap
Content object IMAGE
M
makelinks
Properties
maxGalleryWidth
Data processor GalleryProcessor
maxGalleryWidthInText
Data processor GalleryProcessor
maximumColumns
Data processor CommaSeparatedValueProcessor
maxItems
Content object FILES
Content object HMENU
mediaOrientation
Data processor GalleryProcessor
MENU
see HMENU
minItems
Content object HMENU
module
view.partialRootPaths
view.templateRootPaths
N
numberFormat
stdWrap
numberformat
Properties
numberOfColumns
Data processor GalleryProcessor
O
optionSplit
Functions
P
PAGE
bodyTag
bodyTagCObject
config
Content objects
CSS_inlineStyle
cssInline.[array]
Examples
footerData.[array]
headerData.[array]
headTag
includeCSS.[array]
includeCSSLibs.[array]
includeJS.[array]
includeJSFooter.[array]
includeJSFooterlibs.[array]
includeJSLibs.[array]
inlineLanguageLabelFiles
inlineSettings
jsFooterInline.[array]
jsInline.[array]
meta
Multiple pages
Properties
shortcutIcon
typeNum
,
[1]
PAGE;
params
Content object IMAGE
,
[1]
parseFunc
allowTags
constants
denyTags
externalBlocks
makelinks
plainTextStdWrap
short
stdWrap
sword
parsefunc
Properties
partialRootPath
Content object FLUIDTEMPLATE
partialRootPaths
Content object FLUIDTEMPLATE
path
Data type
PHP
Call a PHP function
Call a PHP method
pixels
Data type
plugin
positive integer
Data type
protectLvar
Content object HMENU
R
RECORDS
categories
conf
dontCheckPid
Properties
Selection with categories
Selection with source
,
[1]
source
tables
references
Content object FILES
Data processor FilesProcessor
references.fieldName
Content object FILES
Data processor FilesProcessor
references.table
Content object FILES
Data processor FilesProcessor
references.uid
Content object FILES
Registers
Loading
Restoring
removeEmptyEntries
Data processor SplitProcessor
renderMode
Content object SVG
renderObj
Content object CONTENT
Content object FILES
replacement
Properties
stdWrap
resource
Data type
round
Properties
stdWrap
S
select
Content object CONTENT
Properties
,
[1]
,
[2]
setCurrent
Content object CASE
settings
Content object FLUIDTEMPLATE
Simple data types
strftime-conf
tag-params
target
wrap
slide
Content object CONTENT
slide.collect
Content object CONTENT
slide.collectFuzzy
Content object CONTENT
slide.collectReverse
Content object CONTENT
sorting
Content object FILES
Data processor FilesProcessor
sorting.direction
Content object FILES
Data processor FilesProcessor
source
Content object RECORDS
sourceCollection
Content object IMAGE
sourceCollection.dataKey
Content object IMAGE
sourceCollection.dataKey.*
Content object IMAGE
sourceCollection.dataKey.height
Content object IMAGE
sourceCollection.dataKey.if
Content object IMAGE
sourceCollection.dataKey.maxH
Content object IMAGE
sourceCollection.dataKey.maxW
Content object IMAGE
sourceCollection.dataKey.minH
Content object IMAGE
sourceCollection.dataKey.minW
Content object IMAGE
sourceCollection.dataKey.pixelDensity
Content object IMAGE
sourceCollection.dataKey.quality
Content object IMAGE
sourceCollection.dataKey.width
Content object IMAGE
special
Content object HMENU
special.value
Content object HMENU
split
stdWrap
src
Content object SVG
stdWrap
addPageCacheTags
age
append
br
brTag
bytes
cache
case
char
cObject
Content object CASE
Content object COA
Content object CONTENT
Content object FILES
Content object FLUIDTEMPLATE
Content object HMENU
Content object IMAGE
Content object IMG_RESOURCE
Content object RECORDS
Content object SVG
Content object TEXT
Content object USER
Content-supplying properties
crop
cropHTML
csConv
current
data
dataWrap
date
debug
debugData
debugFunc
doubleBrTag
editIcons
editPanel
encapsLines
encodeForJavaScriptValue
field
fieldRequired
Getting data
hash
HTMLparser
htmlSanitize
htmlSpecialChars
if
ifBlank
ifEmpty
ifNull
innerWrap
innerWrap2
insertData
intval
keywords
lang
listNum
noTrimWrap
numberFormat
numRows
orderedStdWrap
outerWrap
override
Override and conditions
parseFunc
Parsing data
postCObject
postUserFunc
postUserFuncInt
preCObject
prefixComment
preIfEmptyListNum
prepend
preUserFunc
prioriCalc
rawUrlEncode
Recursive call
replacement
required
round
setContentToCurrent
setCurrent
split
strftime
stripHtml
strPad
strtotime
substring
trim
typolink
wrap
wrap2
wrap3
wrapAlign
strftime-conf
Data type
string
Data type
strPad
Properties
SVG
Properties
T
table
Content object CONTENT
Data processor DatabaseQueryProcessor
tables
Content object RECORDS
tag
Data type
tag-params
Data type
tags
Properties
,
[1]
target
Data type
template
Content object FLUIDTEMPLATE
templateName
Content object FLUIDTEMPLATE
templateRootPath
Content object FLUIDTEMPLATE
templateRootPaths
Content object FLUIDTEMPLATE
TEXT
Properties
titleField
Data processor MenuProcessor
titleText
Content object IMAGE
TMENU
Item states
properties
sectionIndex
showAccessRestrictedPages
TMENUITEM
Top level object 'config'
absRefPrefix
additionalHeaders
Top-level objects
_GIFBUILDER
config
constants
lib
module
page
plugin
resources
sitetitle
styles
temp
tt_content
types
typolink
additionalParams
addQueryString
ATagBeforeWrap
ATagParams
extTarget
fileTarget
forceAbsoluteUrl
JSwindow_params
language
Link handler syntax
linkAccessRestrictedPages
no_cache
parameter
Resource references
returnLast
section
stdWrap
target
title
userFunc
TypoScript
Add in the backend
Analyzer
Constants debugging
Debugging
Debugging stdWrap
Debugging TMENU
Include as file
Include from extensions
Include other TypoScript templates
Register usage
Syntax errors
Using and setting
TypoScript in extensions
File locations
Load always
Static includes
U
USER
Properties
USER_INT
Properties
userFunc
Content object USER
V
value
Content object TEXT
variables
Content object FLUIDTEMPLATE
W
width
Content object SVG
wrap
Content object COA
Content object CONTENT
Content object HMENU
Content object IMAGE
Content object RECORDS
Data type