FAF: Documentation UI Twig Blocks

This commit is contained in:
Eric
2021-06-18 18:00:14 +02:00
parent 8edc7c7ce0
commit 5fa85eb05a
5 changed files with 102 additions and 13 deletions

View File

@@ -30,11 +30,13 @@ Twig Tag
:Type:
+------------------------------------------+-------------------------------------------------------------------+
| :ref:`Standard <UIContentBlockStandard>` | No comment |
+------------------------------------------+-------------------------------------------------------------------+
| :ref:`ForCode <UIContentBlockForCode>` | Used to display a block of code like <pre> but allows line break. |
+------------------------------------------+-------------------------------------------------------------------+
+--------------------------------------------------------+-------------------------------------------------------------------+
| :ref:`Standard <UIContentBlockStandard>` | No comment |
+--------------------------------------------------------+-------------------------------------------------------------------+
| :ref:`ForCode <UIContentBlockForCode>` | Used to display a block of code like <pre> but allows line break. |
+--------------------------------------------------------+-------------------------------------------------------------------+
| :ref:`ForPreformatted <UIContentBlockForPreformatted>` | No comment |
+--------------------------------------------------------+-------------------------------------------------------------------+
.. _UIContentBlockStandard:
@@ -78,6 +80,27 @@ UIContentBlock ForCode
| sId | string | optional | NULL | |
+-------+--------+-----------+------+--+
.. _UIContentBlockForPreformatted:
UIContentBlock ForPreformatted
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:syntax:
.. code-block:: twig
{% UIContentBlock ForPreformatted {sCode:'value', sId:'value'} %}
Content Goes Here
{% EndUIContentBlock %}
:parameters:
+-------+--------+-----------+------+--+
| sCode | string | mandatory | | |
+-------+--------+-----------+------+--+
| sId | string | optional | NULL | |
+-------+--------+-----------+------+--+
UIContentBlock common parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^