[TASK] Improve changelog docs 51/58551/2
authorDaniel Siepmann <daniel.siepmann@typo3.org>
Tue, 2 Oct 2018 06:07:28 +0000 (08:07 +0200)
committerGeorg Ringer <georg.ringer@gmail.com>
Tue, 2 Oct 2018 06:25:19 +0000 (08:25 +0200)
* Fix wrong indentation level in example.
* Adjust sorting of paragraphs for explanation to match order of
  configuration options in example above.
* Keep example consistent. Remove single quotes around two keys in a
  single line, not used in other lines.
* Add syntax highlighting to SiteConfiguration syntax for environment
  variables.

Releases: master
Resolves: #86365, #86409
Change-Id: Ic7923bf7a3215f86637d3a8e20776f74666daf3f
Reviewed-on: https://review.typo3.org/58551
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
Reviewed-by: Georg Ringer <georg.ringer@gmail.com>
Tested-by: Georg Ringer <georg.ringer@gmail.com>
typo3/sysext/core/Documentation/Changelog/9.5/Feature-86365-RoutingEnhancersAndAspects.rst
typo3/sysext/core/Documentation/Changelog/9.5/Feature-86409-AllowUsageOfEnvironmentVariablesInSiteConfiguration.rst

index 0802498..aee4529 100644 (file)
@@ -83,23 +83,23 @@ The configuration looks like this::
        routePath: '/show-by-category/{category_id}/{tag}'
        defaults:
          tag: ''
-         requirements:
-           category_id: '[0-9]{1..3}'
-           tag: '^[a-zA-Z0-9].*$'
-         _arguments:
-           category_id: 'category'
+       requirements:
+         category_id: '[0-9]{1..3}'
+         tag: '^[a-zA-Z0-9].*$'
+       _arguments:
+         category_id: 'category'
 
 The configuration option `routePath` defines the static keyword (previously known to some as "postVarSets" keyword for
 some TYPO3 folks), and the available placeholders.
 
-The `requirements` section exactly specifies what kind of parameter should be added to that route as regular expression.
-This way, it is configurable to only allow integer values for e.g. pagination. If the requirements are too loose, a
-URL signature parameter ("cHash") is added to the end of the URL which cannot be removed.
-
 The `defaults` section defines which URL parameters are optional. If the parameters are omitted on generation, they
 can receive a default value, and do not need a placeholder - it is also possible to add them at the very end of the
 `routePath`.
 
+The `requirements` section exactly specifies what kind of parameter should be added to that route as regular expression.
+This way, it is configurable to only allow integer values for e.g. pagination. If the requirements are too loose, a
+URL signature parameter ("cHash") is added to the end of the URL which cannot be removed.
+
 The `_arguments` section defines what Route Parameters should be available to the system. In this example, the
 placeholder is called `category_id` but the URL generation receives the argument `category`, so this is mapped to
 this very name.
@@ -183,7 +183,7 @@ And generate the following URLs
        plugin: Pi1
        routes:
          - { routePath: '/list/{page}', _controller: 'News::list', _arguments: {'page': '@widget_0/currentPage'} }
-         - { routePath: '/tag/{tag_name}', '_controller': 'News::list', '_arguments': {'tag_name': 'overwriteDemand/tags'}}
+         - { routePath: '/tag/{tag_name}', _controller: 'News::list', _arguments: {'tag_name': 'overwriteDemand/tags'}}
          - { routePath: '/blog/{news_title}', _controller: 'News::detail', _arguments: {'news_title': 'news'} }
          - { routePath: '/archive/{year}/{month}', _controller: 'News::archive' }
        defaultController: 'News::list'
@@ -329,7 +329,7 @@ The configuration could look like this::
              - locale: 'fr_FR.*|fr_CA.*'
                value: 'archives'
              - locale: 'de_DE.*'
-                value: 'archiv'
+               value: 'archiv'
 
 You'll see the placeholder "localized_archive" where the aspect replaces the localized archive based on the locale of
 the language of that page.
index 5c07d4f..b7b1d65 100644 (file)
@@ -15,7 +15,7 @@ disabled via flags. When editing the site configuration through the backend inte
 of environment variables needs to be disabled to be able to add environment configuration through
 the interface.
 
-The format for environment variables is %env(ENV_NAME)%. Environment variables may be used to replace
+The format for environment variables is `%env(ENV_NAME)%`. Environment variables may be used to replace
 complete values or parts of a value.