Skip to content

Commit

Permalink
[DOC] Resolve documentation warnings (#2309)
Browse files Browse the repository at this point in the history
* [DOCS] Remove outdated reference to Extbase-Fluid Book

* [DOCS] Fix all warnings
  • Loading branch information
linawolf authored Jan 21, 2024
1 parent b5da14a commit 018a6ca
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 72 deletions.
2 changes: 1 addition & 1 deletion Documentation/Tutorials/BestPractice/Seo/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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<t3coreapi:ModifyHrefLangTagsEvent>`.
in :ref:`TYPO3 Explained, ModifyHrefLangTagsEvent <t3coreapi:ModifyHrefLangTagsEvent>`.

EXT:news reduces the rendered hreflang attributes by using this event and checking the availability of the records.

Expand Down
2 changes: 1 addition & 1 deletion Documentation/Tutorials/Templates/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Templates

.. rst-class:: card-header h3

.. rubric:: :ref:`Render content elements<renderContentElements>`
.. rubric:: :ref:`Render content elements <renderContentElements>`

.. container:: card-body

Expand Down
5 changes: 2 additions & 3 deletions Documentation/Tutorials/Templates/Start/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <t3coreapi:fluid>`,
:doc:`Developing TYPO3 Extensions with Extbase and Fluid
<t3extbasebook:Index>` or many third party sites, videos and books.
:ref:`TYPO3 Explained: Fluid <t3coreapi:fluid>` or many third party sites,
videos and books.

.. _templatingSitepackage:

Expand Down
129 changes: 62 additions & 67 deletions Documentation/UsersManual/Records/Tag/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,70 +19,65 @@ or :ref:`List <listAddFirstRecord>` 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: <title>-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>

0 comments on commit 018a6ca

Please sign in to comment.