Skip to content

Commit

Permalink
[TASK] Add exemplary site set settings definition
Browse files Browse the repository at this point in the history
This showcases how the actual site set settings definition set
of settings can be set in the documentation of auto-generated
settable site set settings.
  • Loading branch information
fe-hicking committed Aug 15, 2024
1 parent 48ed2b9 commit 412b32e
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 0 deletions.
31 changes: 31 additions & 0 deletions Configuration/Sets/Examples/settings.definitions.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
settings:
example.output.view.templateRootPath:
default: 'EXT:example/Resources/Private/Templates/'
label: 'Path to template root (FE)'
type: string
description: ''
example.output.view.partialRootPath:
default: 'EXT:example/Resources/Private/Partials/'
label: 'Path to template partials (FE)'
type: string
description: ''
example.output.view.layoutRootPath:
default: 'EXT:example/Resources/Private/Layouts/'
label: 'Path to template layouts (FE)'
type: string
description: ''
example.output.pages.excludedDoktypes:
default: '3, 4, 6, 7, 199, 254'
label: 'Doktypes to exclude'
type: string
description: ''
example.output.pages.excludePagesRecursive:
default: ''
label: 'List of page uids which should be excluded recursive'
type: string
description: ''
example.output.pages.additionalWhere:
default: "{#no_index} = 0 AND {#canonical_link} = ''"
label: 'Additional where clause'
type: string
description: ''
14 changes: 14 additions & 0 deletions Documentation/Introduction/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,20 @@ Extending TCA

.. _introduction-credits:

Site set settings
=================

Site set settings can be defined through a file like
:file:`EXT:example/Configuration/Sets/Examples/settings.definitions.yaml`.

Here is the auto-generated listing of all definitions. This is for example
purposes only, and not yet implemented:

.. typo3:site-set-settings:: EXT:self/Configuration/Sets/Examples/settings.definitions.yaml
:name: example-settings-definitions
:type:
:Label: Example site set settings definitions

Credits
=======

Expand Down

0 comments on commit 412b32e

Please sign in to comment.