PAGE¶
This defines what is rendered in the frontend.
PAGE is an object type. A good habit is to use page
as the top-level object name for
the content-page on a website.
TYPO3 does not initialize page
by default. You must initialize this
explicitly, for example:
page = PAGE
Pages are referenced by two main values. The "id" and "type".
The "id" points to the uid of the page (or the alias). Thus the page is found.
Most of this code is executed in the PHP script
\TYPO3\CMS\Frontend\Http\RequestHandler
.
Output of the PAGE object¶
An empty PAGE
object without further configuration renders a HTML page
like the following:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!--
This website is powered by TYPO3 - inspiring people to share!
TYPO3 is a free open source Content Management Framework initially created by Kasper Skaarhoj and licensed under GNU/GPL.
TYPO3 is copyright 1998-2019 of Kasper Skaarhoj. Extensions are copyright of their respective owners.
Information and contribution at https://typo3.org/
-->
<title>Page title</title>
<meta name="generator" content="TYPO3 CMS">
</head>
<body>
</body>
</html>
This default behaviour can be changed by setting the property disableAllHeaderCode:
page.config.disableAllHeaderCode = 1
If the output represents another format different from HTML the HTTP header should also be set, for example:
page.config.additionalHeaders.10.header = Content-type:application/json
Multiple pages¶
When rendering pages in the frontend, TYPO3 uses the GET parameter "type" to define how the page should be rendered. This is primarily used with different representations of the same content. Your default page will most likely have type 0 (which is the default) while a JSON stream with the same content could go with type 1.
The property typeNum defines for which type, the page will be used.
Example:
page = PAGE
page.typeNum = 0
page {
# set properties ...
}
json = PAGE
json.typeNum = 1
# ...
See An example page type used for JSON data about an example for the latter page.
In the frontend, the original URLs that are generated will include the type and an id parameter (for the page id), example (for json and page id 22):
/index.php?id=22&type=1
Guidelines¶
Good, general PAGE object names to use are:
- page for the main page with content
- json for a json stream with content
- xml for a XML stream with content
These are just recommendations. However, especially the name page for the content bearing page is very common and most documentation will imply that your main page object is called page.
Examples¶
Please see the dedicated example page about examples of how to use the PAGE object: Examples
Properties¶
1,2,3,4...¶
-
1,2,3,4...
¶ -
- Type
- cObject
These properties can be used to define any number of objects, just like you can do with a COA content object.
The content of these objects will be rendered on the page in the order of the numbers, not in the order they get defined in the TypoScript definition.
It is considered best practice to leave space between the numbers such that it will be possible to place objects before and after other objects in the future. Therefore you will often see that people use the number 10 and no number 1 is found.
Example: Render "Hello World"¶
page = PAGE
page.20 = TEXT
page.20.value = World
page.10 = TEXT
page.10.value = Hello
This renders to HelloWorld
.
bodyTag¶
Example: Set a class on the body tag¶
# This will lead to <body class="example"> if constant "bodyClass" is set accordingly.
page.bodyTag = <body class="{$bodyClass}">
bodyTagAdd¶
-
bodyTagAdd
¶ -
- Type
- string
This content is added inside of the opening
<body>
tag right before the>
character. This is mostly useful for adding attributes to the<body>
tag.
Example: Add a parameter to the body tag¶
# This will lead to <body class="example">
page.bodyTagAdd = class="example"
bodyTagCObject¶
-
bodyTagCObject
¶ -
- Type
- cObject
This is the default body tag. It is overridden by bodyTag, if that is set.
Note
Additionally to the body tag properties noted here,
there also is the property disableBodyTag, which, if set, disables body tag generation independently from what might be set here.
config¶
-
config
¶ -
- Type
- ->CONFIG
Configuration for the page. Any entries made here override the same entries in the top-level object CONFIG & config.
CSS_inlineStyle¶
Changed in version 12.0
Using this setting has no effect anymore. Use page.cssInline instead.
cssInline.[array]¶
-
cssInline.[array]
¶ -
- Type
- cObject
Allows to add inline CSS to the page
<head>
section. ThecssInline
property contains any number of numeric keys, each representing one cObject. Internally handled as PHP integer, maximum number is therefore restricted toPHP_INT_MAX
.
Example: Add inline styles for the h1 tag¶
cssInline {
10 = TEXT
10.value = h1 {margin:15px;}
20 = TEXT
20.value = h1 span {color: blue;}
}
headerData.[array]¶
-
headerData.[array]
¶ -
- Type
- cObject
Inserts custom content in the head section of the website.
While you can also use this to include stylesheet references or JavaScript, you should better use page.includeCSS and page.includeJS for such files. Features like file concatenation and file compression will not work on files, which are included using
headerData
.For meta tags, use the dedicated configuration page.meta.
By default, gets inserted after all the style definitions.
The
headerData
property contains any number of numeric keys, each representing one cObject. Internally handled as PHP integer, maximum number is therefore restricted toPHP_INT_MAX
.
Example: Add a script tag and a comment to the head tag¶
page.headerData {
3 = TEXT
3.value = <script src="...."></script>
50 = TEXT
50.value = <!-- Hello from the comment! -->
}
headTag¶
includeCSS.[array]¶
-
includeCSS.[array]
¶ -
- Type
- resource
Inserts a stylesheet (just like the
stylesheet
property), but allows setting up more than a single stylesheet, because you can enter files in an array.The file definition must be a valid resource data type, otherwise nothing is inserted.
Each file has optional properties:
allWrap
- Wraps the complete tag, useful for conditional comments.
allWrap.splitChar
- Defines an alternative splitting character (default is "|" - the vertical line).
alternate
- If set (boolean) then the rel-attribute will be "alternate stylesheet".
disableCompression
- If
config.compressCss
is enabled, this disables the compression of this file. excludeFromConcatenation
- If
config.concatenateCss
is enabled, this prevents the file from being concatenated. external
- If set, there is no file existence check. Useful for inclusion of external files.
forceOnTop
- Boolean flag. If set, this file will be added on top of all other files.
if
- Allows to define conditions, which must evaluate to
true
for the file to be included. If they do not evaluate totrue
, the file will not be included. Extensive usage might cause huge numbers of temporary files to be created. See function if for details. inline
- If set, the content of the CSS file is inlined using
<style>
tags. Note that external files are not inlined. media
- Setting the media attribute of the
<style>
tag. title
- Setting the title of the
<style>
tag.
New in version 12.1
Additional data attributes can be configured using a key-value list.
Example: Include additional css files¶
includeCSS {
styles = EXT:site_package/Resources/Public/Css/styles.css
print = EXT:site_package/Resources/Public/Css/print.css
print.title = High contrast
print.media = print
additional = EXT:site_package/Resources/Public/Css/additional_styles.css
additional.data-foo = bar
ie6 = EXT:site_package/Resources/Public/Css/ie6.css
ie6.allWrap = <!--[if lte IE 7]>|<![endif]-->
example = https://example.org/some_external_styles.css
example.external = 1
}
includeCSSLibs.[array]¶
-
includeCSSLibs.[array]
¶ -
- Type
- resource
Adds CSS library files to head of page.
The file definition must be a valid resource data type, otherwise nothing is inserted. This means that remote files cannot be referenced (i.e. using
https://...
), except by using the.external
property.Each file has optional properties:
allWrap
- Wraps the complete tag, useful for conditional comments.
allWrap.splitChar
- Defines an alternative splitting character (default is "|" - the vertical line).
alternate
- If set (boolean) then the rel-attribute will be "alternate stylesheet".
disableCompression
- If
config.compressCss
is enabled, this disables the compression of this file. excludeFromConcatenation
- If
config.concatenateCss
is enabled, this prevents the file from being concatenated. external
- If set, there is no file existence check. Useful for inclusion of external files.
forceOnTop
- Boolean flag. If set, this file will be added on top of all other files.
if
- Allows to define conditions, which must evaluate to TRUE for the file to be included. If they do not evaluate to TRUE, the file will not be included. Extensive usage might cause huge numbers of temporary files to be created. See ->if for details.
media
- Setting the media attribute of the
<style>
tag. title
- Setting the title of the
<style>
tag.
New in version 12.1
Additional data attributes can be configured using a key-value list.
Example: Include CSS libraries¶
includeCSSLibs {
bootstrap = https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css
bootstrap.external = 1
additional = EXT:site_package/Resources/Public/Css/additional_styles.css
additional.data-foo = bar
}
includeJS.[array]¶
-
includeJS.[array]
¶ -
- Type
- resource
Inserts one or more (Java)Scripts in
<script>
tags. With moveJsFromHeaderToFooter set to TRUE all files will be moved to the footer. The file definition must be a valid resource data type, otherwise nothing is inserted. This means that remote files cannot be referenced (i.e. usinghttps://...
), except by using the.external
property.Each file has optional properties:
allWrap
- Wraps the complete tag, useful for conditional comments.
allWrap.splitChar
- Defines an alternative splitting character (default is "|" - the vertical line).
async
- Allows the file to be loaded asynchronously.
crossorigin
- Allows to set the cross-origin attribute in script tags.
It is automatically set to
anonymous
for external JavaScript files if an.integrity
is set. defer
- Allows to set the HTML5 attribute
defer
. disableCompression
- If
config.compressJs
is enabled, this disables the compression of this file. excludeFromConcatenation
- If
config.concatenateJs
is enabled, this prevents the file from being concatenated. external
- If set, there is no file existence check. Useful for inclusion of external files.
forceOnTop
- Boolean flag. If set, this file will be added on top of all other files.
if
- Allows to define conditions, which must evaluate to TRUE for the file to be included. If they do not evaluate to TRUE, the file will not be included. Extensive usage might cause huge numbers of temporary files to be created. See ->if for details.
type
- Setting the MIME type of the script. Default: The attribute is
omitted for frontend rendering when
config.doctype
is not set or set tohtml5
. Otherwisetext/javascript
is used as type. integrity
- Adds the integrity attribute to the script element to let browsers ensure subresource integrity. Useful in hosting scenarios with resources externalized to CDN's. See SRI for more details. Integrity hashes may be generated using https://srihash.org/.
New in version 12.1
data
- Array with key/value for additional attributes to be added to the script tag.
Example: Include JavaScript in the header¶
includeJS {
helloworld = EXT:site_package/Resources/Public/JavaScript/helloworld.js
helloworld.type = application/x-javascript
# Include the file only if myConstant is set in the TS constants field.
conditional = EXT:site_package/Resources/Public/JavaScript/conditional.js
conditional.if.isTrue = {$myConstant}
# Include another file for consent management
# A data attribute enriches the tag with additional information
# which can be used in the according JavaScript.
# This results in "<script data-consent-type="essential" ...></script>"
consent = EXT:site_package/Resources/Public/JavaScript/consent.js
consent.data.data-consent-type = essential
# Another attribute can also be defined also with the "data" key.
# This results in "<script other-attribute="value" ...></script>"
consent.data.other-attribute = value
jquery = https://code.jquery.com/jquery-3.4.1.min.js
jquery.external = 1
jquery.integrity = sha384-vk5WoKIaW/vJyUAd9n/wmopsmNhiy+L2Z+SBxGYnUkunIxVxAv/UtMOhba/xskxh
}
includeJSLibs.[array]¶
-
includeJSLibs.[array]
¶ -
- Type
- resource
Adds JavaScript library files to head of page.
Same as includeJSFooterlibs, except that this block gets included inside
<head>
. tag).The optional properties from includeJS can be applied.
inlineLanguageLabelFiles¶
-
inlineLanguageLabelFiles
¶ -
- Type
- (array of strings)
Adds language labels to the page. All labels will be then be available in the JavaScript object
TYPO3.lang
.Available sub-properties:selectionPrefix
- Only label keys that start with this prefix will be included. Default: ''.
stripFromSelectionName
- A string that will be removed from any included label key. Default: ''.
errorMode
- Error mode if the file could not be found: 0 - syslog entry, 1 - do nothing, 2 - throw an exception. Default: 0
Example: Make a language file available in JavaScript¶
inlineLanguageLabelFiles {
someLabels = EXT:my_extension/Resources/Private/Language/locallang.xlf
someLabels.selectionPrefix = idPrefix
someLabels.stripFromSelectionName = strip_me
someLabels.errorMode = 2
}
inlineSettings¶
-
inlineSettings
¶ -
- Type
- (array of strings)
Adds settings to the page as inline javascript, which is accessible within the JavaScript object
TYPO3.settings
.
Example: Make some values available in JavaScript¶
page.inlineSettings {
setting1 = Hello
setting2 = GoOnTop
}
Will produce following source
TYPO3.settings = {"TS":{"setting1":"Hello","setting2":"GoOnTop"}};
jsInline.[array]¶
-
jsInline.[array]
¶ -
- Type
- cObject
Use array of cObjects for creating inline JavaScript.
Note
With
config.removeDefaultJS = external
, the inline JavaScript is moved to an external file.The
jsInline
property contains any number of numeric keys, each representing one cObject. Internally handled as PHP integer, maximum number is therefore restricted toPHP_INT_MAX
.
Example: Make a cObject available in JavaScript¶
page.jsInline {
10 = TEXT
10.stdWrap.dataWrap = var pageId = {TSFE:id};
}
meta¶
-
meta
¶ -
- Type
- array of key names (string / stdWrap)
Use the scheme
meta.key = value
to define any HTML meta tag.value
is the content of the meta tag. If the value is empty (after trimming), the meta tag is not generated.The
key
can be the name of any meta tag, for exampledescription
orkeywords
. If the key isrefresh
(case insensitive), then thehttp-equiv
attribute is used in the meta tag instead of thename
attribute.For each key the following sub-properties are available:
httpEquivalent
- If set to 1, the
http-equiv
attribute is used in the meta tag instead of thename
attribute. Default: 0. replace
- If set to 1, the tag will replace the one set earlier by a plugin. If set to 0 (default), the meta tag generated by the plugin will be used. If there is none yet, the one from TypoScript is set.
Example: Define meta tags for description and keywords¶
meta.description = This is the description of the content in this document.
meta.keywords = These are the keywords.
Example: Fetch data for the keyword meta tag from the page record¶
If the page record is not set search up the root line of pages.
meta.keywords.data = levelfield:-1, keywords, slide
Example: Make a meta.refresh entry¶
meta.refresh = [seconds]; [URL, leave blank for same page]
Example: Set a meta tag with HTTP equivalent¶
meta.X-UA-Compatible = IE=edge
meta.X-UA-Compatible.httpEquivalent = 1
Result:
<meta http-equiv="X-UA-Compatible" content="IE=edge">.
Example set Open graph meta tags¶
Meta tags with a different attribute name are supported like the Open Graph meta tags:
page {
meta {
X-UA-Compatible = IE=edge
X-UA-Compatible.attribute = http-equiv
keywords = TYPO3
og:site_name = TYPO3
og:site_name.attribute = property
description = Inspiring people to share Normal
dc\.description = Inspiring people to share [DC tags]
og:description = Inspiring people to share [OpenGraph]
og:description.attribute = property
og:locale = en_GB
og:locale.attribute = property
og:locale:alternate {
attribute = property
value {
1 = fr_FR
2 = de_DE
}
}
refresh = 5; url=https://example.org/
refresh.attribute = http-equiv
}
}
Note
Since the dot (.
) has a meaning in TypoScript, it must be escaped with
a backslash if used in a meta
key.
They can be used like property
used for OG tags in the example.
You may also supply multiple values for one name, which results in multiple meta tags with the same name to be rendered.
Result for og:description
:
<meta property="og:description"
content="Inspiring people to share [OpenGraph]" />
See https://ogp.me/ for more information about the Open Graph protocol and its properties.
shortcutIcon¶
-
shortcutIcon
¶ -
- Type
- resource
Favicon of the page. Create a reference to an icon here!
Browsers that support favicons display them in the address bar of the browser, next to the name of the site in lists of bookmarks and next to the title of the page in the tab.
If the file is missing no tag will be rendered.
Example: Add a favicon to the page¶
page.shortcutIcon = EXT:site_package/Resources/Public/Images/favicon.ico
stdWrap¶
Wraps the content of the cObject array with stdWrap options.