FAF: Documentation UI Twig Blocks

This commit is contained in:
Eric
2021-05-28 22:46:30 +02:00
parent 541231ee5e
commit b87afed08a
23 changed files with 1226 additions and 274 deletions

View File

@@ -1,6 +1,8 @@
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
.. _Column:
Column
======
@@ -27,19 +29,45 @@ Twig Tag
:Type:
+----------+------------+
| Standard | No comment |
+----------+------------+
| ForBlock | No comment |
+----------+------------+
+----------------------------------+------------+
| :ref:`Standard <ColumnStandard>` | No comment |
+----------------------------------+------------+
| :ref:`ForBlock <ColumnForBlock>` | No comment |
+----------------------------------+------------+
:Column *Standard* parameters:
.. _ColumnStandard:
Column Standard
^^^^^^^^^^^^^^^
:syntax:
::
{% UIColumn Standard {sId:'value'} %}
Content Goes Here
{% EndUIColumn %}
:parameters:
+-----+--------+----------+------+--+
| sId | string | optional | NULL | |
+-----+--------+----------+------+--+
:Column *ForBlock* parameters:
.. _ColumnForBlock:
Column ForBlock
^^^^^^^^^^^^^^^
:syntax:
::
{% UIColumn ForBlock {oBlock:value, sId:'value'} %}
Content Goes Here
{% EndUIColumn %}
:parameters:
+--------+---------+-----------+------+--+
| oBlock | UIBlock | mandatory | | |
@@ -47,8 +75,8 @@ Twig Tag
| sId | string | optional | NULL | |
+--------+---------+-----------+------+--+
:Column common parameters:
Column common parameters
^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------+----------+------------------------------------------------------------+
| AddCSSClass | string | CSS class to add to the generated html block |
+-------------------+----------+------------------------------------------------------------+