Skip to content

Commit

Permalink
[TASK] Unify placeholder syntax (#1613)
Browse files Browse the repository at this point in the history
Use `<placeholder>` as default placeholder style in
URLs since it's standard in Backus–Naur form.

To avoid URL linking, apply the reST directive `:samp:`.
  • Loading branch information
alexander-nitsche committed Nov 24, 2021
1 parent 5e7c754 commit abcc188
Show file tree
Hide file tree
Showing 34 changed files with 97 additions and 103 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
@@ -1,4 +1,4 @@
# EditorConfig is awesome: http://EditorConfig.org
# EditorConfig is awesome: https://EditorConfig.org
# Use as master: https://github.com/TYPO3-Documentation/T3DocTeam/blob/master/.editorconfig

# top-most EditorConfig file? false = no!
Expand Down
12 changes: 6 additions & 6 deletions Documentation/ApiOverview/BackendRouting/Index.rst
Expand Up @@ -92,7 +92,7 @@ Backend routes can enforce an HTTP Referer header's existence by adding a
Values for :php:`referrer` are declared as comma-separated list:

* `required` enforces existence of HTTP `Referer` header that has to match the
currently used backend URL (e.g. `https://example.org/typo3/`), the request
currently used backend URL (e.g. :samp:`https://example.org/typo3/`), the request
will be denied otherwise.
* `refresh-empty` triggers a HTML based refresh in case HTTP `Referer` header
is not given or empty - this attempt uses an HTML refresh, since regular HTTP
Expand All @@ -106,21 +106,21 @@ to protect and keep information about the current session token internal.

The request sequence in the TYPO3 Core looks like this:

* HTTP request to `https://example.org/typo3/` having a valid user session
* HTTP request to :samp:`https://example.org/typo3/` having a valid user session
* internally **public** backend route `/login` is processed
* internally redirects to **restricted** backend route `/main` since an
existing and valid backend user session was found
+ HTTP redirect to `https://example.org/typo3/main?token=...`
+ HTTP redirect to :samp:`https://example.org/typo3/main?token=...`
+ exposing the token is mitigated with `referrer` route option mentioned above

.. important::

Please keep in mind these steps are part of a mitigation strategy, which requires
to be aware of mentioned implications when implementing custom web applications.


.. index:: Backend routing; Generating backend URLs

Generating backend URLs
=======================

Expand Down
Expand Up @@ -289,7 +289,7 @@ InnoDB Issues
-------------

The database backend for MySQL uses InnoDB tables. Due to the nature of InnoDB, deleting records
`does not reclaim <http://bugs.mysql.com/bug.php?id=1287>`_ the actual disk space. E.g. if the cache uses 10GB,
`does not reclaim <https://bugs.mysql.com/bug.php?id=1287>`_ the actual disk space. E.g. if the cache uses 10GB,
cleaning it will still keep 10GB allocated on the disk even though phpMyAdmin will show 0 as the cache table size.
To reclaim the space, turn on the MySQL option file_per_table, drop the cache tables and re-create
them using the Install Tool.
Expand Down Expand Up @@ -344,7 +344,7 @@ Options
Memcached Backend
=================

`Memcached <http://memcached.org/>`_ is a simple, distributed key/value RAM database.
`Memcached <https://memcached.org/>`_ is a simple, distributed key/value RAM database.
To use this backend, at least one memcached daemon must be reachable,
and the PECL module "memcache" must be loaded.
There are two PHP memcached implementations: "memcache" and "memcached".
Expand Down Expand Up @@ -450,7 +450,7 @@ Options
Redis Backend
=============

`Redis <http://redis.io/>`_ is a key-value storage/database.
`Redis <https://redis.io/>`_ is a key-value storage/database.
In contrast to memcached, it allows structured values.
Data is stored in RAM but it allows persistence to disk
and doesn't suffer from the design problems of the memcached backend implementation.
Expand Down Expand Up @@ -591,7 +591,7 @@ Options
Wincache Backend
================

`Wincache <http://www.iis.net/downloads/microsoft/wincache-extension>`_ is a PHP opcode cache similar to APC, but
`Wincache <https://www.iis.net/downloads/microsoft/wincache-extension>`_ is a PHP opcode cache similar to APC, but
dedicated to the Windows OS platform. Similar to APC, the cache can also be used as in-memory key/value cache.

The cache backend implementation is nearly identical to the implementation of `APC backend <https://docs.typo3.org/m/typo3/reference-coreapi/9.5/en-us/ApiOverview/CachingFramework/FrontendsBackends/Index.html#apc-backend>`_ and has the same design constrains.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/ApiOverview/CachingFramework/Index.rst
Expand Up @@ -283,7 +283,7 @@ and can implement its own specific storage strategy.

The caching framework exists to help speeding up TYPO3 sites, especially heavily loaded ones.
It is possible to move all caches to a dedicated cache server with specialized cache systems
like the Redis key-value store (a so called `NoSQL database <http://en.wikipedia.org/wiki/NoSQL>`_).
like the Redis key-value store (a so called `NoSQL database <https://en.wikipedia.org/wiki/NoSQL>`_).

Major parts of the original caching framework were originally backported from TYPO3 Flow.

Expand Down
Expand Up @@ -180,7 +180,7 @@ seeAlso

.. code-block:: text
pages:starttime , pages:endtime , tt\_content:header , Link to TYPO3.org \| http://typo3.org/
pages:starttime , pages:endtime , tt\_content:header , Link to TYPO3.org \| https://typo3.org/
.. _csh-files-extend-label:
Expand Down
2 changes: 1 addition & 1 deletion Documentation/ApiOverview/Database/Configuration/Index.rst
Expand Up @@ -51,7 +51,7 @@ Remarks:

* The connect options are hand over to Doctrine DBAL without much manipulation from TYPO3 CMS side.
Please refer to the
`doctrine connection docs <http://docs.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html>`__
`doctrine connection docs <https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html>`__
for a full overview of settings.

* If `charset` option is not specified it defaults to `utf8`.
Expand Down
6 changes: 3 additions & 3 deletions Documentation/ApiOverview/Database/Introduction/Index.rst
Expand Up @@ -39,7 +39,7 @@ Doctrine DBAL
=============

Database queries in TYPO3 are done with an API based on
`Doctrine DBAL <http://www.doctrine-project.org/projects/dbal.html>`__.
`Doctrine DBAL <https://www.doctrine-project.org/projects/dbal.html>`__.
The API is provided by the system extension `core` which is always loaded and
thus always available.

Expand Down Expand Up @@ -74,9 +74,9 @@ extensions.
Understanding Doctrine DBAL and Doctrine ORM
============================================

Doctrine is a two-fold project with `Doctrine DBAL <http://www.doctrine-project.org/projects/dbal.html>`__
Doctrine is a two-fold project with `Doctrine DBAL <https://www.doctrine-project.org/projects/dbal.html>`__
being the low-level database abstraction and query building interface to specific database engines, while
`Doctrine ORM <http://www.doctrine-project.org/projects/orm.html>`__
`Doctrine ORM <https://www.doctrine-project.org/projects/orm.html>`__
is a high-level object relational mapping on top of Doctrine DBAL.

The TYPO3 Core - only - implements the dbal part. `Doctrine ORM` is neither required nor
Expand Down
Expand Up @@ -175,7 +175,7 @@ Values in plain text can be changed in LocalConfiguration.php.
.. seealso::

`PHP predefined constants for errors and logging
<http://php.net/manual/en/errorfunc.constants.php>`__
<https://www.php.net/manual/en/errorfunc.constants.php>`__

.. tip::

Expand Down
6 changes: 3 additions & 3 deletions Documentation/ApiOverview/GlobalValues/Typo3ConfVars/HTTP.rst
Expand Up @@ -10,7 +10,7 @@ $GLOBALS['TYPO3_CONF_VARS']['HTTP']
===================================

HTTP configuration to tune how TYPO3 behaves on HTTP requests made by TYPO3.
See `Guzzle documentation <http://docs.guzzlephp.org/en/latest/request-options.html>`__
See `Guzzle documentation <https://docs.guzzlephp.org/en/latest/request-options.html>`__
for more background information on those settings.

.. index::
Expand Down Expand Up @@ -131,7 +131,7 @@ $GLOBALS['TYPO3_CONF_VARS']['HTTP']['ssl_key']
:Default: null

Local certificate and an optional passphrase, see
`Guzzle option ssl-key <http://docs.guzzlephp.org/en/latest/request-options.html#ssl-key>`__
`Guzzle option ssl-key <https://docs.guzzlephp.org/en/latest/request-options.html#ssl-key>`__

.. index::
TYPO3_CONF_VARS HTTP; timeout
Expand Down Expand Up @@ -165,7 +165,7 @@ $GLOBALS['TYPO3_CONF_VARS']['HTTP']['verify']
:Default: true

Describes the SSL certificate verification behavior of a request, see
`Guzzle option verify <http://docs.guzzlephp.org/en/latest/request-options.html#verify>`__
`Guzzle option verify <https://docs.guzzlephp.org/en/latest/request-options.html#verify>`__

.. index::
TYPO3_CONF_VARS HTTP; version
Expand Down
6 changes: 3 additions & 3 deletions Documentation/ApiOverview/Http/Index.rst
Expand Up @@ -21,12 +21,12 @@ a simplified wrapper to access Guzzle clients.

All options available under :php:`$GLOBALS['TYPO3_CONF_VARS'][HTTP]` are automatically applied to the Guzzle
clients when using the :php:`RequestFactory` class. The options are a subset to the available options
on Guzzle (http://docs.guzzlephp.org/en/latest/request-options.html) but can further be extended.
on Guzzle (https://docs.guzzlephp.org/en/latest/request-options.html) but can further be extended.

Existing :php:`$GLOBALS['TYPO3_CONF_VARS'][HTTP]` options have been removed and/or migrated to the
new Guzzle-compliant options.

A full documentation for Guzzle can be found at http://docs.guzzlephp.org/en/latest/.
A full documentation for Guzzle can be found at https://docs.guzzlephp.org/en/latest/.

Although Guzzle can handle Promises/A+ and asynchronous requests, it currently acts as
a drop-in replacement for the previous mixed options and implementations within
Expand Down Expand Up @@ -63,7 +63,7 @@ The `RequestFactory` class can be used like this:
$additionalOptions = [
// Additional headers for this specific request
'headers' => ['Cache-Control' => 'no-cache'],
// Additional options, see http://docs.guzzlephp.org/en/latest/request-options.html
// Additional options, see https://docs.guzzlephp.org/en/latest/request-options.html
'allow_redirects' => false,
'cookies' => true,
];
Expand Down
Expand Up @@ -143,7 +143,7 @@ translated:
'gsw_CH' => array('de_AT', 'de'),
);
In this case we define that "gsw_CH" (which is the `official code <http://www.localeplanet.com/icu/>`_ for
In this case we define that "gsw_CH" (which is the `official code <https://www.localeplanet.com/icu/>`_ for
"Schwiizertüütsch" - that is, "Swiss German") can fall back on "de_AT" (another custom translation) and then on "de".

The translations have to be stored in the appropriate labels path sub folder
Expand Down
Expand Up @@ -83,10 +83,10 @@ If translations exist on Pootle there is no need to retranslate everything on Cr
#. **Fetch translations**
Download the translations you need. You will need to download them directly from the TER with the following URL pattern:

`https://extensions.typo3.org/fileadmin/ter/{e}/{x}/{extension_key}-l10n/{extension_key}-l10n-{lang}.zip`
:samp:`https://extensions.typo3.org/fileadmin/ter/<e>/<x>/<extension_key>-l10n/<extension_key>-l10n-<lang>.zip`

Here `{extension_key}` is the full extension key, `{e}` the 1st and `{x}` the 2nd letter of that extension key.
Finally `{lang}` is the 2-lettered language identifier, e.g. `de`.
Here `<extension_key>` is the full extension key, `<e>` the 1st and `<x>` the 2nd letter of that extension key.
Finally `<lang>` is the 2-lettered language identifier, e.g. `de`.

For example to download the German translations of the extension *powermail*:
`wget 'https://extensions.typo3.org/fileadmin/ter/p/o/powermail-l10n/powermail-l10n-de.zip'`
Expand Down
Expand Up @@ -39,7 +39,7 @@ The class (listener) which receives the event
public function postProcessMirrorUrl(ModifyLanguagePackRemoteBaseUrlEvent $event): void
{
if ($event->getPackageKey() === self::$extensionKey) {
$mirrorUrl = 'http://mycompany.tld/typo3-packages/';
$mirrorUrl = 'https://example.org/typo3-packages/';
$event->setBaseUrl($mirrorUrl);
}
}
Expand All @@ -52,7 +52,7 @@ On the custom translation server side, the structure needs to be:

.. code-block:: text
https://mycompany.tld/typo3-packages/
https://example.org/typo3-packages/
`-- <first-letter-of-extension-key>
`-- <second-letter-of-extension-key>
`-- <extension-key>-l10n
Expand All @@ -65,7 +65,7 @@ hence in our example:

.. code-block:: text
https://mycompany.tld/typo3-packages/
https://example.org/typo3-packages/
`-- m
`-- y
`-- myext-l10n
Expand Down
Expand Up @@ -17,5 +17,5 @@ in English are uploaded on that server and translations are packaged nightly.
They can be fetched in the TYPO3 CMS backend, via the Install Tool and on the command line.

It is not the point of this manual to go into the details of the translation
process. More information can be found in the `TYPO3 wiki <http://wiki.typo3.org/Translation>`_.
process. More information can be found in the `TYPO3 wiki <https://wiki.typo3.org/Translation>`_.

Expand Up @@ -6,8 +6,8 @@
XLIFF Format
============

The `XML Localisation Interchange File Format <http://en.wikipedia.org/wiki/XLIFF>`_
(or XLIFF) is an `OASIS-blessed <http://www.oasis-open.org/committees/xliff>`_
The `XML Localisation Interchange File Format <https://en.wikipedia.org/wiki/XLIFF>`_
(or XLIFF) is an `OASIS-blessed <https://www.oasis-open.org/committees/xliff>`_
standard format for translations.

In a nutshell an XLIFF document contains one or more :code:`<file>` elements. Each file
Expand Down
6 changes: 3 additions & 3 deletions Documentation/ApiOverview/LockingApi/Index.rst
Expand Up @@ -32,15 +32,15 @@ or function, that is not available on your system, TYPO3 will automatically dete
not use this mechanism and respective locking strategy (e.g. if function :php:`sem_get()` is not
available, :php:`SemaphoreLockStrategy` will not be used).

* **FileLockStrategy**: uses the PHP function `flock() <http://php.net/manual/en/function.flock.php>`__
* **FileLockStrategy**: uses the PHP function `flock() <https://www.php.net/manual/en/function.flock.php>`__
and creates a file in `typo3temp/var/lock`
The directory can be overwritten by configuration::

// The directory specified here must exist und must be a subdirectory of `Environment::getProjectPath()`
$GLOBALS['TYPO3_CONF_VARS']['SYS']['locking']['strategies'][\TYPO3\CMS\Core\Locking\FileLockStrategy::class]['lockFileDir'] = 'mylockdir';

* **SemaphoreLockStrategy**: uses the PHP function `sem_get()
<http://php.net/manual/en/function.sem-get.php>`__
<https://www.php.net/manual/en/function.sem-get.php>`__
* **SimpleLockStrategy** is a simple method of file locking. It also uses the folder
`typo3temp/var/lock`.

Expand Down Expand Up @@ -226,7 +226,7 @@ FileLockStrategy & NFS
----------------------

There is a problem with PHP `flock()
<http://php.net/manual/en/function.flock.php>`__ on NFS systems.
<https://www.php.net/manual/en/function.flock.php>`__ on NFS systems.
This problem may or may not affect you, if you use NFS. See this
issue for more information

Expand Down
8 changes: 4 additions & 4 deletions Documentation/ApiOverview/Logging/Processors/Index.rst
Expand Up @@ -64,7 +64,7 @@ MemoryUsageProcessor
The memory usage processor adds the amount of used memory to the log record
(result from `memory_get_usage()`__).

__ http://www.php.net/manual/en/function.memory-get-usage.php
__ https://www.php.net/manual/en/function.memory-get-usage.php

================ ========= =========================================================================== ============
Option Mandatory Description Default
Expand All @@ -73,7 +73,7 @@ realMemoryUsage no Use real__ size of memory allocated from system ins
formatSize no Whether the size is formatted with GeneralUtility::formatSize() :code:`TRUE`
================ ========= =========================================================================== ============

__ http://www.php.net/manual/en/function.memory-get-usage.php
__ https://www.php.net/manual/en/function.memory-get-usage.php


.. index:: Logging; MemoryPeakUsageProcessor
Expand All @@ -85,7 +85,7 @@ MemoryPeakUsageProcessor
The memory peak usage processor adds the peak amount of used memory to the log record
(result from `memory_get_peak_usage()`__).

__ http://www.php.net/manual/en/function.memory-get-peak-usage.php
__ https://www.php.net/manual/en/function.memory-get-peak-usage.php

================ ========== =========================================================================== ============
Option Mandatory Description Default
Expand All @@ -94,7 +94,7 @@ realMemoryUsage no Use real__ size of memory allocated from system in
formatSize no Whether the size is formatted with GeneralUtility::formatSize() :code:`TRUE`
================ ========== =========================================================================== ============

__ http://www.php.net/manual/en/function.memory-get-peak-usage.php
__ https://www.php.net/manual/en/function.memory-get-peak-usage.php


.. index:: Logging; Processors
Expand Down
4 changes: 2 additions & 2 deletions Documentation/ApiOverview/Logging/Writers/Index.rst
Expand Up @@ -131,7 +131,7 @@ PhpErrorLogWriter

Logs into the PHP error log using `error_log()`_

.. _error_log(): http://www.php.net/manual/en/function.error-log.php
.. _error_log(): https://www.php.net/manual/en/function.error-log.php

.. _logging-writers-syslog:

Expand All @@ -148,7 +148,7 @@ facility no Syslog Facility_ ``USER``
to log into.
======== ========= ================ ========

.. _Facility: http://en.wikipedia.org/wiki/Syslog#Facility_Levels
.. _Facility: https://en.wikipedia.org/wiki/Syslog#Facility_Levels


.. _logging-writers-custom:
Expand Down
2 changes: 1 addition & 1 deletion Documentation/ApiOverview/PasswordHashing/Index.rst
Expand Up @@ -324,7 +324,7 @@ To add an additional hash algorithm, these steps are necessary:
.. _Argon2: https://en.wikipedia.org/wiki/Argon2
.. _bcrypt: https://en.wikipedia.org/wiki/Bcrypt
.. _PBKDF2: https://en.wikipedia.org/wiki/PBKDF2
.. _phpass: http://www.openwall.com/phpass/
.. _phpass: https://www.openwall.com/phpass/
.. _blowfish: https://en.wikipedia.org/wiki/Blowfish_(cipher)
.. _md5: https://en.wikipedia.org/wiki/MD5

Expand Down
Expand Up @@ -30,9 +30,9 @@ to access the Page with ID *13*.

Enhancers are a way to extend this route with placeholders on top of this specific route to a page.

:code:`https://example.org/path-to/my-page/products/{product-name}`
:samp:`https://example.org/path-to/my-page/products/<product-name>`

The suffix `/products/{product-name}` to the base route of the page is added by an enhancer. The placeholder variable
The suffix `/products/<product-name>` to the base route of the page is added by an enhancer. The placeholder variable
which is added by the curly braces can then be statically or dynamically resolved or built by an Aspect (more
commonly known as a Mapper).

Expand Down
4 changes: 2 additions & 2 deletions Documentation/ApiOverview/Routing/Examples.rst
Expand Up @@ -658,8 +658,8 @@ EXT: DpnGlossary

**Result:**

* List view: :samp:`https://example.org/[YOUR_PLUGINPAGE_SLUG]`
* Detail view: :samp:`https://example.org/[YOUR_PLUGINPAGE_SLUG]/term/the-term-title`
* List view: :samp:`https://example.org/<YOUR_PLUGINPAGE_SLUG>`
* Detail view: :samp:`https://example.org/<YOUR_PLUGINPAGE_SLUG>/term/the-term-title`

.. code-block:: yaml
:linenos:
Expand Down
Expand Up @@ -10,4 +10,4 @@ General Links
* https://docs.google.com/document/d/1CqSgEgxnWwq8GT31kawGSVJp7hfU2TcVe9BAbtzFK0A/edit#
- ACME architecture document 2015-07 Nueremberg

* http://www.phptherightway.com/
* https://phptherightway.com/
Expand Up @@ -87,4 +87,4 @@ For these reasons the trait has been dissolved into an `AbstractMenuViewHelper`.
Further Reading
===============

See http://rosstuck.com/how-i-use-traits/.
See https://www.rosstuck.com/how-i-use-traits.
2 changes: 1 addition & 1 deletion Documentation/CodingGuidelines/Introduction.rst
Expand Up @@ -71,7 +71,7 @@ EditorConfig
~~~~~~~~~~~~

One method to set up your IDE / editor to adhere to specific Coding Guidelines,
is to use an .editorconfig file. Read `EditorConfig.org <http://EditorConfig.org>`__
is to use an .editorconfig file. Read `EditorConfig.org <https://EditorConfig.org>`__
to find out more about it. Various IDEs or Editors support editorconfig by default or with
an additional plugin.

Expand Down
Expand Up @@ -48,7 +48,7 @@ Given a version number **MAJOR.MINOR.PATCH**, increment the:
Additional labels for pre-release and build metadata are available as extensions
to the **MAJOR.MINOR.PATCH format**.

More you can see at `https://semver.org <https://semver.org>`__
More you can see at https://semver.org.

Offer feedback options
======================
Expand Down

0 comments on commit abcc188

Please sign in to comment.