Skip to content

[Contributing] Mention php-symfony and php-standalone markup formats #17768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 19, 2023
Merged

[Contributing] Mention php-symfony and php-standalone markup formats #17768

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions contributing/documentation/format.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
~~~~~~~~~~~~
Expand Down