diff --git a/.doc/UI/bin/generate_uiblock.php b/.doc/UI/bin/generate_uiblock.php new file mode 100644 index 000000000..6e1787a0c --- /dev/null +++ b/.doc/UI/bin/generate_uiblock.php @@ -0,0 +1,374 @@ + $iMax) { + $iLen = strlen($aParam[$sColName]); + if ($iLen > $iMax) { + $aColumns[$sColName] = $iLen; + } + } + } + + $sArrayLine = '+'; + foreach ($aColumns as $iMax) { + $sArrayLine .= str_repeat('-', $iMax + 2).'+'; + } + echo "$sArrayLine\n"; + foreach ($aParams as $aParam) { + foreach ($aColumns as $sColName => $iMax) { + echo '| '.str_pad($aParam[$sColName], $iMax).' '; + } + echo "|\n"; + echo "$sArrayLine\n"; + } + echo "\n"; +} + +function output(string $sClass, string $sClassComment, string $sDir, string $sTag, bool $bHasSubBlocks, array $aDocTypes, array $aDocGeneralParams) +{ + if ($bHasSubBlocks) { + $sSyntax = << $aDoc) { + $sComment = $aDoc['comment']; + $iLength = strlen($sType); + if ($iLength > $iMaxLength) { + $iMaxLength = $iLength; + } + $iComLength = strlen($sComment); + if ($iComLength > $iMaxComLength) { + $iMaxComLength = $iComLength; + } + } + $sArrayLine = '+'.str_repeat('-', $iMaxLength + 2).'+'.str_repeat('-', $iMaxComLength + 2).'+'; + echo "$sArrayLine\n"; + foreach ($aDocTypes as $sType => $aDoc) { + $sComment = $aDoc['comment']; + echo '| '.str_pad($sType, $iMaxLength).' | '.str_pad($sComment, $iMaxComLength)." |\n"; + echo "$sArrayLine\n"; + } + echo "\n"; + + // Parameters for each type + foreach ($aDocTypes as $sType => $aDoc) { + $aParams = $aDoc['params']; + if (!empty($aParams)) { + echo ":$sClass *$sType* parameters:\n"; + echo "\n"; + $aColumns = [ + 'name' => 0, + 'type' => 0, + 'status' => 0, + 'default' => 0, + 'comment' => 0, + ]; + DisplayParamsArray($aParams, $aColumns); + } + } + + if (!empty($aDocGeneralParams)) { + echo ":$sClass common parameters:\n"; + echo "\n"; + $aColumns = [ + 'name' => 0, + 'type' => 0, + 'comment' => 0, + ]; + usort($aDocGeneralParams, function ($a, $b) { + return strcmp($a['name'], $b['name']); + }); + DisplayParamsArray($aDocGeneralParams, $aColumns); + } + + echo "----\n"; + echo "\n"; + echo ".. include:: /manual/{$sDir}Footer.rst\n"; + +} + +/** + * @param \ReflectionMethod $oMethod + * @param string $sFullComment + * + * @return array + * @throws \ReflectionException + */ +function GetMethodParameters(ReflectionMethod $oMethod, string $sFullComment): array +{ + $aDocParams = []; + $aParameters = $oMethod->getParameters(); + foreach ($aParameters as $oParameter) { + $sName = $oParameter->getName(); + $aDocParam['name'] = $sName; + if ($oParameter->isOptional()) { + $aDocParam['status'] = 'optional'; + $sDefault = $oParameter->getDefaultValue(); + $aDocParam['default'] = str_replace("\n", '', var_export($sDefault, true)); + } else { + $aDocParam['status'] = 'mandatory'; + $aDocParam['default'] = ''; + } + + $oParamType = $oParameter->getType(); + if ($oParamType instanceof ReflectionNamedType) { + $sType = $oParamType->getName(); + $iPos = strrpos($sType, "\\"); + if ($iPos !== false) { + $sType = substr($sType, $iPos + 1); + } + $aDocParam['type'] = $sType; + } else { + $aDocParam['type'] = ''; + } + + if ($sFullComment !== false) { + $sComment = $sFullComment; + $iPos = strpos($sComment, $sName); + if ($iPos !== false) { + $sComment = substr($sComment, strpos($sComment, '@param')); + $iPos = strpos($sComment, $sName); + $sComment = substr($sComment, $iPos + strlen($sName)); + $sComment = substr($sComment, 0, strpos($sComment, "\n")); + $sComment = trim($sComment); + } else { + $sComment = ''; + } + } else { + $sComment = ''; + } + $aDocParam['comment'] = $sComment; + $aDocParams[] = $aDocParam; + } + + return $aDocParams; +} + +///////////////////////////// +/// Main +/// + +if (!utils::IsModeCLI()) { + \Combodo\iTop\FullTextSearch\log("Only CLI mode is allowed"); + + return; +} + +$sUIBlock = utils::ReadParam('uiblock', '', true); + +$sSourceDir = '../source'; + +$sInterface = "Combodo\\iTop\\Application\\UI\\Base\\iUIBlockFactory"; +$aFactoryClasses = utils::GetClassesForInterface($sInterface, $sUIBlock.'UIBlockFactory'); + + +foreach ($aFactoryClasses as $sFactoryClass) { + try { + $sTag = call_user_func([$sFactoryClass, 'GetTwigTagName']); + $sBlockClassName = call_user_func([$sFactoryClass, 'GetUIBlockClassName']); + $bHasSubBlocks = is_subclass_of($sBlockClassName, "Combodo\\iTop\\Application\\UI\\Base\\Layout\\UIContentBlock") || $sBlockClassName == "Combodo\\iTop\\Application\\UI\\Base\\Layout\\UIContentBlock"; + + $oReflectionClassFactory = new ReflectionClass($sFactoryClass); + $oReflectionClassUIBlock = new ReflectionClass($sBlockClassName); + $sClassName = $oReflectionClassUIBlock->getShortName(); + + $aMethods = $oReflectionClassFactory->getMethods(ReflectionMethod::IS_PUBLIC); + + $aDocTypes = []; + foreach ($aMethods as $oMethod) { + $sMethodName = $oMethod->name; + if (utils::StartsWith($sMethodName, 'Make')) { + $oMethod = $oReflectionClassFactory->getMethod($sMethodName); + $sFullComment = $oMethod->getDocComment(); + if ($sFullComment !== false) { + // Remove the first line + $sComment = $sFullComment; + $sComment = substr($sComment, strpos($sComment, "\n") + 1); + $sComment = trim(substr($sComment, strpos($sComment, "*") + 1)); + // Remove the last lines + $sComment = substr($sComment, 0, strpos($sComment, "\n")); + } else { + $sComment = 'No comment'; + } + $sType = substr($sMethodName, strlen('Make')); + $aDocType['comment'] = $sComment; + + $aDocType['params'] = GetMethodParameters($oMethod, $sFullComment); + $aDocTypes[$sType] = $aDocType; + } + } + + // Setters and Adders + $aMethods = $oReflectionClassUIBlock->getMethods(ReflectionMethod::IS_PUBLIC); + $aDocGeneralParams = []; + foreach ($aMethods as $oMethod) { + if (!$oMethod->isStatic() && $oMethod->getNumberOfParameters() == 1) { + $sName = ''; + if (utils::StartsWith($oMethod->getName(), 'Set')) { + $sName = substr($oMethod->getName(), 3); // remove 'Set' to get the variable name + } + if (utils::StartsWith($oMethod->getName(), 'Add')) { + $sName = $oMethod->getName(); + } + if (!empty($sName)) { + $sFullComment = $oMethod->getDocComment(); + $aParams = GetMethodParameters($oMethod, $sFullComment)[0]; + $aParams['name'] = $sName; + $aDocGeneralParams[] = $aParams; + } + } + } + + // Class comment + $sFullClassComment = $oReflectionClassUIBlock->getDocComment(); + $aComments = preg_split("@\n@", $sFullClassComment); + $aClassComments = []; + // remove first line + array_shift($aComments); + while ($sComment = array_shift($aComments)) { + if (utils::StartsWith($sComment, " * @")) { + break; + } + $sComment = trim(preg_replace("@^ \*@", '', $sComment)); + if (strlen($sComment) > 0) { + $aClassComments[] = $sComment; + } + } + + $sClassComment = implode("\n", $aClassComments); + + if (empty($sClassComment)) { + $sClassComment = "Class $sClassName"; + } + + $sDir = str_replace("Combodo\\iTop\\Application\\UI\\Base\\", '', $sBlockClassName); + $sDir = str_replace("\\", '/', $sDir); + + ob_start(); + output($sClassName, $sClassComment, $sDir, $sTag, $bHasSubBlocks, $aDocTypes, $aDocGeneralParams); + $sContent = ob_get_contents(); + ob_end_clean(); + + $sFilename = $sSourceDir.'/generated/'.$sDir.'.rst'; + @mkdir(dirname($sFilename), 0775, true); + file_put_contents($sFilename, $sContent); + + // Check that manual files exists + $sAdditionalDescription = $sSourceDir.'/manual/'.$sDir.'AdditionalDescription.rst'; + @mkdir(dirname($sAdditionalDescription), 0775, true); + if (!is_file($sAdditionalDescription)) { + file_put_contents($sAdditionalDescription, <<` - ----- - -Examples --------- - -.. include:: Examples.rst \ No newline at end of file diff --git a/.doc/UI/source/Component/Alert/OutputExamples.rst b/.doc/UI/source/Component/Alert/OutputExamples.rst deleted file mode 100644 index 9d6db0444..000000000 --- a/.doc/UI/source/Component/Alert/OutputExamples.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. Copyright (C) 2010-2021 Combodo SARL -.. http://opensource.org/licenses/AGPL-3.0 - - -:Success Alert: - -.. image:: AlertSuccess.png - -:Failure Alert: - -.. image:: AlertFailure.png - -:Information Alert: - -.. image:: AlertInformation.png - -:Warning Alert: - -.. image:: AlertWarning.png diff --git a/.doc/UI/source/Component/Button/Button.rst b/.doc/UI/source/Component/Button/Button.rst deleted file mode 100644 index 8d9b4f9f0..000000000 --- a/.doc/UI/source/Component/Button/Button.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. Copyright (C) 2010-2021 Combodo SARL -.. http://opensource.org/licenses/AGPL-3.0 - -Button -====== - -*In Progress* - ----- - -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 --------- - -Example to generate a button:: - - {% UIButton Type {Parameters} %} - Content Goes Here - {% EndUIButton %} - diff --git a/.doc/UI/source/Component/ButtonGroup/ButtonGroup.rst b/.doc/UI/source/Component/ButtonGroup/ButtonGroup.rst deleted file mode 100644 index df98b8527..000000000 --- a/.doc/UI/source/Component/ButtonGroup/ButtonGroup.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. Copyright (C) 2010-2021 Combodo SARL -.. http://opensource.org/licenses/AGPL-3.0 - -ButtonGroup -=========== - -*In Progress* - ----- - -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:: - - {% UIButtonGroup Type {Parameters} %} - Content Goes Here - {% EndUIButtonGroup %} - diff --git a/.doc/UI/source/Component/CollapsibleSection/CollapsibleSection.rst b/.doc/UI/source/Component/CollapsibleSection/CollapsibleSection.rst deleted file mode 100644 index 8cfb1b75d..000000000 --- a/.doc/UI/source/Component/CollapsibleSection/CollapsibleSection.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. Copyright (C) 2010-2021 Combodo SARL -.. http://opensource.org/licenses/AGPL-3.0 - -CollapsibleSection -================== - -*In Progress* - ----- - -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:: - - {% UICollapsibleSection Type {Parameters} %} - Content Goes Here - {% EndUICollapsibleSection %} - diff --git a/.doc/UI/source/Component/DataTable/DataTable.rst b/.doc/UI/source/Component/DataTable/DataTable.rst deleted file mode 100644 index cf6bf0308..000000000 --- a/.doc/UI/source/Component/DataTable/DataTable.rst +++ /dev/null @@ -1,148 +0,0 @@ -.. Copyright (C) 2010-2021 Combodo SARL -.. http://opensource.org/licenses/AGPL-3.0 - -DataTable -========= - -Description ------------ - -This block is used to display data in a tabular way. -Data can come from the database (*Dynamic DataTable*) or from a static array (*Static DataTable*). - -Examples --------- - -Dynamic DataTable - -.. image:: Datatable.png - -Static DataTable - -.. image:: DatatableStatic.png - -Twig Tag --------- - -:Tag: **UIDataTable** - -:Syntax: - -:: - - {% UIDataTable Type {Parameters} %} - Content Goes Here - {% EndUIDataTable %} - -:Type: - -- **ForResult** - -Create a table from search results. The data to display are given using a *DBObjectSet*. - - ----- - -- **ForObject** - -Create a table from search results. The data to display are given using a *DBObjectSet*. - ----- - -- **ForRendering** - -Create a table from search results. The data to display are given using a *DBObjectSet*. - - ----- - -- **ForRenderingObject** - -Create a table from search results. The data to display are given using a *DBObjectSet*. - - ----- - -- **ForStaticData** - -Create a table from static data. - -:Parameters: - -+-------------------+--------+-----------+----------------------------------+ -| *sTitle* | string | mandatory | Title of the table | -+-------------------+--------+-----------+----------------------------------+ -| *aColumns* | array | mandatory | Array of columns | -+-------------------+--------+-----------+----------------------------------+ -| *aData* | array | optional | Array of data | -+-------------------+--------+-----------+----------------------------------+ -| *sId* | string | optional | Id of the block | -+-------------------+--------+-----------+----------------------------------+ -| *aExtraParams* | array | optional | Array of extra parameters | -+-------------------+--------+-----------+----------------------------------+ -| *sFilter* | string | optional | OQL filter | -+-------------------+--------+-----------+----------------------------------+ -| *aOptions* | array | optional | Array of options | -+-------------------+--------+-----------+----------------------------------+ - - -The columns (*aColumns*) have the following format: - -:: - - [ - 'nameField1' => ['label' => labelField1, 'description' => descriptionField1], - ... - ] - -The data (*aData*) format has to be: - -:: - - [ - ['nameField1' => valueField1, 'nameField2' => valueField2, ...], - ... - ] - - ----- - -- **ForForm** - -Create a table from static data. - -:Parameters: - -+-------------------+--------+-----------+----------------------------------+ -| *sRef* | string | mandatory | Title of the table | -+-------------------+--------+-----------+----------------------------------+ -| *aColumns* | array | mandatory | Array of columns | -+-------------------+--------+-----------+----------------------------------+ -| *aData* | array | optional | Array of data | -+-------------------+--------+-----------+----------------------------------+ -| *sFilter* | string | optional | OQL filter | -+-------------------+--------+-----------+----------------------------------+ - -:See also: :ref:`UIBlock Common parameters ` - - -The columns (*aColumns*) have the following format: - -:: - - [ - 'nameField1' => ['label' => labelField1, 'description' => descriptionField1], - ... - ] - -The data (*aData*) format has to be: - -:: - - [ - ['nameField1' => valueField1, 'nameField2' => valueField2, ...], - ... - ] - - - diff --git a/.doc/UI/source/Component/Field/Field.rst b/.doc/UI/source/Component/Field/Field.rst deleted file mode 100644 index f51080cce..000000000 --- a/.doc/UI/source/Component/Field/Field.rst +++ /dev/null @@ -1,127 +0,0 @@ -.. Copyright (C) 2010-2021 Combodo SARL -.. http://opensource.org/licenses/AGPL-3.0 -.. _Field: - -Field -===== - -*In Progress* - ----- - -Output Result -------------- - -:Example Fields: - -.. image:: Field.png - ----- - -Twig Tag --------- - -:Tag: **UIField** - -:Syntax: - -:: - - {% UIField Type {Parameters} %} - Content Goes Here - {% EndUIField %} - -:Type: - -+------------------------------+-----------------------------------------------------+ -| *Standard* | Create a *Default FieldSet* | -+------------------------------+-----------------------------------------------------+ -| *Small* | Create a *FieldSet* with *small* layout | -+------------------------------+-----------------------------------------------------+ -| *Large* | Create a *FieldSet* with *large* layout | -+------------------------------+-----------------------------------------------------+ -| *FromParams* | Create a *FieldSet* from given parameters | -+------------------------------+-----------------------------------------------------+ - -:Field *Standard* parameters: - -+-------------------+--------+-----------+---------------------------------------------+ -| *sLabel* | string | optional | Label (default empty) | -+-------------------+--------+-----------+---------------------------------------------+ -| *sLayout* | string | optional | Layout ('small' or 'large') default 'small' | -+-------------------+--------+-----------+---------------------------------------------+ -| *sId* | string | optional | ID of the HTML block | -+-------------------+--------+-----------+---------------------------------------------+ - -:Field *Small* and *Large* parameters: - -+-------------------+--------+-----------+----------------------------------+ -| *sLabel* | string | Mandatory | Label | -+-------------------+--------+-----------+----------------------------------+ -| *sValueHtml* | string | optional | HTML value (default empty) | -+-------------------+--------+-----------+----------------------------------+ - -:Field *FromParams* parameters: - -+-------------------+--------+-----------+----------------------------------+ -| *aParams* | array | Mandatory | array of parameters | -+-------------------+--------+-----------+----------------------------------+ - -:*aParams* values: - -+-------------------+--------+----------------------------------------------+ -| *layout* | string | Layout ('small' or 'large') | -+-------------------+--------+----------------------------------------------+ -| *attcode* | string | Attribute code | -+-------------------+--------+----------------------------------------------+ -| *atttype* | string | Attribute type | -+-------------------+--------+----------------------------------------------+ -| *attlabel* | string | Attribute label | -+-------------------+--------+----------------------------------------------+ -| *value_raw* | string | Attribute raw value | -+-------------------+--------+----------------------------------------------+ -| *comments* | string | Comments (tooltip) | -+-------------------+--------+----------------------------------------------+ -| *input_id* | string | Input id | -+-------------------+--------+----------------------------------------------+ -| *input_type* | string | Input type | -+-------------------+--------+----------------------------------------------+ -| *attflags* | array | Array of flags | -+-------------------+--------+----------------------------------------------+ - -:*attflags* values: - -+-------------------+---------+----------------------------------------------+ -| *1* | boolean | Hidden flag | -+-------------------+---------+----------------------------------------------+ -| *2* | boolean | Read only flag | -+-------------------+---------+----------------------------------------------+ -| *4* | boolean | Mandatory flag | -+-------------------+---------+----------------------------------------------+ -| *8* | boolean | Must change flag | -+-------------------+---------+----------------------------------------------+ -| *16* | boolean | Must prompt flag | -+-------------------+---------+----------------------------------------------+ -| *32* | boolean | Slave flag | -+-------------------+---------+----------------------------------------------+ - - -:See also: :ref:`UIBlock Common parameters ` - -:Related Tag: :ref:`FieldSet
` - ----- - -Examples --------- - -Example to generate a Field:: - - {% UIField Small {sLabel: "Product"} %} - iTop - {% EndUIField %} - - -The result: - -.. image:: Field.png diff --git a/.doc/UI/source/Component/FieldSet/FieldSet.rst b/.doc/UI/source/Component/FieldSet/FieldSet.rst deleted file mode 100644 index 3895027d3..000000000 --- a/.doc/UI/source/Component/FieldSet/FieldSet.rst +++ /dev/null @@ -1,73 +0,0 @@ -.. Copyright (C) 2010-2021 Combodo SARL -.. http://opensource.org/licenses/AGPL-3.0 -.. _FieldSet: - -FieldSet -======== - -*In Progress* - ----- - -Output Result -------------- - -:Example FieldSets: - -.. image:: FieldSet.png - ----- - -Twig Tag --------- - -:Tag: **UIFieldSet** - -:Syntax: - -:: - - {% UIFieldSet Type {Parameters} %} - Content Goes Here - {% EndUIFieldSet %} - -:Type: - -+------------------------------+-----------------------------------------------------+ -| *Standard* | Create a *Default FieldSet* | -+------------------------------+-----------------------------------------------------+ -| *Small* | Create a *FieldSet* with *small* layout | -+------------------------------+-----------------------------------------------------+ -| *Large* | Create a *FieldSet* with *large* layout | -+------------------------------+-----------------------------------------------------+ -| *FromParams* | Create a *FieldSet* from given parameters | -+------------------------------+-----------------------------------------------------+ - -:FieldSet common parameters: - -+-------------------+--------+-----------+----------------------------------+ -| *sLegend* | string | Mandatory | Displayed legend of the FieldSet | -+-------------------+--------+-----------+----------------------------------+ -| *sId* | string | optional | ID of the HTML block | -+-------------------+--------+-----------+----------------------------------+ - -:See also: :ref:`UIBlock Common parameters ` - -:Related Tag: :ref:`Field ` - ----- - -Examples --------- - -Example to generate a FieldSet:: - - {% UIFieldSet Standard {sLegend: "iTop environment"} %} - {% UIField ... %} - ... - {% EndUIFieldSet %} - -The result: - -.. image:: FieldSet-explained.png - diff --git a/.doc/UI/source/Component/Title/Title.rst b/.doc/UI/source/Component/Title/Title.rst deleted file mode 100644 index d64112925..000000000 --- a/.doc/UI/source/Component/Title/Title.rst +++ /dev/null @@ -1,88 +0,0 @@ -.. Copyright (C) 2010-2021 Combodo SARL -.. http://opensource.org/licenses/AGPL-3.0 - -Title -===== - -Display a title. - ----- - -Output Result -------------- - -.. image:: Title.png - ----- - -Twig Tag --------- - -:Tag: **UITitle** - -:Syntax: - -:: - - {% UITitle Type {Parameters} %} - Content Goes Here - {% EndUITitle %} - -:Type: - -+------------------------------+-----------------------------------------------------+ -| *ForPage* | Create a *page title* | -+------------------------------+-----------------------------------------------------+ -| *ForPageWithIcon* | Create an *page title with icon* | -+------------------------------+-----------------------------------------------------+ -| *Neutral* | Create an *generic title* | -+------------------------------+-----------------------------------------------------+ - -:Title common parameters: - -+-------------------+--------+-----------+----------------------------------+ -| *sTitle* | string | mandatory | Title | -+-------------------+--------+-----------+----------------------------------+ -| *sId* | string | optional | ID of the HTML block | -+-------------------+--------+-----------+----------------------------------+ - -:ForPageWithIcon specific parameters: - -+--------------------+--------+-----------+------------------------------------------------+ -| *sIconUrl* | string | mandatory | Icon URL | -+--------------------+--------+-----------+------------------------------------------------+ -| *sIconCoverMethod* | string | optional | one of *contain* (default), *zoomout*, *cover* | -+--------------------+--------+-----------+------------------------------------------------+ -| *bIsMedallion* | bool | optional | displayed as medallion (default true) | -+--------------------+--------+-----------+------------------------------------------------+ - -:sIconCoverMethod values: - - - *contain*: Icon should be contained (boxed) in the medallion, best for icons with transparent background and some margin around - - *zoomout*: Icon should be a little zoomed out to cover almost all space, best for icons with transparent background and no margin around (eg. class icons) - - *cover*: Icon should cover all the space, best for icons with filled background - -:Neutral specific parameters: - -+-------------------+---------+-----------+----------------------------------+ -| *iLevel* | integer | mandatory | Title level (1-5) 1 is biggest | -+-------------------+---------+-----------+----------------------------------+ - - -:See also: :ref:`UIBlock Common parameters ` - ----- - -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 deleted file mode 100644 index 3d5fb6851..000000000 --- a/.doc/UI/source/Component/UIBlock/UIBlock.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. Copyright (C) 2010-2021 Combodo SARL -.. http://opensource.org/licenses/AGPL-3.0 - -UIBlock -======= - -Description ------------ - -UIBlock is the root class for all the other blocks. - - -Twig Tag --------- - -This block has no Twig tag, but the following parameters are common to all the other Twig blocks. - -.. _UIBlock_parameters: - -:Parameters: - -+------------------+--------+----------+----------------------------------------------+ -| *CSSClasses* | array | optional | Array of CSS classes to set to the block | -+------------------+--------+----------+----------------------------------------------+ -| *DataAttributes* | array | optional | Array of data attributes to set to the block | -+------------------+--------+----------+----------------------------------------------+ -| *IsHidden* | bool | optional | Show or hide the current block | -+------------------+--------+----------+----------------------------------------------+ -| *AddCSSClass* | string | optional | Add a CSS class to the block | -+------------------+--------+----------+----------------------------------------------+ -| *AddCSSClasses* | array | optional | Add CSS classes to the block | -+------------------+--------+----------+----------------------------------------------+ - - diff --git a/.doc/UI/source/Layout/UIContentBlock/UIContentBlock.rst b/.doc/UI/source/Layout/UIContentBlock/UIContentBlock.rst deleted file mode 100644 index c0ec15f53..000000000 --- a/.doc/UI/source/Layout/UIContentBlock/UIContentBlock.rst +++ /dev/null @@ -1,67 +0,0 @@ -.. Copyright (C) 2010-2021 Combodo SARL -.. http://opensource.org/licenses/AGPL-3.0 - -UIContentBlock -============== - -Add a content block. - -Create a ``
`` only if container class or data attributes are provided or is hidden. - ----- - -Twig Tag --------- - -:Tag: **UIContentBlock** - -:Syntax: - -:: - - {% UIContentBlock Type {Parameters} %} - Content Goes Here - {% EndUIContentBlock %} - -:Type: - -+------------------------------+-----------------------------------------------------+ -| *Standard* | Create a default content block | -+------------------------------+-----------------------------------------------------+ -| *ForCode* | Create a content block to display code | -+------------------------------+-----------------------------------------------------+ - -:UIContentBlock common parameters: - -+---------------------+--------+-----------+----------------------------------+ -| *aContainerClasses* | array | optional | array of classes | -+---------------------+--------+-----------+----------------------------------+ -| *sId* | string | optional | ID of the HTML block | -+---------------------+--------+-----------+----------------------------------+ - -:ForCode specific parameters: - -+--------------------+--------+-----------+------------------------------------------------+ -| *sCode* | string | mandatory | Provided code to display | -+--------------------+--------+-----------+------------------------------------------------+ - - -:See also: :ref:`UIBlock Common parameters ` - ----- - -Examples --------- - -:: - - {% UIContentBlock Standard {aContainerClasses:["my-class", "my-other-class"], DataAttributes: {role: "my-role"}} %} - Content Goes Here - {% EndUIContentBlock %} - -Will produce the following HTML:: - -
- Content Goes Here -
- diff --git a/.doc/UI/source/generated/Component/Alert/Alert.rst b/.doc/UI/source/generated/Component/Alert/Alert.rst new file mode 100644 index 000000000..f53c434b9 --- /dev/null +++ b/.doc/UI/source/generated/Component/Alert/Alert.rst @@ -0,0 +1,171 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +Alert +===== + +Alerts are the main component to give feedback to the user or communicate page specific to system wide messages. +Alerts are a rectangular component displaying a title and a message. + +---- + +.. include:: /manual/Component/Alert/AlertAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UIAlert** + +:Syntax: + +:: + + {% UIAlert Type {Parameters} %} + Content Goes Here + {% EndUIAlert %} + +:Type: + ++----------------------------+-----------------------------------------------------+ +| Neutral | Make a basis Alert component | ++----------------------------+-----------------------------------------------------+ +| ForInformation | Make an Alert component for informational messages | ++----------------------------+-----------------------------------------------------+ +| ForSuccess | Make an Alert component for successful messages | ++----------------------------+-----------------------------------------------------+ +| ForWarning | Make an Alert component for warning messages | ++----------------------------+-----------------------------------------------------+ +| ForDanger | Make an Alert component for danger messages | ++----------------------------+-----------------------------------------------------+ +| ForFailure | Make an Alert component for failure messages | ++----------------------------+-----------------------------------------------------+ +| WithBrandingPrimaryColor | Make an Alert component with primary color scheme | ++----------------------------+-----------------------------------------------------+ +| WithBrandingSecondaryColor | Make an Alert component with secondary color scheme | ++----------------------------+-----------------------------------------------------+ + +:Alert *Neutral* parameters: + ++----------+--------+----------+------+-------------------------------------------------+ +| sTitle | string | optional | '' | | ++----------+--------+----------+------+-------------------------------------------------+ +| sContent | string | optional | '' | The raw HTML content, must be already sanitized | ++----------+--------+----------+------+-------------------------------------------------+ +| sId | string | optional | NULL | | ++----------+--------+----------+------+-------------------------------------------------+ + +:Alert *ForInformation* parameters: + ++----------+--------+----------+------+-------------------------------------------------+ +| sTitle | string | optional | '' | | ++----------+--------+----------+------+-------------------------------------------------+ +| sContent | string | optional | '' | The raw HTML content, must be already sanitized | ++----------+--------+----------+------+-------------------------------------------------+ +| sId | string | optional | NULL | | ++----------+--------+----------+------+-------------------------------------------------+ + +:Alert *ForSuccess* parameters: + ++----------+--------+----------+------+-------------------------------------------------+ +| sTitle | string | optional | '' | | ++----------+--------+----------+------+-------------------------------------------------+ +| sContent | string | optional | '' | The raw HTML content, must be already sanitized | ++----------+--------+----------+------+-------------------------------------------------+ +| sId | string | optional | NULL | | ++----------+--------+----------+------+-------------------------------------------------+ + +:Alert *ForWarning* parameters: + ++----------+--------+----------+------+-------------------------------------------------+ +| sTitle | string | optional | '' | | ++----------+--------+----------+------+-------------------------------------------------+ +| sContent | string | optional | '' | The raw HTML content, must be already sanitized | ++----------+--------+----------+------+-------------------------------------------------+ +| sId | string | optional | NULL | | ++----------+--------+----------+------+-------------------------------------------------+ + +:Alert *ForDanger* parameters: + ++----------+--------+----------+------+-------------------------------------------------+ +| sTitle | string | optional | '' | | ++----------+--------+----------+------+-------------------------------------------------+ +| sContent | string | optional | '' | The raw HTML content, must be already sanitized | ++----------+--------+----------+------+-------------------------------------------------+ +| sId | string | optional | NULL | | ++----------+--------+----------+------+-------------------------------------------------+ + +:Alert *ForFailure* parameters: + ++----------+--------+----------+------+-------------------------------------------------+ +| sTitle | string | optional | '' | | ++----------+--------+----------+------+-------------------------------------------------+ +| sContent | string | optional | '' | The raw HTML content, must be already sanitized | ++----------+--------+----------+------+-------------------------------------------------+ +| sId | string | optional | NULL | | ++----------+--------+----------+------+-------------------------------------------------+ + +:Alert *WithBrandingPrimaryColor* parameters: + ++----------+--------+----------+------+-------------------------------------------------+ +| sTitle | string | optional | '' | | ++----------+--------+----------+------+-------------------------------------------------+ +| sContent | string | optional | '' | The raw HTML content, must be already sanitized | ++----------+--------+----------+------+-------------------------------------------------+ +| sId | string | optional | NULL | | ++----------+--------+----------+------+-------------------------------------------------+ + +:Alert *WithBrandingSecondaryColor* parameters: + ++----------+--------+----------+------+-------------------------------------------------+ +| sTitle | string | optional | '' | | ++----------+--------+----------+------+-------------------------------------------------+ +| sContent | string | optional | '' | The raw HTML content, must be already sanitized | ++----------+--------+----------+------+-------------------------------------------------+ +| sId | string | optional | NULL | | ++----------+--------+----------+------+-------------------------------------------------+ + +:Alert common parameters: + ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddDeferredBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddSubBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| Color | string | | ++-------------------+----------+--------------------------------------------------------+ +| Content | string | | ++-------------------+----------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+----------+--------------------------------------------------------+ +| DeferredBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ +| IsClosable | bool | | ++-------------------+----------+--------------------------------------------------------+ +| IsCollapsible | bool | | ++-------------------+----------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+----------+--------------------------------------------------------+ +| OpenedByDefault | bool | | ++-------------------+----------+--------------------------------------------------------+ +| SubBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ +| Title | string | | ++-------------------+----------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/Alert/AlertFooter.rst diff --git a/.doc/UI/source/generated/Component/Button/Button.rst b/.doc/UI/source/generated/Component/Button/Button.rst new file mode 100644 index 000000000..af4d00243 --- /dev/null +++ b/.doc/UI/source/generated/Component/Button/Button.rst @@ -0,0 +1,306 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +Button +====== + +Class Button + +---- + +.. include:: /manual/Component/Button/ButtonAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UIButton** + +:Syntax: + +:: + + {% UIButton Type {Parameters} %} + +:Type: + ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| Neutral | Make a basis Button component for any purpose | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| ForPrimaryAction | Make a Button component for a primary action, should be used to tell the user this is the main choice | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| ForSecondaryAction | Make a Button component for a secondary action, should be used to tell the user this is an second hand choice | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| ForPositiveAction | Make a Button component for a success action, should be used to tell the user he/she going to make a positive action/choice | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| ForDestructiveAction | Make a Button component for a destructive action, should be used to tell the user he/she going to make something that cannot be | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| AlternativeNeutral | Make a basis Button component for any purpose | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| ForAlternativePrimaryAction | Make a Button component for an alternative primary action, should be used to avoid the user to consider this action as the first | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| ForAlternativeSecondaryAction | Make a Button component for an alternative secondary action, should be used to avoid the user to focus on this | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| ForAlternativeValidationAction | Make a Button component for a validation action, should be used to avoid the user to focus on this | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| ForAlternativeDestructiveAction | Make a Button component for a destructive action, should be used to avoid the user to focus on this | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| ForCancel | Make a Button component for a cancel, should be used only for UI navigation, not destructive action | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| IconAction | @param string $sIconClasses | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| LinkNeutral | Make a link Button component to open an URL instead of triggering a form action | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| IconLink | @param string $sIconClasses | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| DestructiveIconLink | @param string $sIconClasses | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + +:Button *Neutral* parameters: + ++--------+--------+-----------+------+----------------------------+ +| sLabel | string | mandatory | | | ++--------+--------+-----------+------+----------------------------+ +| sName | string | optional | NULL | See {@link Button::$sName} | ++--------+--------+-----------+------+----------------------------+ +| sId | string | optional | NULL | | ++--------+--------+-----------+------+----------------------------+ + +:Button *ForPrimaryAction* parameters: + ++-----------+--------+-----------+-------+---------------------+ +| sLabel | string | mandatory | | | ++-----------+--------+-----------+-------+---------------------+ +| sName | string | optional | NULL | See Button::$sName | ++-----------+--------+-----------+-------+---------------------+ +| sValue | string | optional | NULL | See Button::$sValue | ++-----------+--------+-----------+-------+---------------------+ +| bIsSubmit | bool | optional | false | See Button::$sType | ++-----------+--------+-----------+-------+---------------------+ +| sId | string | optional | NULL | | ++-----------+--------+-----------+-------+---------------------+ + +:Button *ForSecondaryAction* parameters: + ++-----------+--------+-----------+-------+---------------------+ +| sLabel | string | mandatory | | | ++-----------+--------+-----------+-------+---------------------+ +| sName | string | optional | NULL | See Button::$sName | ++-----------+--------+-----------+-------+---------------------+ +| sValue | string | optional | NULL | See Button::$sValue | ++-----------+--------+-----------+-------+---------------------+ +| bIsSubmit | bool | optional | false | See Button::$sType | ++-----------+--------+-----------+-------+---------------------+ +| sId | string | optional | NULL | | ++-----------+--------+-----------+-------+---------------------+ + +:Button *ForPositiveAction* parameters: + ++-----------+--------+-----------+-------+---------------------+ +| sLabel | string | mandatory | | | ++-----------+--------+-----------+-------+---------------------+ +| sName | string | optional | NULL | See Button::$sName | ++-----------+--------+-----------+-------+---------------------+ +| sValue | string | optional | NULL | See Button::$sValue | ++-----------+--------+-----------+-------+---------------------+ +| bIsSubmit | bool | optional | false | See Button::$sType | ++-----------+--------+-----------+-------+---------------------+ +| sId | string | optional | NULL | | ++-----------+--------+-----------+-------+---------------------+ + +:Button *ForDestructiveAction* parameters: + ++-----------+--------+-----------+-------+---------------------+ +| sLabel | string | mandatory | | | ++-----------+--------+-----------+-------+---------------------+ +| sName | string | optional | NULL | See Button::$sName | ++-----------+--------+-----------+-------+---------------------+ +| sValue | string | optional | NULL | See Button::$sValue | ++-----------+--------+-----------+-------+---------------------+ +| bIsSubmit | bool | optional | false | See Button::$sType | ++-----------+--------+-----------+-------+---------------------+ +| sId | string | optional | NULL | | ++-----------+--------+-----------+-------+---------------------+ + +:Button *AlternativeNeutral* parameters: + ++-----------+--------+-----------+-------+---------------------+ +| sLabel | string | mandatory | | | ++-----------+--------+-----------+-------+---------------------+ +| sName | string | optional | NULL | See Button::$sName | ++-----------+--------+-----------+-------+---------------------+ +| sValue | string | optional | NULL | See Button::$sValue | ++-----------+--------+-----------+-------+---------------------+ +| bIsSubmit | bool | optional | false | See Button::$sType | ++-----------+--------+-----------+-------+---------------------+ +| sId | string | optional | NULL | | ++-----------+--------+-----------+-------+---------------------+ + +:Button *ForAlternativePrimaryAction* parameters: + ++-----------+--------+-----------+-------+---------------------+ +| sLabel | string | mandatory | | | ++-----------+--------+-----------+-------+---------------------+ +| sName | string | optional | NULL | See Button::$sName | ++-----------+--------+-----------+-------+---------------------+ +| sValue | string | optional | NULL | See Button::$sValue | ++-----------+--------+-----------+-------+---------------------+ +| bIsSubmit | bool | optional | false | See Button::$sType | ++-----------+--------+-----------+-------+---------------------+ +| sId | string | optional | NULL | | ++-----------+--------+-----------+-------+---------------------+ + +:Button *ForAlternativeSecondaryAction* parameters: + ++-----------+--------+-----------+-------+---------------------+ +| sLabel | string | mandatory | | | ++-----------+--------+-----------+-------+---------------------+ +| sName | string | optional | NULL | See Button::$sName | ++-----------+--------+-----------+-------+---------------------+ +| sValue | string | optional | NULL | See Button::$sValue | ++-----------+--------+-----------+-------+---------------------+ +| bIsSubmit | bool | optional | false | See Button::$sType | ++-----------+--------+-----------+-------+---------------------+ +| sId | string | optional | NULL | | ++-----------+--------+-----------+-------+---------------------+ + +:Button *ForAlternativeValidationAction* parameters: + ++-----------+--------+-----------+-------+---------------------+ +| sLabel | string | mandatory | | | ++-----------+--------+-----------+-------+---------------------+ +| sName | string | optional | NULL | See Button::$sName | ++-----------+--------+-----------+-------+---------------------+ +| sValue | string | optional | NULL | See Button::$sValue | ++-----------+--------+-----------+-------+---------------------+ +| bIsSubmit | bool | optional | false | See Button::$sType | ++-----------+--------+-----------+-------+---------------------+ +| sId | string | optional | NULL | | ++-----------+--------+-----------+-------+---------------------+ + +:Button *ForAlternativeDestructiveAction* parameters: + ++-----------+--------+-----------+-------+---------------------+ +| sLabel | string | mandatory | | | ++-----------+--------+-----------+-------+---------------------+ +| sName | string | optional | NULL | See Button::$sName | ++-----------+--------+-----------+-------+---------------------+ +| sValue | string | optional | NULL | See Button::$sValue | ++-----------+--------+-----------+-------+---------------------+ +| bIsSubmit | bool | optional | false | See Button::$sType | ++-----------+--------+-----------+-------+---------------------+ +| sId | string | optional | NULL | | ++-----------+--------+-----------+-------+---------------------+ + +:Button *ForCancel* parameters: + ++-----------+--------+----------+-------+---------------------+ +| sLabel | string | optional | NULL | | ++-----------+--------+----------+-------+---------------------+ +| sName | string | optional | NULL | See Button::$sName | ++-----------+--------+----------+-------+---------------------+ +| sValue | string | optional | NULL | See Button::$sValue | ++-----------+--------+----------+-------+---------------------+ +| bIsSubmit | bool | optional | false | See Button::$sType | ++-----------+--------+----------+-------+---------------------+ +| sId | string | optional | NULL | | ++-----------+--------+----------+-------+---------------------+ + +:Button *IconAction* parameters: + ++--------------+--------+-----------+-------+--+ +| sIconClasses | string | mandatory | | | ++--------------+--------+-----------+-------+--+ +| sTooltipText | string | optional | '' | | ++--------------+--------+-----------+-------+--+ +| sName | string | optional | NULL | | ++--------------+--------+-----------+-------+--+ +| sValue | string | optional | NULL | | ++--------------+--------+-----------+-------+--+ +| bIsSubmit | bool | optional | false | | ++--------------+--------+-----------+-------+--+ +| sId | string | optional | NULL | | ++--------------+--------+-----------+-------+--+ + +:Button *LinkNeutral* parameters: + ++--------------+--------+-----------+------+--+ +| sURL | string | mandatory | | | ++--------------+--------+-----------+------+--+ +| sLabel | string | optional | '' | | ++--------------+--------+-----------+------+--+ +| sIconClasses | string | optional | NULL | | ++--------------+--------+-----------+------+--+ +| sTarget | string | optional | NULL | | ++--------------+--------+-----------+------+--+ +| sId | string | optional | NULL | | ++--------------+--------+-----------+------+--+ + +:Button *IconLink* parameters: + ++--------------+--------+-----------+------+--+ +| sIconClasses | string | mandatory | | | ++--------------+--------+-----------+------+--+ +| sTooltipText | string | mandatory | | | ++--------------+--------+-----------+------+--+ +| sURL | string | optional | '' | | ++--------------+--------+-----------+------+--+ +| sTarget | string | optional | NULL | | ++--------------+--------+-----------+------+--+ +| sId | string | optional | NULL | | ++--------------+--------+-----------+------+--+ + +:Button *DestructiveIconLink* parameters: + ++--------------+--------+-----------+------+--+ +| sIconClasses | string | mandatory | | | ++--------------+--------+-----------+------+--+ +| sTooltipText | string | mandatory | | | ++--------------+--------+-----------+------+--+ +| sURL | string | optional | NULL | | ++--------------+--------+-----------+------+--+ +| sName | string | optional | NULL | | ++--------------+--------+-----------+------+--+ +| sTarget | string | optional | NULL | | ++--------------+--------+-----------+------+--+ +| sId | string | optional | NULL | | ++--------------+--------+-----------+------+--+ + +:Button common parameters: + ++-------------------+--------+--------------------------------------------------------+ +| ActionType | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+--------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+--------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+--------+--------------------------------------------------------+ +| Color | string | | ++-------------------+--------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+--------+--------------------------------------------------------+ +| IconClass | string | | ++-------------------+--------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+--------+--------------------------------------------------------+ +| JsCode | string | | ++-------------------+--------+--------------------------------------------------------+ +| Label | string | | ++-------------------+--------+--------------------------------------------------------+ +| OnClickJsCode | string | | ++-------------------+--------+--------------------------------------------------------+ +| Tooltip | string | | ++-------------------+--------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/Button/ButtonFooter.rst diff --git a/.doc/UI/source/generated/Component/ButtonGroup/ButtonGroup.rst b/.doc/UI/source/generated/Component/ButtonGroup/ButtonGroup.rst new file mode 100644 index 000000000..de835c876 --- /dev/null +++ b/.doc/UI/source/generated/Component/ButtonGroup/ButtonGroup.rst @@ -0,0 +1,70 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +ButtonGroup +=========== + +Class ButtonGroup + +---- + +.. include:: /manual/Component/ButtonGroup/ButtonGroupAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UIButtonGroup** + +:Syntax: + +:: + + {% UIButtonGroup Type {Parameters} %} + +:Type: + ++-----------------------+--------------------------------------------------------------------------------------------------+ +| ButtonWithOptionsMenu | Make a button that has a primary action ($oButton) but also an options menu ($oMenu) on the side | ++-----------------------+--------------------------------------------------------------------------------------------------+ + +:ButtonGroup *ButtonWithOptionsMenu* parameters: + ++---------+-------------+-----------+--+--+ +| oButton | Button | mandatory | | | ++---------+-------------+-----------+--+--+ +| oMenu | PopoverMenu | mandatory | | | ++---------+-------------+-----------+--+--+ + +:ButtonGroup common parameters: + ++-------------------+----------+--------------------------------------------------------+ +| AddButton | Button | | ++-------------------+----------+--------------------------------------------------------+ +| AddButtons | array | | ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddExtraBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| Buttons | array | | ++-------------------+----------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+----------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+----------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/ButtonGroup/ButtonGroupFooter.rst diff --git a/.doc/UI/source/generated/Component/CollapsibleSection/CollapsibleSection.rst b/.doc/UI/source/generated/Component/CollapsibleSection/CollapsibleSection.rst new file mode 100644 index 000000000..8c2aa0911 --- /dev/null +++ b/.doc/UI/source/generated/Component/CollapsibleSection/CollapsibleSection.rst @@ -0,0 +1,74 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +CollapsibleSection +================== + +Class CollapsibleSection + +---- + +.. include:: /manual/Component/CollapsibleSection/CollapsibleSectionAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UICollapsibleSection** + +:Syntax: + +:: + + {% UICollapsibleSection Type {Parameters} %} + Content Goes Here + {% EndUICollapsibleSection %} + +:Type: + ++----------+------------+ +| Standard | No comment | ++----------+------------+ + +:CollapsibleSection *Standard* parameters: + ++--------+--------+-----------+------+--+ +| sTitle | string | mandatory | | | ++--------+--------+-----------+------+--+ +| sId | string | optional | NULL | | ++--------+--------+-----------+------+--+ + +:CollapsibleSection common parameters: + ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddDeferredBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddSubBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+----------+--------------------------------------------------------+ +| DeferredBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+----------+--------------------------------------------------------+ +| OpenedByDefault | bool | | ++-------------------+----------+--------------------------------------------------------+ +| SubBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/CollapsibleSection/CollapsibleSectionFooter.rst diff --git a/.doc/UI/source/Component/Component.rst b/.doc/UI/source/generated/Component/Component.rst similarity index 64% rename from .doc/UI/source/Component/Component.rst rename to .doc/UI/source/generated/Component/Component.rst index 2d4333ac1..79737937d 100644 --- a/.doc/UI/source/Component/Component.rst +++ b/.doc/UI/source/generated/Component/Component.rst @@ -19,4 +19,13 @@ A UI component is a unitary block used to display information in iTop console. ButtonGroup/ButtonGroup CollapsibleSection/CollapsibleSection DataTable/DataTable - UIBlock/UIBlock + FieldBadge/FieldBadge + Form/Form + Input/Input + Input/FileSelect/FileSelect + Input/Select/Select + Input/Select/SelectOption + Panel/Panel + Spinner/Spinner + Toolbar/Toolbar + Toolbar/ToolbarSpacer/ToolbarSpacer diff --git a/.doc/UI/source/generated/Component/DataTable/DataTable.rst b/.doc/UI/source/generated/Component/DataTable/DataTable.rst new file mode 100644 index 000000000..cc37ac97f --- /dev/null +++ b/.doc/UI/source/generated/Component/DataTable/DataTable.rst @@ -0,0 +1,160 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +DataTable +========= + +Class DataTable + +---- + +.. include:: /manual/Component/DataTable/DataTableAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UIDataTable** + +:Syntax: + +:: + + {% UIDataTable Type {Parameters} %} + Content Goes Here + {% EndUIDataTable %} + +:Type: + ++--------------------+------------------------------+ +| ForResult | @param \WebPage $oPage | ++--------------------+------------------------------+ +| ForObject | @param \WebPage $oPage | ++--------------------+------------------------------+ +| ForRendering | Make a basis Panel component | ++--------------------+------------------------------+ +| ForRenderingObject | @param string $sListId | ++--------------------+------------------------------+ +| ForStaticData | No comment | ++--------------------+------------------------------+ +| ForForm | @param string $sRef | ++--------------------+------------------------------+ + +:DataTable *ForResult* parameters: + ++--------------+-------------+-----------+----------+--+ +| oPage | WebPage | mandatory | | | ++--------------+-------------+-----------+----------+--+ +| sListId | string | mandatory | | | ++--------------+-------------+-----------+----------+--+ +| oSet | DBObjectSet | mandatory | | | ++--------------+-------------+-----------+----------+--+ +| aExtraParams | | optional | array () | | ++--------------+-------------+-----------+----------+--+ + +:DataTable *ForObject* parameters: + ++--------------+-------------+-----------+----------+--+ +| oPage | WebPage | mandatory | | | ++--------------+-------------+-----------+----------+--+ +| sListId | string | mandatory | | | ++--------------+-------------+-----------+----------+--+ +| oSet | DBObjectSet | mandatory | | | ++--------------+-------------+-----------+----------+--+ +| aExtraParams | | optional | array () | | ++--------------+-------------+-----------+----------+--+ + +:DataTable *ForRendering* parameters: + ++--------------+-------------+-----------+----------+--+ +| sListId | string | mandatory | | | ++--------------+-------------+-----------+----------+--+ +| oSet | DBObjectSet | mandatory | | | ++--------------+-------------+-----------+----------+--+ +| aExtraParams | | optional | array () | | ++--------------+-------------+-----------+----------+--+ + +:DataTable *ForRenderingObject* parameters: + ++--------------+-------------+-----------+----------+--+ +| sListId | string | mandatory | | | ++--------------+-------------+-----------+----------+--+ +| oSet | DBObjectSet | mandatory | | | ++--------------+-------------+-----------+----------+--+ +| aExtraParams | | optional | array () | | ++--------------+-------------+-----------+----------+--+ + +:DataTable *ForStaticData* parameters: + ++--------------+--------+-----------+----------+--+ +| sTitle | string | mandatory | | | ++--------------+--------+-----------+----------+--+ +| aColumns | array | mandatory | | | ++--------------+--------+-----------+----------+--+ +| aData | array | mandatory | | | ++--------------+--------+-----------+----------+--+ +| sId | string | optional | NULL | | ++--------------+--------+-----------+----------+--+ +| aExtraParams | array | optional | array () | | ++--------------+--------+-----------+----------+--+ +| sFilter | string | optional | '' | | ++--------------+--------+-----------+----------+--+ +| aOptions | array | optional | array () | | ++--------------+--------+-----------+----------+--+ + +:DataTable *ForForm* parameters: + ++----------+--------+-----------+----------+--+ +| sRef | string | mandatory | | | ++----------+--------+-----------+----------+--+ +| aColumns | array | mandatory | | | ++----------+--------+-----------+----------+--+ +| aData | array | optional | array () | | ++----------+--------+-----------+----------+--+ +| sFilter | string | optional | '' | | ++----------+--------+-----------+----------+--+ + +:DataTable common parameters: + ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddDeferredBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddSubBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| AjaxData | array | | ++-------------------+----------+--------------------------------------------------------+ +| AjaxUrl | string | | ++-------------------+----------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+----------+--------------------------------------------------------+ +| DeferredBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ +| DisplayColumns | | | ++-------------------+----------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+----------+--------------------------------------------------------+ +| JSRefresh | string | | ++-------------------+----------+--------------------------------------------------------+ +| Options | | | ++-------------------+----------+--------------------------------------------------------+ +| ResultColumns | | | ++-------------------+----------+--------------------------------------------------------+ +| SubBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/DataTable/DataTableFooter.rst diff --git a/.doc/UI/source/generated/Component/Field/Field.rst b/.doc/UI/source/generated/Component/Field/Field.rst new file mode 100644 index 000000000..7eb814c8c --- /dev/null +++ b/.doc/UI/source/generated/Component/Field/Field.rst @@ -0,0 +1,146 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +Field +===== + +Class Field + +---- + +.. include:: /manual/Component/Field/FieldAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UIField** + +:Syntax: + +:: + + {% UIField Type {Parameters} %} + Content Goes Here + {% EndUIField %} + +:Type: + ++------------+------------+ +| FromParams | No comment | ++------------+------------+ +| FromObject | No comment | ++------------+------------+ +| Large | No comment | ++------------+------------+ +| Small | No comment | ++------------+------------+ +| Standard | No comment | ++------------+------------+ + +:Field *FromParams* parameters: + ++---------+--+-----------+--+--+ +| aParams | | mandatory | | | ++---------+--+-----------+--+--+ + +:Field *FromObject* parameters: + ++---------+---------+-----------+------+--+ +| sLabel | string | mandatory | | | ++---------+---------+-----------+------+--+ +| oInput | UIBlock | mandatory | | | ++---------+---------+-----------+------+--+ +| sLayout | string | optional | NULL | | ++---------+---------+-----------+------+--+ + +:Field *Large* parameters: + ++------------+--------+-----------+----+--+ +| sLabel | string | mandatory | | | ++------------+--------+-----------+----+--+ +| sValueHtml | string | optional | '' | | ++------------+--------+-----------+----+--+ + +:Field *Small* parameters: + ++------------+--------+-----------+----+--+ +| sLabel | string | mandatory | | | ++------------+--------+-----------+----+--+ +| sValueHtml | string | optional | '' | | ++------------+--------+-----------+----+--+ + +:Field *Standard* parameters: + ++---------+--------+----------+---------+--+ +| sLabel | string | optional | '' | | ++---------+--------+----------+---------+--+ +| sLayout | string | optional | 'small' | | ++---------+--------+----------+---------+--+ +| sId | string | optional | NULL | | ++---------+--------+----------+---------+--+ + +:Field common parameters: + ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddDeferredBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddSubBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| AttCode | string | | ++-------------------+----------+--------------------------------------------------------+ +| AttLabel | string | | ++-------------------+----------+--------------------------------------------------------+ +| AttType | string | | ++-------------------+----------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| Comments | string | | ++-------------------+----------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+----------+--------------------------------------------------------+ +| DeferredBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ +| InputId | string | | ++-------------------+----------+--------------------------------------------------------+ +| InputType | string | | ++-------------------+----------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+----------+--------------------------------------------------------+ +| IsMandatory | bool | | ++-------------------+----------+--------------------------------------------------------+ +| IsReadOnly | bool | | ++-------------------+----------+--------------------------------------------------------+ +| IsSlave | bool | | ++-------------------+----------+--------------------------------------------------------+ +| Label | string | | ++-------------------+----------+--------------------------------------------------------+ +| Layout | string | | ++-------------------+----------+--------------------------------------------------------+ +| MustChange | bool | | ++-------------------+----------+--------------------------------------------------------+ +| MustPrompt | bool | | ++-------------------+----------+--------------------------------------------------------+ +| SubBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ +| Value | UIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| ValueId | string | | ++-------------------+----------+--------------------------------------------------------+ +| ValueRaw | string | | ++-------------------+----------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/Field/FieldFooter.rst diff --git a/.doc/UI/source/generated/Component/FieldBadge/FieldBadge.rst b/.doc/UI/source/generated/Component/FieldBadge/FieldBadge.rst new file mode 100644 index 000000000..d14345ea0 --- /dev/null +++ b/.doc/UI/source/generated/Component/FieldBadge/FieldBadge.rst @@ -0,0 +1,72 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +FieldBadge +========== + +Class FieldBadge + +---- + +.. include:: /manual/Component/FieldBadge/FieldBadgeAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UIFieldBadge** + +:Syntax: + +:: + + {% UIFieldBadge Type {Parameters} %} + Content Goes Here + {% EndUIFieldBadge %} + +:Type: + ++----------+-----------------------+ +| ForField | @param string $sValue | ++----------+-----------------------+ + +:FieldBadge *ForField* parameters: + ++--------+----------+-----------+--+--+ +| sValue | string | mandatory | | | ++--------+----------+-----------+--+--+ +| oStyle | ormStyle | mandatory | | | ++--------+----------+-----------+--+--+ + +:FieldBadge common parameters: + ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddDeferredBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddSubBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+----------+--------------------------------------------------------+ +| DeferredBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+----------+--------------------------------------------------------+ +| SubBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/FieldBadge/FieldBadgeFooter.rst diff --git a/.doc/UI/source/generated/Component/FieldSet/FieldSet.rst b/.doc/UI/source/generated/Component/FieldSet/FieldSet.rst new file mode 100644 index 000000000..f476a903d --- /dev/null +++ b/.doc/UI/source/generated/Component/FieldSet/FieldSet.rst @@ -0,0 +1,72 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +FieldSet +======== + +Class FieldSet + +---- + +.. include:: /manual/Component/FieldSet/FieldSetAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UIFieldSet** + +:Syntax: + +:: + + {% UIFieldSet Type {Parameters} %} + Content Goes Here + {% EndUIFieldSet %} + +:Type: + ++----------+------------+ +| Standard | No comment | ++----------+------------+ + +:FieldSet *Standard* parameters: + ++---------+--------+-----------+------+--+ +| sLegend | string | mandatory | | | ++---------+--------+-----------+------+--+ +| sId | string | optional | NULL | | ++---------+--------+-----------+------+--+ + +:FieldSet common parameters: + ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddDeferredBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddSubBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+----------+--------------------------------------------------------+ +| DeferredBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+----------+--------------------------------------------------------+ +| SubBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/FieldSet/FieldSetFooter.rst diff --git a/.doc/UI/source/generated/Component/Form/Form.rst b/.doc/UI/source/generated/Component/Form/Form.rst new file mode 100644 index 000000000..02dc716ad --- /dev/null +++ b/.doc/UI/source/generated/Component/Form/Form.rst @@ -0,0 +1,74 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +Form +==== + +Class Form + +---- + +.. include:: /manual/Component/Form/FormAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UIForm** + +:Syntax: + +:: + + {% UIForm Type {Parameters} %} + Content Goes Here + {% EndUIForm %} + +:Type: + ++----------+------------+ +| Standard | No comment | ++----------+------------+ + +:Form *Standard* parameters: + ++-----+--------+----------+------+--+ +| sId | string | optional | NULL | | ++-----+--------+----------+------+--+ + +:Form common parameters: + ++-------------------+----------+--------------------------------------------------------+ +| Action | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddDeferredBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddSubBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+----------+--------------------------------------------------------+ +| DeferredBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+----------+--------------------------------------------------------+ +| OnSubmitJsCode | string | | ++-------------------+----------+--------------------------------------------------------+ +| SubBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/Form/FormFooter.rst diff --git a/.doc/UI/source/generated/Component/Input/FileSelect/FileSelect.rst b/.doc/UI/source/generated/Component/Input/FileSelect/FileSelect.rst new file mode 100644 index 000000000..dfc504c2c --- /dev/null +++ b/.doc/UI/source/generated/Component/Input/FileSelect/FileSelect.rst @@ -0,0 +1,68 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +FileSelect +========== + +Class FileSelect + +---- + +.. include:: /manual/Component/Input/FileSelect/FileSelectAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UIFileSelect** + +:Syntax: + +:: + + {% UIFileSelect Type {Parameters} %} + +:Type: + ++----------+------------+ +| Standard | No comment | ++----------+------------+ + +:FileSelect *Standard* parameters: + ++-------+--------+-----------+------+--+ +| sName | string | mandatory | | | ++-------+--------+-----------+------+--+ +| sId | string | optional | NULL | | ++-------+--------+-----------+------+--+ + +:FileSelect common parameters: + ++-------------------+--------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+--------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+--------+--------------------------------------------------------+ +| ButtonText | string | | ++-------------------+--------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+--------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+--------+--------------------------------------------------------+ +| FileName | | | ++-------------------+--------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+--------+--------------------------------------------------------+ +| ShowFilename | bool | | ++-------------------+--------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/Input/FileSelect/FileSelectFooter.rst diff --git a/.doc/UI/source/generated/Component/Input/Input.rst b/.doc/UI/source/generated/Component/Input/Input.rst new file mode 100644 index 000000000..326a40981 --- /dev/null +++ b/.doc/UI/source/generated/Component/Input/Input.rst @@ -0,0 +1,108 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +Input +===== + +Class Input + +---- + +.. include:: /manual/Component/Input/InputAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UIInput** + +:Syntax: + +:: + + {% UIInput Type {Parameters} %} + +:Type: + ++-------------------+------------------------------------------------------------------------------------+ +| ForHidden | No comment | ++-------------------+------------------------------------------------------------------------------------+ +| Standard | No comment | ++-------------------+------------------------------------------------------------------------------------+ +| ForInputWithLabel | @see Field component that is better adapter when dealing with a standard iTop form | ++-------------------+------------------------------------------------------------------------------------+ + +:Input *ForHidden* parameters: + ++--------+--------+-----------+------+--+ +| sName | string | mandatory | | | ++--------+--------+-----------+------+--+ +| sValue | string | mandatory | | | ++--------+--------+-----------+------+--+ +| sId | string | optional | NULL | | ++--------+--------+-----------+------+--+ + +:Input *Standard* parameters: + ++--------+--------+-----------+------+--+ +| sType | string | mandatory | | | ++--------+--------+-----------+------+--+ +| sName | string | mandatory | | | ++--------+--------+-----------+------+--+ +| sValue | string | mandatory | | | ++--------+--------+-----------+------+--+ +| sId | string | optional | NULL | | ++--------+--------+-----------+------+--+ + +:Input *ForInputWithLabel* parameters: + ++-------------+--------+-----------+--------+--+ +| sLabel | string | mandatory | | | ++-------------+--------+-----------+--------+--+ +| sInputName | string | mandatory | | | ++-------------+--------+-----------+--------+--+ +| sInputValue | string | optional | NULL | | ++-------------+--------+-----------+--------+--+ +| sInputId | string | optional | NULL | | ++-------------+--------+-----------+--------+--+ +| sInputType | string | optional | 'type' | | ++-------------+--------+-----------+--------+--+ + +:Input common parameters: + ++-------------------+--------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+--------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+--------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+--------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+--------+--------------------------------------------------------+ +| IsChecked | | | ++-------------------+--------+--------------------------------------------------------+ +| IsDisabled | bool | | ++-------------------+--------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+--------+--------------------------------------------------------+ +| IsReadonly | bool | | ++-------------------+--------+--------------------------------------------------------+ +| Name | string | | ++-------------------+--------+--------------------------------------------------------+ +| Placeholder | string | | ++-------------------+--------+--------------------------------------------------------+ +| Type | string | | ++-------------------+--------+--------------------------------------------------------+ +| Value | string | | ++-------------------+--------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/Input/InputFooter.rst diff --git a/.doc/UI/source/generated/Component/Input/Select/Select.rst b/.doc/UI/source/generated/Component/Input/Select/Select.rst new file mode 100644 index 000000000..475475892 --- /dev/null +++ b/.doc/UI/source/generated/Component/Input/Select/Select.rst @@ -0,0 +1,94 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +Select +====== + +Class Select + +---- + +.. include:: /manual/Component/Input/Select/SelectAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UISelect** + +:Syntax: + +:: + + {% UISelect Type {Parameters} %} + Content Goes Here + {% EndUISelect %} + +:Type: + ++--------------------+------------------------------------------------------------------------------------------------+ +| ForSelect | @param string $sName | ++--------------------+------------------------------------------------------------------------------------------------+ +| ForSelectWithLabel | If you need to have a real field with a label, you might use a {@link Field} component instead | ++--------------------+------------------------------------------------------------------------------------------------+ + +:Select *ForSelect* parameters: + ++-------+--------+-----------+------+--+ +| sName | string | mandatory | | | ++-------+--------+-----------+------+--+ +| sId | string | optional | NULL | | ++-------+--------+-----------+------+--+ + +:Select *ForSelectWithLabel* parameters: + ++--------+--------+-----------+------+--+ +| sName | string | mandatory | | | ++--------+--------+-----------+------+--+ +| sLabel | string | mandatory | | | ++--------+--------+-----------+------+--+ +| sId | string | optional | NULL | | ++--------+--------+-----------+------+--+ + +:Select common parameters: + ++-------------------+--------------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+--------------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+--------------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+--------------+--------------------------------------------------------+ +| AddDeferredBlock | iUIBlock | | ++-------------------+--------------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+--------------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+--------------+--------------------------------------------------------+ +| AddOption | SelectOption | | ++-------------------+--------------+--------------------------------------------------------+ +| AddSubBlock | iUIBlock | | ++-------------------+--------------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+--------------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+--------------+--------------------------------------------------------+ +| DeferredBlocks | array | | ++-------------------+--------------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+--------------+--------------------------------------------------------+ +| IsMultiple | bool | | ++-------------------+--------------+--------------------------------------------------------+ +| Name | string | | ++-------------------+--------------+--------------------------------------------------------+ +| SubBlocks | array | | ++-------------------+--------------+--------------------------------------------------------+ +| SubmitOnChange | bool | | ++-------------------+--------------+--------------------------------------------------------+ +| Value | string | | ++-------------------+--------------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/Input/Select/SelectFooter.rst diff --git a/.doc/UI/source/generated/Component/Input/Select/SelectOption.rst b/.doc/UI/source/generated/Component/Input/Select/SelectOption.rst new file mode 100644 index 000000000..c0f8ec2e1 --- /dev/null +++ b/.doc/UI/source/generated/Component/Input/Select/SelectOption.rst @@ -0,0 +1,74 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +SelectOption +============ + +Class SelectOption + +---- + +.. include:: /manual/Component/Input/Select/SelectOptionAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UISelectOption** + +:Syntax: + +:: + + {% UISelectOption Type {Parameters} %} + +:Type: + ++-----------------+------------+ +| ForSelectOption | No comment | ++-----------------+------------+ + +:SelectOption *ForSelectOption* parameters: + ++-----------+--------+-----------+------+--+ +| sValue | string | mandatory | | | ++-----------+--------+-----------+------+--+ +| sLabel | string | mandatory | | | ++-----------+--------+-----------+------+--+ +| bSelected | bool | mandatory | | | ++-----------+--------+-----------+------+--+ +| sId | string | optional | NULL | | ++-----------+--------+-----------+------+--+ + +:SelectOption common parameters: + ++-------------------+--------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+--------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+--------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+--------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+--------+--------------------------------------------------------+ +| Disabled | bool | | ++-------------------+--------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+--------+--------------------------------------------------------+ +| Label | string | | ++-------------------+--------+--------------------------------------------------------+ +| Selected | bool | | ++-------------------+--------+--------------------------------------------------------+ +| Value | string | | ++-------------------+--------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/Input/Select/SelectOptionFooter.rst diff --git a/.doc/UI/source/generated/Component/Panel/Panel.rst b/.doc/UI/source/generated/Component/Panel/Panel.rst new file mode 100644 index 000000000..36e0ece10 --- /dev/null +++ b/.doc/UI/source/generated/Component/Panel/Panel.rst @@ -0,0 +1,190 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +Panel +===== + +Class Panel + +---- + +.. include:: /manual/Component/Panel/PanelAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UIPanel** + +:Syntax: + +:: + + {% UIPanel Type {Parameters} %} + Content Goes Here + {% EndUIPanel %} + +:Type: + ++----------------------------+---------------------------------------------------------------+ +| Neutral | Make a basis Panel component | ++----------------------------+---------------------------------------------------------------+ +| ForInformation | Make a Panel component for informational messages | ++----------------------------+---------------------------------------------------------------+ +| ForSuccess | Make a Panel component for successful messages | ++----------------------------+---------------------------------------------------------------+ +| ForWarning | Make a Panel component for warning messages | ++----------------------------+---------------------------------------------------------------+ +| ForDanger | Make a Panel component for danger messages | ++----------------------------+---------------------------------------------------------------+ +| ForFailure | Make a Panel component for failure messages | ++----------------------------+---------------------------------------------------------------+ +| WithBrandingPrimaryColor | Make a Panel component with primary color scheme | ++----------------------------+---------------------------------------------------------------+ +| WithBrandingSecondaryColor | Make a Panel component with secondary color scheme | ++----------------------------+---------------------------------------------------------------+ +| ForClass | Make a Panel component with the specific $sClass color scheme | ++----------------------------+---------------------------------------------------------------+ + +:Panel *Neutral* parameters: + ++-----------+--------+-----------+------+--+ +| sTitle | string | mandatory | | | ++-----------+--------+-----------+------+--+ +| sSubTitle | string | optional | NULL | | ++-----------+--------+-----------+------+--+ + +:Panel *ForInformation* parameters: + ++-----------+--------+-----------+------+--+ +| sTitle | string | mandatory | | | ++-----------+--------+-----------+------+--+ +| sSubTitle | string | optional | NULL | | ++-----------+--------+-----------+------+--+ + +:Panel *ForSuccess* parameters: + ++-----------+--------+-----------+------+--+ +| sTitle | string | mandatory | | | ++-----------+--------+-----------+------+--+ +| sSubTitle | string | optional | NULL | | ++-----------+--------+-----------+------+--+ + +:Panel *ForWarning* parameters: + ++-----------+--------+-----------+------+--+ +| sTitle | string | mandatory | | | ++-----------+--------+-----------+------+--+ +| sSubTitle | string | optional | NULL | | ++-----------+--------+-----------+------+--+ + +:Panel *ForDanger* parameters: + ++-----------+--------+-----------+------+--+ +| sTitle | string | mandatory | | | ++-----------+--------+-----------+------+--+ +| sSubTitle | string | optional | NULL | | ++-----------+--------+-----------+------+--+ + +:Panel *ForFailure* parameters: + ++-----------+--------+-----------+------+--+ +| sTitle | string | mandatory | | | ++-----------+--------+-----------+------+--+ +| sSubTitle | string | optional | NULL | | ++-----------+--------+-----------+------+--+ + +:Panel *WithBrandingPrimaryColor* parameters: + ++-----------+--------+-----------+------+--+ +| sTitle | string | mandatory | | | ++-----------+--------+-----------+------+--+ +| sSubTitle | string | optional | NULL | | ++-----------+--------+-----------+------+--+ + +:Panel *WithBrandingSecondaryColor* parameters: + ++-----------+--------+-----------+------+--+ +| sTitle | string | mandatory | | | ++-----------+--------+-----------+------+--+ +| sSubTitle | string | optional | NULL | | ++-----------+--------+-----------+------+--+ + +:Panel *ForClass* parameters: + ++-----------+--------+-----------+------+--------------------------------------+ +| sClass | string | mandatory | | Class of the object the panel is for | ++-----------+--------+-----------+------+--------------------------------------+ +| sTitle | string | mandatory | | | ++-----------+--------+-----------+------+--------------------------------------+ +| sSubTitle | string | optional | NULL | | ++-----------+--------+-----------+------+--------------------------------------+ + +:Panel common parameters: + ++-------------------+-----------------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+-----------------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+-----------------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+-----------------+--------------------------------------------------------+ +| AddDeferredBlock | iUIBlock | | ++-------------------+-----------------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+-----------------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+-----------------+--------------------------------------------------------+ +| AddMainBlock | iUIBlock | | ++-------------------+-----------------+--------------------------------------------------------+ +| AddMainBlocks | array | | ++-------------------+-----------------+--------------------------------------------------------+ +| AddSubBlock | iUIBlock | directly in the main area | ++-------------------+-----------------+--------------------------------------------------------+ +| AddSubTitleBlock | iUIBlock | | ++-------------------+-----------------+--------------------------------------------------------+ +| AddSubTitleBlocks | array | | ++-------------------+-----------------+--------------------------------------------------------+ +| AddTitleBlock | iUIBlock | | ++-------------------+-----------------+--------------------------------------------------------+ +| AddTitleBlocks | array | | ++-------------------+-----------------+--------------------------------------------------------+ +| AddToolbarBlock | iUIBlock | | ++-------------------+-----------------+--------------------------------------------------------+ +| AddToolbarBlocks | array | | ++-------------------+-----------------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+-----------------+--------------------------------------------------------+ +| Color | string | | ++-------------------+-----------------+--------------------------------------------------------+ +| ColorFromClass | string | | ++-------------------+-----------------+--------------------------------------------------------+ +| ColorFromOrmStyle | ormStyle | | ++-------------------+-----------------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+-----------------+--------------------------------------------------------+ +| DeferredBlocks | array | | ++-------------------+-----------------+--------------------------------------------------------+ +| IsCollapsible | bool | | ++-------------------+-----------------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+-----------------+--------------------------------------------------------+ +| MainBlocks | array | | ++-------------------+-----------------+--------------------------------------------------------+ +| SubBlocks | array | | ++-------------------+-----------------+--------------------------------------------------------+ +| SubTitle | string | | ++-------------------+-----------------+--------------------------------------------------------+ +| SubTitleBlock | iUIContentBlock | | ++-------------------+-----------------+--------------------------------------------------------+ +| Title | string | | ++-------------------+-----------------+--------------------------------------------------------+ +| TitleBlock | iUIContentBlock | | ++-------------------+-----------------+--------------------------------------------------------+ +| ToolBlocks | array | | ++-------------------+-----------------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/Panel/PanelFooter.rst diff --git a/.doc/UI/source/generated/Component/Spinner/Spinner.rst b/.doc/UI/source/generated/Component/Spinner/Spinner.rst new file mode 100644 index 000000000..b9b7affe7 --- /dev/null +++ b/.doc/UI/source/generated/Component/Spinner/Spinner.rst @@ -0,0 +1,60 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +Spinner +======= + +Class Spinner + +---- + +.. include:: /manual/Component/Spinner/SpinnerAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UISpinner** + +:Syntax: + +:: + + {% UISpinner Type {Parameters} %} + +:Type: + ++----------+------------+ +| Standard | No comment | ++----------+------------+ + +:Spinner *Standard* parameters: + ++-----+--------+----------+------+--+ +| sId | string | optional | NULL | | ++-----+--------+----------+------+--+ + +:Spinner common parameters: + ++-------------------+--------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+--------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+--------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+--------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+--------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+--------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/Spinner/SpinnerFooter.rst diff --git a/.doc/UI/source/generated/Component/Title/Title.rst b/.doc/UI/source/generated/Component/Title/Title.rst new file mode 100644 index 000000000..f9468c2cd --- /dev/null +++ b/.doc/UI/source/generated/Component/Title/Title.rst @@ -0,0 +1,112 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +Title +===== + +Class Title + +---- + +.. include:: /manual/Component/Title/TitleAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UITitle** + +:Syntax: + +:: + + {% UITitle Type {Parameters} %} + Content Goes Here + {% EndUITitle %} + +:Type: + ++-----------------+------------+ +| ForPage | No comment | ++-----------------+------------+ +| ForPageWithIcon | No comment | ++-----------------+------------+ +| Neutral | No comment | ++-----------------+------------+ +| Standard | No comment | ++-----------------+------------+ + +:Title *ForPage* parameters: + ++--------+--------+-----------+------+--+ +| sTitle | string | mandatory | | | ++--------+--------+-----------+------+--+ +| sId | string | optional | NULL | | ++--------+--------+-----------+------+--+ + +:Title *ForPageWithIcon* parameters: + ++------------------+--------+-----------+-----------+--+ +| sTitle | string | mandatory | | | ++------------------+--------+-----------+-----------+--+ +| sIconUrl | string | mandatory | | | ++------------------+--------+-----------+-----------+--+ +| sIconCoverMethod | string | optional | 'contain' | | ++------------------+--------+-----------+-----------+--+ +| bIsMedallion | bool | optional | true | | ++------------------+--------+-----------+-----------+--+ +| sId | string | optional | NULL | | ++------------------+--------+-----------+-----------+--+ + +:Title *Neutral* parameters: + ++--------+--------+-----------+------+--+ +| sTitle | string | mandatory | | | ++--------+--------+-----------+------+--+ +| iLevel | int | optional | 1 | | ++--------+--------+-----------+------+--+ +| sId | string | optional | NULL | | ++--------+--------+-----------+------+--+ + +:Title *Standard* parameters: + ++--------+---------+-----------+------+--+ +| oTitle | UIBlock | mandatory | | | ++--------+---------+-----------+------+--+ +| iLevel | int | optional | 1 | | ++--------+---------+-----------+------+--+ +| sId | string | optional | NULL | | ++--------+---------+-----------+------+--+ + +:Title common parameters: + ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddDeferredBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddSubBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+----------+--------------------------------------------------------+ +| DeferredBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+----------+--------------------------------------------------------+ +| SubBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/Title/TitleFooter.rst diff --git a/.doc/UI/source/generated/Component/Toolbar/Toolbar.rst b/.doc/UI/source/generated/Component/Toolbar/Toolbar.rst new file mode 100644 index 000000000..61a15db95 --- /dev/null +++ b/.doc/UI/source/generated/Component/Toolbar/Toolbar.rst @@ -0,0 +1,90 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +Toolbar +======= + +Class Toolbar + +---- + +.. include:: /manual/Component/Toolbar/ToolbarAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UIToolbar** + +:Syntax: + +:: + + {% UIToolbar Type {Parameters} %} + Content Goes Here + {% EndUIToolbar %} + +:Type: + ++-----------+------------+ +| ForAction | No comment | ++-----------+------------+ +| Standard | No comment | ++-----------+------------+ +| ForButton | No comment | ++-----------+------------+ + +:Toolbar *ForAction* parameters: + ++-----+--------+----------+------+--+ +| sId | string | optional | NULL | | ++-----+--------+----------+------+--+ + +:Toolbar *Standard* parameters: + ++-------------------+--------+----------+----------+--+ +| sId | string | optional | NULL | | ++-------------------+--------+----------+----------+--+ +| aContainerClasses | array | optional | array () | | ++-------------------+--------+----------+----------+--+ + +:Toolbar *ForButton* parameters: + ++-------------------+--------+----------+----------+--+ +| sId | string | optional | NULL | | ++-------------------+--------+----------+----------+--+ +| aContainerClasses | array | optional | array () | | ++-------------------+--------+----------+----------+--+ + +:Toolbar common parameters: + ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddDeferredBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddSubBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+----------+--------------------------------------------------------+ +| DeferredBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+----------+--------------------------------------------------------+ +| SubBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/Toolbar/ToolbarFooter.rst diff --git a/.doc/UI/source/generated/Component/Toolbar/ToolbarSpacer/ToolbarSpacer.rst b/.doc/UI/source/generated/Component/Toolbar/ToolbarSpacer/ToolbarSpacer.rst new file mode 100644 index 000000000..e380b3318 --- /dev/null +++ b/.doc/UI/source/generated/Component/Toolbar/ToolbarSpacer/ToolbarSpacer.rst @@ -0,0 +1,60 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +ToolbarSpacer +============= + +Class ButtonToolbarSpacer + +---- + +.. include:: /manual/Component/Toolbar/ToolbarSpacer/ToolbarSpacerAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UIToolbarSpacer** + +:Syntax: + +:: + + {% UIToolbarSpacer Type {Parameters} %} + +:Type: + ++----------+-------------------------+ +| Standard | @param string|null $sId | ++----------+-------------------------+ + +:ToolbarSpacer *Standard* parameters: + ++-----+--------+----------+------+--+ +| sId | string | optional | NULL | | ++-----+--------+----------+------+--+ + +:ToolbarSpacer common parameters: + ++-------------------+--------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+--------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+--------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+--------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+--------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+--------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+--------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Component/Toolbar/ToolbarSpacer/ToolbarSpacerFooter.rst diff --git a/.doc/UI/source/Layout/Layout.rst b/.doc/UI/source/generated/Layout/Layout.rst similarity index 74% rename from .doc/UI/source/Layout/Layout.rst rename to .doc/UI/source/generated/Layout/Layout.rst index 21b636746..d48686ef3 100644 --- a/.doc/UI/source/Layout/Layout.rst +++ b/.doc/UI/source/generated/Layout/Layout.rst @@ -10,4 +10,6 @@ A UI block that serves as a layout for the page. :maxdepth: 1 :caption: Components: - UIContentBlock/UIContentBlock \ No newline at end of file + UIContentBlock + MultiColumn/MultiColumn + MultiColumn/Column/Column \ No newline at end of file diff --git a/.doc/UI/source/generated/Layout/MultiColumn/Column/Column.rst b/.doc/UI/source/generated/Layout/MultiColumn/Column/Column.rst new file mode 100644 index 000000000..ef73300b3 --- /dev/null +++ b/.doc/UI/source/generated/Layout/MultiColumn/Column/Column.rst @@ -0,0 +1,80 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +Column +====== + +Class Column + +---- + +.. include:: /manual/Layout/MultiColumn/Column/ColumnAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UIColumn** + +:Syntax: + +:: + + {% UIColumn Type {Parameters} %} + Content Goes Here + {% EndUIColumn %} + +:Type: + ++----------+------------+ +| Standard | No comment | ++----------+------------+ +| ForBlock | No comment | ++----------+------------+ + +:Column *Standard* parameters: + ++-----+--------+----------+------+--+ +| sId | string | optional | NULL | | ++-----+--------+----------+------+--+ + +:Column *ForBlock* parameters: + ++--------+---------+-----------+------+--+ +| oBlock | UIBlock | mandatory | | | ++--------+---------+-----------+------+--+ +| sId | string | optional | NULL | | ++--------+---------+-----------+------+--+ + +:Column common parameters: + ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddDeferredBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddSubBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+----------+--------------------------------------------------------+ +| DeferredBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+----------+--------------------------------------------------------+ +| SubBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Layout/MultiColumn/Column/ColumnFooter.rst diff --git a/.doc/UI/source/generated/Layout/MultiColumn/MultiColumn.rst b/.doc/UI/source/generated/Layout/MultiColumn/MultiColumn.rst new file mode 100644 index 000000000..b4a4b447d --- /dev/null +++ b/.doc/UI/source/generated/Layout/MultiColumn/MultiColumn.rst @@ -0,0 +1,72 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +MultiColumn +=========== + +Class MultiColumn + +---- + +.. include:: /manual/Layout/MultiColumn/MultiColumnAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UIMultiColumn** + +:Syntax: + +:: + + {% UIMultiColumn Type {Parameters} %} + Content Goes Here + {% EndUIMultiColumn %} + +:Type: + ++----------+------------+ +| Standard | No comment | ++----------+------------+ + +:MultiColumn *Standard* parameters: + ++-----+--------+----------+------+--+ +| sId | string | optional | NULL | | ++-----+--------+----------+------+--+ + +:MultiColumn common parameters: + ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClass | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddCSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| AddColumn | Column | | ++-------------------+----------+--------------------------------------------------------+ +| AddCssFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddDeferredBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| AddHtml | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddJsFileRelPath | string | | ++-------------------+----------+--------------------------------------------------------+ +| AddSubBlock | iUIBlock | | ++-------------------+----------+--------------------------------------------------------+ +| CSSClasses | array | like ['ibo-is-hidden', 'ibo-alert--body'] | ++-------------------+----------+--------------------------------------------------------+ +| DataAttributes | array | | ++-------------------+----------+--------------------------------------------------------+ +| DeferredBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ +| IsHidden | bool | | ++-------------------+----------+--------------------------------------------------------+ +| SubBlocks | array | | ++-------------------+----------+--------------------------------------------------------+ + +---- + +.. include:: /manual/Layout/MultiColumn/MultiColumnFooter.rst diff --git a/.doc/UI/source/generated/Layout/UIContentBlock.rst b/.doc/UI/source/generated/Layout/UIContentBlock.rst new file mode 100644 index 000000000..c853f3a8e --- /dev/null +++ b/.doc/UI/source/generated/Layout/UIContentBlock.rst @@ -0,0 +1,83 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + +UIContentBlock +============== + +Class UIContentBlock +Base block containing sub-blocks + +---- + +.. include:: /manual/Layout/UIContentBlockAdditionalDescription.rst + +---- + +Twig Tag +-------- + +:Tag: **UIContentBlock** + +:Syntax: + +:: + + {% UIContentBlock Type {Parameters} %} + Content Goes Here + {% EndUIContentBlock %} + +:Type: + ++----------+-------------------------------------------------------------------+ +| Standard | No comment | ++----------+-------------------------------------------------------------------+ +| ForCode | Used to display a block of code like
 but allows line break. |
++----------+-------------------------------------------------------------------+
+
+:UIContentBlock *Standard* parameters:
+
++-------------------+--------+----------+----------+--+
+| sId               | string | optional | NULL     |  |
++-------------------+--------+----------+----------+--+
+| aContainerClasses | array  | optional | array () |  |
++-------------------+--------+----------+----------+--+
+
+:UIContentBlock *ForCode* parameters:
+
++-------+--------+-----------+------+--+
+| sCode | string | mandatory |      |  |
++-------+--------+-----------+------+--+
+| sId   | string | optional  | NULL |  |
++-------+--------+-----------+------+--+
+
+:UIContentBlock common parameters:
+
++-------------------+----------+--------------------------------------------------------+
+| AddCSSClass       | string   |                                                        |
++-------------------+----------+--------------------------------------------------------+
+| AddCSSClasses     | array    | like ['ibo-is-hidden', 'ibo-alert--body'] |
++-------------------+----------+--------------------------------------------------------+
+| AddCssFileRelPath | string   |                                                        |
++-------------------+----------+--------------------------------------------------------+
+| AddDeferredBlock  | iUIBlock |                                                        |
++-------------------+----------+--------------------------------------------------------+
+| AddHtml           | string   |                                                        |
++-------------------+----------+--------------------------------------------------------+
+| AddJsFileRelPath  | string   |                                                        |
++-------------------+----------+--------------------------------------------------------+
+| AddSubBlock       | iUIBlock |                                                        |
++-------------------+----------+--------------------------------------------------------+
+| CSSClasses        | array    | like ['ibo-is-hidden', 'ibo-alert--body'] |
++-------------------+----------+--------------------------------------------------------+
+| DataAttributes    | array    |                                                        |
++-------------------+----------+--------------------------------------------------------+
+| DeferredBlocks    | array    |                                                        |
++-------------------+----------+--------------------------------------------------------+
+| IsHidden          | bool     |                                                        |
++-------------------+----------+--------------------------------------------------------+
+| SubBlocks         | array    |                                                        |
++-------------------+----------+--------------------------------------------------------+
+
+----
+
+.. include:: /manual/Layout/UIContentBlockFooter.rst
diff --git a/.doc/UI/source/index.rst b/.doc/UI/source/index.rst
index 4975e0fa5..1bcc84c2b 100644
--- a/.doc/UI/source/index.rst
+++ b/.doc/UI/source/index.rst
@@ -8,8 +8,8 @@ Welcome to iTop 3.0 UI's documentation!
     :maxdepth: 2
     :caption: Contents:
 
-    Component/Component
-    Layout/Layout
+    generated/Component/Component
+    generated/Layout/Layout
 
 
 
diff --git a/.doc/UI/source/manual/Component/Alert/AlertAdditionalDescription.rst b/.doc/UI/source/manual/Component/Alert/AlertAdditionalDescription.rst
new file mode 100644
index 000000000..8778653e7
--- /dev/null
+++ b/.doc/UI/source/manual/Component/Alert/AlertAdditionalDescription.rst
@@ -0,0 +1,21 @@
+.. Copyright (C) 2010-2021 Combodo SARL
+.. http://opensource.org/licenses/AGPL-3.0
+
+Output
+------
+
+:Success Alert:
+
+.. image:: /manual/Component/Alert/AlertSuccess.png
+
+:Failure Alert:
+
+.. image:: /manual/Component/Alert/AlertFailure.png
+
+:Information Alert:
+
+.. image:: /manual/Component/Alert/AlertInformation.png
+
+:Warning Alert:
+
+.. image:: /manual/Component/Alert/AlertWarning.png
diff --git a/.doc/UI/source/Component/Alert/AlertFailure.png b/.doc/UI/source/manual/Component/Alert/AlertFailure.png
similarity index 100%
rename from .doc/UI/source/Component/Alert/AlertFailure.png
rename to .doc/UI/source/manual/Component/Alert/AlertFailure.png
diff --git a/.doc/UI/source/Component/Alert/AlertFailureExample.png b/.doc/UI/source/manual/Component/Alert/AlertFailureExample.png
similarity index 100%
rename from .doc/UI/source/Component/Alert/AlertFailureExample.png
rename to .doc/UI/source/manual/Component/Alert/AlertFailureExample.png
diff --git a/.doc/UI/source/Component/Alert/Examples.rst b/.doc/UI/source/manual/Component/Alert/AlertFooter.rst
similarity index 91%
rename from .doc/UI/source/Component/Alert/Examples.rst
rename to .doc/UI/source/manual/Component/Alert/AlertFooter.rst
index d32008ad6..669c54aac 100644
--- a/.doc/UI/source/Component/Alert/Examples.rst
+++ b/.doc/UI/source/manual/Component/Alert/AlertFooter.rst
@@ -1,6 +1,8 @@
 .. Copyright (C) 2010-2021 Combodo SARL
 .. http://opensource.org/licenses/AGPL-3.0
 
+Examples
+--------
 
 Example to generate an temporary information with a spinner (on the real display the spinner is animated)::
 
@@ -14,7 +16,7 @@ Example to generate an temporary information with a spinner (on the real display
 
 The information displayed:
 
-.. image:: AlertInformationExample.png
+.. image:: /manual/Component/Alert/AlertInformationExample.png
 
 The javascript to set a success or a failure in return of an ajax call::
 
@@ -44,4 +46,4 @@ The javascript to show the alert::
 
 The error displayed:
 
-.. image:: AlertFailureExample.png
+.. image:: /manual/Component/Alert/AlertFailureExample.png
diff --git a/.doc/UI/source/Component/Alert/AlertInformation.png b/.doc/UI/source/manual/Component/Alert/AlertInformation.png
similarity index 100%
rename from .doc/UI/source/Component/Alert/AlertInformation.png
rename to .doc/UI/source/manual/Component/Alert/AlertInformation.png
diff --git a/.doc/UI/source/Component/Alert/AlertInformationExample.png b/.doc/UI/source/manual/Component/Alert/AlertInformationExample.png
similarity index 100%
rename from .doc/UI/source/Component/Alert/AlertInformationExample.png
rename to .doc/UI/source/manual/Component/Alert/AlertInformationExample.png
diff --git a/.doc/UI/source/Component/Alert/AlertSuccess.png b/.doc/UI/source/manual/Component/Alert/AlertSuccess.png
similarity index 100%
rename from .doc/UI/source/Component/Alert/AlertSuccess.png
rename to .doc/UI/source/manual/Component/Alert/AlertSuccess.png
diff --git a/.doc/UI/source/Component/Alert/AlertSuccessFolded.png b/.doc/UI/source/manual/Component/Alert/AlertSuccessFolded.png
similarity index 100%
rename from .doc/UI/source/Component/Alert/AlertSuccessFolded.png
rename to .doc/UI/source/manual/Component/Alert/AlertSuccessFolded.png
diff --git a/.doc/UI/source/Component/Alert/AlertWarning.png b/.doc/UI/source/manual/Component/Alert/AlertWarning.png
similarity index 100%
rename from .doc/UI/source/Component/Alert/AlertWarning.png
rename to .doc/UI/source/manual/Component/Alert/AlertWarning.png
diff --git a/.doc/UI/source/Component/Button/Button-all.png b/.doc/UI/source/manual/Component/Button/Button-all.png
similarity index 100%
rename from .doc/UI/source/Component/Button/Button-all.png
rename to .doc/UI/source/manual/Component/Button/Button-all.png
diff --git a/.doc/UI/source/manual/Component/Button/ButtonAdditionalDescription.rst b/.doc/UI/source/manual/Component/Button/ButtonAdditionalDescription.rst
new file mode 100644
index 000000000..17ebabbcd
--- /dev/null
+++ b/.doc/UI/source/manual/Component/Button/ButtonAdditionalDescription.rst
@@ -0,0 +1,10 @@
+.. Copyright (C) 2010-2021 Combodo SARL
+.. http://opensource.org/licenses/AGPL-3.0
+
+Output
+------
+
+:Example Buttons:
+
+.. image:: /manual/Component/Button/Button-all.png
+
diff --git a/.doc/UI/source/manual/Component/Button/ButtonFooter.rst b/.doc/UI/source/manual/Component/Button/ButtonFooter.rst
new file mode 100644
index 000000000..011ff286c
--- /dev/null
+++ b/.doc/UI/source/manual/Component/Button/ButtonFooter.rst
@@ -0,0 +1,11 @@
+.. Copyright (C) 2010-2021 Combodo SARL
+.. http://opensource.org/licenses/AGPL-3.0
+
+
+Examples
+--------
+
+No examples provided yet
+
+.. example of image
+	.. image:: /manual/Component/Button/Button.png
diff --git a/.doc/UI/source/manual/Component/ButtonGroup/ButtonGroupAdditionalDescription.rst b/.doc/UI/source/manual/Component/ButtonGroup/ButtonGroupAdditionalDescription.rst
new file mode 100644
index 000000000..3c347263d
--- /dev/null
+++ b/.doc/UI/source/manual/Component/ButtonGroup/ButtonGroupAdditionalDescription.rst
@@ -0,0 +1,12 @@
+.. Copyright (C) 2010-2021 Combodo SARL
+.. http://opensource.org/licenses/AGPL-3.0
+
+
+Output
+------
+
+No output provided yet
+
+.. example of image
+	.. image:: /manual/Component/ButtonGroup/ButtonGroup.png
+
diff --git a/.doc/UI/source/manual/Component/ButtonGroup/ButtonGroupFooter.rst b/.doc/UI/source/manual/Component/ButtonGroup/ButtonGroupFooter.rst
new file mode 100644
index 000000000..89e2ff284
--- /dev/null
+++ b/.doc/UI/source/manual/Component/ButtonGroup/ButtonGroupFooter.rst
@@ -0,0 +1,11 @@
+.. Copyright (C) 2010-2021 Combodo SARL
+.. http://opensource.org/licenses/AGPL-3.0
+
+
+Examples
+--------
+
+No examples provided yet
+
+.. example of image
+	.. image:: /manual/Component/ButtonGroup/ButtonGroup.png
diff --git a/.doc/UI/source/manual/Component/CollapsibleSection/CollapsibleSectionAdditionalDescription.rst b/.doc/UI/source/manual/Component/CollapsibleSection/CollapsibleSectionAdditionalDescription.rst
new file mode 100644
index 000000000..cfdd09de9
--- /dev/null
+++ b/.doc/UI/source/manual/Component/CollapsibleSection/CollapsibleSectionAdditionalDescription.rst
@@ -0,0 +1,12 @@
+.. Copyright (C) 2010-2021 Combodo SARL
+.. http://opensource.org/licenses/AGPL-3.0
+
+
+Output
+------
+
+No output provided yet
+
+.. example of image
+	.. image:: /manual/Component/CollapsibleSection/CollapsibleSection.png
+
diff --git a/.doc/UI/source/manual/Component/CollapsibleSection/CollapsibleSectionFooter.rst b/.doc/UI/source/manual/Component/CollapsibleSection/CollapsibleSectionFooter.rst
new file mode 100644
index 000000000..ca6ed22cb
--- /dev/null
+++ b/.doc/UI/source/manual/Component/CollapsibleSection/CollapsibleSectionFooter.rst
@@ -0,0 +1,11 @@
+.. Copyright (C) 2010-2021 Combodo SARL
+.. http://opensource.org/licenses/AGPL-3.0
+
+
+Examples
+--------
+
+No examples provided yet
+
+.. example of image
+	.. image:: /manual/Component/CollapsibleSection/CollapsibleSection.png
diff --git a/.doc/UI/source/manual/Component/DataTable/DataTableAdditionalDescription.rst b/.doc/UI/source/manual/Component/DataTable/DataTableAdditionalDescription.rst
new file mode 100644
index 000000000..7905329fe
--- /dev/null
+++ b/.doc/UI/source/manual/Component/DataTable/DataTableAdditionalDescription.rst
@@ -0,0 +1,14 @@
+.. Copyright (C) 2010-2021 Combodo SARL
+.. http://opensource.org/licenses/AGPL-3.0
+
+
+Output
+------
+
+Dynamic DataTable
+
+.. image:: /manual/Component/Datatable/Datatable.png
+
+Static DataTable
+
+.. image:: /manual/Component/Datatable/DatatableStatic.png
diff --git a/.doc/UI/source/manual/Component/DataTable/DataTableFooter.rst b/.doc/UI/source/manual/Component/DataTable/DataTableFooter.rst
new file mode 100644
index 000000000..21b65a914
--- /dev/null
+++ b/.doc/UI/source/manual/Component/DataTable/DataTableFooter.rst
@@ -0,0 +1,27 @@
+.. Copyright (C) 2010-2021 Combodo SARL
+.. http://opensource.org/licenses/AGPL-3.0
+
+The columns (*aColumns*) have the following format:
+
+::
+
+    [
+        'nameField1' => ['label' => labelField1, 'description' => descriptionField1],
+        ...
+    ]
+
+The data (*aData*) format has to be:
+
+::
+
+    [
+        ['nameField1' => valueField1, 'nameField2' => valueField2, ...],
+        ...
+    ]
+
+----
+
+Examples
+--------
+
+No examples provided yet
diff --git a/.doc/UI/source/Component/DataTable/Datatable.png b/.doc/UI/source/manual/Component/DataTable/Datatable.png
similarity index 100%
rename from .doc/UI/source/Component/DataTable/Datatable.png
rename to .doc/UI/source/manual/Component/DataTable/Datatable.png
diff --git a/.doc/UI/source/Component/DataTable/DatatableStatic.png b/.doc/UI/source/manual/Component/DataTable/DatatableStatic.png
similarity index 100%
rename from .doc/UI/source/Component/DataTable/DatatableStatic.png
rename to .doc/UI/source/manual/Component/DataTable/DatatableStatic.png
diff --git a/.doc/UI/source/Component/Field/Field.png b/.doc/UI/source/manual/Component/Field/Field.png
similarity index 100%
rename from .doc/UI/source/Component/Field/Field.png
rename to .doc/UI/source/manual/Component/Field/Field.png
diff --git a/.doc/UI/source/manual/Component/Field/FieldAdditionalDescription.rst b/.doc/UI/source/manual/Component/Field/FieldAdditionalDescription.rst
new file mode 100644
index 000000000..47e5fe2c5
--- /dev/null
+++ b/.doc/UI/source/manual/Component/Field/FieldAdditionalDescription.rst
@@ -0,0 +1,10 @@
+.. Copyright (C) 2010-2021 Combodo SARL
+.. http://opensource.org/licenses/AGPL-3.0
+
+
+Output
+------
+
+:Example Fields:
+
+.. image:: /manual/Component/Field/Field.png
diff --git a/.doc/UI/source/manual/Component/Field/FieldFooter.rst b/.doc/UI/source/manual/Component/Field/FieldFooter.rst
new file mode 100644
index 000000000..7ef770126
--- /dev/null
+++ b/.doc/UI/source/manual/Component/Field/FieldFooter.rst
@@ -0,0 +1,21 @@
+.. Copyright (C) 2010-2021 Combodo SARL
+.. http://opensource.org/licenses/AGPL-3.0
+
+
+:Related Tag: :ref:`FieldSet 
` + +---- + +Examples +-------- + +Example to generate a Field:: + + {% UIField Small {sLabel: "Product"} %} + iTop + {% EndUIField %} + + +The result: + +.. image:: /manual/Component/Field/Field.png diff --git a/.doc/UI/source/manual/Component/FieldBadge/FieldBadgeAdditionalDescription.rst b/.doc/UI/source/manual/Component/FieldBadge/FieldBadgeAdditionalDescription.rst new file mode 100644 index 000000000..9eee03754 --- /dev/null +++ b/.doc/UI/source/manual/Component/FieldBadge/FieldBadgeAdditionalDescription.rst @@ -0,0 +1,12 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Output +------ + +No output provided yet + +.. example of image + .. image:: /manual/Component/FieldBadge/FieldBadge.png + diff --git a/.doc/UI/source/manual/Component/FieldBadge/FieldBadgeFooter.rst b/.doc/UI/source/manual/Component/FieldBadge/FieldBadgeFooter.rst new file mode 100644 index 000000000..3b2b8dfd1 --- /dev/null +++ b/.doc/UI/source/manual/Component/FieldBadge/FieldBadgeFooter.rst @@ -0,0 +1,11 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Examples +-------- + +No examples provided yet + +.. example of image + .. image:: /manual/Component/FieldBadge/FieldBadge.png diff --git a/.doc/UI/source/Component/FieldSet/FieldSet-explained.png b/.doc/UI/source/manual/Component/FieldSet/FieldSet-explained.png similarity index 100% rename from .doc/UI/source/Component/FieldSet/FieldSet-explained.png rename to .doc/UI/source/manual/Component/FieldSet/FieldSet-explained.png diff --git a/.doc/UI/source/Component/FieldSet/FieldSet.png b/.doc/UI/source/manual/Component/FieldSet/FieldSet.png similarity index 100% rename from .doc/UI/source/Component/FieldSet/FieldSet.png rename to .doc/UI/source/manual/Component/FieldSet/FieldSet.png diff --git a/.doc/UI/source/manual/Component/FieldSet/FieldSetAdditionalDescription.rst b/.doc/UI/source/manual/Component/FieldSet/FieldSetAdditionalDescription.rst new file mode 100644 index 000000000..7bf7f2091 --- /dev/null +++ b/.doc/UI/source/manual/Component/FieldSet/FieldSetAdditionalDescription.rst @@ -0,0 +1,10 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Output +------ + +:Example FieldSets: + +.. image:: /manual/Component/FieldSet/FieldSet.png \ No newline at end of file diff --git a/.doc/UI/source/manual/Component/FieldSet/FieldSetFooter.rst b/.doc/UI/source/manual/Component/FieldSet/FieldSetFooter.rst new file mode 100644 index 000000000..082750159 --- /dev/null +++ b/.doc/UI/source/manual/Component/FieldSet/FieldSetFooter.rst @@ -0,0 +1,22 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +:Related Tag: :ref:`Field ` + +---- + +Examples +-------- + +Example to generate a FieldSet:: + + {% UIFieldSet Standard {sLegend: "iTop environment"} %} + {% UIField ... %} + ... + {% EndUIFieldSet %} + +The result: + +.. image:: /manual/Component/FieldSet/FieldSet-explained.png + diff --git a/.doc/UI/source/manual/Component/Form/FormAdditionalDescription.rst b/.doc/UI/source/manual/Component/Form/FormAdditionalDescription.rst new file mode 100644 index 000000000..11b43c7b4 --- /dev/null +++ b/.doc/UI/source/manual/Component/Form/FormAdditionalDescription.rst @@ -0,0 +1,12 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Output +------ + +No output provided yet + +.. example of image + .. image:: /manual/Component/Form/Form.png + diff --git a/.doc/UI/source/manual/Component/Form/FormFooter.rst b/.doc/UI/source/manual/Component/Form/FormFooter.rst new file mode 100644 index 000000000..af9ef031c --- /dev/null +++ b/.doc/UI/source/manual/Component/Form/FormFooter.rst @@ -0,0 +1,11 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Examples +-------- + +No examples provided yet + +.. example of image + .. image:: /manual/Component/Form/Form.png diff --git a/.doc/UI/source/manual/Component/Input/FileSelect/FileSelectAdditionalDescription.rst b/.doc/UI/source/manual/Component/Input/FileSelect/FileSelectAdditionalDescription.rst new file mode 100644 index 000000000..e2e15a5de --- /dev/null +++ b/.doc/UI/source/manual/Component/Input/FileSelect/FileSelectAdditionalDescription.rst @@ -0,0 +1,12 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Output +------ + +No output provided yet + +.. example of image + .. image:: /manual/Component/Input/FileSelect/FileSelect.png + diff --git a/.doc/UI/source/manual/Component/Input/FileSelect/FileSelectFooter.rst b/.doc/UI/source/manual/Component/Input/FileSelect/FileSelectFooter.rst new file mode 100644 index 000000000..5021742b7 --- /dev/null +++ b/.doc/UI/source/manual/Component/Input/FileSelect/FileSelectFooter.rst @@ -0,0 +1,11 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Examples +-------- + +No examples provided yet + +.. example of image + .. image:: /manual/Component/Input/FileSelect/FileSelect.png diff --git a/.doc/UI/source/manual/Component/Input/InputAdditionalDescription.rst b/.doc/UI/source/manual/Component/Input/InputAdditionalDescription.rst new file mode 100644 index 000000000..a589c9b3f --- /dev/null +++ b/.doc/UI/source/manual/Component/Input/InputAdditionalDescription.rst @@ -0,0 +1,12 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Output +------ + +No output provided yet + +.. example of image + .. image:: /manual/Component/Input/Input.png + diff --git a/.doc/UI/source/manual/Component/Input/InputFooter.rst b/.doc/UI/source/manual/Component/Input/InputFooter.rst new file mode 100644 index 000000000..f25d215b2 --- /dev/null +++ b/.doc/UI/source/manual/Component/Input/InputFooter.rst @@ -0,0 +1,11 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Examples +-------- + +No examples provided yet + +.. example of image + .. image:: /manual/Component/Input/Input.png diff --git a/.doc/UI/source/manual/Component/Input/Select/SelectAdditionalDescription.rst b/.doc/UI/source/manual/Component/Input/Select/SelectAdditionalDescription.rst new file mode 100644 index 000000000..39b3b0ae7 --- /dev/null +++ b/.doc/UI/source/manual/Component/Input/Select/SelectAdditionalDescription.rst @@ -0,0 +1,12 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Output +------ + +No output provided yet + +.. example of image + .. image:: /manual/Component/Input/Select/Select.png + diff --git a/.doc/UI/source/manual/Component/Input/Select/SelectFooter.rst b/.doc/UI/source/manual/Component/Input/Select/SelectFooter.rst new file mode 100644 index 000000000..1f9eb2e27 --- /dev/null +++ b/.doc/UI/source/manual/Component/Input/Select/SelectFooter.rst @@ -0,0 +1,11 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Examples +-------- + +No examples provided yet + +.. example of image + .. image:: /manual/Component/Input/Select/Select.png diff --git a/.doc/UI/source/manual/Component/Input/Select/SelectOptionAdditionalDescription.rst b/.doc/UI/source/manual/Component/Input/Select/SelectOptionAdditionalDescription.rst new file mode 100644 index 000000000..aeaa04d06 --- /dev/null +++ b/.doc/UI/source/manual/Component/Input/Select/SelectOptionAdditionalDescription.rst @@ -0,0 +1,12 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Output +------ + +No output provided yet + +.. example of image + .. image:: /manual/Component/Input/Select/SelectOption.png + diff --git a/.doc/UI/source/manual/Component/Input/Select/SelectOptionFooter.rst b/.doc/UI/source/manual/Component/Input/Select/SelectOptionFooter.rst new file mode 100644 index 000000000..364cf0b94 --- /dev/null +++ b/.doc/UI/source/manual/Component/Input/Select/SelectOptionFooter.rst @@ -0,0 +1,11 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Examples +-------- + +No examples provided yet + +.. example of image + .. image:: /manual/Component/Input/Select/SelectOption.png diff --git a/.doc/UI/source/manual/Component/Panel/PanelAdditionalDescription.rst b/.doc/UI/source/manual/Component/Panel/PanelAdditionalDescription.rst new file mode 100644 index 000000000..a7d8ce044 --- /dev/null +++ b/.doc/UI/source/manual/Component/Panel/PanelAdditionalDescription.rst @@ -0,0 +1,12 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Output +------ + +No output provided yet + +.. example of image + .. image:: /manual/Component/Panel/Panel.png + diff --git a/.doc/UI/source/manual/Component/Panel/PanelFooter.rst b/.doc/UI/source/manual/Component/Panel/PanelFooter.rst new file mode 100644 index 000000000..86519ea0e --- /dev/null +++ b/.doc/UI/source/manual/Component/Panel/PanelFooter.rst @@ -0,0 +1,11 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Examples +-------- + +No examples provided yet + +.. example of image + .. image:: /manual/Component/Panel/Panel.png diff --git a/.doc/UI/source/manual/Component/Spinner/SpinnerAdditionalDescription.rst b/.doc/UI/source/manual/Component/Spinner/SpinnerAdditionalDescription.rst new file mode 100644 index 000000000..f90c714af --- /dev/null +++ b/.doc/UI/source/manual/Component/Spinner/SpinnerAdditionalDescription.rst @@ -0,0 +1,12 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Output +------ + +No output provided yet + +.. example of image + .. image:: /manual/Component/Spinner/Spinner.png + diff --git a/.doc/UI/source/manual/Component/Spinner/SpinnerFooter.rst b/.doc/UI/source/manual/Component/Spinner/SpinnerFooter.rst new file mode 100644 index 000000000..84fb8c780 --- /dev/null +++ b/.doc/UI/source/manual/Component/Spinner/SpinnerFooter.rst @@ -0,0 +1,11 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Examples +-------- + +No examples provided yet + +.. example of image + .. image:: /manual/Component/Spinner/Spinner.png diff --git a/.doc/UI/source/Component/Title/Title.png b/.doc/UI/source/manual/Component/Title/Title.png similarity index 100% rename from .doc/UI/source/Component/Title/Title.png rename to .doc/UI/source/manual/Component/Title/Title.png diff --git a/.doc/UI/source/manual/Component/Title/TitleAdditionalDescription.rst b/.doc/UI/source/manual/Component/Title/TitleAdditionalDescription.rst new file mode 100644 index 000000000..5ee17ab7a --- /dev/null +++ b/.doc/UI/source/manual/Component/Title/TitleAdditionalDescription.rst @@ -0,0 +1,8 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Output +------ + +.. image:: /manual/Component/Title/Title.png diff --git a/.doc/UI/source/manual/Component/Title/TitleFooter.rst b/.doc/UI/source/manual/Component/Title/TitleFooter.rst new file mode 100644 index 000000000..68537fb82 --- /dev/null +++ b/.doc/UI/source/manual/Component/Title/TitleFooter.rst @@ -0,0 +1,17 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Examples +-------- + +:The following code: + +:: + + {% UITitle ForPage {sTitle: 'UI:FullTextSearchTitle_Text'|dict_format(sFullText)} %}{% EndUITitle %} + +:Will display: + +.. image:: /manual/Component/Title/Title.png + diff --git a/.doc/UI/source/manual/Component/Toolbar/ToolbarAdditionalDescription.rst b/.doc/UI/source/manual/Component/Toolbar/ToolbarAdditionalDescription.rst new file mode 100644 index 000000000..1e7007184 --- /dev/null +++ b/.doc/UI/source/manual/Component/Toolbar/ToolbarAdditionalDescription.rst @@ -0,0 +1,12 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Output +------ + +No output provided yet + +.. example of image + .. image:: /manual/Component/Toolbar/Toolbar.png + diff --git a/.doc/UI/source/manual/Component/Toolbar/ToolbarFooter.rst b/.doc/UI/source/manual/Component/Toolbar/ToolbarFooter.rst new file mode 100644 index 000000000..cd242d5af --- /dev/null +++ b/.doc/UI/source/manual/Component/Toolbar/ToolbarFooter.rst @@ -0,0 +1,11 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Examples +-------- + +No examples provided yet + +.. example of image + .. image:: /manual/Component/Toolbar/Toolbar.png diff --git a/.doc/UI/source/manual/Component/Toolbar/ToolbarSpacer/ToolbarSpacerAdditionalDescription.rst b/.doc/UI/source/manual/Component/Toolbar/ToolbarSpacer/ToolbarSpacerAdditionalDescription.rst new file mode 100644 index 000000000..3bf380ccd --- /dev/null +++ b/.doc/UI/source/manual/Component/Toolbar/ToolbarSpacer/ToolbarSpacerAdditionalDescription.rst @@ -0,0 +1,12 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Output +------ + +No output provided yet + +.. example of image + .. image:: /manual/Component/Toolbar/ToolbarSpacer/ToolbarSpacer.png + diff --git a/.doc/UI/source/manual/Component/Toolbar/ToolbarSpacer/ToolbarSpacerFooter.rst b/.doc/UI/source/manual/Component/Toolbar/ToolbarSpacer/ToolbarSpacerFooter.rst new file mode 100644 index 000000000..bff118455 --- /dev/null +++ b/.doc/UI/source/manual/Component/Toolbar/ToolbarSpacer/ToolbarSpacerFooter.rst @@ -0,0 +1,11 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Examples +-------- + +No examples provided yet + +.. example of image + .. image:: /manual/Component/Toolbar/ToolbarSpacer/ToolbarSpacer.png diff --git a/.doc/UI/source/manual/Layout/MultiColumn/Column/ColumnAdditionalDescription.rst b/.doc/UI/source/manual/Layout/MultiColumn/Column/ColumnAdditionalDescription.rst new file mode 100644 index 000000000..0fa9c67d0 --- /dev/null +++ b/.doc/UI/source/manual/Layout/MultiColumn/Column/ColumnAdditionalDescription.rst @@ -0,0 +1,12 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Output +------ + +No output provided yet + +.. example of image + .. image:: /manual/Layout/MultiColumn/Column/Column.png + diff --git a/.doc/UI/source/manual/Layout/MultiColumn/Column/ColumnFooter.rst b/.doc/UI/source/manual/Layout/MultiColumn/Column/ColumnFooter.rst new file mode 100644 index 000000000..9148e8eb9 --- /dev/null +++ b/.doc/UI/source/manual/Layout/MultiColumn/Column/ColumnFooter.rst @@ -0,0 +1,11 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Examples +-------- + +No examples provided yet + +.. example of image + .. image:: /manual/Layout/MultiColumn/Column/Column.png diff --git a/.doc/UI/source/manual/Layout/MultiColumn/MultiColumnAdditionalDescription.rst b/.doc/UI/source/manual/Layout/MultiColumn/MultiColumnAdditionalDescription.rst new file mode 100644 index 000000000..f6b7f8925 --- /dev/null +++ b/.doc/UI/source/manual/Layout/MultiColumn/MultiColumnAdditionalDescription.rst @@ -0,0 +1,12 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Output +------ + +No output provided yet + +.. example of image + .. image:: /manual/Layout/MultiColumn/MultiColumn.png + diff --git a/.doc/UI/source/manual/Layout/MultiColumn/MultiColumnFooter.rst b/.doc/UI/source/manual/Layout/MultiColumn/MultiColumnFooter.rst new file mode 100644 index 000000000..6a1d912f7 --- /dev/null +++ b/.doc/UI/source/manual/Layout/MultiColumn/MultiColumnFooter.rst @@ -0,0 +1,11 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Examples +-------- + +No examples provided yet + +.. example of image + .. image:: /manual/Layout/MultiColumn/MultiColumn.png diff --git a/.doc/UI/source/manual/Layout/UIContentBlockAdditionalDescription.rst b/.doc/UI/source/manual/Layout/UIContentBlockAdditionalDescription.rst new file mode 100644 index 000000000..ce78786ec --- /dev/null +++ b/.doc/UI/source/manual/Layout/UIContentBlockAdditionalDescription.rst @@ -0,0 +1,12 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Output +------ + +No output provided yet + +.. example of image + .. image:: /manual/Layout/UIContentBlock.png + diff --git a/.doc/UI/source/manual/Layout/UIContentBlockFooter.rst b/.doc/UI/source/manual/Layout/UIContentBlockFooter.rst new file mode 100644 index 000000000..f83860b34 --- /dev/null +++ b/.doc/UI/source/manual/Layout/UIContentBlockFooter.rst @@ -0,0 +1,11 @@ +.. Copyright (C) 2010-2021 Combodo SARL +.. http://opensource.org/licenses/AGPL-3.0 + + +Examples +-------- + +No examples provided yet + +.. example of image + .. image:: /manual/Layout/UIContentBlock.png