composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-05-19 23:32:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

FAF: Documentation UI Twig Blocks

Browse Source
This commit is contained in:
Eric
2021-05-18 17:53:05 +02:00
parent 9405eae922
commit e246e79eeb
14 changed files with 197 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.doc/UI/source/Component/Alert/Alert.rst
View File

@@ -1,3 +1,6 @@
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
Alert
=====

56
.doc/UI/source/Component/Button/Button.rst
View File

@@ -1,21 +1,57 @@
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
Button
======
*In Progress*
Description
-----------
----
Output Result
-------------
:Example Buttons:
.. image:: Button-all.png
----
Twig Tag
--------
:Tag: **UIButton**
:Syntax:
::
{% UIButton Type {Parameters} %}
Content Goes Here
{% EndUIButton %}
:Type:
+------------------------------+-----------------------------------------------------+
| *Standard* | Create a *Default Button* |
+------------------------------+-----------------------------------------------------+
:Button common parameters:
+-------------------+--------+-----------+----------------------------------+
| *sId* | string | optional | ID of the HTML block |
+-------------------+--------+-----------+----------------------------------+
:See also: :ref:`UIBlock Common parameters <UIBlock_parameters>`
----
Examples
--------
.. image:: Button-all.png
Example to generate a button::
Factory Methods
---------------
{% UIButton Type {Parameters} %}
Content Goes Here
{% EndUIButton %}
Class Methods
-------------
Twig
----

54
.doc/UI/source/Component/ButtonGroup/ButtonGroup.rst
View File

@@ -1,20 +1,56 @@
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
ButtonGroup
===========
*In Progress*
Description
-----------
----
Output Result
-------------
:Example ButtonGroups:
----
Twig Tag
--------
:Tag: **UIButtonGroup**
:Syntax:
::
{% UIButtonGroup Type {Parameters} %}
Content Goes Here
{% EndUIButtonGroup %}
:Type:
+------------------------------+-----------------------------------------------------+
| *Standard* | Create a *Default ButtonGroup* |
+------------------------------+-----------------------------------------------------+
:ButtonGroup common parameters:
+-------------------+--------+-----------+----------------------------------+
| *sId* | string | optional | ID of the HTML block |
+-------------------+--------+-----------+----------------------------------+
:See also: :ref:`UIBlock Common parameters <UIBlock_parameters>`
----
Examples
--------
Example to generate a ButtonGroup::
Factory Methods
---------------
{% UIButtonGroup Type {Parameters} %}
Content Goes Here
{% EndUIButtonGroup %}
Class Methods
-------------
Twig
----

54
.doc/UI/source/Component/CollapsibleSection/CollapsibleSection.rst
View File

@@ -1,20 +1,56 @@
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
CollapsibleSection
==================
*In Progress*
Description
-----------
----
Output Result
-------------
:Example CollapsibleSections:
----
Twig Tag
--------
:Tag: **UICollapsibleSection**
:Syntax:
::
{% UICollapsibleSection Type {Parameters} %}
Content Goes Here
{% EndUICollapsibleSection %}
:Type:
+------------------------------+-----------------------------------------------------+
| *Standard* | Create a *Default CollapsibleSection* |
+------------------------------+-----------------------------------------------------+
:CollapsibleSection common parameters:
+-------------------+--------+-----------+----------------------------------+
| *sId* | string | optional | ID of the HTML block |
+-------------------+--------+-----------+----------------------------------+
:See also: :ref:`UIBlock Common parameters <UIBlock_parameters>`
----
Examples
--------
Example to generate a CollapsibleSection::
Factory Methods
---------------
{% UICollapsibleSection Type {Parameters} %}
Content Goes Here
{% EndUICollapsibleSection %}
Class Methods
-------------
Twig
----

3
.doc/UI/source/Component/Component.rst
View File

@@ -1,3 +1,6 @@
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
UI Component
============

7
.doc/UI/source/Component/DataTable/DataTable.rst
View File

@@ -1,3 +1,6 @@
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
DataTable
=========
@@ -18,8 +21,8 @@ Static DataTable
.. image:: DatatableStatic.png
Twig
----
Twig Tag
--------
:Tag: **UIDataTable**

BIN
.doc/UI/source/Component/Title/Title.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.3 KiB

15
.doc/UI/source/Component/Title/Title.rst
View File

@@ -1,3 +1,6 @@
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
Title
=====
@@ -8,7 +11,7 @@ Display a title.
Output Result
-------------
.. image:: Title.png
----
@@ -73,3 +76,13 @@ Twig Tag
Examples
--------
:The following code:
::
{% UITitle ForPage {sTitle: 'UI:FullTextSearchTitle_Text'|dict_format(sFullText)} %}{% EndUITitle %}
:Will display:
.. image:: Title.png

7
.doc/UI/source/Component/UIBlock/UIBlock.rst
View File

@@ -1,3 +1,6 @@
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
UIBlock
=======
@@ -7,8 +10,8 @@ Description
UIBlock is the root class for all the other blocks.
Twig
----
Twig Tag
--------
This block has no Twig tag, but the following parameters are common to all the other Twig blocks.

4
.doc/UI/source/Layout/Layout.rst
View File

@@ -1,4 +1,6 @@
=========
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
UI Layout
=========

3
.doc/UI/source/Layout/UIContentBlock/UIContentBlock.rst
View File

@@ -1,3 +1,6 @@
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
UIContentBlock
==============

11
.doc/UI/source/_static/css/ui-doc.css Normal file
View File

@@ -0,0 +1,11 @@
/*!
* @copyright Copyright (C) 2010-2021 Combodo SARL
* @license http://opensource.org/licenses/AGPL-3.0
*/
/* theme.css | .doc/UI/build/html/_static/css/theme.css */
.wy-nav-content {
max-width: 1024px;
min-height: 100%;
}

6
.doc/UI/source/conf.py
View File

@@ -71,4 +71,8 @@ html_logo = "img/itop-logo.png"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = ['_static']
html_css_files = [
'css/ui-doc.css',
]

15
.doc/UI/source/index.rst
View File

@@ -1,10 +1,13 @@
.. iTop UI documentation master file, created by
sphinx-quickstart on Wed Apr 7 10:53:55 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
Welcome to iTop UI's documentation!
===================================
.. iTop UI documentation master file, created by
sphinx-quickstart on Wed Apr 7 10:53:55 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to iTop 3.0 UI's documentation!
=======================================
.. toctree::
:maxdepth: 2