Site settings

Settings.rst

..  typo3:site-set-settings:: settings.definitions.yaml
    :name: my-set
    :type:
    :Label: max=20
    :default: max=10

Name	Type	Label	Default
Example		Site settings exampl...
Example.examples		Examples
example.output.view.templateRootPath	`string`	Path to template roo...	"...
example.output.view.partialRootPath	`string`	Path to template par...	"...
example.output.view.layoutRootPath	`string`	Path to template lay...	"...
example.output.pages.excludedDoktypes	`string`	Doktypes to exclude	"...
example.output.pages.excludePagesRecursive	`string`	List of page uids wh...
example.output.pages.additionalWhere	`string`	Additional where cla...	"...
BlogExample.types		Available types
example.types.int	`int`	Type int	4...
example.types.number	`number`	Type number	3...
example.types.bool	`bool`	Type bool	t...
example.types.bool-false	`bool`	Type bool	f...
example.types.string	`string`	Type string	"...
example.types.text	`text`	Type text	"...
Unknown
example.types.stringlist	`stringlist`	Type stringlist	[...
_global
example.types.color	`color`	Type text	"...

Example

Label: Site settings examples

Example.examples

Label: Examples

example.output.view.templateRootPath

Type: string
Default: "EXT:example/Resources/Private/Templates/"
Label: Path to template root (FE)
Category: Site settings examples > Examples

example.output.view.partialRootPath

Type: string
Default: "EXT:example/Resources/Private/Partials/"
Label: Path to template partials (FE)
Category: Site settings examples > Examples

example.output.view.layoutRootPath

Type: string
Default: "EXT:example/Resources/Private/Layouts/"
Label: Path to template layouts (FE)
Category: Site settings examples > Examples

example.output.pages.excludedDoktypes

Type: string
Default: "3, 4, 6, 7, 199, 254"
Label: Doktypes to exclude
Category: Site settings examples > Examples

example.output.pages.excludePagesRecursive

Type: string
Label: List of page uids which should be excluded recursive
Category: Site settings examples > Examples

example.output.pages.additionalWhere

Type: string
Default: "{#no_index} = 0 AND {#canonical_link} = ''"
Label: Additional where clause
Category: Site settings examples > Examples

BlogExample.types

Label: Available types

example.types.int

Type: int
Default: 42
Label: Type int
Category: Site settings examples > Available types

Checks whether the value is already an integer or can be interpreted as an integer. If yes, the string is converted into an integer.

example.types.number

Type: number
Default: 3.16
Label: Type number
Category: Site settings examples > Available types

Checks whether the value is already an integer or float or whether the string can be interpreted as an integer or float. If yes, the string is converted to an integer or float.

example.types.bool

Type: bool
Default: true
Label: Type bool
Category: Site settings examples > Available types

Casts the value to a boolean.

example.types.bool-false

Type: bool
Default: false
Label: Type bool
Category: Site settings examples > Available types

Casts the value to a boolean.

example.types.string

Type: string
Default: "EXT:example/Resources/Private/Templates/"
Label: Type string
Category: Site settings examples > Available types

Converts almost all data types into a string. If an object has been specified, it must be stringable, otherwise no conversion takes place. Boolean values are converted to "true" and "false".

example.types.text

Type: text
Default: "EXT:example/Resources/Private/Templates/"
Label: Type text
Category: Site settings examples > Available types

Exactly the same as the `string` type. Use it as an alias if someone doesn't know what to do with `string`.

Unknown

example.types.stringlist

Type: stringlist
Default: [ "Dog", "Cat", "Bird", "Spider" ]
Label: Type stringlist
Category: Unknown

The value must be an array whose array keys start at 0 and increase by 1 per element. The list in this type is derived from the internal PHP method array_is_list() and has nothing to do with the fact that comma-separated lists can also be converted here. The `string` type is executed for each array entry.

_global

example.types.color

Type: color
Default: "#FF8700"
Label: Type text

Checks whether the specified string can be interpreted as a color code. Entries starting with `rgb`, `rgba` and `#` are permitted here. For `#` color codes, for example, the system checks whether they have 3, 6 or 8 digits.