Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TASK] Switch to confvals for options #464

Merged
merged 1 commit into from
Apr 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 43 additions & 41 deletions 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]
Loading