Skip to content

Commit

Permalink
[TASK] Take care of rendering warnings in core Changelog rendering
Browse files Browse the repository at this point in the history
Also, some improvements are made to sentence structure, tenses
and syntax highlightning.

Resolves: #88748
Releases: master, 9.5
Change-Id: I932dabbfc404de7c3dc4f3cef1ccb50c2fd94f72
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/61268
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
  • Loading branch information
Anja Leichsenring authored and maddy2101 committed Jul 17, 2019
1 parent ada069a commit 38c47bb
Show file tree
Hide file tree
Showing 32 changed files with 191 additions and 200 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ It takes the field content as a whole and can additionally take some parameters

The full parameter usage in Fluid might look like this, where {link} is the field content:

.. code-block:: HTML
.. code-block:: php
<f:link.typolink parameter="{link}" target="_blank" class="ico-class" title="some title" additionalParams="b=u" additionalAttributes="{type:'button'}">
<f:link.typolink parameter="{link}" target="_blank" class="ico-class" title="some title" additionalParams="b=u" additionalAttributes="{type:'button'}">
<f:uri.typolink parameter="{link}" additionalParameters="b=u">
<f:uri.typolink parameter="{link}" additionalParameters="b=u">
Only *parameter* is required, all other parameters are optional.
Expand All @@ -41,7 +41,7 @@ In case of the Uri.Typolink Viewhelper, only the first and the fourth parameter
the tag related properties are discarded.
For the given examples, the output is:

.. code-block:: html
.. code-block:: php
<a href="index.php?id=19&X=y&b=u" title="some title" target="_blank" class="ico-class" type="button">
index.php?id=19&X=y&b=u
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ of the Frontend rendering engine as a replacement for :php:`getLLL()`.
If you are not doing anything special on language initialization, the call to :php:`initLLvars()`
can likely be dropped. If you need to influence language initialization yourself, you can use the
hooks :php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_fe.php']['settingLanguage_preProcess']`
or :php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_fe.php']['settingLanguage_postProcess']`.
or :php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_fe.php']['settingLanguage_postProcess']`.

For doing special logic, it is recommend to set up a custom instance of :php:`LanguageService`
which holds all functionality directly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ imports and works as follows:

.. code-block:: typoscript
# Import a single file
@import 'EXT:myproject/Configuration/TypoScript/randomfile.typoscript'
# Import multiple files in a single directory, sorted by file name
@import 'EXT:myproject/Configuration/TypoScript/*.typoscript'
# Import all files in a directory
@import 'EXT:myproject/Configuration/TypoScript/'
# It's possible to omit the file ending, then "typoscript" is automatically added
@import 'EXT:myproject/Configuration/TypoScript/'
# Import a single file
@import 'EXT:myproject/Configuration/TypoScript/randomfile.typoscript'
# Import multiple files in a single directory, sorted by file name
@import 'EXT:myproject/Configuration/TypoScript/*.typoscript'
# Import all files in a directory
@import 'EXT:myproject/Configuration/TypoScript/'
# It's possible to omit the file ending, then "typoscript" is automatically added
@import 'EXT:myproject/Configuration/TypoScript/'
The main benefits of `@import` over using `<INCLUDE_TYPOSCRIPT>` are:

Expand All @@ -40,14 +40,13 @@ The main benefits of `@import` over using `<INCLUDE_TYPOSCRIPT>` are:

The following rules apply:

- If multiple files are found, the file name is important in which order the files (sorted
alphabetically by filename)
- If multiple files are found, the file name is important in which order the files (sorted alphabetically by filename)

- Recursive inclusion of files (@import within @import is possible)

- It is not possible to use a condition as possible with <INCLUDE_TYPOSCRIPT condition=""> as its
sole purpose is to include files, which happens before the actual real condition matching happens,
and the INCLUDE_TYPOSCRIPT condition syntax is a conceptual mistake, and should be avoided.
sole purpose is to include files, which happens before the actual real condition matching happens,
and the INCLUDE_TYPOSCRIPT condition syntax is a conceptual mistake, and should be avoided.

- Both `<INCLUDE_TYPOSCRIPT>` and `@import` can work side-by-side in the same project

Expand Down
10 changes: 0 additions & 10 deletions typo3/sysext/core/Documentation/Changelog/9.1/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,3 @@ Deprecation
:glob:

Deprecation-*

Important
^^^^^^^^^

.. toctree::
:maxdepth: 1
:titlesonly:
:glob:

Important-*
Original file line number Diff line number Diff line change
Expand Up @@ -268,10 +268,12 @@ Purpose
Adminpanel module settings interface denotes that a module has own settings.

The adminpanel knows two types of settings:
* ModuleSettings are relevant for the module itself and its representation (for example the log module provides
settings where displayed log level and grouping of the module can be configured)
* PageSettings are relevant for rendering the page (for example the preview module provides settings showing or
hiding hidden content elements or simulating a specific rendering time)

* ModuleSettings are relevant for the module itself and its representation (for example the log module provides settings
where displayed log level and grouping of the module can be configured)

* PageSettings are relevant for rendering the page (for example the preview module provides settings showing or hiding
hidden content elements or simulating a specific rendering time)

If a module provides settings relevant to its own content, use this interface.

Expand Down Expand Up @@ -354,8 +356,10 @@ Purpose
Adminpanel page settings interface denotes that a module has settings regarding the page rendering.

The adminpanel knows two types of settings:

* ModuleSettings are relevant for the module itself and its representation (for example the log module provides settings
where displayed log level and grouping of the module can be configured)

* PageSettings are relevant for rendering the page (for example the preview module provides settings showing or hiding
hidden content elements or simulating a specific rendering time)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,17 @@ See :issue:`86907`
Description
===========

The dependency injection via properties has been deprecated for all properties that are non public.
The dependency injection via properties has been marked as deprecated for all properties that are non public.

While there are several reasons not to use property injection at all there is one specific drawback with non public properties. To be able to inject dependencies into non public properties, said properties have to be made accessible during runtime. As that process is quite slow and expensive and non cachable, it should not be used at all.
While there are several reasons not to use property injection at all there is one specific drawback with non public properties.
To be able to inject dependencies into non public properties, said properties have to be made accessible during runtime.
As that process is quite slow and expensive and non cachable, it should not be used at all.


Impact
======

Dependency injection will no longer work with non public properties
Dependency injection will no longer work with non public properties.


Affected Installations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Since introduction of the standalone package typo3fluid/fluid, the TYPO3 core pr
for the moved classes to ease usage in extensions.
These class aliases will be dropped in TYPO3 v10.

The following class aliases are deprecated:
The following class aliases have been marked as deprecated and should no longer be used:

* :php:`TYPO3\CMS\Fluid\Core\Compiler\TemplateCompiler`
* :php:`TYPO3\CMS\Fluid\Core\Exception`
Expand Down Expand Up @@ -48,16 +48,16 @@ Extensions and third party packages using the :php:`TYPO3\CMS\Fluid` namespace m
by the stand alone Fluid package change.
If aliased class names are used, there will be fatal PHP Errors after update to TYPO3 v10.

The extension scanner will find usage of these classes.

Affected Installations
======================

All installations that use the :php:`TYPO3\CMS\Fluid` namespace for class aliases.


Migration
=========

Migrate to the original classes in namespace :php:`TYPO3Fluid\Fluid\`.
Migrate to the original classes in namespace :php:`TYPO3Fluid\Fluid`.

.. index:: PHP-API, FullyScanned, ext:fluid
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ See :issue:`83334`
Description
===========

The new method :php:`\TYPO3\CMS\Core\Utility\HttpUtility::buildQueryString()` has been added as an enhancement to the `PHP function`_ :php:`http_build_query()`
to implode multidimensional parameter arrays, properly encode parameter names as well as values with an optional prepend of :php:`?` or :php:`&` if the query
string is not empty and skipping empty parameters.
The method :php:`\TYPO3\CMS\Core\Utility\HttpUtility::buildQueryString()` has been added as an enhancement to the `PHP function`_ :php:`http_build_query()`.
It implodes multidimensional parameter arrays and properly encodes parameter names as well as values to a valid query string.
with an optional prepend of :php:`?` or :php:`&` If the query is not empty, `?` or `&` are prepended in the correct sequence.
Empty parameters are skipped.

.. _`PHP function`: https://secure.php.net/manual/de/function.http-build-query.php

Expand All @@ -20,4 +21,4 @@ Impact

Parameter arrays can be safely transformed into HTTP GET query strings using the new method.

.. index:: PHP-API, NotScanned
.. index:: PHP-API
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ Impact

Especially for enhancing the site configuration it might be useful to set the configuration.

Full example
Easy example
------------

By using the following configuration, slashes are removed from the slug.

.. code-block:: php
Expand All @@ -39,6 +40,7 @@ By using the following configuration, slashes are removed from the slug.
Advanced examples
-----------------

The following configuration uses more replacements:

.. code-block:: php
Expand All @@ -59,4 +61,4 @@ The following configuration uses more replacements:
This will change the provided slug `Some Job in city1/city2 (f/m)` to `some-job-in-city1-city2`.

.. index:: Frontend, ext:core, NotScanned
.. index:: Frontend, ext:core
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ content in a different language than the default language (sys_language_uid=0).

The functionality of "fallbackChain" can now be defined in any kind of fallback type (see below).

The "fallbackChain" checks access / availability of a page translation of a language. And if
The "fallbackChain" checks access / availability of a page translation of a language. If
this language does not exist, TYPO3 checks for other languages, and uses this language then
for showing content.

This results in three different kinds of rendering modes ("Fallback Type") for content in
translated content, however it is necessary to understand the overlay concept when fetching
translated pages, however it is necessary to understand the overlay concept when fetching
content in TYPO3 Frontend.

Using "language overlays" means that the default language records are fetched at first.
Using "language overlays" means that the default language records are fetched first.
Also, various "enable fields" (e.g. hidden / frontend user groups etc) are evaluated for the
default language. Each record then is "overlaid" with the record of the target language.

Expand All @@ -40,7 +40,7 @@ This mode is typically used for 1:1 translations of fully different languages li
"English" (default) and "Danish" (translation).

2. "fallback" -- Fetch records from default language, and checks for a translation of
each record. If the record has no translation, the default language is still shown.
each record. If the record has no translation, the default language is shown.

This scenario is usually used when the default language is "German" but the translation
is "Swiss-German" where only different content elements are translated, but the rest is
Expand All @@ -57,8 +57,8 @@ are added in language "Swahili".
Impact
======

Existing installations with site configuration "fallback" will also now render the non-translated
content (un-localized records).
Existing installations with site configuration "fallback" will now render the non-translated
content (un-localized records), too.

Regardless of the fallback type, records without localization parent, and records set to "-1"
(All Languages) are always fetched.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ See :issue:`86826`
Description
===========

The :php:`RecordsXmlSitemapDataProvider` supports now the configuration `recursive` to include
The class :php:`TYPO3\CMS\Seo\XmlSitemap\RecordsXmlSitemapDataProvider` supports now the configuration `recursive` to include
records not only from provided list of page ids but also its subpages.
`recursive` refers to the number of levels taken into account beyond the `pid` page. (default: 0)
:typoscript:`recursive` refers to the number of levels taken into account beyond the `pid` page. (default: 0)

Impact
======
Expand All @@ -37,19 +37,17 @@ A full example:
fieldToParameterMap {
uid = tx_news_pi1[news]
}
additionalGetParameters {
tx_news_pi1.controller = News
tx_news_pi1.action = detail
}
useCacheHash = 1
}
}
}
}
}
}
}
.. index:: Frontend, ext:seo, NotScanned
.. index:: Frontend, ext:seo
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ See :issue:`86881`
Description
===========

With #83429 the core got support for feature toggles including a small API.
This patch adds support for feature toggle check in the symfony expression language DefaultFunctionProvider.
Support for feature toggle check in the symfony expression language DefaultFunctionProvider is provided.
With the new function :typoscript:`feature()` the feature toggle can be checked.

.. code-block:: typoscript
Expand All @@ -24,4 +23,4 @@ With the new function :typoscript:`feature()` the feature toggle can be checked.
[END]
.. index:: Backend, Frontend, TypoScript, ext:core, NotScanned
.. index:: Backend, Frontend, TypoScript, ext:core
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,25 @@ See :issue:`86973`
Description
===========

Site language configuration can now be accessed via the :typoscript:`getText` property `siteLanguage`
Site language configuration can now be accessed via the :typoscript:`getText` property :typoscript:`siteLanguage`
in TypoScript.

Examples:

.. code-block:: typoscript
page.10 = TEXT
page.10.data = siteLanguage:navigationTitle
page.10.wrap = This is the title of the current site language: |
page.10 = TEXT
page.10.data = siteLanguage:navigationTitle
page.10.wrap = This is the title of the current site language: |
.. code-block:: typoscript
page.10 = TEXT
page.10.dataWrap = The current site language direction is {siteLanguage:direction}
page.10 = TEXT
page.10.dataWrap = The current site language direction is {siteLanguage:direction}
Impact
======

Accessing the current site language configuration is now possible in TypoScript.

.. index:: PHP-API, ext:frontend, NotScanned
.. index:: PHP-API, ext:frontend
Original file line number Diff line number Diff line change
Expand Up @@ -12,33 +12,33 @@ Description
The new site handling functionality adds some attributes to the frontend rendering <html> tag automatically, even per language
(e.g. "lang" and "dir" attributes) without having to use TypoScript anymore.

However, if custom properties should be added, e.g. `<html lang="fr" amp>`, this is not possible anymore without having
to reintroduce TypoScript conditions or complex stdWrap functionality. In previous versions the property `config.htmlTag_setParams`
However, if custom properties should be added, e.g. :html:`<html lang="fr" amp>`, this is not possible anymore without having
to reintroduce TypoScript conditions or complex stdWrap functionality. In previous versions the property :typoscript:`config.htmlTag_setParams`
was used to override all properties, but since there were conditions in place for languages, this was a one-liner change per language.

In order to use the full power of TypoScript flexibility, it is possible now to use `config.htmlTag.attributes` which
In order to use the full power of TypoScript flexibility, it is possible now to use :typoscript:`config.htmlTag.attributes` which
allows to override and add custom attributes via TypoScript without having to re-add the existing attributes generated by SiteHandling.

This property supersedes the previous `config.htmlTag_setParams` option by providing a more flexible API to add attributes.
This property supersedes the previous :typoscript:`config.htmlTag_setParams` option by providing a more flexible API to add attributes.

Examples:

- :ts:`config.htmlTag.attributes.class = no-js`
- :typoscript:`config.htmlTag.attributes.class = no-js`

Will result in `<html lang="fr" class="no-js">`.
Will result in :html:`<html lang="fr" class="no-js">`.

It is even possible to add attributes without a value:

`config.htmlTag.attributes.amp = `
:typoscript:`config.htmlTag.attributes.amp =`

will render `<html lang="it" amp>`
will render :html:`<html lang="it" amp>`

Please note that "lang" attribute in these examples are auto-generated by Site configuration, depending on the value added there.


Impact
======

If the TypoScript option `config.htmlTag.attributes` is used, then `config.htmlTag_setParams` has no effect anymore.
If the TypoScript option :typoscript:`config.htmlTag.attributes` is used, then :typoscript:`config.htmlTag_setParams` has no effect anymore.

.. index:: TypoScript, ext:frontend, NotScanned
.. index:: TypoScript, ext:frontend
Loading

0 comments on commit 38c47bb

Please sign in to comment.