Commit b3187510 authored by Lina Wolf's avatar Lina Wolf Committed by Christian Kuhn
Browse files

[BUGFIX] Fix sphinx warnings in previous changelog entries

Fixes Layout problems: Malformed lists, malformed
headlines, non-working links to documentation or
other changelogs.
Directive `:ts:` and `.. code-block:: ts` is only
used for typescript, exchanged it into `:typoscript:`
for typoscript examples.

Resolves: #94534
Releases: master, 10.4, 9.5
Change-Id: I61e3c5910d6a5bc97f1ec887ce5b2c1e6d59a2db
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/69922

Tested-by: Simon Gilli's avatarSimon Gilli <typo3@gilbertsoft.org>
Tested-by: core-ci's avatarcore-ci <typo3@b13.com>
Tested-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Simon Gilli's avatarSimon Gilli <typo3@gilbertsoft.org>
Reviewed-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
parent bf8c6585
......@@ -10,7 +10,7 @@ See :issue:`23156`
Description
===========
A new TypoScript configuration option :ts:`breadcrumbWrap` has been added. It allows to configure
A new TypoScript configuration option :typoscript:`breadcrumbWrap` has been added. It allows to configure
the page path separator used in breadcrumbs in Indexed Search results. This option supports TypoScript
option split syntax.
......@@ -21,13 +21,13 @@ Impact
By default Indexed Search is configured to use "/" as a path separator, so it's backward compatible.
Use following configuration for Indexed Search Extbase plugin:
.. code-block:: ts
.. code-block:: typoscript
plugin.tx_indexedsearch.settings.breadcrumbWrap = / || /
For plugin based on AbstractPlugin use:
.. code-block:: ts
.. code-block:: typoscript
plugin.tx_indexedsearch.breadcrumbWrap = / || /
......
......@@ -15,13 +15,13 @@ It controls whether the `no_cache` parameter should be added to page links toget
Use following configuration for Indexed Search Extbase plugin:
.. code-block:: ts
.. code-block:: typoscript
plugin.tx_indexedsearch.settings.forwardSearchWordsInResultLink.no_cache = 1
For plugin based on AbstractPlugin use:
.. code-block:: ts
.. code-block:: typoscript
plugin.tx_indexedsearch.forwardSearchWordsInResultLink.no_cache = 1
......
......@@ -13,7 +13,7 @@ Description
stdWrap sub-properties on boolean properties were not evaluated correctly unless the
property itself was explicitly set.
Example: :ts:`page.10.value.prioriCalc.wrap =` without :ts:`page.10.value.prioriCalc =`
Example: :typoscript:`page.10.value.prioriCalc.wrap =` without :typoscript:`page.10.value.prioriCalc =`
Impact
......
......@@ -10,7 +10,7 @@ See :issue:`75710`
Description
===========
The two RTE-related TSconfig options :ts:`RTE.default.proc.skipAlign` and :ts:`RTE.default.proc.skipClass`
The two RTE-related TSconfig options :typoscript:`RTE.default.proc.skipAlign` and :typoscript:`RTE.default.proc.skipClass`
that don't allow align and class attributes when converting content from the RTE to the database have been removed.
......@@ -23,17 +23,17 @@ Setting these options will have no effect anymore.
Affected Installations
======================
Any installation setting custom TSconfig options for :ts:`skipAlign`, :ts:`skipClass` or setting
:ts:`keepPDIVattribs` without :ts:`class` and :ts:`align` as values are affected.
Any installation setting custom TSconfig options for :typoscript:`skipAlign`, :typoscript:`skipClass` or setting
:typoscript:`keepPDIVattribs` without :typoscript:`class` and :typoscript:`align` as values are affected.
Migration
=========
In order to allow class and align attributes in paragraph tags, the option :ts:`keepPDIVattribs`
In order to allow class and align attributes in paragraph tags, the option :typoscript:`keepPDIVattribs`
needs to be extended to also include "class" and "align" as values, which is done by default.
If an installation has custom TSconfig settings using :ts:`keepPDIVattribs`, the two attributes need to be added
If an installation has custom TSconfig settings using :typoscript:`keepPDIVattribs`, the two attributes need to be added
accordingly to still allow class and align attributes to be kept when transforming from the RTE to the database.
.. index:: TSConfig, RTE, Backend
......@@ -12,9 +12,9 @@ Description
Due to the wrong approach of removeBadHTML it is not 100% complete and does not keep its promise.
- :php:`ContentObjectRenderer::stdWrap_removeBadHTML()`
- :php:`ContentObjectRenderer::removeBadHTML()`
- :ts:`stdWrap.removeBadHTML`
- :php:`ContentObjectRenderer::stdWrap_removeBadHTML()`
- :php:`ContentObjectRenderer::removeBadHTML()`
- :typoscript:`stdWrap.removeBadHTML`
Impact
......@@ -32,8 +32,8 @@ Instances that use the method or stdWrap property.
Migration
=========
Implement a proper encoding by yourself. Use :php:`htmlspecialchars()` or :ts:`stdWrap.htmlSpecialChars`
in the context of HTML, :php:`GeneralUtility::quoteJSvalue()` or :ts:`stdWrap.encodeForJavaScriptValue`
Implement a proper encoding by yourself. Use :php:`htmlspecialchars()` or :typoscript:`stdWrap.htmlSpecialChars`
in the context of HTML, :php:`GeneralUtility::quoteJSvalue()` or :typoscript:`stdWrap.encodeForJavaScriptValue`
in the context of JavaScript.
.. index:: Frontend, TypoScript, PHP-API
......@@ -12,8 +12,8 @@ Description
Font tags are not used any more in HTML since years.
- :php:`ContentObjectRenderer::stdWrap_fontTag()`
- :ts:`stdWrap.fontTag``
- :php:`ContentObjectRenderer::stdWrap_fontTag()`
- :typoscript:`stdWrap.fontTag``
Impact
......@@ -32,6 +32,6 @@ Migration
=========
Update HTML to not output font tags. Use CSS instead. In case you really want to use the font tag,
it can be created by :ts:`stdWrap.wrap`.
it can be created by :typoscript:`stdWrap.wrap`.
.. index:: Frontend, PHP-API, TypoScript
......@@ -16,7 +16,7 @@ The import module of EXT:impexp has been disabled for non-admin users by default
Impact
======
For non-admin users who need that functionality, the userTsConfig option :ts:`options.impexp.enableImportForNonAdminUser = 1`
For non-admin users who need that functionality, the userTsConfig option :typoscript:`options.impexp.enableImportForNonAdminUser = 1`
can be set. This can become a security problem to the TYPO3 instance in core versions
7.6 and 6.2 and should only be enabled for "trustworthy" backend users in general.
......@@ -29,6 +29,6 @@ Installations with non-admin users making active use of the import / export modu
Migration
=========
Set userTsConfig option :ts:`options.impexp.enableImportForNonAdminUser = 1` to restore the old behavior.
Set userTsConfig option :typoscript:`options.impexp.enableImportForNonAdminUser = 1` to restore the old behavior.
.. index:: TSConfig, ext:impexp
......@@ -10,8 +10,8 @@ See :issue:`77209`
Description
===========
The value of the constant :ts:`styles.content.shortcut.tables` which is set by
EXT:fluid_styled_content has been changed from :ts:`tt_content,tt_address,tt_news,tx_news_domain_model_news` to :ts:`tt_content`.
The value of the constant :typoscript:`styles.content.shortcut.tables` which is set by
EXT:fluid_styled_content has been changed from :typoscript:`tt_content,tt_address,tt_news,tx_news_domain_model_news` to :typoscript:`tt_content`.
Impact
......
......@@ -31,6 +31,6 @@ TYPO3 instances using the `templateFile` option via FlexForms in Frontend Login
Migration
=========
Use the TypoScript setting :ts:`plugin.tx_felogin.templateFile` to set an alternative template file.
Use the TypoScript setting :typoscript:`plugin.tx_felogin.templateFile` to set an alternative template file.
.. index:: Frontend, ext:felogin, TypoScript
......@@ -24,7 +24,7 @@ in Frontend mode will not yield the expected result.
Affected Installations
======================
Any installation that uses the :ts:`FILES` cObject, e.g. via the `uploads` CType, as well as
Any installation that uses the :typoscript:`FILES` cObject, e.g. via the `uploads` CType, as well as
any installation with a 3rd party extension that uses the named method.
Migration
......
......@@ -12,7 +12,7 @@ Description
The feature subsearch which enabled the possibility to append previously searched words to the current
query was removed.
The option TypoScript :ts:`plugin.tx_indexedsearch.clearSearchBox` has been removed.
The option TypoScript :typoscript:`plugin.tx_indexedsearch.clearSearchBox` has been removed.
Impact
......
......@@ -15,10 +15,10 @@ The button can be disabled by the following TCA setting:
:php:`[table_name]['columns'][field_name]['config']['appearance']['elementBrowserEnabled'] = false;`
The button can be disabled by the following pageTs setting:
:ts:`TCEFORM.table_name.field_name.config.appearance.elementBrowserEnabled = 0`
:typoscript:`TCEFORM.table_name.field_name.config.appearance.elementBrowserEnabled = 0`
The button can be disabled by the following userTs setting:
:ts:`page.TCEFORM.table_name.field_name.config.appearance.elementBrowserEnabled = 0`
:typoscript:`page.TCEFORM.table_name.field_name.config.appearance.elementBrowserEnabled = 0`
Impact
......
......@@ -36,7 +36,7 @@ Either one of the following:
:html:`noCacheHash="1"` argument from link view-helpers
+ disable the :ts:`requireCHashArgumentForActionArguments` feature, e.g. for EXT:indexed_search:
.. code-block:: ts
.. code-block:: typoscript
plugin {
tx_indexedsearch {
......
......@@ -14,17 +14,17 @@ The browser support for framesets could be dropped in the future.
Creating a layout based on framesets has been marked deprecated:
* DocumentationFrame_
* DocumentationFrameset_
* DocumentationFrame_
* DocumentationFrameset_
The following TypoScript has been marked as deprecated:
* :ts:`config.frameReloadIfNotInFrameset`
* :ts:`config.doctype = xhtml_frames`
* :ts:`config.xhtmlDoctype= xhtml_frames`
* :ts:`frameSet` and its options
* :ts:`FRAME` and its options
* :ts:`FRAMESET` and its options
* :typoscript:`config.frameReloadIfNotInFrameset`
* :typoscript:`config.doctype = xhtml_frames`
* :typoscript:`config.xhtmlDoctype= xhtml_frames`
* :typoscript:`frameSet` and its options
* :typoscript:`FRAME` and its options
* :typoscript:`FRAMESET` and its options
Furthermore the class :php:`FramesetRenderer` has been marked as deprecated.
......
......@@ -9,7 +9,7 @@ See :issue:`17904`
Description
===========
HMENU setting :ts:`showAccessRestrictedPages = NONE` now acts as documented in
HMENU setting :typoscript:`showAccessRestrictedPages = NONE` now acts as documented in
:ref:`TypoScript reference <t3tsref:menu-common-properties-showaccessrestrictedpages>`.
Before: using the option renders :html:`<a>Page title</a>` when page is inaccessible.
......
......@@ -22,7 +22,7 @@ EXT:felogin doesn't add default CSS styles anymore.
Affected Installations
======================
All installations using EXT:felogin with default/non-overwritten :ts:`plugin.tx_felogin_pi1._CSS_DEFAULT_STYLE`
All installations using EXT:felogin with default/non-overwritten :typoscript:`plugin.tx_felogin_pi1._CSS_DEFAULT_STYLE`
TypoScript setup are affected.
......
......@@ -9,7 +9,7 @@ See :issue:`79243`
Description
===========
The TypoScript setting :ts:`config.sys_language_softMergeIfNotBlank` has been removed
The TypoScript setting :typoscript:`config.sys_language_softMergeIfNotBlank` has been removed
without any replacement. This is a result of removing the TCA setting
`mergeIfNotBlank` from the list of possible values for `l10n_mode`.
......@@ -17,6 +17,6 @@ without any replacement. This is a result of removing the TCA setting
Migration
=========
Remove TypoScript setting :ts:`config.sys_language_softMergeIfNotBlank`.
Remove TypoScript setting :typoscript:`config.sys_language_softMergeIfNotBlank`.
.. index:: Frontend, TypoScript, TCA
......@@ -9,7 +9,7 @@ See :issue:`79270`
Description
===========
The RTE option that could be set via PageTSconfig :ts:`RTE.default.proc.disableUnifyLineBreaks` has been removed.
The RTE option that could be set via PageTSconfig :typoscript:`RTE.default.proc.disableUnifyLineBreaks` has been removed.
The option was never set by default.
......
......@@ -37,7 +37,7 @@ Migration
Install the compatibility7 extension to have the same functionality as before, or use HTTPS enforcing via server configuration (.htaccess)
or any SSL related extension in the TYPO3 Extension Repository (TER) that provides superior functionality.
To ensure a certain protocol when previewing a page the TSconfig option :ts:`TCEMAIN.previewDomain` can be used to set a preview prefix including
To ensure a certain protocol when previewing a page the TSconfig option :typoscript:`TCEMAIN.previewDomain` can be used to set a preview prefix including
the URL scheme.
.. index:: Database, Frontend
......@@ -18,7 +18,7 @@ A good value for the `customWidgetId` is the {contentObjectData.uid} to ensure n
Example:
.. code-block:: xml
.. code-block:: none
<f:widget.paginate customWidgetId="{contentObjectData.uid}" ...></f:widget.paginate>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment