Skip to content

Commit 12741c8

Browse files
committed
minor #17768 [Contributing] Mention php-symfony and php-standalone markup formats (alexandre-daubois)
This PR was merged into the 5.4 branch. Discussion ---------- [Contributing] Mention `php-symfony` and `php-standalone` markup formats Commits ------- c396237 [Contributing] Mention `php-symfony` and `php-standalone` markup formats
2 parents 4fcfa79 + c396237 commit 12741c8

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

contributing/documentation/format.rst

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,25 @@ The previous reStructuredText snippet renders as follow:
9090
9191
// Configuration in PHP
9292
93+
It may be relevant in some cases to write code examples when using the whole Symfony framework, but also
94+
when using components as standalone libraries without the whole framework installed. In this case, you
95+
may use special formats ``php-symfony`` and ``php-standalone``, which will be rendered like this:
96+
97+
.. configuration-block::
98+
99+
.. code-block:: php-symfony
100+
101+
// PHP code using features provided by the Symfony framework
102+
103+
.. code-block:: php-standalone
104+
105+
// PHP code using standalone components
106+
93107
The current list of supported formats are the following:
94108

95-
=================== ======================================
109+
=================== ==========================================================================================
96110
Markup Format Use It to Display
97-
=================== ======================================
111+
=================== ==========================================================================================
98112
``html`` HTML
99113
``xml`` XML
100114
``php`` PHP
@@ -105,7 +119,9 @@ Markup Format Use It to Display
105119
``ini`` INI
106120
``php-annotations`` PHP Annotations
107121
``php-attributes`` PHP Attributes
108-
=================== ======================================
122+
``php-symfony`` PHP code example when using the Symfony framework
123+
``php-standalone`` PHP code to be used in a standalone context, for example when using standalone components
124+
=================== ==========================================================================================
109125

110126
Adding Links
111127
~~~~~~~~~~~~

0 commit comments

Comments
 (0)