From c3962376a49904f4c5dad6dbb60572ce13d268bf Mon Sep 17 00:00:00 2001 From: Alexandre Daubois Date: Wed, 18 Jan 2023 13:53:09 +0100 Subject: [PATCH] [Contributing] Mention `php-symfony` and `php-standalone` markup formats --- contributing/documentation/format.rst | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/contributing/documentation/format.rst b/contributing/documentation/format.rst index 83a18f1aaba..3bd2d28f742 100644 --- a/contributing/documentation/format.rst +++ b/contributing/documentation/format.rst @@ -90,11 +90,25 @@ The previous reStructuredText snippet renders as follow: // Configuration in PHP +It may be relevant in some cases to write code examples when using the whole Symfony framework, but also +when using components as standalone libraries without the whole framework installed. In this case, you +may use special formats ``php-symfony`` and ``php-standalone``, which will be rendered like this: + +.. configuration-block:: + + .. code-block:: php-symfony + + // PHP code using features provided by the Symfony framework + + .. code-block:: php-standalone + + // PHP code using standalone components + The current list of supported formats are the following: -=================== ====================================== +=================== ========================================================================================== Markup Format Use It to Display -=================== ====================================== +=================== ========================================================================================== ``html`` HTML ``xml`` XML ``php`` PHP @@ -105,7 +119,9 @@ Markup Format Use It to Display ``ini`` INI ``php-annotations`` PHP Annotations ``php-attributes`` PHP Attributes -=================== ====================================== +``php-symfony`` PHP code example when using the Symfony framework +``php-standalone`` PHP code to be used in a standalone context, for example when using standalone components +=================== ========================================================================================== Adding Links ~~~~~~~~~~~~