Skip to content

Commit

Permalink
[TASK] Replace "t3-function-cache" with "confval" (#1058)
Browse files Browse the repository at this point in the history
This is a preparation for switching to PHP-based documentation rendering.

Additionally:
- Anchor links are added

Releases: main, 12.4
  • Loading branch information
brotkrueml authored Feb 2, 2024
1 parent 2e58bc9 commit 7bd4741
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
20 changes: 14 additions & 6 deletions Documentation/Functions/Cache.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,18 @@ rendered content will be stored in the cache, if :typoscript:`cache.key` was set
configuration options :typoscript:`cache.tags` and :typoscript:`cache.lifetime` allow to control
the caching.

.. contents::
:local:
.. contents::
:local:

Properties
==========

.. _cache-key:

key
---

.. t3-function-cache:: key
.. confval:: key

:Data type: :ref:`data-type-string` / :ref:`stdwrap`

Expand All @@ -45,10 +47,13 @@ key
cache key that is accurate enough to distinguish different versions of the
rendered content while being generic enough to stay efficient.


.. _cache-lifetime:

lifetime
--------

.. t3-function-cache:: lifetime
.. confval:: lifetime

:Data type: mixed / :ref:`stdwrap`
:Default: default
Expand All @@ -73,10 +78,13 @@ lifetime
The default cache lifetime as configured in :typoscript:`config.cache_period` is
used.


.. _cache-tags:

tags
----

.. t3-function-cache:: tags
.. confval:: tags

:Data type: :ref:`data-type-string` / :ref:`stdwrap`

Expand All @@ -85,7 +93,7 @@ tags
`cache_pages` cache) and can be used to purge the cached content.


.. _cache-examples:
.. _cache-examples:

Examples
========
Expand Down
1 change: 0 additions & 1 deletion Documentation/Settings.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ use_opensearch =

[sphinx_object_types_to_add]

t3-function-cache = t3-function-cache // t3-function-cache // Function cache
t3-function-encapslines = t3-function-encapslines // t3-function-encapslines // Function encapsLines
t3-function-htmlparser = t3-function-htmlparser // t3-function-htmlparser // Function HTMLparser
t3-function-htmlparser-tags = t3-function-htmlparser-tags // t3-function-htmlparser-tags // Function HTMLparser_tags
Expand Down

0 comments on commit 7bd4741

Please sign in to comment.