Skip to content

Commit

Permalink
[TASK] Switch to confvals for mod.web_list (#464)
Browse files Browse the repository at this point in the history
* use confvals
* correct indentation
* Give headers to examples

No other text changes made. This is a preparation to document options.hideModules for TYPO3-Documentation/Changelog-To-Doc#3

releases: main, 12.4, 11.5
  • Loading branch information
linawolf authored Apr 14, 2024
1 parent dd9c734 commit 7e73a28
Showing 1 changed file with 43 additions and 41 deletions.
84 changes: 43 additions & 41 deletions Documentation/TSconfig/Documentation/PageTsconfig/Options.rst
Original file line number Diff line number Diff line change
@@ -1,72 +1,72 @@
.. include:: /Includes.rst.txt
.. include:: /Includes.rst.txt

.. _pageoptions:
.. _pageoptions:

=======
options
=======

Various options for the page affecting the core at various points.
Various options for the page affecting the Core at various points.

Properties
==========

.. contents::
:depth: 2
:local:
.. contents::
:depth: 2
:local:

.. index::
options.backendLayout
Backend; Layout
.. _pagebackendlayout:

backendLayout
-------------
.. index::
options.backendLayout
Backend; Layout
.. _pagebackendlayout:

exclude
~~~~~~~
backendLayout.exclude
---------------------

:aspect:`Datatype`
list of identifiers / uids
.. confval:: backendLayout.exclude
:name: options-backendLayout-exclude
:type: list of identifiers / uids

:aspect:`Description`
Exclude a list of backend layouts from being selectable when assigning a backend layout
to a page record.

Use the uid/identifier of the record in the default data provider.

:aspect:`Example`
.. figure:: /Images/ManualScreenshots/List/BackendLayoutID.png
:alt: Two backend layout records shown in list module
.. _pagebackendlayout-example:

Two backend layout records shown in list module
Example: Exclude two backend layouts from drop down selector
------------------------------------------------------------

.. code-block:: typoscript
:caption: EXT:site_package/Configuration/page.tsconfig
.. figure:: /Images/ManualScreenshots/List/BackendLayoutID.png
:alt: Two backend layout records shown in list module

# Exclude two backend layouts from drop down selector
options.backendLayout.exclude = 1,2
Before: Two backend layout records shown in list module

.. figure:: /Images/ManualScreenshots/List/BackendLayoutsExcluded.png
:alt: Drop down without backend layouts
.. code-block:: typoscript
:caption: EXT:site_package/Configuration/page.tsconfig
Drop down without backend layouts
# Exclude two backend layouts from drop down selector
options.backendLayout.exclude = 1,2
.. figure:: /Images/ManualScreenshots/List/BackendLayoutsExcluded.png
:alt: Drop down without backend layouts

.. index::
After: Drop down without backend layouts

.. index::
options.backendLayout
Backend; Layout
.. _pagedefaultuploadfolder:
.. _pagedefaultuploadfolder:

defaultUploadFolder
-------------------

.. versionadded:: 12.3

:aspect:`Datatype`
string
.. confval:: defaultUploadFolder
:name: options-defaultUploadFolder
:type: string

:aspect:`Description`
Identical to the user TSconfig setting
:ref:`options.defaultUploadFolder <useroptions-defaultUploadFolder>`,
this allows the setting of a default upload folder per page.
Expand All @@ -76,11 +76,13 @@ defaultUploadFolder

The syntax is "storage_uid:file_path".

:aspect:`Example`
.. code-block:: typoscript
:caption: EXT:site_package/Configuration/page.tsconfig
Example: Set default upload
---------------------------

.. code-block:: typoscript
:caption: EXT:site_package/Configuration/page.tsconfig
# Set default upload folder to "fileadmin/page_upload" on PID 1
[page["uid"] == 1]
options.defaultUploadFolder = 1:/page_upload/
[END]
# Set default upload folder to "fileadmin/page_upload" on PID 1
[traverse(page, "uid") == 1]
options.defaultUploadFolder = 1:/page_upload/
[END]

0 comments on commit 7e73a28

Please sign in to comment.