Skip to content

Commit

Permalink
[TASK] Align with new TYPO3 documentation standards (#507)
Browse files Browse the repository at this point in the history
* [TASK] Align with new TYPO3 documentation standards

- align README.rst, Settings.cfg, Index.rst, Includes.rst.txt, Sitemap.rst, genindex.rst
- move Sitemap/Index.rst to Sitemap.rst
- remove outdated Targets.rst

See TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument@c2bb63b for further details.

* [DOCS] Apply new intersphinx mapping names

* [DOCS] Reference manual's start page with :doc:`<manual>:Index`

Adding the custom label `start` to the beginning of the manual's
Index.rst is redundant. Use :doc:`<manual>:Index` instead of
:ref:`<manual:start>` to refer to it.

* [DOCS] Replace :ts: with :typoscript: text role

The ambiguous :ts: text role has been removed to
not confuse the writer with typescript and typoscript.

* [DOCS] Fix rendering warnings
  • Loading branch information
alexander-nitsche authored Mar 27, 2022
1 parent 247d03b commit c2bfa98
Show file tree
Hide file tree
Showing 61 changed files with 540 additions and 642 deletions.
4 changes: 3 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Use as master: https://github.com/TYPO3-Documentation/T3DocTeam/blob/main/.editorconfig

# top-most EditorConfig file
root = false
root = true

[{*.rst,*.rst.txt}]
charset = utf-8
Expand All @@ -12,6 +12,7 @@ insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 3
max_line_length = 80

# MD-Files
[*.md]
Expand All @@ -21,3 +22,4 @@ insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 4
max_line_length = 80
4 changes: 2 additions & 2 deletions Documentation/About.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ About This Manual

This document is a complete reference to all objects types and properties of
TypoScript as used in frontend TypoScript template building, and not in
:ref:`TSconfig <t3tsconfig:start>`.
:doc:`TSconfig <t3tsconfig:Index>`.

.. seealso::

* For explanations about the syntax of TypoScript itself,
please refer to the
:ref:`TypoScript Syntax <t3coreapi:typoscript-syntax-start>`
chapter in "TYPO3 Explained"
* For an introduction to TypoScript Templates, see :ref:`t3ts45:start`
* For an introduction to TypoScript Templates, see :doc:`t3ts45:Index`

.. _credits:

Expand Down
2 changes: 1 addition & 1 deletion Documentation/AppendixA/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ call it, if the content you create may not be cached.
from executing it, then the :php:`$GLOBALS['TSFE']->set_no_cache()`
function is not executed and the page *is* cached! So in these
situations, correct the error, clear the page-cache and try again.
This is true only for :ts:`USER` and not for :ts:`USER_INT`, which is
This is true only for :typoscript:`USER` and not for :typoscript:`USER_INT`, which is
rendered *after* the cached page!


Expand Down
12 changes: 6 additions & 6 deletions Documentation/Conditions/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -244,9 +244,9 @@ tree.rootLineParentIds

.. versionadded:: 10.3

This implements the old :ts:`PIDupinRootline` condition within the Symfony
This implements the old :typoscript:`PIDupinRootline` condition within the Symfony
expression language, see
:doc:`t3core:Changelog/10.3/Feature-88962-Re-implementOldPIDupinRootlineTypoScriptCondition`
:doc:`ext_core:Changelog/10.3/Feature-88962-Re-implementOldPIDupinRootlineTypoScriptCondition`

:aspect:`Variable`
tree.rootLineParentIds
Expand Down Expand Up @@ -541,7 +541,7 @@ workspace
~~~~~~~~~

.. versionadded:: 10.3
:doc:`t3core:Changelog/10.3/Feature-90203-MakeWorkspaceAvailableInTypoScriptConditions`
:doc:`ext_core:Changelog/10.3/Feature-90203-MakeWorkspaceAvailableInTypoScriptConditions`

:aspect:`Variable`
workspace
Expand All @@ -560,7 +560,7 @@ workspace.workspaceId
"""""""""""""""""""""

.. versionadded:: 10.3
:doc:`t3core:Changelog/10.3/Feature-90203-MakeWorkspaceAvailableInTypoScriptConditions`
:doc:`ext_core:Changelog/10.3/Feature-90203-MakeWorkspaceAvailableInTypoScriptConditions`


:aspect:`Variable`
Expand All @@ -585,7 +585,7 @@ workspace.isLive
""""""""""""""""

.. versionadded:: 10.3
:doc:`t3core:Changelog/10.3/Feature-90203-MakeWorkspaceAvailableInTypoScriptConditions`
:doc:`ext_core:Changelog/10.3/Feature-90203-MakeWorkspaceAvailableInTypoScriptConditions`


:aspect:`Variable`
Expand All @@ -610,7 +610,7 @@ workspace.isOffline
"""""""""""""""""""

.. versionadded:: 10.3
:doc:`t3core:Changelog/10.3/Feature-90203-MakeWorkspaceAvailableInTypoScriptConditions`
:doc:`ext_core:Changelog/10.3/Feature-90203-MakeWorkspaceAvailableInTypoScriptConditions`


:aspect:`Variable`
Expand Down
14 changes: 7 additions & 7 deletions Documentation/ContentObjects/Content/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -190,13 +190,13 @@ renderObj
:ref:`data-type-cObject`

Default
:ts:`< [table name]`
:typoscript:`< [table name]`

Description
The cObject used for rendering the records resulting from the query in
.select.

If :ts:`renderObj` is not set explicitly, then :ts:`< [table name]` is used. So
If :typoscript:`renderObj` is not set explicitly, then :typoscript:`< [table name]` is used. So
in this case the configuration of the according table is being copied.
See the notes on the example below.

Expand All @@ -223,16 +223,16 @@ slide
If set and no content element is found by the select command, the
rootLine will be traversed back until some content is found.

Possible values are :ts:`-1` (slide back up to the siteroot), :ts:`1` (only
the current level) and :ts:`2` (up from one level back).
Possible values are :typoscript:`-1` (slide back up to the siteroot), :typoscript:`1` (only
the current level) and :typoscript:`2` (up from one level back).

Use :ts:`-1` in combination with collect.
Use :typoscript:`-1` in combination with collect.

slide.collect
(integer /:ref:`stdWrap`) If set, all content elements found
on the current and parent pages will be collected. Otherwise, the sliding
would stop after the first hit. Set this value to the amount of levels
to collect on, or use :ts:`-1` to collect up to the siteroot.
to collect on, or use :typoscript:`-1` to collect up to the siteroot.

slide.collectFuzzy
(boolean /:ref:`stdWrap`) Only useful in collect mode. If
Expand Down Expand Up @@ -322,7 +322,7 @@ Here is an example of the CONTENT object::
}

Since in the above example .renderObj is not set explicitly, TYPO3
will automatically set :ts:`1.renderObj < tt_content`, so that `renderObj`
will automatically set :typoscript:`1.renderObj < tt_content`, so that `renderObj`
will reference the TypoScript configuration of `tt_content`. The
according TypoScript configuration will be copied to `renderObj`.

Expand Down
4 changes: 2 additions & 2 deletions Documentation/ContentObjects/Files/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ and is there to output information about files.
folder is often equivalent to the relative path of the
folder.

The property folders has the option :ts:`recursive` to get
The property folders has the option :typoscript:`recursive` to get
files recursively.

**Example:**
Expand All @@ -122,7 +122,7 @@ and is there to output information about files.
page.10 = FILES
page.10.folders = 2:mypics/,4:myimages/
Example for option :ts:`recursive`:
Example for option :typoscript:`recursive`:

.. code-block:: typoscript
Expand Down
4 changes: 2 additions & 2 deletions Documentation/ContentObjects/Fluidtemplate/DataProcessing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ dataProcessing

Add one or multiple processors to manipulate the :php:`$data` variable of
the currently rendered content object, like tt_content or page. The sub-
property :ts:`options` can be used to pass parameters to the processor
property :typoscript:`options` can be used to pass parameters to the processor
class.

There are several data processors available to allow flexible processing,
Expand Down Expand Up @@ -59,7 +59,7 @@ would be the page record and all fields of the :typoscript:`pages` table
are available.

All examples base on :typoscript:`lib.contentElement`, which is provided by
the system extension :ref:`fluid_styled_content <fsc:start>`.
the system extension :doc:`fluid_styled_content <ext_fsc:Index>`.

In this system extension it is defined as follows::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ specific custom data processor, of course.
Example output
==============

.. include:: /Images/AutomaticScreenshots/DataProcessing/Custom data processors.rst.txt
.. include:: /Images/AutomaticScreenshots/DataProcessing/CustomDataProcessors.rst.txt

Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This data processor can be used for processing file information:
* all files from a certain folder
* all files from a collection

A :ts:`FLUIDTEMPLATE` can then simply iterate over processed data automatically.
A :typoscript:`FLUIDTEMPLATE` can then simply iterate over processed data automatically.


Options:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ LanguageMenuProcessor
=====================

This menu processor generates a json encoded menu string that will be
decoded again and assigned to the :ts:`FLUIDTEMPLATE` as a variable.
decoded again and assigned to the :typoscript:`FLUIDTEMPLATE` as a variable.

.. hint:: The third party extension
`b13/menus <https://extensions.typo3.org/extension/menus>`__ also provides
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ MenuProcessor


The :php:`MenuProcessor` utilizes :ref:`HMENU <cobj-hmenu>` to generate a JSON encoded menu string
that will be decoded again and assigned to :ts:`FLUIDTEMPLATE` as a variable.
that will be decoded again and assigned to :typoscript:`FLUIDTEMPLATE` as a variable.
Additional data processing is supported and will be applied to each record.

.. hint:: The third party extension
Expand Down
43 changes: 22 additions & 21 deletions Documentation/ContentObjects/Fluidtemplate/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ FLUIDTEMPLATE
=============

An object of type FLUIDTEMPLATE combines TypoScript with the Fluid
templating engine.
templating engine.

.. versionchanged:: 11.0
The content object FLUIDTEMPLATE has replaced `TEMPLATE
Expand All @@ -27,23 +27,23 @@ Data available in Fluid templates

The following data will be available in the called Fluid template:

* The content of the current :php:`data` array.
* The content of the current :php:`data` array.

* On page level it contains the current page record.
* If the :typoscript:`FLUIDTEMPLATE` is used in the
context of the Fluid ViewHelper :html:`<f:cObject>` it contains the data set
* On page level it contains the current page record.
* If the :typoscript:`FLUIDTEMPLATE` is used in the
context of the Fluid ViewHelper :html:`<f:cObject>` it contains the data set
in the Fluid Property :ref:`data <t3viewhelper:cobject_data>`.
* If called in the context of Extbase it contains the data assigned to the view
* If called in the context of Extbase it contains the data assigned to the view
in the :ref:`Controller <t3extbasebook:controllers>`.
* The :php:`settings` array set by the parameter

* The :php:`settings` array set by the parameter
:ref:`settings <cobj-fluidtemplate-properties-settings>`
* Variables set by the setting
* Variables set by the setting
:ref:`variables <cobj-fluidtemplate-properties-variables>`
* Additional data retrieved by
* Additional data retrieved by
:ref:`data processors <cobj-fluidtemplate-properties-dataprocessing>`
You can use the ViewHelper :ref:`debug <t3viewhelper:typo3fluid-fluid-debug>` to

You can use the ViewHelper :ref:`debug <t3viewhelper:typo3fluid-fluid-debug>` to
receive a complete listing of the available data using the magic `{_all}` variable:

.. code-block:: html
Expand Down Expand Up @@ -83,7 +83,7 @@ dataProcessing

Add one or multiple processors to manipulate the :php:`$data` variable of
the currently rendered content object, like tt_content or page. The sub-
property :ts:`options` can be used to pass parameters to the processor
property :typoscript:`options` can be used to pass parameters to the processor
class.

.. note::
Expand Down Expand Up @@ -123,10 +123,11 @@ extbase.controllerExtensionName

.. tip::
Setting this allows you to skip the `extensionName` argument for the
:ref:`<t3vh:translate>` and the :ref:`<t3vh:uri-resource>` viewhelpers.

:ref:`<t3viewhelper:typo3-fluid-translate>` and the :ref:`<t3viewhelper:typo3-fluid-uri-resource>`
viewhelpers.

This requires you to put translations and public images in the
:ref:`usual paths in your extension <t3coreapi:reserved-folders>`.
:ref:`usual paths in your extension <t3coreapi:extension-reserved-folders>`.


.. index:: FLUIDTEMPLATE; extbase.controllerName
Expand Down Expand Up @@ -199,7 +200,7 @@ format
:sep:`|` :aspect:`Default:` html
:sep:`|`

:ts:`format` sets the format of the current request. It can be something
:typoscript:`format` sets the format of the current request. It can be something
like "html", "xml", "png", "json". And it can even come in the form of
"rss.xml" or alike.

Expand Down Expand Up @@ -370,8 +371,8 @@ template

.. warning::

The :ts:`FILE` object type has been removed in TYPO3 10. As the :ts:`.template`
property used :ts:`FILE`, you should generally check your code if
The :typoscript:`FILE` object type has been removed in TYPO3 10. As the :typoscript:`.template`
property used :typoscript:`FILE`, you should generally check your code if
using this and switch to using :ref:`.templateName <cobj-fluidtemplate-properties-templatename>`
with :ref:`.templateRootPaths <cobj-fluidtemplate-properties-templaterootpaths>` or use
:ref:`.file <cobj-fluidtemplate-properties-file>`.
Expand All @@ -392,7 +393,7 @@ templateName

This name is used together with the set format to find the template in the
given templateRootPaths. Use this property to define a content object, which
should be used as template file. It is an alternative to :ts:`.file`. If
should be used as template file. It is an alternative to :typoscript:`.file`. If

`.templateName` is set, it takes precedence.

Expand Down Expand Up @@ -564,4 +565,4 @@ headlines. The copyright year will be taken from the TypoScript constant

* :ref:`dataProcessing` examples
* :ref:`t3coreapi:adding-your-own-content-elements`
* :ref:`t3sitepackage:start`
* :doc:`t3sitepackage:Index`
10 changes: 5 additions & 5 deletions Documentation/ContentObjects/Hmenu/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,8 @@ Options
rootLine. Thus "-1" is a menu with items from the outermost level,
"-2" is the level before the outermost...

**Note:** :ts:`entryLevel` does not show a menu **of a certain level of pages**
(use :ts:`special = directory` for that)
**Note:** :typoscript:`entryLevel` does not show a menu **of a certain level of pages**
(use :typoscript:`special = directory` for that)
but it means that it will start to be visible **from that level on**.

So, for example if you build a simple "sitemap" menu like this one::
Expand All @@ -148,7 +148,7 @@ Options
}

it will start to be visible from the 4th level (and will contain only the subpages from that level).
Please note also that this affects also the menu generated with :ts:`MenuProcessor`. Example::
Please note also that this affects also the menu generated with :typoscript:`MenuProcessor`. Example::

page.10{
dataProcessing {
Expand Down Expand Up @@ -470,8 +470,8 @@ certain page" and so on.

.. note::

:ts:`.entryLevel` generally is not supported together with the
:ts:`.special` property! The only exception is :ts:`special = keywords`.
:typoscript:`.entryLevel` generally is not supported together with the
:typoscript:`.special` property! The only exception is :typoscript:`special = keywords`.

Also be aware that this property selects pages for the first level in
the menu. Submenus by menuObjects 2+ will be created as usual.
Expand Down
Loading

0 comments on commit c2bfa98

Please sign in to comment.