mirror of
https://github.com/Combodo/iTop.git
synced 2026-04-29 13:38:44 +02:00
FAF: Documentation UI Twig Blocks - HTML result
This commit is contained in:
Eric
17
.doc/UI/build/html/_sources/generated/Layout/Layout.rst.txt
Normal file
17
.doc/UI/build/html/_sources/generated/Layout/Layout.rst.txt
Normal file
@@ -0,0 +1,17 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Layouts:
|
||||
|
||||
UI Layouts
|
||||
==========
|
||||
|
||||
A UI block that serves as a layout for the page.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Components:
|
||||
|
||||
MultiColumn/Column/Column
|
||||
MultiColumn/MultiColumn
|
||||
UIContentBlock
|
||||
@@ -0,0 +1,113 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Column:
|
||||
|
||||
Column
|
||||
======
|
||||
|
||||
Class Column
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Layout/MultiColumn/Column/ColumnAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIColumn**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIColumn Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIColumn %}
|
||||
|
||||
:Type:
|
||||
|
||||
+----------------------------------+------------+
|
||||
| :ref:`Standard <ColumnStandard>` | No comment |
|
||||
+----------------------------------+------------+
|
||||
| :ref:`ForBlock <ColumnForBlock>` | No comment |
|
||||
+----------------------------------+------------+
|
||||
|
||||
.. _ColumnStandard:
|
||||
|
||||
Column Standard
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIColumn Standard {sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIColumn %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----+--------+----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----+--------+----------+------+--+
|
||||
|
||||
.. _ColumnForBlock:
|
||||
|
||||
Column ForBlock
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIColumn ForBlock {oBlock:value, sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIColumn %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------+---------+-----------+------+--+
|
||||
| oBlock | UIBlock | mandatory | | |
|
||||
+--------+---------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------+---------+-----------+------+--+
|
||||
|
||||
Column common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsHidden | bool | Indicates if the block is hidden by default |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Layout/MultiColumn/Column/ColumnFooter.rst
|
||||
@@ -0,0 +1,92 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _MultiColumn:
|
||||
|
||||
MultiColumn
|
||||
===========
|
||||
|
||||
Class MultiColumn
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Layout/MultiColumn/MultiColumnAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIMultiColumn**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIMultiColumn Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIMultiColumn %}
|
||||
|
||||
:Type:
|
||||
|
||||
+---------------------------------------+------------+
|
||||
| :ref:`Standard <MultiColumnStandard>` | No comment |
|
||||
+---------------------------------------+------------+
|
||||
|
||||
.. _MultiColumnStandard:
|
||||
|
||||
MultiColumn Standard
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIMultiColumn Standard {sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIMultiColumn %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----+--------+----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----+--------+----------+------+--+
|
||||
|
||||
MultiColumn common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddColumn | Column | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsHidden | bool | Indicates if the block is hidden by default |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Layout/MultiColumn/MultiColumnFooter.rst
|
||||
@@ -0,0 +1,116 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _UIContentBlock:
|
||||
|
||||
UIContentBlock
|
||||
==============
|
||||
|
||||
Class UIContentBlock
|
||||
Base block containing sub-blocks
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Layout/UIContentBlockAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIContentBlock**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIContentBlock Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIContentBlock %}
|
||||
|
||||
:Type:
|
||||
|
||||
+------------------------------------------+-------------------------------------------------------------------+
|
||||
| :ref:`Standard <UIContentBlockStandard>` | No comment |
|
||||
+------------------------------------------+-------------------------------------------------------------------+
|
||||
| :ref:`ForCode <UIContentBlockForCode>` | Used to display a block of code like <pre> but allows line break. |
|
||||
+------------------------------------------+-------------------------------------------------------------------+
|
||||
|
||||
.. _UIContentBlockStandard:
|
||||
|
||||
UIContentBlock Standard
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIContentBlock Standard {sId:'value', aContainerClasses:{name:value, name:value}} %}
|
||||
Content Goes Here
|
||||
{% EndUIContentBlock %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-------------------+--------+----------+----------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-------------------+--------+----------+----------+--+
|
||||
| aContainerClasses | array | optional | array () | |
|
||||
+-------------------+--------+----------+----------+--+
|
||||
|
||||
.. _UIContentBlockForCode:
|
||||
|
||||
UIContentBlock ForCode
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIContentBlock ForCode {sCode:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIContentBlock %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-------+--------+-----------+------+--+
|
||||
| sCode | string | mandatory | | |
|
||||
+-------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-------+--------+-----------+------+--+
|
||||
|
||||
UIContentBlock common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsHidden | bool | Indicates if the block is hidden by default |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Layout/UIContentBlockFooter.rst
|
||||
Reference in New Issue
Block a user