confval 

Permalink to confval: rendertest:confval-case-array.

Name Type Default Possible
shy Happy new year, Sophie!
align left left | center | right
boolean 1 | 0
boolean 1 | 0
case
array

Summary 

.. confval:: is the directive.

:confval: is a text role to create a reference to the description.

See also https://sphinx-toolbox.readthedocs.io/en/stable/extensions/confval.html#directive-option-confval-noindex

Demo 1 

Source:

..  confval:: mr_pommeroy
    :Default: Happy new year, Sophie!
    :required: false
    :type: shy

    Participant of Miss Sophie's birthday party.
Copied!

Result:

mr_pommeroy

mr_pommeroy
Type
shy
Default
Happy new year, Sophie!

Participant of Miss Sophie's birthday party.

You can easily link to the description of a 'confval' by means of the :confval: text role. Example: Here is a link to mr_pommeroy.

Demo 2 

Adapted from the TypoScript Reference Manual:

align

align
Type
align
Required

true

Default
left
Possible
left | center | right

Decides about alignment.

Example:

10.align = right


Copied!

boolean

boolean
Type
boolean
Possible
1 | 0

1 means TRUE and 0 means FALSE.

Everything else is evaluated to one of these values by PHP: Non-empty strings (except 0 [zero]) are treated as TRUE, empty strings are evaluated to FALSE.

Examples:

dummy.enable = 0    # false, preferred notation
dummy.enable = 1    # true,  preferred notation
dummy.enable =      # false, because the value is empty
Copied!

boolean2

boolean2
Type
boolean
Possible
1 | 0

1 means TRUE and 0 means FALSE.

Everything else is evaluated to one of these values by PHP: Non-empty strings (except 0 [zero]) are treated as TRUE, empty strings are evaluated to FALSE.

Examples:

dummy.enable = 0    # false, preferred notation
dummy.enable = 1    # true,  preferred notation
dummy.enable =      #
Copied!

case

case
Type
case
Possible
Value Effect
upper Convert all letters of the string to upper case
lower Convert all letters of the string to lower case
capitalize Uppercase the first character of each word in the string
ucfirst Convert the first letter of the string to upper case
lcfirst Convert the first letter of the string to lower case
uppercamelcase Convert underscored upper_camel_case to UpperCamelCase
lowercamelcase Convert underscored lower_camel_case to lowerCamelCase

Do a case conversion.

Example code:

10 = TEXT
10.value = Hello world!
10.case = upper
Copied!

Result:

HELLO WORLD!
Copied!

Demo 3 - addRecord 

addRecord

addRecord
Type
array
Scope
fieldControl
Types
group

Control button to directly add a related record. Leaves the current view and opens a new form to add a new record. On 'Save and close', the record is directly selected as referenced element in the type='group' field. If multiple tables are allowed, the first table from the allowed list is selected, if no specific table option is given.

Confval with name 

addRecord

addRecord
Type
array
Scope
fieldControl
Types
group

Lorem Ipsum

Link here with addRecord, link to the one above with addRecord.

Confval with noindex 

addRecord

addRecord
Type
array
Scope
fieldControl
Types
group

Lorem Ipsum

You cannot link here with the :confval: textrole, but only with :ref: to the reference above it. Confval with noindex.