composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-30 14:08:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

FAF: Documentation UI Twig Blocks

Browse Source
This commit is contained in:
Eric
2021-05-30 11:45:13 +02:00
parent 862e49ba4e
commit 96bf56b51c
37 changed files with 355 additions and 135 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
.doc/UI/source/generated/Component/Alert/Alert.rst
View File

@@ -21,8 +21,8 @@ Twig Tag
:Tag: **UIAlert**
:Syntax:
::
.. code-block:: twig
{% UIAlert Type {Parameters} %}
Content Goes Here
@@ -55,7 +55,7 @@ Alert Neutral
:syntax:
::
.. code-block:: twig
{% UIAlert Neutral {sTitle:'value', sContent:'value', sId:'value'} %}
Content Goes Here
@@ -78,7 +78,7 @@ Alert ForInformation
:syntax:
::
.. code-block:: twig
{% UIAlert ForInformation {sTitle:'value', sContent:'value', sId:'value'} %}
Content Goes Here
@@ -101,7 +101,7 @@ Alert ForSuccess
:syntax:
::
.. code-block:: twig
{% UIAlert ForSuccess {sTitle:'value', sContent:'value', sId:'value'} %}
Content Goes Here
@@ -124,7 +124,7 @@ Alert ForWarning
:syntax:
::
.. code-block:: twig
{% UIAlert ForWarning {sTitle:'value', sContent:'value', sId:'value'} %}
Content Goes Here
@@ -147,7 +147,7 @@ Alert ForDanger
:syntax:
::
.. code-block:: twig
{% UIAlert ForDanger {sTitle:'value', sContent:'value', sId:'value'} %}
Content Goes Here
@@ -170,7 +170,7 @@ Alert ForFailure
:syntax:
::
.. code-block:: twig
{% UIAlert ForFailure {sTitle:'value', sContent:'value', sId:'value'} %}
Content Goes Here
@@ -193,7 +193,7 @@ Alert WithBrandingPrimaryColor
:syntax:
::
.. code-block:: twig
{% UIAlert WithBrandingPrimaryColor {sTitle:'value', sContent:'value', sId:'value'} %}
Content Goes Here
@@ -216,7 +216,7 @@ Alert WithBrandingSecondaryColor
:syntax:
::
.. code-block:: twig
{% UIAlert WithBrandingSecondaryColor {sTitle:'value', sContent:'value', sId:'value'} %}
Content Goes Here

34
.doc/UI/source/generated/Component/Button/Button.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UIButton**
:Syntax:
::
.. code-block:: twig
{% UIButton Type {Parameters} %}
@@ -66,7 +66,7 @@ Button Neutral
:syntax:
::
.. code-block:: twig
{% UIButton Type Neutral {sLabel:'value', sName:'value', sId:'value'} %}
@@ -87,7 +87,7 @@ Button ForPrimaryAction
:syntax:
::
.. code-block:: twig
{% UIButton Type ForPrimaryAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
@@ -112,7 +112,7 @@ Button ForSecondaryAction
:syntax:
::
.. code-block:: twig
{% UIButton Type ForSecondaryAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
@@ -137,7 +137,7 @@ Button ForPositiveAction
:syntax:
::
.. code-block:: twig
{% UIButton Type ForPositiveAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
@@ -162,7 +162,7 @@ Button ForDestructiveAction
:syntax:
::
.. code-block:: twig
{% UIButton Type ForDestructiveAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
@@ -187,7 +187,7 @@ Button AlternativeNeutral
:syntax:
::
.. code-block:: twig
{% UIButton Type AlternativeNeutral {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
@@ -212,7 +212,7 @@ Button ForAlternativePrimaryAction
:syntax:
::
.. code-block:: twig
{% UIButton Type ForAlternativePrimaryAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
@@ -237,7 +237,7 @@ Button ForAlternativeSecondaryAction
:syntax:
::
.. code-block:: twig
{% UIButton Type ForAlternativeSecondaryAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
@@ -262,7 +262,7 @@ Button ForAlternativeValidationAction
:syntax:
::
.. code-block:: twig
{% UIButton Type ForAlternativeValidationAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
@@ -287,7 +287,7 @@ Button ForAlternativeDestructiveAction
:syntax:
::
.. code-block:: twig
{% UIButton Type ForAlternativeDestructiveAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
@@ -312,7 +312,7 @@ Button ForCancel
:syntax:
::
.. code-block:: twig
{% UIButton Type ForCancel {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
@@ -337,7 +337,7 @@ Button IconAction
:syntax:
::
.. code-block:: twig
{% UIButton Type IconAction {sIconClasses:'value', sTooltipText:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
@@ -364,7 +364,7 @@ Button LinkNeutral
:syntax:
::
.. code-block:: twig
{% UIButton Type LinkNeutral {sURL:'value', sLabel:'value', sIconClasses:'value', sTarget:'value', sId:'value'} %}
@@ -389,7 +389,7 @@ Button IconLink
:syntax:
::
.. code-block:: twig
{% UIButton Type IconLink {sIconClasses:'value', sTooltipText:'value', sURL:'value', sTarget:'value', sId:'value'} %}
@@ -414,7 +414,7 @@ Button DestructiveIconLink
:syntax:
::
.. code-block:: twig
{% UIButton Type DestructiveIconLink {sIconClasses:'value', sTooltipText:'value', sURL:'value', sName:'value', sTarget:'value', sId:'value'} %}

6
.doc/UI/source/generated/Component/ButtonGroup/ButtonGroup.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UIButtonGroup**
:Syntax:
::
.. code-block:: twig
{% UIButtonGroup Type {Parameters} %}
@@ -38,7 +38,7 @@ ButtonGroup ButtonWithOptionsMenu
:syntax:
::
.. code-block:: twig
{% UIButtonGroup Type ButtonWithOptionsMenu {oButton:value, oMenu:value} %}

6
.doc/UI/source/generated/Component/CollapsibleSection/CollapsibleSection.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UICollapsibleSection**
:Syntax:
::
.. code-block:: twig
{% UICollapsibleSection Type {Parameters} %}
Content Goes Here
@@ -40,7 +40,7 @@ CollapsibleSection Standard
:syntax:
::
.. code-block:: twig
{% UICollapsibleSection Standard {sTitle:'value', sId:'value'} %}
Content Goes Here

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

@@ -1,31 +1,32 @@
.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0
UI Component
============
.. _Components:
UI Components
=============
A UI component is a unitary block used to display information in iTop console.
.. toctree::
:maxdepth: 1
:caption: Components:
Alert/Alert
Title/Title
FieldSet/FieldSet
Field/Field
Button/Button
ButtonGroup/ButtonGroup
CollapsibleSection/CollapsibleSection
DataTable/DataTable
Field/Field
FieldBadge/FieldBadge
FieldSet/FieldSet
Form/Form
Input/Input
Input/FileSelect/FileSelect
Input/Input
Input/Select/Select
Input/Select/SelectOption
Panel/Panel
Spinner/Spinner
Title/Title
Toolbar/Toolbar
Toolbar/ToolbarSpacer/ToolbarSpacer

16
.doc/UI/source/generated/Component/DataTable/DataTable.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UIDataTable**
:Syntax:
::
.. code-block:: twig
{% UIDataTable Type {Parameters} %}
Content Goes Here
@@ -50,7 +50,7 @@ DataTable ForResult
:syntax:
::
.. code-block:: twig
{% UIDataTable ForResult {oPage:value, sListId:'value', oSet:value, aExtraParams:value} %}
Content Goes Here
@@ -75,7 +75,7 @@ DataTable ForObject
:syntax:
::
.. code-block:: twig
{% UIDataTable ForObject {oPage:value, sListId:'value', oSet:value, aExtraParams:value} %}
Content Goes Here
@@ -100,7 +100,7 @@ DataTable ForRendering
:syntax:
::
.. code-block:: twig
{% UIDataTable ForRendering {sListId:'value', oSet:value, aExtraParams:value} %}
Content Goes Here
@@ -123,7 +123,7 @@ DataTable ForRenderingObject
:syntax:
::
.. code-block:: twig
{% UIDataTable ForRenderingObject {sListId:'value', oSet:value, aExtraParams:value} %}
Content Goes Here
@@ -146,7 +146,7 @@ DataTable ForStaticData
:syntax:
::
.. code-block:: twig
{% UIDataTable ForStaticData {sTitle:'value', aColumns:{name:value, name:value}, aData:{name:value, name:value}, sId:'value', aExtraParams:{name:value, name:value}, sFilter:'value', aOptions:{name:value, name:value}} %}
Content Goes Here
@@ -177,7 +177,7 @@ DataTable ForForm
:syntax:
::
.. code-block:: twig
{% UIDataTable ForForm {sRef:'value', aColumns:{name:value, name:value}, aData:{name:value, name:value}, sFilter:'value'} %}
Content Goes Here

14
.doc/UI/source/generated/Component/Field/Field.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UIField**
:Syntax:
::
.. code-block:: twig
{% UIField Type {Parameters} %}
Content Goes Here
@@ -48,7 +48,7 @@ Field FromParams
:syntax:
::
.. code-block:: twig
{% UIField FromParams {aParams:value} %}
Content Goes Here
@@ -67,7 +67,7 @@ Field FromObject
:syntax:
::
.. code-block:: twig
{% UIField FromObject {sLabel:'value', oInput:value, sLayout:'value'} %}
Content Goes Here
@@ -90,7 +90,7 @@ Field Large
:syntax:
::
.. code-block:: twig
{% UIField Large {sLabel:'value', sValueHtml:'value'} %}
Content Goes Here
@@ -111,7 +111,7 @@ Field Small
:syntax:
::
.. code-block:: twig
{% UIField Small {sLabel:'value', sValueHtml:'value'} %}
Content Goes Here
@@ -132,7 +132,7 @@ Field Standard
:syntax:
::
.. code-block:: twig
{% UIField Standard {sLabel:'value', sLayout:'value', sId:'value'} %}
Content Goes Here

6
.doc/UI/source/generated/Component/FieldBadge/FieldBadge.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UIFieldBadge**
:Syntax:
::
.. code-block:: twig
{% UIFieldBadge Type {Parameters} %}
Content Goes Here
@@ -40,7 +40,7 @@ FieldBadge ForField
:syntax:
::
.. code-block:: twig
{% UIFieldBadge ForField {sValue:'value', oStyle:value} %}
Content Goes Here

6
.doc/UI/source/generated/Component/FieldSet/FieldSet.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UIFieldSet**
:Syntax:
::
.. code-block:: twig
{% UIFieldSet Type {Parameters} %}
Content Goes Here
@@ -40,7 +40,7 @@ FieldSet Standard
:syntax:
::
.. code-block:: twig
{% UIFieldSet Standard {sLegend:'value', sId:'value'} %}
Content Goes Here

6
.doc/UI/source/generated/Component/Form/Form.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UIForm**
:Syntax:
::
.. code-block:: twig
{% UIForm Type {Parameters} %}
Content Goes Here
@@ -40,7 +40,7 @@ Form Standard
:syntax:
::
.. code-block:: twig
{% UIForm Standard {sId:'value'} %}
Content Goes Here

6
.doc/UI/source/generated/Component/Input/FileSelect/FileSelect.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UIFileSelect**
:Syntax:
::
.. code-block:: twig
{% UIFileSelect Type {Parameters} %}
@@ -38,7 +38,7 @@ FileSelect Standard
:syntax:
::
.. code-block:: twig
{% UIFileSelect Type Standard {sName:'value', sId:'value'} %}

10
.doc/UI/source/generated/Component/Input/Input.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UIInput**
:Syntax:
::
.. code-block:: twig
{% UIInput Type {Parameters} %}
@@ -42,7 +42,7 @@ Input ForHidden
:syntax:
::
.. code-block:: twig
{% UIInput Type ForHidden {sName:'value', sValue:'value', sId:'value'} %}
@@ -63,7 +63,7 @@ Input Standard
:syntax:
::
.. code-block:: twig
{% UIInput Type Standard {sType:'value', sName:'value', sValue:'value', sId:'value'} %}
@@ -86,7 +86,7 @@ Input ForInputWithLabel
:syntax:
::
.. code-block:: twig
{% UIInput Type ForInputWithLabel {sLabel:'value', sInputName:'value', sInputValue:'value', sInputId:'value', sInputType:'value'} %}

8
.doc/UI/source/generated/Component/Input/Select/Select.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UISelect**
:Syntax:
::
.. code-block:: twig
{% UISelect Type {Parameters} %}
Content Goes Here
@@ -42,7 +42,7 @@ Select ForSelect
:syntax:
::
.. code-block:: twig
{% UISelect ForSelect {sName:'value', sId:'value'} %}
Content Goes Here
@@ -63,7 +63,7 @@ Select ForSelectWithLabel
:syntax:
::
.. code-block:: twig
{% UISelect ForSelectWithLabel {sName:'value', sLabel:'value', sId:'value'} %}
Content Goes Here

6
.doc/UI/source/generated/Component/Input/Select/SelectOption.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UISelectOption**
:Syntax:
::
.. code-block:: twig
{% UISelectOption Type {Parameters} %}
@@ -38,7 +38,7 @@ SelectOption ForSelectOption
:syntax:
::
.. code-block:: twig
{% UISelectOption Type ForSelectOption {sValue:'value', sLabel:'value', bSelected:true, sId:'value'} %}

22
.doc/UI/source/generated/Component/Panel/Panel.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UIPanel**
:Syntax:
::
.. code-block:: twig
{% UIPanel Type {Parameters} %}
Content Goes Here
@@ -56,7 +56,7 @@ Panel Neutral
:syntax:
::
.. code-block:: twig
{% UIPanel Neutral {sTitle:'value', sSubTitle:'value'} %}
Content Goes Here
@@ -77,7 +77,7 @@ Panel ForInformation
:syntax:
::
.. code-block:: twig
{% UIPanel ForInformation {sTitle:'value', sSubTitle:'value'} %}
Content Goes Here
@@ -98,7 +98,7 @@ Panel ForSuccess
:syntax:
::
.. code-block:: twig
{% UIPanel ForSuccess {sTitle:'value', sSubTitle:'value'} %}
Content Goes Here
@@ -119,7 +119,7 @@ Panel ForWarning
:syntax:
::
.. code-block:: twig
{% UIPanel ForWarning {sTitle:'value', sSubTitle:'value'} %}
Content Goes Here
@@ -140,7 +140,7 @@ Panel ForDanger
:syntax:
::
.. code-block:: twig
{% UIPanel ForDanger {sTitle:'value', sSubTitle:'value'} %}
Content Goes Here
@@ -161,7 +161,7 @@ Panel ForFailure
:syntax:
::
.. code-block:: twig
{% UIPanel ForFailure {sTitle:'value', sSubTitle:'value'} %}
Content Goes Here
@@ -182,7 +182,7 @@ Panel WithBrandingPrimaryColor
:syntax:
::
.. code-block:: twig
{% UIPanel WithBrandingPrimaryColor {sTitle:'value', sSubTitle:'value'} %}
Content Goes Here
@@ -203,7 +203,7 @@ Panel WithBrandingSecondaryColor
:syntax:
::
.. code-block:: twig
{% UIPanel WithBrandingSecondaryColor {sTitle:'value', sSubTitle:'value'} %}
Content Goes Here
@@ -224,7 +224,7 @@ Panel ForClass
:syntax:
::
.. code-block:: twig
{% UIPanel ForClass {sClass:'value', sTitle:'value', sSubTitle:'value'} %}
Content Goes Here

6
.doc/UI/source/generated/Component/Spinner/Spinner.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UISpinner**
:Syntax:
::
.. code-block:: twig
{% UISpinner Type {Parameters} %}
@@ -38,7 +38,7 @@ Spinner Standard
:syntax:
::
.. code-block:: twig
{% UISpinner Type Standard {sId:'value'} %}

12
.doc/UI/source/generated/Component/Title/Title.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UITitle**
:Syntax:
::
.. code-block:: twig
{% UITitle Type {Parameters} %}
Content Goes Here
@@ -46,7 +46,7 @@ Title ForPage
:syntax:
::
.. code-block:: twig
{% UITitle ForPage {sTitle:'value', sId:'value'} %}
Content Goes Here
@@ -67,7 +67,7 @@ Title ForPageWithIcon
:syntax:
::
.. code-block:: twig
{% UITitle ForPageWithIcon {sTitle:'value', sIconUrl:'value', sIconCoverMethod:'value', bIsMedallion:true, sId:'value'} %}
Content Goes Here
@@ -94,7 +94,7 @@ Title Neutral
:syntax:
::
.. code-block:: twig
{% UITitle Neutral {sTitle:'value', iLevel:value, sId:'value'} %}
Content Goes Here
@@ -117,7 +117,7 @@ Title Standard
:syntax:
::
.. code-block:: twig
{% UITitle Standard {oTitle:value, iLevel:value, sId:'value'} %}
Content Goes Here

10
.doc/UI/source/generated/Component/Toolbar/Toolbar.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UIToolbar**
:Syntax:
::
.. code-block:: twig
{% UIToolbar Type {Parameters} %}
Content Goes Here
@@ -44,7 +44,7 @@ Toolbar ForAction
:syntax:
::
.. code-block:: twig
{% UIToolbar ForAction {sId:'value'} %}
Content Goes Here
@@ -63,7 +63,7 @@ Toolbar Standard
:syntax:
::
.. code-block:: twig
{% UIToolbar Standard {sId:'value', aContainerClasses:{name:value, name:value}} %}
Content Goes Here
@@ -84,7 +84,7 @@ Toolbar ForButton
:syntax:
::
.. code-block:: twig
{% UIToolbar ForButton {sId:'value', aContainerClasses:{name:value, name:value}} %}
Content Goes Here

6
.doc/UI/source/generated/Component/Toolbar/ToolbarSpacer/ToolbarSpacer.rst
View File

@@ -20,8 +20,8 @@ Twig Tag
:Tag: **UIToolbarSpacer**
:Syntax:
::
.. code-block:: twig
{% UIToolbarSpacer Type {Parameters} %}
@@ -38,7 +38,7 @@ ToolbarSpacer Standard
:syntax:
::
.. code-block:: twig
{% UIToolbarSpacer Type Standard {sId:'value'} %}