From 018a6ca6cfa372626c5898b2b46632f937bd7a69 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 05:43:17 +0100 Subject: [PATCH] [DOC] Resolve documentation warnings (#2309) * [DOCS] Remove outdated reference to Extbase-Fluid Book * [DOCS] Fix all warnings --- .../Tutorials/BestPractice/Seo/Index.rst | 2 +- Documentation/Tutorials/Templates/Index.rst | 2 +- .../Tutorials/Templates/Start/Index.rst | 5 +- .../UsersManual/Records/Tag/Index.rst | 129 +++++++++--------- 4 files changed, 66 insertions(+), 72 deletions(-) diff --git a/Documentation/Tutorials/BestPractice/Seo/Index.rst b/Documentation/Tutorials/BestPractice/Seo/Index.rst index 5d4524be58..57f1580941 100644 --- a/Documentation/Tutorials/BestPractice/Seo/Index.rst +++ b/Documentation/Tutorials/BestPractice/Seo/Index.rst @@ -261,7 +261,7 @@ If using languages with the language mode `strict`, the hreflang tag must only b .. note:: This feature is only supported by TYPO3 10 and up, described - in :ref:`TYPO3 Explained, ModifyHrefLangTagsEvent`. + in :ref:`TYPO3 Explained, ModifyHrefLangTagsEvent `. EXT:news reduces the rendered hreflang attributes by using this event and checking the availability of the records. diff --git a/Documentation/Tutorials/Templates/Index.rst b/Documentation/Tutorials/Templates/Index.rst index 07268694d7..5cbf151450 100755 --- a/Documentation/Tutorials/Templates/Index.rst +++ b/Documentation/Tutorials/Templates/Index.rst @@ -76,7 +76,7 @@ Templates .. rst-class:: card-header h3 - .. rubric:: :ref:`Render content elements` + .. rubric:: :ref:`Render content elements ` .. container:: card-body diff --git a/Documentation/Tutorials/Templates/Start/Index.rst b/Documentation/Tutorials/Templates/Start/Index.rst index 9f3c75a45f..bebca33ad0 100644 --- a/Documentation/Tutorials/Templates/Start/Index.rst +++ b/Documentation/Tutorials/Templates/Start/Index.rst @@ -12,9 +12,8 @@ already, you might skip this section. This documentation won't bring you all information about Fluid but only the most important things you need for using it. You can get more information in the TYPO3 Documentation -:ref:`TYPO3 Explained: Fluid `, -:doc:`Developing TYPO3 Extensions with Extbase and Fluid -` or many third party sites, videos and books. +:ref:`TYPO3 Explained: Fluid ` or many third party sites, +videos and books. .. _templatingSitepackage: diff --git a/Documentation/UsersManual/Records/Tag/Index.rst b/Documentation/UsersManual/Records/Tag/Index.rst index 969911f638..959cbab299 100755 --- a/Documentation/UsersManual/Records/Tag/Index.rst +++ b/Documentation/UsersManual/Records/Tag/Index.rst @@ -19,70 +19,65 @@ or :ref:`List ` module. Properties ========== -.. t3-field-list-table:: - :header-rows: 1 - - - :Field: - Title - :Description: - Title of the tag. This field is required! - - - :Field: - Hidden - :Description: - Hide a tag. - - - :Field: - SEO: -Tag - :Description: - Can be used to set a special <title>-Tag for category pages. - This must be enabled in the template: - - .. code-block:: html - - <f:if condition="{tags.0.title}"> - <n:titleTag> - <f:format.htmlentitiesDecode>{tags.0.title}</f:format.htmlentitiesDecode> - </n:titleTag> - </f:if> - - - :Field: - SEO: Meta-Description - :Description: - Can be used to set a special meta description for category pages. - This must be enabled in the template: - - .. code-block:: html - - <f:if condition="{tags.0.description}"> - <n:metaTag name="description" content="{tags.0.description -> f:format.stripTags()}" /> - </f:if> - - - :Field: - SEO: Headline - :Description: - Can be used to set a special headline for category pages, e.g. for H1 tag - This must be enabled in the template: - - .. code-block:: html - - <f:if condition="{tags.0.headline}"> - <f:then> - <h1>{tags.0.headline}</h1> - </f:then> - <f:else> - <h1>News Category</h1> - </f:else> - </f:if> - - - :Field: - SEO: Text - :Description: - Can be used to add additional content text for category pages - This must be enabled in the template: - - .. code-block:: html - - <f:if condition="{tags.0.text}"> - <f:format.html>{tags.0.text}</f:format.html> - </f:if> +.. confval:: Title + :Required: true + + Title of the tag. + +.. confval:: Hidden + + Hide a tag. + +.. confval:: SEO: <title>-Tag + + Can be used to set a special <title>-Tag for category pages. + This must be enabled in the template: + + .. code-block:: html + + <f:if condition="{tags.0.title}"> + <n:titleTag> + <f:format.htmlentitiesDecode>{tags.0.title}</f:format.htmlentitiesDecode> + </n:titleTag> + </f:if> + + +.. confval:: SEO: Meta-Description + + Can be used to set a special meta description for category pages. + This must be enabled in the template: + + .. code-block:: html + + <f:if condition="{tags.0.description}"> + <n:metaTag name="description" content="{tags.0.description -> f:format.stripTags()}" /> + </f:if> + + +.. confval:: SEO: Headline + + Can be used to set a special headline for category pages, e.g. for H1 tag + This must be enabled in the template: + + .. code-block:: html + + <f:if condition="{tags.0.headline}"> + <f:then> + <h1>{tags.0.headline}</h1> + </f:then> + <f:else> + <h1>News Category</h1> + </f:else> + </f:if> + + +.. confval:: SEO: Text + + Can be used to add additional content text for category pages + This must be enabled in the template: + + .. code-block:: html + + <f:if condition="{tags.0.text}"> + <f:format.html>{tags.0.text}</f:format.html> + </f:if>