diff --git a/.doc/UI/source/Component/Alert/Alert.rst b/.doc/UI/source/Component/Alert/Alert.rst index ca508e7a2..f21a95fcb 100644 --- a/.doc/UI/source/Component/Alert/Alert.rst +++ b/.doc/UI/source/Component/Alert/Alert.rst @@ -1,3 +1,6 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + Alert ===== diff --git a/.doc/UI/source/Component/Button/Button.rst b/.doc/UI/source/Component/Button/Button.rst index 094ee5314..8d9b4f9f0 100644 --- a/.doc/UI/source/Component/Button/Button.rst +++ b/.doc/UI/source/Component/Button/Button.rst @@ -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 ` + +---- Examples -------- -.. image:: Button-all.png +Example to generate a button:: -Factory Methods ---------------- + {% UIButton Type {Parameters} %} + Content Goes Here + {% EndUIButton %} -Class Methods -------------- - -Twig ----- diff --git a/.doc/UI/source/Component/ButtonGroup/ButtonGroup.rst b/.doc/UI/source/Component/ButtonGroup/ButtonGroup.rst index a7e051467..df98b8527 100644 --- a/.doc/UI/source/Component/ButtonGroup/ButtonGroup.rst +++ b/.doc/UI/source/Component/ButtonGroup/ButtonGroup.rst @@ -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 ` + +---- Examples -------- +Example to generate a ButtonGroup:: -Factory Methods ---------------- + {% UIButtonGroup Type {Parameters} %} + Content Goes Here + {% EndUIButtonGroup %} -Class Methods -------------- - -Twig ----- diff --git a/.doc/UI/source/Component/CollapsibleSection/CollapsibleSection.rst b/.doc/UI/source/Component/CollapsibleSection/CollapsibleSection.rst index 6cb18fa9b..8cfb1b75d 100644 --- a/.doc/UI/source/Component/CollapsibleSection/CollapsibleSection.rst +++ b/.doc/UI/source/Component/CollapsibleSection/CollapsibleSection.rst @@ -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 ` + +---- Examples -------- +Example to generate a CollapsibleSection:: -Factory Methods ---------------- + {% UICollapsibleSection Type {Parameters} %} + Content Goes Here + {% EndUICollapsibleSection %} -Class Methods -------------- - -Twig ----- diff --git a/.doc/UI/source/Component/Component.rst b/.doc/UI/source/Component/Component.rst index 79daa7566..71c21b00c 100644 --- a/.doc/UI/source/Component/Component.rst +++ b/.doc/UI/source/Component/Component.rst @@ -1,3 +1,6 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + UI Component ============ diff --git a/.doc/UI/source/Component/DataTable/DataTable.rst b/.doc/UI/source/Component/DataTable/DataTable.rst index 5196a829a..cf6bf0308 100644 --- a/.doc/UI/source/Component/DataTable/DataTable.rst +++ b/.doc/UI/source/Component/DataTable/DataTable.rst @@ -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** diff --git a/.doc/UI/source/Component/Title/Title.png b/.doc/UI/source/Component/Title/Title.png new file mode 100644 index 000000000..111e5bbf1 Binary files /dev/null and b/.doc/UI/source/Component/Title/Title.png differ diff --git a/.doc/UI/source/Component/Title/Title.rst b/.doc/UI/source/Component/Title/Title.rst index da0d0a6a2..d64112925 100644 --- a/.doc/UI/source/Component/Title/Title.rst +++ b/.doc/UI/source/Component/Title/Title.rst @@ -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 + diff --git a/.doc/UI/source/Component/UIBlock/UIBlock.rst b/.doc/UI/source/Component/UIBlock/UIBlock.rst index 4c645da43..a00e49d8c 100644 --- a/.doc/UI/source/Component/UIBlock/UIBlock.rst +++ b/.doc/UI/source/Component/UIBlock/UIBlock.rst @@ -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. diff --git a/.doc/UI/source/Layout/Layout.rst b/.doc/UI/source/Layout/Layout.rst index 7916dddc9..21b636746 100644 --- a/.doc/UI/source/Layout/Layout.rst +++ b/.doc/UI/source/Layout/Layout.rst @@ -1,4 +1,6 @@ -========= +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + UI Layout ========= diff --git a/.doc/UI/source/Layout/UIContentBlock/UIContentBlock.rst b/.doc/UI/source/Layout/UIContentBlock/UIContentBlock.rst index 1773842af..c0ec15f53 100644 --- a/.doc/UI/source/Layout/UIContentBlock/UIContentBlock.rst +++ b/.doc/UI/source/Layout/UIContentBlock/UIContentBlock.rst @@ -1,3 +1,6 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + UIContentBlock ============== diff --git a/.doc/UI/source/_static/css/ui-doc.css b/.doc/UI/source/_static/css/ui-doc.css new file mode 100644 index 000000000..9caaa8622 --- /dev/null +++ b/.doc/UI/source/_static/css/ui-doc.css @@ -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%; +} diff --git a/.doc/UI/source/conf.py b/.doc/UI/source/conf.py index 1869f6243..1b171030a 100644 --- a/.doc/UI/source/conf.py +++ b/.doc/UI/source/conf.py @@ -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'] \ No newline at end of file +html_static_path = ['_static'] + +html_css_files = [ + 'css/ui-doc.css', +] \ No newline at end of file diff --git a/.doc/UI/source/index.rst b/.doc/UI/source/index.rst index 86cc0f699..d652be84b 100644 --- a/.doc/UI/source/index.rst +++ b/.doc/UI/source/index.rst @@ -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