Top-level objects¶
Properties¶
| Property | Data Type | stdWrap | Default |
|---|---|---|---|
| ((abc ...?)) | ->PAGE | ||
| ((bcd ...?)) | (whatever) | ||
| config | ->CONFIG | ||
| constants | ->CONSTANTS | ||
| FEData | ->FE_DATA | ||
| Other reserved TLO's: | (whatever) | ||
| resources | readonly | ||
| sitetitle | readonly | ||
| types | readonly |
Property details¶
((abc ...?))¶
Property
...
Data type
->PAGE
Description
Start a new page.
Example:
page = PAGE
page.typeNum = 1
Guidelines:
Good, general PAGE object names to use are such as:
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'.
((bcd ...?))¶
Property
...
Data type
(whatever)
Description
If a top-level object is not a PAGE object it could be used as a temporary repository for setup. In this case you should use the "temp" or "styles" objects.
"tt_..." is normally used to define the setup of content-records. E.g. "tt_content" would be used for the tt_content-table as default. See the "CONTENT" cObject.
config¶
Property
config
Data type
->CONFIG
Description
Global configuration.
These values are stored with cached pages which means they are also accessible when retrieving a cached page.
constants¶
Property
constants
Data type
->CONSTANTS
Description
Site-specific constants, e.g. a general email address. These constants may be substituted in the text throughout the pages. The substitution is done by parseFunc (with .constants = 1 set).
FEData¶
Property
FEData
Data type
->FE_DATA
Description
Here you can configure how data submitted from the front-end should be processed, which script and so on.
Other reserved TLO's:¶
Property
Other reserved TLO's:
plugin
tt_*
temp
styles
lib
_GIFBUILDER
Data type
(whatever)
Description
These top-level object names are reserved. That means you can risk static_templates to use them:
"plugin" is used for rendering of special content like boards, e-commerce solutions, guestbooks and so on. Normally set from static_templates.
"tt_*", e.g. tt_content (from "content (default)") is used to render content from tables.
"temp" and "styles" are used for code-libraries you can copy during parse-time, but they are not saved with the template in cache. "temp" and "styles" are unset before the template is cached! Therefore use these names to store temporary data.
"lib" can be used for a "library" of code, you can reference in TypoScript (unlike "styles" which is unset).