config

In typo3/sysext/frontend/Classes/ this is known as $GLOBALS['TSFE']->config['config'], thus the property "debug" below is accessible as $GLOBALS['TSFE']->config['config']['debug'].

Properties

Property Data Type Default
absRefPrefix string  
additionalHeaders array with numeric indices  
admPanel boolean  
ATagParams <A>-params  
baseURL string  
beLoginLinkIPList [IP-number]  
beLoginLinkIPList_login HTML code  
beLoginLinkIPList_logout HTML code  
cache array  
cache_clearAtMidnight boolean false
cache_period integer 86400 (= 24 hours)
compensateFieldWidth double  
compressCss boolean  
compressJs boolean  
concatenateCss boolean  
concatenateJs boolean  
concatenateJsAndCss boolean 0
content_from_pid_allowOutsideDomain boolean  
contentObjectExceptionHandler array  
debug boolean  
defaultGetVars array  
disableAllHeaderCode boolean false
disableBodyTag boolean 0
disableCharsetHeader boolean  
disableImgBorderAttr boolean  
disablePageExternalUrl boolean  
disablePrefixComment boolean  
disablePreviewNotification boolean 0
disableLanguageHeader boolean 0
doctype string  
doctypeSwitch boolean / string  
enableContentLengthHeader boolean 1
extTarget target _top
fileTarget target  
forceTypeValue integer  
formMailCharset string  
frameReloadIfNotInFrameset boolean  
ftu boolean false
headerComment string  
htmlTag_dir string  
htmlTag_langKey string en
htmlTag_setParams string  
htmlTag_stdWrap stdWrap  
index_descrLgd integer 200
index_enable boolean  
index_externals boolean  
index_metatags boolean true
inlineStyle2TempFile boolean  
intTarget target  
language string  
language_alt string  
linkVars list  
locale_all string  
lockFilePath string fileadmin/
mainScript string index.php
message_page_is_being_generated string  
message_preview string  
message_preview_workspace string  
metaCharset string utf-8
moveJsFromHeaderToFooter boolean  
MP_defaults string  
MP_disableTypolinkClosestMPvalue boolean  
MP_mapRootPoints list of PIDs/string  
namespaces (array of strings)  
no_cache boolean 0
noPageTitle integer 0
noScaleUp boolean  
pageGenScript resource typo3/sysext/frontend/Classes/Page/PageGenerator.php
pageRendererTemplateFile string  
pageTitle stdWrap  
pageTitleFirst boolean 0
pageTitleSeparator string /stdWrap `: ` (colon with following space)
prefixLocalAnchors string  
removeDefaultCss boolean  
removeDefaultJS boolean / string  
removePageCss boolean  
sendCacheHeaders boolean  
sendCacheHeaders_onlyWhenLoginDeniedInBranch boolean  
setJS_mouseOver boolean  
setJS_openPic boolean  
spamProtectEmailAddresses "ascii" /  
spamProtectEmailAddresses_atSubst string (at)
spamProtectEmailAddresses_lastDotSubst string . (just a simple dot)
sword_noMixedCase boolean  
sword_standAlone boolean  
sys_language_isocode string  
sys_language_isocode_default string  
sys_language_mode string  
sys_language_overlay boolean / keyword  
sys_language_softExclude string  
sys_language_softMergeIfNotBlank string  
sys_language_uid integer  
titleTagFunction function name  
tx_[extension key with no underscores]_[*] -  
typolinkCheckRootline boolean  
typolinkEnableLinksAcrossDomains boolean 0
typolinkLinkAccessRestrictedPages integer (page id) / keyword "NONE"  
typolinkLinkAccessRestrictedPages_addParams string  
USERNAME_substToken string <!--###USERNAME###-->
USERUID_substToken string  
xhtmlDoctype string  
xmlprologue string  

Property details

absRefPrefix

Property

absRefPrefix

Data type

string

Description

If this value is set, then all relative links in TypoScript are prepended with this string.

Examples:

  1. Prefixing all links with a "/" results in absolute link paths:

    config.absRefPrefix = /
    
  2. Prefixing all links with the path to a subdirectory:

    config.absRefPrefix = /some-subsite/
    
  3. Prefixing all links with a URI scheme:

    config.absRefPrefix = http://example.com/
    

Special keyword: "auto" lets TYPO3 autodetect the site root based on path prefixes (and not based on host name variables from the server, making this value safe for multi-domain environments).

Note: Using an URI in absRefPrefix will require additional conditions if you use different domains for your deployment stages in CI environments.

Note: If you're working on a server where you have different domain names or different path segments leading to the same page (e.g. for internal and external access), you might do yourself a favor and set absRefPrefix to the URL and path of your site, e.g. https://typo3.org/. If you do not, you risk to render pages to cache from the internal network and thereby prefix image-references and links with a wrong path or a path not accessible from outside.

additionalHeaders

Property

additionalHeaders

Data type

array with numeric indices

Description

This property can be used to define additional HTTP headers.

For each numeric index, there are the following sub-properties:

header: The header string.

replace: Optional. If set, previous headers with the same name are replaced with the current one. Default is "1".

httpResponseCode: Optional. HTTP status code as an integer.

Example:

config.additionalHeaders {
   10 {
      # The header string
      header = WWW-Authenticate: Negotiate

      # Do not replace previous headers with the same name.
      replace = 0

      # Force a 401 HTTP response code
      httpResponseCode = 401
   }
   # Always set cache headers to private, overwriting the default TYPO3 Cache-control header
   20.header = Cache-control: Private
}

By default TYPO3 sends a "Content-Type" header with the defined encoding, unless this is disabled using config.disableCharsetHeader (see above). It then sends cache headers, if configured (see above). Then come the additional headers, plus finally a "Content-Length" header, if enabled (see below).

admPanel

Property

admPanel

Data type

boolean

Description

If set, the admin panel appears in the bottom of pages.

Note: In addition the panel must be enabled for the user as well, using the TSconfig for the user! See the TSconfig reference about additional admin panel properties.

ATagParams

Property

ATagParams

Data type

<A>-params

Description

Additional parameters to all links in TYPO3 (excluding menu-links).

baseURL

Property

baseURL

Data type

string

Description

This writes the <base> tag in the header of the document. Set this to the value that is expected to be the URL and append a "/" to the end of the string.

Example:

config.baseURL = http://typo3.org/sub_dir/

beLoginLinkIPList

Property

beLoginLinkIPList

Data type

[IP-number]

Description

If set and REMOTE_ADDR matches one of the listed IP-numbers (Wild- card, *, allowed) then a link to the typo3/ login script with redirect pointing back to the page is shown.

Note: beLoginLinkIPList_login and/or beLoginLinkIPList_logout (see below) must be defined if the link should show up!

beLoginLinkIPList_login

Property

beLoginLinkIPList_login

Data type

HTML

Description

HTML code wrapped with the login link, see 'beLoginLinkIPList'

Example:

<hr /><b>LOGIN</b>

beLoginLinkIPList_logout

Property

beLoginLinkIPList_logout

Data type

HTML

Description

HTML code wrapped with the logout link, see above

cache

Property

cache

Data type

array

Description

Determine the maximum cache lifetime of a page.

The maximum cache lifetime of a page can not only be determined by the start and stop times of content elements on the page itself, but also by arbitrary records on any other page. However, the page has to be configured so that TYPO3 knows the start and stop times of which records to include. Otherwise, the cache entry will be used although a start/stop date already passed by.

To include records of type <table name> on page <pid> into the cache lifetime calculation of page <page-id>, add the following TypoScript:

config.cache.<page-id> = <table name>:<pid>

Multiple record sources can be added as comma-separated list, see the examples.

You can use the keyword "all" instead of a <page-id> to consider records for the cache lifetime of all pages.

Examples:

config.cache.10 = fe_users:2

This includes the fe_users records on page 2 in the cache lifetime calculation for page 10:

config.cache.10 = fe_users:2,tt_news:11

This includes records from multiple sources, namely the fe_users records on page 2 and the tt_news records on page 11:

config.cache.all = fe_users:2

Consider the fe_user records on page 2 for the cache lifetime of all pages.

cache_clearAtMidnight

Property

cache_clearAtMidnight

Data type

boolean

Description

With this setting the cache always expires at midnight of the day, the page is scheduled to expire.

Default

false

cache_period

Property

cache_period

Data type

integer

Description

The number of second a page may remain in cache.

This value is overridden by the value set in the page-record (field="cache_timeout") if this value is greater than zero.

Default

86400 (= 24 hours)

compensateFieldWidth

Property

compensateFieldWidth

Data type

double

Description

This floating point value will be used by the FORMS cObject to compensate the length of the form fields text and input.

This option may be overridden by the property of the same name in the FORMS cObject.

compressCss

Property

compressCss

Data type

boolean

Description

If set, CSS files referenced in page.includeCSS and the like will be minified and compressed. Does not work on files, which are referenced in page.headerData.

Minification will remove all excess space. The more significant compression step (using gzip compression) requires $TYPO3_CONF_VARS['FE']['compressionLevel'] to be enabled in the Install Tool. For this to work you also need to activate the gzip- related compressionLevel options in .htaccess, as otherwise the compressed files will not be readable by the user agent.

Example:

config.compressCss = 1

Note: TYPO3 comes with a built-in compression handler, but you can also register your own one using $GLOBALS['TYPO3_CONF_VARS']['FE']['cssCompressHandler'].

Example:

$GLOBALS['TYPO3_CONF_VARS']['FE']['cssCompressHandler'] =
   TYPO3\CMS\Core\Extension\ExtensionManager::extPath($_EXTKEY) .
   'Classes/class.tx_myext_cssCompressHandler.php:tx_myext_cssCompressHandler->compressCss';

Default

0

compressJs

Property

compressJs

Data type

boolean

Description

Enabling this option together with $TYPO3_CONF_VARS['FE']['compressionLevel'] in the Install Tool delivers Frontend JavaScript files referenced in page.includeJS and the like using GZIP compression. Does not work on files, which are referenced in page.headerData.

This can significantly reduce file sizes of linked JavaScript files and thus decrease loading times.

Please note that this requires .htaccess to be adjusted, as otherwise the files will not be readable by the user agent. Please see the description of $TYPO3_CONF_VARS['FE']['compressionLevel'] in the Install Tool.

Example:

config.compressJs = 1

Note: TYPO3 comes with a built-in compression handler, but you can also register your own one using $GLOBALS['TYPO3_CONF_VARS']['FE']['jsCompressHandler'].

Example:

$GLOBALS['TYPO3_CONF_VARS']['FE']['jsCompressHandler'] =
   TYPO3\CMS\Core\Extension\ExtensionManager::extPath($_EXTKEY) .
   'Classes/class.tx_myext_jsCompressHandler.php:tx_myext_jsCompressHandler->compressJs';

Default

0

concatenateCss

Property

concatenateCss

Data type

boolean

Description

Setting config.concatenateCss merges Stylesheet files referenced in the Frontend in page.includeCSS and the like together. Files are merged only, if their media attribute has the same value, e.g. if it is "all" for several files. Does not work on files, which are referenced in page.headerData.

Example:

config.concatenateCss = 1

Note: TYPO3 comes with a built-in concatenation handler, but you can also register your own one using $GLOBALS['TYPO3_CONF_VARS']['FE']['cssConcatenateHandler'].

Example:

$GLOBALS['TYPO3_CONF_VARS']['FE']['cssConcatenateHandler'] =
   TYPO3\CMS\Core\Extension\ExtensionManager::extPath($_EXTKEY) .
   'Classes/class.tx_myext_cssConcatenateHandler.php:tx_myext_cssConcatenateHandler->concatenateCss';

Default

0

concatenateJs

Property

concatenateJs

Data type

boolean

Description

Setting config.concatenateJs merges JavaScript files referenced in the Frontend in page.includeJS and the like together. Does not work on files, which are referenced in page.headerData.

Example:

config.concatenateJs = 1

Note: TYPO3 comes with a built-in concatenation handler, but you can also register your own one using $GLOBALS['TYPO3_CONF_VARS']['FE']['jsConcatenateHandler'].

Example:

$GLOBALS['TYPO3_CONF_VARS']['FE']['jsConcatenateHandler'] =
   TYPO3\CMS\Core\Extension\ExtensionManager::extPath($_EXTKEY) .
   'Classes/class.tx_myext_jsConcatenateHandler.php:tx_myext_jsConcatenateHandler->concatenateJs';

Default

0

concatenateJsAndCss

Property

concatenateJsAndCss

Data type

boolean

Description

Setting config.concatenateJsAndCss bundles JS and CSS files in the FE.

Example:

config.concatenateJsAndCss = 1

Note: TYPO3 comes with a built-in concatenation handler, but you can also register your own one using $GLOBALS['TYPO3_CONF_VARS']['FE']['concatenateHandler'].

Example:

$GLOBALS['TYPO3_CONF_VARS']['FE']['concatenateHandler'] =
   TYPO3\CMS\Core\Extension\ExtensionManager::extPath($_EXTKEY) .
   'Classes/class.tx_myext_concatenateHandler.php:tx_myext_concatenateHandler->concatenateFiles';

Note: This property was deprecated and is planned to be removed! Use config.concatenateJs and config.concatenateCss instead.

Default

0

content_from_pid_allowOutsideDomain

Property
content_from_pid_allowOutsideDomain
Data type
boolean
Description

Using the "Show content from this page instead" feature allows you to insert content from the current domain only. Setting this option will allow content included from anywhere in the page tree!

Another use case is mount points: By means of the page type "Mount Point" you can virtually insert a whole subtree from somwhere else by just pointing to it. However, usually this only works within the page tree of the given domain. Setting config.content_from_pid_allowOutsideDomain = 1 removes that restriction.

Keywords: mountpoint

contentObjectExceptionHandler

Property

contentObjectExceptionHandler

Data type

array

Description

Exceptions which occur during rendering of content objects (typically plugins) will now be caught by default in production context and an error message is shown along with the rendered output.

If this is done, the page will remain available while the section of the page that produces an error (i.e. throws an exception) will show a configurable error message. By default this error message contains a random code which references the exception and is also logged by the logging framework for developer reference.

Usage

# Use 1 for the default exception handler (enabled by default in production context)
config.contentObjectExceptionHandler = 1

# Use a class name for individual exception handlers
config.contentObjectExceptionHandler = TYPO3\CMS\Frontend\ContentObject\Exception\ProductionExceptionHandler

# Customize the error message. A randomly generated code is replaced within the message if needed.
config.contentObjectExceptionHandler.errorMessage = Oops an error occurred. Code: %s

# Configure exception codes which will not be handled, but bubble up again (useful for temporary fatal errors)
tt_content.login.20.exceptionHandler.ignoreCodes.10 = 1414512813

# Disable the exception handling for an individual plugin/ content object
tt_content.login.20.exceptionHandler = 0

# ignoreCodes and errorMessage can be both configured globally …
config.contentObjectExceptionHandler.errorMessage = Oops an error occurred. Code: %s
config.contentObjectExceptionHandler.ignoreCodes.10 = 1414512813

# … or locally for individual content objects
tt_content.login.20.exceptionHandler.errorMessage = Oops an error occurred. Code: %s
tt_content.login.20.exceptionHandler.ignoreCodes.10 = 1414512813

Important

Instead of breaking the whole page when an exception occurs, an error message is shown for the part of the page that is broken. Be aware that unlike before, it is now possible that a page with error message gets cached.

To get rid of the error message not only the actual error needs to be fixed, but the cache must be cleared for this page.

debug

Property

debug

Data type

boolean

Description

If set any debug-information in the TypoScript code is output. This applies e.g. to menu objects and the parsetime output.

defaultGetVars

Property

defaultGetVars

Data type

array

Description

Allows to set default values for GET parameters. Default value is taken only if the GET parameter isn't defined. Array notation is done with dots, e.g.:

test[var1] will be written as text.var1

Example:

config.defaultGetVars {
    test.var1.var2.p3 = 15
    L = 3
}

disableAllHeaderCode

Property

disableAllHeaderCode

Data type

boolean

Description

If this is set, none of the features of the PAGE object is processed and the content of the page will be the result of the cObject array (1,2,3,4...) of the PAGE object. This means that the result of the cObject should include everything from the <HTML> .... to the </HTML> tag!

Use this feature in templates supplying other content-types than HTML. That could be an image or a WAP-page!

Default

false

disableBodyTag

Property
disableBodyTag
Data type
boolean
Description

If this option is set the TYPO3 core will not generate the opening <body ...> part of the body tag. The closing </body> is not affected and will still be issued.

disableBodyTag takes precedence over the page properties bodyTagCObject, bodyTag, bodyTagMargins and bodyTagAdd. With config.disableBodyTag =1 the others are ignored and don't have any effect.

Default
0 (false)

disableCharsetHeader

Property

disableCharsetHeader

Data type

boolean

Description

By default a HTTP header "content-type:text/html; charset..." is sent. This option will disable that.

disableImgBorderAttr

Property

disableImgBorderAttr

Data type

boolean

Description

Returns the 'border' attribute for an <img> tag only if the doctype is not xhtml_strict or xhtml_11 or if the config parameter 'disableImgBorderAttr' is not set

disablePageExternalUrl

Property

disablePageExternalUrl

Data type

boolean

Description

If set, pages with doktype "External Url" will not trigger jumpUrl in TSFE. This may help you to have external URLs open inside you framesets.

disablePrefixComment

Property

disablePrefixComment

Data type

boolean

Description

If set, the stdWrap property "prefixComment" will be disabled, thus preventing any revealing and space-consuming comments in the HTML source code.

disablePreviewNotification

Property

disablePreviewNotification

Data type

boolean

Description

Disables the "preview" notification box completely.

Default

0

disableLanguageHeader

Property

disableLanguageHeader

Data type

boolean

Description

TYPO3 by default sends a "Content-language: XX" HTTP header, where "XX" is the ISO code of the according lanuage.

For the default language (sys_language_uid=0), this header is based on the value of config.sys_language_isocode_default. If this is unset, config.language is used. If that is unset as well, it finally falls back to "en".

For other languages, it uses the value from language_isocode from sys_language. That value may be overwritten by config.sys_language_isocode.

If config.disableLanguageHeader is set, this header will not be sent.

Default

0

doctype

Property

doctype

Data type

string

Description

If set, then a document type declaration (and an XML prologue) will be generated. The value can either be a complete doctype or one of the following keywords:

xhtml_trans for the XHTML 1.0 Transitional doctype.

xhtml_frames for the XHTML 1.0 Frameset doctype.

xhtml_strict for the XHTML 1.0 Strict doctype.

xhtml_basic for the XHTML basic doctype.

xhtml_11 for the XHTML 1.1 doctype.

xhtml+rdfa_10 for the XHTML+RDFa 1.0 doctype.

html5 for the HTML5 doctype.

none for no doctype at all.

Note

Keywords also change the way TYPO3 generates some of the XHTML tags to ensure valid XML. If you set doctype to a string, then you must also set config.xhtmlDoctype (see below).

See config.htmlTag_setParams and comfig.htmlTag_langKey for more details on the effect on the HTML tag.

Default is the HTML 5 doctype:

<!DOCTYPE html>

doctypeSwitch

Property

doctypeSwitch

Data type

boolean / string

Description

If set, the order of <?xml...> and <!DOCTYPE...> will be reversed. This is needed for MSIE to be standards compliant with XHTML.

Background:

By default TYPO3 outputs the XML/DOCTYPE in compliance with the standards of XHTML. However a browser like MSIE will still run in "quirks-mode" unless the <?xml> and <DOCTYPE> tags are ordered opposite. But this breaks CSS validation...

With this option designers can decide for themselves what they want then.

If you want to check the compatibility-mode of your webbrowser you can do so with a simple JavaScript that can be inserted on a TYPO3 page like this:

page.headerData.1 = TEXT
page.headerData.1.value = <script>alert(document.compatMode);</script>

If your browser has detected the DOCTYPE correctly it will report "CSS1Compat"

If you are not running in compliance mode you will get some other message. MSIE will report "BackCompat" for instance - this means it runs in quirks-mode, supporting all the old "browser-bugs".

enableContentLengthHeader

Property

enableContentLengthHeader

Data type

boolean

Description

If set, a header "content-length: [bytes of content]" is sent.

If the Backend user is logged in, this is disabled. The reason is that the content length header cannot include the length of these objects and the content-length will cut off the length of the document in some browsers.

Default

1

extTarget

Property

extTarget

Data type

target

Description

Default external target. Used by typolink if no extTarget is set

Default

_top

fileTarget

Property

fileTarget

Data type

target

Description

Default file link target. Used by typolink if no fileTarget is set.

forceTypeValue

Property

forceTypeValue

Data type

integer

Description

Force the &type value of all TYPO3 generated links to a specific value (except if overruled by local forceTypeValue values).

Useful if you run a template with special content at - say &type=95 - but still wants to keep your targets neutral. Then you set your targets to blank and this value to the type value you wish.

formMailCharset

Property

formMailCharset

Data type

string

Description

Character set of mails sent through TYPO3 mail forms. If it is unset, the character set defined in config.metaCharset is used.

Default

"" (unset)

frameReloadIfNotInFrameset

Property

frameReloadIfNotInFrameset

Data type

boolean

Description

If set, then the current page will check if the page object name (e.g. "page" or "frameset") exists as "parent.[name]" (e.g. "parent.page") and if not the page will be reloaded in top frame. This secures that links from search engines to pages inside a frameset will load the frameset.

Works only with type-values different from zero.

ftu

Property

ftu

Data type

boolean

Description

If set, the "&ftu=...." GET-fallback identification is inserted.

"&ftu=[hash]" is always inserted in the links on the first page a user hits. If it turns out in the next hit that the user has cookies enabled, this variable is not set anymore as the cookies does the job. If no cookies is accepted the "ftu" remains set for all links on the site and thereby we can still track the user.

You should not set this feature if grabber-spiders like Teleport are going to grab your site!

You should not set this feature if you want search-engines to index your site.

You can also ignore this feature if you're certain, website users will use cookies.

"ftu" means fe_typo_user ("fe" is "frontend").

Default

false

headerComment

Property

headerComment

Data type

string

Description

The content is added before the "TYPO3 Content Management Framework" comment in the <head> section of the page. Use this to insert a note like that "Programmed by My-Agency".

htmlTag_dir

Property

htmlTag_dir

Data type

string

Description

Sets text direction for whole document (useful for display of Arabic, Hebrew pages).

Basically the value becomes the attribute value of "dir" for the <html> tag.

Values:

rtl = Right-To-Left (for Arabic / Hebrew)

ltr = Left-To-Right (Default for other languages)

Example:

config.htmlTag_dir = rtl

htmlTag_langKey

Property

htmlTag_langKey

Data type

string

Description

Allows you to set the language value for the attributes "xml:lang" and "lang" in the <html> tag (when using "config.doctype = xhtml*").

The values must follow the format specified in IETF RFC 3066

Example:

config.htmlTag_langKey = en-US

Default

en

htmlTag_setParams

Property

htmlTag_setParams

Data type

string

Description

Sets the attributes for the <html> tag on the page. If you set "config.doctype" to a keyword enabling XHTML then some attributes are already set. This property allows you to override any preset attributes with your own content if needed.

Special: If you set it to "none" then no attributes will be set at any event.

Example:

config.htmlTag_setParams = xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US"

htmlTag_stdWrap

Property

htmlTag_stdWrap

Data type

->stdWrap

Description

Modify the whole <html> tag with stdWrap functionality. This can be used to extend or override this tag.

index_descrLgd

Property

index_descrLgd

Data type

integer

Description

This indicates how many chars to preserve as description for an indexed page. This may be used in the search result display.

Default

200

index_enable

Property

index_enable

Data type

boolean

Description

Enables cached pages to be indexed. Automatically enabled when EXT:indexed_search is enabled.

index_externals

Property

index_externals

Data type

boolean

Description

If set, external media linked to on the pages is indexed as well. Automatically enabled when EXT:indexed_search is enabled.

index_metatags

Property

index_metatags

Data type

boolean

Description

This allows to turn on or off the indexing of metatags. It is turned on by default.

Default

true

inlineStyle2TempFile

Property

inlineStyle2TempFile

Data type

boolean

Description

If set, the inline styles TYPO3 controls in the core are written to a file, typo3temp/assets/css/stylesheet_[hashstring].css, and the header will only contain the link to the stylesheet.

The file hash is based solely on the content of the styles.

Example:

config.inlineStyle2TempFile = 0

Default

1

intTarget

Property

intTarget

Data type

target

Description

Default internal target. Used by typolink if no target is set

language

Property

language

Data type

string

Description

Language key. See stdWrap.lang for more information.

Select between:

English (default) = [empty]

Danish = dk

German = de

Norwegian = no

Italian = it

etc...

The value must correspond to the key used for the backend system language if there is one. See inside typo3/sysext/core/Classes/Localization/Locales.php or look at the translation page on typo3.org for the official 2-byte key for a given language. Notice that selecting the official key is important if you want to get labels in the correct language from "locallang" files.

If the language you need is not yet a system language in TYPO3 you can use an artificial string of your choice and provide values for it via the TypoScript template where the property "_LOCAL_LANG" for most plugins will provide a way to override/add values for labels. The keys to use must be looked up in the locallang-file used by the plugin of course.

language_alt

Property

language_alt

Data type

string

Description

If "config.language" (above) is used, this can be set to another language key which will be used for labels if a label was not found for the main language. For instance a brazil portuguese website might specify "pt" as alternative language which means the portuguese label will be shown if none was available in the main language, brazil portuguese. This feature makes sense if one language is incompletely translated and close to another language.

linkVars

Property

linkVars

Data type

list

Description

HTTP_GET_VARS, which should be passed on with links in TYPO3. This is compiled into a string stored in $GLOBALS['TSFE']->linkVars

The values are rawurlencoded in PHP.

You can specify a range of valid values by appending a () after each value. If this range does not match, the variable won't be appended to links. This is very important to prevent that the cache system gets flooded with forged values.

The range may contain one of these values:

  • [a]-[b] -A range of allowed integer values
  • int -Only integer values are allowed
  • [a]|[b]|[c] -A list of allowed strings (whitespaces will be removed)
  • /[regex]/ -Match against a regular expression (PCRE style)

Example:

config.linkVars = L, print

This will add "&L=[L-value]&print=[print-value]" to all links in TYPO3.

config.linkVars = L(1-3), print

Same as above, but "&L=[L-value]" will only be added if the current value is 1, 2 or 3.

Note: Do not include the "type" parameter in the linkVars list, as this can result in unexpected behavior.

locale_all

Property

locale_all

Data type

string

Description

PHP: setlocale("LC_ALL", [value]);

value-examples: deutsch, de_DE, danish, portuguese, spanish, french, norwegian, italian. See www.php.net for other value. Also on linux, look at /usr/share/locale/

TSFE->localeCharset is intelligently set to the assumed charset of the locale strings. This is used in stdWrap.strftime to convert locale strings to the UTF-8 of the frontend.

Example:

This will render dates in danish made with stdWrap/strftime:

locale_all = danish
locale_all = da_DK

Note

It is possible to supply a comma-separated list of locales as a fallback chain

lockFilePath

Property

lockFilePath

Data type

string

Description

This is used to lock paths to be "inside" this path.

Used by "filelist" in stdWrap

Default

fileadmin/

mainScript

Property

mainScript

Data type

string

Description

This lets you specify an alternative "mainScript" which is the document that TYPO3 expects to be the default doc. This is used in form-tags and other places where TYPO3 needs to refer directly to the main-script of the application

Default

index.php

message_page_is_being_generated

Property

message_page_is_being_generated

Data type

string

Description

Alternative HTML message that appears if a page is being generated.

Normally when a page is being generated a temporary copy is stored in the cache-table with an expire-time of 30 seconds.

It is possible to use some keywords that are replaced with the corresponding values. Possible keywords are: ###TITLE###, ###REQUEST_URI###

message_preview

Property

message_preview

Data type

string

Description

Alternative message in HTML that appears when the preview function is active!

message_preview_workspace

Property

message_preview_workspace

Data type

string

Description

Alternative message in HTML that appears when the preview function is active in a draft workspace. You can use sprintf() placeholders for Workspace title (first) and number (second).

Examples:

config.message_preview_workspace = <div class="previewbox">Displaying workspace named "%s" (number %s)!</div>
config.message_preview_workspace = <div class="previewbox">Displaying workspace number %2$s named "%1$s"!</div>

metaCharset

Property

metaCharset

Data type

string

Description

Charset used for the output document. For example in the meta tag:

<meta charset=... />

It is used for a) HTML meta tag, b) HTTP header (unless disabled with .disableCharsetHeader) and c) xhtml prologues (if available).

If metaCharset is not UTF-8, the output content is automatically converted to metaCharset before output and likewise are values posted back to the page converted from metaCharset to UTF-8 for internal processing. This conversion takes time of course so there is another good reason to use the same charset for both.

Default

utf-8

moveJsFromHeaderToFooter

Property

moveJsFromHeaderToFooter

Data type

boolean

Description

If set, all JavaScript (includes and inline) will be moved to the bottom of the HTML document, which is after the content and before the closing body tag.

MP_defaults

Property

MP_defaults

Data type

string

Description

Allows you to set a list of page id numbers which will always have a certain "&MP=..." parameter added.

Syntax:

[id],[id],... : [MP-var] | [id],[id],... : [MP-var] | ...

Example:

config.MP_defaults = 36,37,48 : 2-207

This will by default add "&MP=2-207" to all links pointing to pages 36,37 and 48.

MP_disableTypolinkClosestMPvalue

Property

MP_disableTypolinkClosestMPvalue

Data type

boolean

Description

If set, the typolink function will not try to find the closest MP value for the id.

MP_mapRootPoints

Property
MP_mapRootPoints
Data type
list of PIDs/string
Description

Defines a list of ID numbers from which the MP-vars are automatically calculated for the branch.

The result is used just like MP_defaults are used to find MP-vars if none has been specified prior to the call to TYPO3\CMS\Core\TypoScript\TemplateService::linkData().

You can specify root as a special keyword in the list of IDs and that will create a map-tree for the whole site (but this may be VERY processing intensive if there are many pages!).

The order of IDs specified may have a significance; Any ID in a branch which is processed already (by a previous ID root point) will not be processed again.

The configured IDs have to be the uids of Mount Point pages itself, not the targets.

Tip

To mount content from parts of the page tree that don't belong to the current domain set content_from_pid_allowOutsideDomain to true.

namespaces

Property

namespaces

Data type

(array of strings)

Description

This property enables you to add xml namespaces (xmlns) to the <html> tag. This is especially useful if you want to add RDFa or microformats to your HTML.

Example:

config.namespaces.dc = http://purl.org/dc/elements/1.1/
config.namespaces.foaf = http://xmlns.com/foaf/0.1/

This configuration will result in an <html> tag like

<html xmlns:dc="http://purl.org/dc/elements/1.1/"
   xmlns:foaf="http://xmlns.com/foaf/0.1/">

no_cache

Property

no_cache

Data type

boolean

Description

If this is set to true, the page will not be cached. If set to false, it's ignored. Other parameters may have set it to true of other reasons.

Default

noPageTitle

Property

noPageTitle

Data type

integer

Description

If you only want to have the site name (from the template record) in your <title> tag, set this to 1. If the value is 2 then the <title> tag is not printed at all.

Please take note that this tag is required for (X)HTML compliant output, so you should only disable this tag if you generate it manually already.

Default

0

noScaleUp

Property

noScaleUp

Data type

boolean

Description

Normally images are scaled to the size specified via TypoScript. This also forces small images to be scaled to a larger size. This is not always a good thing.

If this property is set, images are not allowed to be scaled up in size. This parameter clears the $this->mayScaleUp var of the class TYPO3CMSCoreImagingGraphicalFunctions (often referred to as "Gifbuilder").

pageGenScript

Property

pageGenScript

Data type

resource

Description

Alternative page generation script for applications using \TYPO3\CMS\Frontend\Http\RequestHandler for initialization, caching, stating and so on. This script is included in the global scope of \TYPO3\CMS\Frontend\Http\RequestHandler and thus you may include libraries here. Always use include_once for libraries.

Remember not to output anything from such an included script. All content must be set into $TSFE->content. Take a look at typo3/sysext/frontend/Classes/Page/PageGenerator.php.

Note: This option is ignored if

['FE']['noPHPscriptInclude'] => 1;

is set in LocalConfiguration.php.

Default

typo3/sysext/frontend/Classes/Page/PageGenerator.php

pageRendererTemplateFile

Property

pageRendererTemplateFile

Data type

string

Description

Sets the template for page renderer class TYPO3CMSCorePagePageRenderer.

Example:

pageRendererTemplateFile = fileadmin/test_pagerender.html

Default

EXT:core/Resources/Private/Templates/PageRenderer.html

pageTitle

Property

pageTitle

Data type

stdWrap

Description

stdWrap for the page title. This option will be executed after all other processing options like config.titleTagFunction and config.pageTitleFirst.

pageTitleFirst

Property

pageTitleFirst

Data type

boolean

Description

TYPO3 by default prints a title tag in the format "website: page title".

If pageTitleFirst is set (and if the page title is printed), then the page title will be printed IN FRONT OF the template title. So it will look like "page title: website".

Default

0

pageTitleSeparator

Property

pageTitleSeparator

Data type

string /stdWrap

Description

The signs which should be printed in the title tag between the website name and the page title. If pageTitleSeparator is set, but no sub-properties are defined, then a space will be added to the end of the separator. stdWrap is useful to adjust whitespaces at the beginning and the end of the separator.

Examples:

config.pageTitleSeparator = .

This produces a title tag with the content "website. page title":

config.pageTitleSeparator = -
config.pageTitleSeparator.noTrimWrap = | | |

This produces a title tag with the content "website - page title":

config.pageTitleSeparator = *
config.pageTitleSeparator.noTrimWrap = |||

This produces a title tag with the content "website*page title".

Default

: (colon with following space)

prefixLocalAnchors

Property

prefixLocalAnchors

Data type

string

Description

If set to one of the keywords, the content will have all local anchors in links prefixed with the path of the script. Basically this means that <a href="#"> will be transformed to <a href="path/path/script?params#">. This procedure is necessary if the <base> tag is set (e.g. if the "realurl" extension is used to produce speaking URLs). See property "config.baseURL".

You can enable this function by setting it to one of the following keywords:

all: The content is always processed before it is possibly stored in cache (or not stored in cache).

cached: The content is only processed, if the page will be put into the cache.

output: The content is processed just before it is echoed out.

Note: This property is deprecated since TYPO3 7! Use absolute links with config.absRefPrefix instead.

removeDefaultCss

Property

removeDefaultCss

Data type

boolean

Description

Remove CSS generated by _CSS_DEFAULT_STYLE configuration of extensions. (_CSS_DEFAULT_STYLE outputs a set of default styles, just because an extension is installed.)

removeDefaultJS

Property

removeDefaultJS

Data type

boolean / string

Description

If set, the default JavaScript in the header will be removed.

The default JavaScript is the decryption function for email addresses.

Special case: If the value is "external", then the default JavaScript is written to a temporary file and included from that file. See "inlineStyle2TempFile" below.

Examples:

config.removeDefaultJS = external
config.removeDefaultJS = 1

Default

1

removePageCss

Property

removePageCss

Data type

boolean

Description

Remove CSS generated by _CSS_PAGE_STYLE configuration of extensions. (_CSS_PAGE_STYLE renders certain styles not just because an extension is installed, but only in a special situation. E.g. some styles will be output, when a textpic element with an image positioned alongside the text is present on the current page.)

sendCacheHeaders

Property

sendCacheHeaders

Data type

boolean

Description

If set, TYPO3 will output cache-control headers to the client based mainly on whether the page was cached internally. This feature allows client browsers and/or reverse proxies to take load off TYPO3 websites.

The conditions for allowing client caching are:

  • page was cached
  • No *_INT or *_EXT objects were on the page (e.g. USER_INT)
  • No frontend user is logged in
  • No backend user is logged in

If these conditions are met, the headers sent are:

  • Last-Modified [SYS_LASTCHANGED of page id]
  • Expires [expire time of page cache]
  • ETag [md5 of content]
  • Cache-Control: max-age: [seconds til expiretime]
  • Pragma: public

In case caching is not allowed, these headers are sent to avoid client caching:

  • Cache-Control: private

Notice that enabling the browser caches means you have to consider how log files are written. Because when a page is cached on the client it will not invoke a request to the webserver, thus not writing the request to the log. There should be ways to circumvent these problems but they are outside the domain of TYPO3 in any case.

Tip: Enabling cache-control headers might confuse editors seeing old content served from the browser cache. "Shift-Reload" will bypass both browser- and reverse-proxy caches and even make TYPO3 regenerate the page. Teach them that trick!

Thanks to Ole Tange, www.forbrug.dk for co-authoring this feature.

sendCacheHeaders_onlyWhenLoginDeniedInBranch

Property

sendCacheHeaders_onlyWhenLoginDeniedInBranch

Data type

boolean

Description

If this is set, then cache-control headers allowing client caching is sent only if user-logins are disabled for the branch. This feature makes it easier to manage client caching on sites where you have a mixture of static pages and dynamic sections with user logins.

The background problem is this: In TYPO3 the same URL can show different content depending on whether a user is logged in or not. If a user is logged in, cache-headers will never allow client caching. But if the same URL was visited without a login prior to the login (allowing caching) the user will still see the page from cache when logged in (and so thinks he is not logged in anyway)! The only general way to prevent this is to have a different URL for pages when users are logged in (which the extension "realurl" can accomplish).

Another way to solve the problem is using this option in combination with disabling and enabling logins in various sections of the site. In the page records ("Advanced" page types) you can disable frontend user logins for branches of the page tree. Since many sites only need the login in a certain branch of the page tree, disabling it in all other branches makes it much easier to use cache-headers in combination with logins; Cache-headers should simply be sent when logins are not allowed and never be send when logins are allowed! Then there will never be problems with logins and same-URLs.

setJS_mouseOver

Property

setJS_mouseOver

Data type

boolean

Description

If set, the over() and out() JavaScript functions are forced to be included

setJS_openPic

Property

setJS_openPic

Data type

boolean

Description

If set, the openPic JavaScript function is forced to be included

spamProtectEmailAddresses

Property

spamProtectEmailAddresses

Data type

"ascii" /

-10 to 10

Description

If set, then all email addresses in typolinks will be encrypted so spam

bots cannot detect them.

If you set this value to a number, then the encryption is simply an

offset of character values. If you set this value to "-2" then all

characters will have their ASCII value offset by "-2". To make this

possible, a little JavaScript code is added to every generated web page!

(It is recommended to set the value in the range from -5 to 1 since setting it to >= 2 means a "z" is converted to "|" which is a special character in TYPO3 tables syntax – and that might confuse columns in tables. Now hardcoded range)

Alternatively you can set this value to the keyword "ascii". This way every

character of the "mailto:" address will be translated to a Unicode HTML

notation. Have a look at the example to see how this works.

Example:

mailto:a@b.c will be converted to

mailto:&#97;&#64;&#98;&#46;&#99;

The big advantage of this method is that it does not need any JavaScript!

spamProtectEmailAddresses_atSubst

Property

spamProtectEmailAddresses_atSubst

Data type

string

Description

Substitute label for the at-sign (@).

Default

(at)

spamProtectEmailAddresses_lastDotSubst

Property

spamProtectEmailAddresses_lastDotSubst

Data type

string

Description

Substitute label for the last dot in the email address.

Example: (dot)

Default

. (just a simple dot)

sword_noMixedCase

Property

sword_noMixedCase

Data type

boolean

Description

Used by the parseFunc-substitution of search Words (sword):

If set, the words MUST be the exact same case as the search word was.

sword_standAlone

Property

sword_standAlone

Data type

boolean

Description

Used by the parseFunc-substitution of search Words (sword):

If set, the words MUST be surrounded by whitespace in order to be marked up.

sys_language_isocode

Property

sys_language_isocode

Data type

string

Description

ISO 639-1 language code for the according language. By default this is being set by TSFE:sys_language_isocode. The value is derived from the ISO code that is stored within the sys_language record. You can override the value, which was retrieved that way, with this setting.

The ISO code is also used for the language attribute of the HTML tag. Therefore the setting config.htmlTag_langKey is not needed anymore, if it is the same as the ISO code.

See the example at sys_language_isocode_default!

sys_language_isocode_default

Property

sys_language_isocode_default

Data type

string

Description

ISO 639-1 language code for the default language (that is sys_language_uid = 0).

Example:

# Danish by default
config.sys_language_uid = 0
config.sys_language_isocode_default = da

[globalVar = GP:L = 1]
   # ISO code is filled by the respective DB value from sys_language (uid 1)
   config.sys_language_uid = 1

   # You can override this of course
   config.sys_language_isocode = fr

[GLOBAL]

Default

en

sys_language_mode

Property

sys_language_mode

Data type

string

Description

Setting various modes of handling localization.

The syntax is "[keyword] ; [value]".

Possible keywords are:

[default] - The system will look for a translation of the page (from "Alternative Page Language" table) and if it is not found it will fall back to the default language and display that.

content_fallback: Recommended. The system will always operate with the selected language even if the page is not translated with a page overlay record. This will keep menus etc. translated. However, the content on the page can still fall back to another language, defined by the value of this keyword, e.g. "content_fallback ; 1,0" to fall back to the content of sys_language_uid 1 and if that is not present either, to default (0).

strict: The system will report an error if the requested translation does not exist. Basically this means that all pages with gray background in the Web > Info / Localization overview module will fail (they would otherwise fall back to default language in one way or another).

ignore: The system will stay with the selected language even if the page is not translated and there's no content available in this language, so you can handle that situation on your own then.

sys_language_overlay

Property

sys_language_overlay

Data type

boolean / keyword

Description

If set, records from certain tables selected by the CONTENT cObject using the "languageField" setting will select the default language (0) instead of any language set by sys_language_uid / sys_language_mode. In addition the system will look for a translation of the selected record and overlay configured fields.

The requirements for this is that the table is configured with "languageField" and "transOrigPointerField" in the [ctrl] section of $GLOBALS['TCA']. Also, exclusion of certain fields can be done with the "l10n_mode" directive in the field-configuration of $GLOBALS['TCA'].

For backend administration this requires that you configure the "Web > Page" module to display content elements accordingly; That each default element is shown and next to it any translation found. This configuration can be done with Page TSconfig for a section of the website using the object path "mod.web_layout.defLangBinding = 1".

Keyword:

hideNonTranslated: If this keyword is used a record that has no translation will not be shown. The default is that records with no translation will show up in the default language.

sys_language_softExclude

Property

sys_language_softExclude

Data type

string

Description

Setting additional "exclude" flags for l10n_mode in TCA for frontend rendering. Works exactly like sys_language_softMergeIfNotBlank (see that for details - same Syntax!).

Fields set in this property will override if the same field is set for "sys_language_softMergeIfNotBlank".

sys_language_softMergeIfNotBlank

Property

sys_language_softMergeIfNotBlank

Data type

string

Description

Setting additional "mergeIfNotBlank" fields from TypoScript.

Background:

In TCA you can configure "l10n_mode" - localization mode - for each field. Two of the options affect how the frontend displays content; The values "exclude" and "mergeIfNotBlank" (see "TYPO3 Core API" document for details). The first ("exclude") simply means that the field when found in a translation of a record will not be overlaid the default records field value. The second ("mergeIfNotBlank") means that it will be overlaid only if it has a non-blank value.

Since it might be practical to set up fields for "mergeIfNotBlank" on a per-site basis this options allows you to override additional fields from tables.

Syntax:

[table]:[field], [table]:[field], [table]:[field], ...

Example:

config.sys_language_softMergeIfNotBlank = tt_content:image , tt_content:header

This setting means that the header and image field of content elements will be used from the translation only if they had a non-blank value. For the image field this might be very practical because it means that the image(s) from the default translation will be used unless other images are inserted!

sys_language_uid

Property

sys_language_uid

Data type

integer

Description

This value points to the uid of a record from the "sys_language" table and if set, this means that various parts of the frontend display code will select records which are assigned to this language. See ->SELECT

Internally, the value is depending on whether an Alternative Page Language record can be found with that language. If not, the value will default to zero (default language) except if "sys_language_mode" is set to a value like "content_fallback".

titleTagFunction

Property

titleTagFunction

Data type

function name

Description

Passes the default <title> tag content to this function. No TypoScript parameters are passed though.

tx_[extension key with no underscores]_[*]

Property

tx_[extension key with no underscores]_[*]

Data type

Description

Configuration space for extensions. This can be used – for example – by plugins that need some TypoScript configuration, but that don't actually display anything in the frontend (i.e. don't receive their configuration as an argument from the frontend rendering process).

Example:

config.tx_realurl_enable = 1

typolinkCheckRootline

Property

typolinkCheckRootline

Data type

boolean

Description

If set, then every "typolink" is checked whether it's linking to a page within the current rootline of the site.

If not, then TYPO3 searches for the first found domain record (without redirect) in that rootline from out to in.

If found (another domain), then that domain is prepended the link, the external target is used instead and thus the link jumps to the page in the correct domain.

typolinkEnableLinksAcrossDomains

Property

typolinkEnableLinksAcrossDomains

Data type

boolean

Description

This option enables to create links across domains using current domain's linking scheme.

If this option is not set, then all cross-domain links will be generated as

"http://domain.tld/index.php?id=12345" (where 12345 is page id). Setting this option requires that domains, where pages are linked, have the same configuration for:

- linking scheme (i.e. all use RealURL or CoolURI but not any mixture)

- all domains have identical localization settings (config.sys_language_XXX directives)

- all domains have the same set of languages defined

This option implies "config.typolinkCheckRootline=1", which will be activated automatically. Setting value of "config. typolinkCheckRootline" inside TS template will have no effect.

Disclaimer: it must be understood that while link is generated to another domain, it is still generated in the context of current domain. No side effects are known at the time of writing of this documentation but they may exist. If any side effects are found, this documentation will be updated to include them.

Default

0

typolinkLinkAccessRestrictedPages

Property

typolinkLinkAccessRestrictedPages

Data type

integer (page id) / keyword "NONE"

Description

If set, typolinks pointing to access restricted pages will still link to the page even though the page cannot be accessed. If the value of this setting is an integer it will be interpreted as a page id to which the link will be directed.

If the value is "NONE" the original link to the page will be kept although it will generate a page-not-found situation (which can of course be picked up properly by the page-not-found handler and present a nice login form).

See "showAccessRestrictedPages" for menu objects as well (similar feature for menus)

Example:

config.typolinkLinkAccessRestrictedPages = 29
config.typolinkLinkAccessRestrictedPages_addParams = &return_url=###RETURN_URL###&pageId=###PAGE_ID###

Will create a link to page with id 29 and add GET parameters where the return URL and original page id is a part of it.

typolinkLinkAccessRestrictedPages_addParams

Property

typolinkLinkAccessRestrictedPages_addParams

Data type

string

Description

See "typolinkLinkAccessRestrictedPages" above

USERNAME_substToken

Property

USERNAME_substToken

Data type

string

Description

The is the token used on the page, which should be substituted with the current username IF a front-end user is logged in! If no login, the substitution will not happen.

Default

<!--###USERNAME###-->

USERUID_substToken

Property

USERUID_substToken

Data type

string

Description

The is the token used on the page, which should be substituted with the current users UID IF a front-end user is logged in! If no login, the substitution will not happen.

This value has no default value and only if you specify a value for this token will a substitution process take place.

xhtmlDoctype

Property

xhtmlDoctype

Data type

string

Description

Sets the document type for the XHTML version of the generated page.

If config.doctype is set to a string then config.xhtmlDoctype must be set to one of these keywords:

xhtml_trans for XHTML 1.0 Transitional doctype.

xhtml_frames for XHTML 1.0 Frameset doctype.

xhtml_strict for XHTML 1.0 Strict doctype.

xhtml_basic for XHTML basic doctype.

xhtml_11 for XHTML 1.1 doctype.

This is an example to use MathML 2.0 in an XHTML 1.1 document:

config.doctype (
  <!DOCTYPE html
      PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN"
      "http://www.w3.org/Math/DTD/mathml2/xhtml-math11-f.dtd">
)
config.xhtmlDoctype = xhtml_11

Default

(same as config.doctype if set to a keyword)

xmlprologue

Property

xmlprologue

Data type

string

Description

If empty (not set) then the default XML 1.0 prologue is set, when the doctype is set to a known keyword (e.g. xhtml_11):

<?xml version="1.0" encoding="utf-8">

If set to one of the following keywords then a standard prologue will be set:

xml_10: XML 1.0 prologue (see above)

xml_11: XML 1.1 prologue

none: The default XML prologue is not set.

Any other string is used as the XML prologue itself.