Skip to content

Commit

Permalink
[TASK] Set unique names for confvals in cobjects chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
linawolf committed Mar 26, 2024
1 parent c6de913 commit 8ae9a98
Show file tree
Hide file tree
Showing 13 changed files with 174 additions and 8 deletions.
9 changes: 9 additions & 0 deletions Documentation/ContentObjects/Case/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ from the "default" property will be used.
.. contents::
:local:

.. _cobj-case-properties:

Properties
==========

Expand All @@ -38,6 +40,7 @@ Properties
-------------------

.. confval:: array of cObjects
:name: case-array

:Data type: :ref:`cObject <data-type-cobject>`

Expand All @@ -52,6 +55,7 @@ cache
-----

.. confval:: cache
:name: case-cache

:Data type: :ref:`cache <cache>`

Expand All @@ -64,6 +68,7 @@ default
-------

.. confval:: default
:name: case-default

:Data type: :ref:`cObject <data-type-cobject>`

Expand All @@ -79,6 +84,7 @@ if
--

.. confval:: if
:name: case-if

:Data type: :ref:`->if <if>`

Expand All @@ -91,6 +97,7 @@ key
---

.. confval:: key
:name: case-key

:Data type: :ref:`data-type-string` / :ref:`stdWrap <stdwrap>`
:Default: default
Expand All @@ -114,6 +121,7 @@ setCurrent
----------

.. confval:: setCurrent
:name: case-setCurrent

:Data type: :ref:`data-type-string` / :ref:`stdWrap <stdwrap>`

Expand All @@ -126,6 +134,7 @@ stdWrap
-------

.. confval:: stdWrap
:name: case-stdWrap

:Data type: :ref:`stdWrap <stdwrap>`

Expand Down
9 changes: 9 additions & 0 deletions Documentation/ContentObjects/CoaAndCoaInt/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,18 @@ you to render *every* cObject non-cached.
.. contents::
:local:

.. _cobj-coa-properties:

Properties
==========

.. _cobj-coa-index:

1,2,3,4...
-----------

.. confval:: 1,2,3,4...
:name: coa-array

:Data type: :ref:`cObject <data-type-cobject>`

Expand All @@ -51,6 +56,7 @@ cache
-----

.. confval:: cache
:name: coa-cache

:Data type: :ref:`cache <cache>`

Expand All @@ -63,6 +69,7 @@ if
--

.. confval:: if
:name: coa-if

:Data type: :ref:`->if <if>`

Expand All @@ -75,6 +82,7 @@ stdWrap
-------

.. confval:: stdWrap
:name: coa-stdWrap

:Data type: :ref:`->stdWrap <stdwrap>`

Expand All @@ -87,6 +95,7 @@ wrap
----

.. confval:: wrap
:name: coa-wrap

:Data type: :ref:`wrap <data-type-wrap>` / :ref:`stdWrap <stdwrap>`

Expand Down
30 changes: 28 additions & 2 deletions Documentation/ContentObjects/Content/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ is raised to the maximum timestamp value of the respective records.
.. contents::
:local:

.. _cobj-content-properties:

Properties
==========

Expand All @@ -35,6 +37,7 @@ select
------

.. confval:: select
:name: content-select

:Data type: :ref:`select`

Expand All @@ -48,6 +51,7 @@ table
-----

.. confval:: table
:name: content-table

:Data type: *table name* / :ref:`stdwrap`

Expand All @@ -63,6 +67,7 @@ renderObj
---------

.. confval:: renderObj
:name: content-renderObj

:Data type: :ref:`data-type-cObject`
:Default: :typoscript:`< [table name]`
Expand All @@ -84,6 +89,7 @@ slide
-----

.. confval:: slide
:name: content-slide

:Data type: :ref:`data-type-integer` / :ref:`stdWrap`

Expand All @@ -103,10 +109,13 @@ slide

Use :typoscript:`-1` in combination with :ref:`collect <cobj-content-slide-collect>`.


.. _cobj-content-slide-collect:

slide.collect
~~~~~~~~~~~~~

.. confval:: slide.collect
:name: content-slide-collect

:Data type: :ref:`data-type-integer` / :ref:`stdWrap`

Expand All @@ -118,7 +127,11 @@ slide

.. _cobj-content-slide-collectFuzzy:

slide.collectFuzzy
~~~~~~~~~~~~~~~~~~

.. confval:: slide.collectFuzzy
:name: content-slide-collectFuzzy

:Data type: :ref:`data-type-boolean` / :ref:`stdWrap`

Expand All @@ -129,7 +142,11 @@ slide

.. _cobj-content-slide-collectReverse:

slide.collectReverse
~~~~~~~~~~~~~~~~~~~~

.. confval:: slide.collectReverse
:name: content-slide-collectReverse

:Data type: :ref:`data-type-boolean` / :ref:`stdWrap`

Expand All @@ -143,6 +160,7 @@ wrap
----

.. confval:: wrap
:name: content-wrap

:Data type: :ref:`wrap <data-type-wrap>` / :ref:`stdWrap`

Expand All @@ -155,6 +173,7 @@ stdWrap
-------

.. confval:: stdWrap
:name: content-stdWrap

:Data type: :ref:`stdWrap`

Expand All @@ -167,15 +186,20 @@ cache
-----

.. confval:: cache
:name: content-cache

:Data type: :ref:`cache <cache>`

See :ref:`cache function description <cache>` for details.


.. _cobj-content-examples:

Examples
========

.. _cobj-content-example-detail:

CONTENT explained in detail
---------------------------

Expand Down Expand Up @@ -270,7 +294,7 @@ See also: :ref:`if`, :ref:`select`, :ref:`data-type-wrap`, :ref:`stdWrap`,
:ref:`data-type-cobject`


.. _cobj-content-examples:
.. _cobj-content-example-display-all:

Display all tt_content records from this page
----------------------------------------------
Expand All @@ -294,6 +318,8 @@ will reference the TypoScript configuration of `tt_content`. The
according TypoScript configuration will be copied to `renderObj`.


.. _cobj-content-special-rendering:

Apply special rendering
========================

Expand Down
18 changes: 18 additions & 0 deletions Documentation/ContentObjects/Files/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ A content object of type FILES uses the :ref:`File Abstraction Layer <t3coreapi:
.. contents::
:local:

.. _cobj-files-properties:

Properties
==========

Expand All @@ -23,6 +25,7 @@ files
------

.. confval:: files
:name: files-files

:Data type: :ref:`data-type-string` / :ref:`stdWrap <stdwrap>`

Expand All @@ -43,6 +46,7 @@ references
----------

.. confval:: references
:name: files-references

:Data type: :ref:`data-type-string` / :ref:`stdWrap <stdwrap>` or array

Expand Down Expand Up @@ -91,6 +95,7 @@ collections
-----------

.. confval:: collections
:name: files-collections

:Data type: :ref:`data-type-string` / :ref:`stdWrap <stdwrap>`

Expand All @@ -104,6 +109,7 @@ folders
-------

.. confval:: folders
:name: files-folders

:Data type: :ref:`data-type-string` / :ref:`stdWrap <stdwrap>`

Expand Down Expand Up @@ -150,6 +156,7 @@ sorting
-------

.. confval:: sorting
:name: files-sorting

:Data type: :ref:`data-type-string` / :ref:`stdWrap <stdwrap>`

Expand All @@ -158,7 +165,11 @@ sorting

.. _cobj-files-sorting-direction:

sorting.direction
~~~~~~~~~~~~~~~~~

.. confval:: sorting.direction
:name: files-sorting-direction

:Data type: :ref:`data-type-string` / :ref:`stdWrap <stdwrap>`
:Default: asc
Expand All @@ -174,6 +185,7 @@ begin
-----

.. confval:: begin
:name: files-begin

:Data type: :ref:`data-type-integer` / :ref:`stdWrap <stdwrap>`

Expand All @@ -187,6 +199,7 @@ maxItems
--------

.. confval:: maxItems
:name: files-maxItems

:Data type: :ref:`data-type-integer` / :ref:`stdWrap <stdwrap>`

Expand All @@ -202,6 +215,7 @@ renderObj
---------

.. confval:: renderObj
:name: files-renderObj

:Data type: :ref:`cObject <data-type-cobject>` :ref:`+optionSplit <optionsplit>`

Expand Down Expand Up @@ -230,6 +244,7 @@ stdWrap
-------

.. confval:: stdWrap
:name: files-stdWrap

:Data type: :ref:`->stdWrap <stdwrap>`

Expand All @@ -246,6 +261,7 @@ references.table
----------------

.. confval:: references.table
:name: files-references-table

:Data type: :ref:`data-type-string` / :ref:`stdWrap <stdwrap>`

Expand All @@ -258,6 +274,7 @@ references.uid
--------------

.. confval:: references.uid
:name: files-references-uid

:Data type: :ref:`data-type-integer` / :ref:`stdWrap <stdwrap>`

Expand All @@ -270,6 +287,7 @@ references.fieldName
--------------------

.. confval:: references.fieldName
:name: files-references-fieldName

:Data type: :ref:`data-type-string` / :ref:`stdWrap <stdwrap>`

Expand Down
Loading

0 comments on commit 8ae9a98

Please sign in to comment.