diff --git a/.doc/UI/bin/generate_uiblock.php b/.doc/UI/bin/generate_uiblock.php index 6e1787a0c..b0df81c2f 100644 --- a/.doc/UI/bin/generate_uiblock.php +++ b/.doc/UI/bin/generate_uiblock.php @@ -49,6 +49,34 @@ function DisplayParamsArray(array $aParams, array $aColumns) echo "\n"; } +function DisplayParamsAsString(array $aParams) +{ + $aParamStr = []; + foreach ($aParams as $aParam) { + $sParam = $aParam['name'].':'; + switch ($aParam['type']) { + case 'string': + $sParam .= "'value'"; + break; + + case 'array': + $sParam .= "{name:value, name:value}"; + break; + + case 'bool': + $sParam .= "true"; + break; + + default: + $sParam .= "value"; + break; + } + $aParamStr[] = $sParam; + } + + return implode(', ', $aParamStr); +} + function output(string $sClass, string $sClassComment, string $sDir, string $sTag, bool $bHasSubBlocks, array $aDocTypes, array $aDocGeneralParams) { if ($bHasSubBlocks) { @@ -67,6 +95,8 @@ EOF; echo ".. Copyright (C) 2010-2021 Combodo SARL\n"; echo ".. http://opensource.org/licenses/AGPL-3.0\n"; echo "\n"; + echo ".. _$sClass:\n"; + echo "\n"; echo "$sClass\n"; $sLine = str_repeat('=', strlen($sClass)); echo "$sLine\n"; @@ -96,6 +126,7 @@ EOF; $iMaxComLength = 0; foreach ($aDocTypes as $sType => $aDoc) { $sComment = $aDoc['comment']; + $sType = ":ref:`$sType <$sClass$sType>`"; $iLength = strlen($sType); if ($iLength > $iMaxLength) { $iMaxLength = $iLength; @@ -109,6 +140,7 @@ EOF; echo "$sArrayLine\n"; foreach ($aDocTypes as $sType => $aDoc) { $sComment = $aDoc['comment']; + $sType = ":ref:`$sType <$sClass$sType>`"; echo '| '.str_pad($sType, $iMaxLength).' | '.str_pad($sComment, $iMaxComLength)." |\n"; echo "$sArrayLine\n"; } @@ -118,7 +150,31 @@ EOF; foreach ($aDocTypes as $sType => $aDoc) { $aParams = $aDoc['params']; if (!empty($aParams)) { - echo ":$sClass *$sType* parameters:\n"; + echo ".. _$sClass$sType:\n"; + echo "\n"; + echo "$sClass $sType\n"; + echo str_repeat("^", strlen("$sClass $sType")); + echo "\n"; + echo "\n"; + echo ":syntax:\n"; + echo "\n"; + echo "::\n"; + echo "\n"; + $sParameters = DisplayParamsAsString($aParams); + if ($bHasSubBlocks) { + $sSyntax = << 0, @@ -132,7 +188,8 @@ EOF; } if (!empty($aDocGeneralParams)) { - echo ":$sClass common parameters:\n"; + echo "$sClass common parameters\n"; + echo str_repeat("^", strlen("$sClass common parameters")); echo "\n"; $aColumns = [ 'name' => 0, diff --git a/.doc/UI/source/_static/css/ui-doc.css b/.doc/UI/source/_static/css/ui-doc.css index 9caaa8622..2de6f1cc6 100644 --- a/.doc/UI/source/_static/css/ui-doc.css +++ b/.doc/UI/source/_static/css/ui-doc.css @@ -3,9 +3,11 @@ * @license http://opensource.org/licenses/AGPL-3.0 */ -/* theme.css | .doc/UI/build/html/_static/css/theme.css */ - .wy-nav-content { max-width: 1024px; min-height: 100%; } + +h3 { + font-size: 100%; +} diff --git a/.doc/UI/source/generated/Component/Alert/Alert.rst b/.doc/UI/source/generated/Component/Alert/Alert.rst index 56236aab8..d61572425 100644 --- a/.doc/UI/source/generated/Component/Alert/Alert.rst +++ b/.doc/UI/source/generated/Component/Alert/Alert.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _Alert: + Alert ===== @@ -28,25 +30,38 @@ Twig Tag :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 | -+----------------------------+-----------------------------------------------------+ ++---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Neutral ` | Make a basis Alert component | ++---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`ForInformation ` | Make an Alert component for informational messages | ++---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`ForSuccess ` | Make an Alert component for successful messages | ++---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`ForWarning ` | Make an Alert component for warning messages | ++---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`ForDanger ` | Make an Alert component for danger messages | ++---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`ForFailure ` | Make an Alert component for failure messages | ++---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`WithBrandingPrimaryColor ` | Make an Alert component with primary color scheme | ++---------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`WithBrandingSecondaryColor ` | Make an Alert component with secondary color scheme | ++---------------------------------------------------------------------+-----------------------------------------------------+ -:Alert *Neutral* parameters: +.. _AlertNeutral: + +Alert Neutral +^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIAlert Neutral {sTitle:'value', sContent:'value', sId:'value'} %} + Content Goes Here + {% EndUIAlert %} + +:parameters: +----------+--------+----------+------+-------------------------------------------------+ | sTitle | string | optional | '' | Title of the alert | @@ -56,7 +71,20 @@ Twig Tag | sId | string | optional | NULL | id of the html block | +----------+--------+----------+------+-------------------------------------------------+ -:Alert *ForInformation* parameters: +.. _AlertForInformation: + +Alert ForInformation +^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIAlert ForInformation {sTitle:'value', sContent:'value', sId:'value'} %} + Content Goes Here + {% EndUIAlert %} + +:parameters: +----------+--------+----------+------+-------------------------------------------------+ | sTitle | string | optional | '' | Title of the alert | @@ -66,7 +94,20 @@ Twig Tag | sId | string | optional | NULL | id of the html block | +----------+--------+----------+------+-------------------------------------------------+ -:Alert *ForSuccess* parameters: +.. _AlertForSuccess: + +Alert ForSuccess +^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIAlert ForSuccess {sTitle:'value', sContent:'value', sId:'value'} %} + Content Goes Here + {% EndUIAlert %} + +:parameters: +----------+--------+----------+------+-------------------------------------------------+ | sTitle | string | optional | '' | Title of the alert | @@ -76,7 +117,20 @@ Twig Tag | sId | string | optional | NULL | | +----------+--------+----------+------+-------------------------------------------------+ -:Alert *ForWarning* parameters: +.. _AlertForWarning: + +Alert ForWarning +^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIAlert ForWarning {sTitle:'value', sContent:'value', sId:'value'} %} + Content Goes Here + {% EndUIAlert %} + +:parameters: +----------+--------+----------+------+-------------------------------------------------+ | sTitle | string | optional | '' | Title of the alert | @@ -86,7 +140,20 @@ Twig Tag | sId | string | optional | NULL | id of the html block | +----------+--------+----------+------+-------------------------------------------------+ -:Alert *ForDanger* parameters: +.. _AlertForDanger: + +Alert ForDanger +^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIAlert ForDanger {sTitle:'value', sContent:'value', sId:'value'} %} + Content Goes Here + {% EndUIAlert %} + +:parameters: +----------+--------+----------+------+-------------------------------------------------+ | sTitle | string | optional | '' | Title of the alert | @@ -96,7 +163,20 @@ Twig Tag | sId | string | optional | NULL | id of the html block | +----------+--------+----------+------+-------------------------------------------------+ -:Alert *ForFailure* parameters: +.. _AlertForFailure: + +Alert ForFailure +^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIAlert ForFailure {sTitle:'value', sContent:'value', sId:'value'} %} + Content Goes Here + {% EndUIAlert %} + +:parameters: +----------+--------+----------+------+-------------------------------------------------+ | sTitle | string | optional | '' | Title of the alert | @@ -106,7 +186,20 @@ Twig Tag | sId | string | optional | NULL | id of the html block | +----------+--------+----------+------+-------------------------------------------------+ -:Alert *WithBrandingPrimaryColor* parameters: +.. _AlertWithBrandingPrimaryColor: + +Alert WithBrandingPrimaryColor +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIAlert WithBrandingPrimaryColor {sTitle:'value', sContent:'value', sId:'value'} %} + Content Goes Here + {% EndUIAlert %} + +:parameters: +----------+--------+----------+------+-------------------------------------------------+ | sTitle | string | optional | '' | Title of the alert | @@ -116,7 +209,20 @@ Twig Tag | sId | string | optional | NULL | id of the html block | +----------+--------+----------+------+-------------------------------------------------+ -:Alert *WithBrandingSecondaryColor* parameters: +.. _AlertWithBrandingSecondaryColor: + +Alert WithBrandingSecondaryColor +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIAlert WithBrandingSecondaryColor {sTitle:'value', sContent:'value', sId:'value'} %} + Content Goes Here + {% EndUIAlert %} + +:parameters: +----------+--------+----------+------+-------------------------------------------------+ | sTitle | string | optional | '' | Title of the alert | @@ -126,8 +232,8 @@ Twig Tag | sId | string | optional | NULL | id of the html block | +----------+--------+----------+------+-------------------------------------------------+ -:Alert common parameters: - +Alert common parameters +^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+----------+------------------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------+----------+------------------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/Button/Button.rst b/.doc/UI/source/generated/Component/Button/Button.rst index 5997a1056..22ad50bee 100644 --- a/.doc/UI/source/generated/Component/Button/Button.rst +++ b/.doc/UI/source/generated/Component/Button/Button.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _Button: + Button ====== @@ -25,39 +27,50 @@ Twig Tag :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 | -+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Neutral ` | Make a basis Button component for any purpose | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ForPrimaryAction ` | Make a Button component for a primary action, should be used to tell the user this is the main choice | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ForSecondaryAction ` | Make a Button component for a secondary action, should be used to tell the user this is an second hand choice | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`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 | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`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 | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AlternativeNeutral ` | Make a basis Button component for any purpose | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ForAlternativePrimaryAction ` | Make a Button component for an alternative primary action, should be used to avoid the user to consider this action as the first | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ForAlternativeSecondaryAction ` | Make a Button component for an alternative secondary action, should be used to avoid the user to focus on this | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ForAlternativeValidationAction ` | Make a Button component for a validation action, should be used to avoid the user to focus on this | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ForAlternativeDestructiveAction ` | Make a Button component for a destructive action, should be used to avoid the user to focus on this | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ForCancel ` | Make a Button component for a cancel, should be used only for UI navigation, not destructive action | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`IconAction ` | @param string $sIconClasses | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`LinkNeutral ` | Make a link Button component to open an URL instead of triggering a form action | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`IconLink ` | @param string $sIconClasses | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`DestructiveIconLink ` | @param string $sIconClasses | ++--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -:Button *Neutral* parameters: +.. _ButtonNeutral: + +Button Neutral +^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIButton Type Neutral {sLabel:'value', sName:'value', sId:'value'} %} + +:parameters: +--------+--------+-----------+------+----------------------------+ | sLabel | string | mandatory | | | @@ -67,7 +80,18 @@ Twig Tag | sId | string | optional | NULL | | +--------+--------+-----------+------+----------------------------+ -:Button *ForPrimaryAction* parameters: +.. _ButtonForPrimaryAction: + +Button ForPrimaryAction +^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIButton Type ForPrimaryAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %} + +:parameters: +-----------+--------+-----------+-------+---------------------+ | sLabel | string | mandatory | | | @@ -81,7 +105,18 @@ Twig Tag | sId | string | optional | NULL | | +-----------+--------+-----------+-------+---------------------+ -:Button *ForSecondaryAction* parameters: +.. _ButtonForSecondaryAction: + +Button ForSecondaryAction +^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIButton Type ForSecondaryAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %} + +:parameters: +-----------+--------+-----------+-------+---------------------+ | sLabel | string | mandatory | | | @@ -95,7 +130,18 @@ Twig Tag | sId | string | optional | NULL | | +-----------+--------+-----------+-------+---------------------+ -:Button *ForPositiveAction* parameters: +.. _ButtonForPositiveAction: + +Button ForPositiveAction +^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIButton Type ForPositiveAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %} + +:parameters: +-----------+--------+-----------+-------+---------------------+ | sLabel | string | mandatory | | | @@ -109,7 +155,18 @@ Twig Tag | sId | string | optional | NULL | | +-----------+--------+-----------+-------+---------------------+ -:Button *ForDestructiveAction* parameters: +.. _ButtonForDestructiveAction: + +Button ForDestructiveAction +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIButton Type ForDestructiveAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %} + +:parameters: +-----------+--------+-----------+-------+---------------------+ | sLabel | string | mandatory | | | @@ -123,7 +180,18 @@ Twig Tag | sId | string | optional | NULL | | +-----------+--------+-----------+-------+---------------------+ -:Button *AlternativeNeutral* parameters: +.. _ButtonAlternativeNeutral: + +Button AlternativeNeutral +^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIButton Type AlternativeNeutral {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %} + +:parameters: +-----------+--------+-----------+-------+---------------------+ | sLabel | string | mandatory | | | @@ -137,7 +205,18 @@ Twig Tag | sId | string | optional | NULL | | +-----------+--------+-----------+-------+---------------------+ -:Button *ForAlternativePrimaryAction* parameters: +.. _ButtonForAlternativePrimaryAction: + +Button ForAlternativePrimaryAction +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIButton Type ForAlternativePrimaryAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %} + +:parameters: +-----------+--------+-----------+-------+---------------------+ | sLabel | string | mandatory | | | @@ -151,7 +230,18 @@ Twig Tag | sId | string | optional | NULL | | +-----------+--------+-----------+-------+---------------------+ -:Button *ForAlternativeSecondaryAction* parameters: +.. _ButtonForAlternativeSecondaryAction: + +Button ForAlternativeSecondaryAction +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIButton Type ForAlternativeSecondaryAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %} + +:parameters: +-----------+--------+-----------+-------+---------------------+ | sLabel | string | mandatory | | | @@ -165,7 +255,18 @@ Twig Tag | sId | string | optional | NULL | | +-----------+--------+-----------+-------+---------------------+ -:Button *ForAlternativeValidationAction* parameters: +.. _ButtonForAlternativeValidationAction: + +Button ForAlternativeValidationAction +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIButton Type ForAlternativeValidationAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %} + +:parameters: +-----------+--------+-----------+-------+---------------------+ | sLabel | string | mandatory | | | @@ -179,7 +280,18 @@ Twig Tag | sId | string | optional | NULL | | +-----------+--------+-----------+-------+---------------------+ -:Button *ForAlternativeDestructiveAction* parameters: +.. _ButtonForAlternativeDestructiveAction: + +Button ForAlternativeDestructiveAction +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIButton Type ForAlternativeDestructiveAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %} + +:parameters: +-----------+--------+-----------+-------+---------------------+ | sLabel | string | mandatory | | | @@ -193,7 +305,18 @@ Twig Tag | sId | string | optional | NULL | | +-----------+--------+-----------+-------+---------------------+ -:Button *ForCancel* parameters: +.. _ButtonForCancel: + +Button ForCancel +^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIButton Type ForCancel {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %} + +:parameters: +-----------+--------+----------+-------+---------------------+ | sLabel | string | optional | NULL | | @@ -207,7 +330,18 @@ Twig Tag | sId | string | optional | NULL | | +-----------+--------+----------+-------+---------------------+ -:Button *IconAction* parameters: +.. _ButtonIconAction: + +Button IconAction +^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIButton Type IconAction {sIconClasses:'value', sTooltipText:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %} + +:parameters: +--------------+--------+-----------+-------+--+ | sIconClasses | string | mandatory | | | @@ -223,7 +357,18 @@ Twig Tag | sId | string | optional | NULL | | +--------------+--------+-----------+-------+--+ -:Button *LinkNeutral* parameters: +.. _ButtonLinkNeutral: + +Button LinkNeutral +^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIButton Type LinkNeutral {sURL:'value', sLabel:'value', sIconClasses:'value', sTarget:'value', sId:'value'} %} + +:parameters: +--------------+--------+-----------+------+--+ | sURL | string | mandatory | | | @@ -237,7 +382,18 @@ Twig Tag | sId | string | optional | NULL | | +--------------+--------+-----------+------+--+ -:Button *IconLink* parameters: +.. _ButtonIconLink: + +Button IconLink +^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIButton Type IconLink {sIconClasses:'value', sTooltipText:'value', sURL:'value', sTarget:'value', sId:'value'} %} + +:parameters: +--------------+--------+-----------+------+--+ | sIconClasses | string | mandatory | | | @@ -251,7 +407,18 @@ Twig Tag | sId | string | optional | NULL | | +--------------+--------+-----------+------+--+ -:Button *DestructiveIconLink* parameters: +.. _ButtonDestructiveIconLink: + +Button DestructiveIconLink +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIButton Type DestructiveIconLink {sIconClasses:'value', sTooltipText:'value', sURL:'value', sName:'value', sTarget:'value', sId:'value'} %} + +:parameters: +--------------+--------+-----------+------+--+ | sIconClasses | string | mandatory | | | @@ -267,8 +434,8 @@ Twig Tag | sId | string | optional | NULL | | +--------------+--------+-----------+------+--+ -:Button common parameters: - +Button common parameters +^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+--------+------------------------------------------------------------+ | ActionType | string | | +-------------------+--------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/ButtonGroup/ButtonGroup.rst b/.doc/UI/source/generated/Component/ButtonGroup/ButtonGroup.rst index 0f1e4f0b4..17e7c88a2 100644 --- a/.doc/UI/source/generated/Component/ButtonGroup/ButtonGroup.rst +++ b/.doc/UI/source/generated/Component/ButtonGroup/ButtonGroup.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _ButtonGroup: + ButtonGroup =========== @@ -25,11 +27,22 @@ Twig Tag :Type: -+-----------------------+--------------------------------------------------------------------------------------------------+ -| ButtonWithOptionsMenu | Make a button that has a primary action ($oButton) but also an options menu ($oMenu) on the side | -+-----------------------+--------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`ButtonWithOptionsMenu ` | Make a button that has a primary action ($oButton) but also an options menu ($oMenu) on the side | ++-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -:ButtonGroup *ButtonWithOptionsMenu* parameters: +.. _ButtonGroupButtonWithOptionsMenu: + +ButtonGroup ButtonWithOptionsMenu +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIButtonGroup Type ButtonWithOptionsMenu {oButton:value, oMenu:value} %} + +:parameters: +---------+-------------+-----------+--+--+ | oButton | Button | mandatory | | | @@ -37,8 +50,8 @@ Twig Tag | oMenu | PopoverMenu | mandatory | | | +---------+-------------+-----------+--+--+ -:ButtonGroup common parameters: - +ButtonGroup common parameters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+----------+------------------------------------------------------------+ | AddButton | Button | | +-------------------+----------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/CollapsibleSection/CollapsibleSection.rst b/.doc/UI/source/generated/Component/CollapsibleSection/CollapsibleSection.rst index c935d3192..e6f978da1 100644 --- a/.doc/UI/source/generated/Component/CollapsibleSection/CollapsibleSection.rst +++ b/.doc/UI/source/generated/Component/CollapsibleSection/CollapsibleSection.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _CollapsibleSection: + CollapsibleSection ================== @@ -27,11 +29,24 @@ Twig Tag :Type: -+----------+------------+ -| Standard | No comment | -+----------+------------+ ++----------------------------------------------+------------+ +| :ref:`Standard ` | No comment | ++----------------------------------------------+------------+ -:CollapsibleSection *Standard* parameters: +.. _CollapsibleSectionStandard: + +CollapsibleSection Standard +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UICollapsibleSection Standard {sTitle:'value', sId:'value'} %} + Content Goes Here + {% EndUICollapsibleSection %} + +:parameters: +--------+--------+-----------+------+--+ | sTitle | string | mandatory | | | @@ -39,8 +54,8 @@ Twig Tag | sId | string | optional | NULL | | +--------+--------+-----------+------+--+ -:CollapsibleSection common parameters: - +CollapsibleSection common parameters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+----------+------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------+----------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/DataTable/DataTable.rst b/.doc/UI/source/generated/Component/DataTable/DataTable.rst index 385ca2ab5..a4fa8df4c 100644 --- a/.doc/UI/source/generated/Component/DataTable/DataTable.rst +++ b/.doc/UI/source/generated/Component/DataTable/DataTable.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _DataTable: + DataTable ========= @@ -27,21 +29,34 @@ Twig Tag :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 | -+--------------------+------------------------------+ ++---------------------------------------------------------+------------------------------+ +| :ref:`ForResult ` | @param \WebPage $oPage | ++---------------------------------------------------------+------------------------------+ +| :ref:`ForObject ` | @param \WebPage $oPage | ++---------------------------------------------------------+------------------------------+ +| :ref:`ForRendering ` | Make a basis Panel component | ++---------------------------------------------------------+------------------------------+ +| :ref:`ForRenderingObject ` | @param string $sListId | ++---------------------------------------------------------+------------------------------+ +| :ref:`ForStaticData ` | No comment | ++---------------------------------------------------------+------------------------------+ +| :ref:`ForForm ` | @param string $sRef | ++---------------------------------------------------------+------------------------------+ -:DataTable *ForResult* parameters: +.. _DataTableForResult: + +DataTable ForResult +^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIDataTable ForResult {oPage:value, sListId:'value', oSet:value, aExtraParams:value} %} + Content Goes Here + {% EndUIDataTable %} + +:parameters: +--------------+-------------+-----------+----------+--+ | oPage | WebPage | mandatory | | | @@ -53,7 +68,20 @@ Twig Tag | aExtraParams | | optional | array () | | +--------------+-------------+-----------+----------+--+ -:DataTable *ForObject* parameters: +.. _DataTableForObject: + +DataTable ForObject +^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIDataTable ForObject {oPage:value, sListId:'value', oSet:value, aExtraParams:value} %} + Content Goes Here + {% EndUIDataTable %} + +:parameters: +--------------+-------------+-----------+----------+--+ | oPage | WebPage | mandatory | | | @@ -65,7 +93,20 @@ Twig Tag | aExtraParams | | optional | array () | | +--------------+-------------+-----------+----------+--+ -:DataTable *ForRendering* parameters: +.. _DataTableForRendering: + +DataTable ForRendering +^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIDataTable ForRendering {sListId:'value', oSet:value, aExtraParams:value} %} + Content Goes Here + {% EndUIDataTable %} + +:parameters: +--------------+-------------+-----------+----------+--+ | sListId | string | mandatory | | | @@ -75,7 +116,20 @@ Twig Tag | aExtraParams | | optional | array () | | +--------------+-------------+-----------+----------+--+ -:DataTable *ForRenderingObject* parameters: +.. _DataTableForRenderingObject: + +DataTable ForRenderingObject +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIDataTable ForRenderingObject {sListId:'value', oSet:value, aExtraParams:value} %} + Content Goes Here + {% EndUIDataTable %} + +:parameters: +--------------+-------------+-----------+----------+--+ | sListId | string | mandatory | | | @@ -85,7 +139,20 @@ Twig Tag | aExtraParams | | optional | array () | | +--------------+-------------+-----------+----------+--+ -:DataTable *ForStaticData* parameters: +.. _DataTableForStaticData: + +DataTable ForStaticData +^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIDataTable ForStaticData {sTitle:'value', aColumns:{name:value, name:value}, aData:{name:value, name:value}, sId:'value', aExtraParams:{name:value, name:value}, sFilter:'value', aOptions:{name:value, name:value}} %} + Content Goes Here + {% EndUIDataTable %} + +:parameters: +--------------+--------+-----------+----------+--+ | sTitle | string | mandatory | | | @@ -103,7 +170,20 @@ Twig Tag | aOptions | array | optional | array () | | +--------------+--------+-----------+----------+--+ -:DataTable *ForForm* parameters: +.. _DataTableForForm: + +DataTable ForForm +^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIDataTable ForForm {sRef:'value', aColumns:{name:value, name:value}, aData:{name:value, name:value}, sFilter:'value'} %} + Content Goes Here + {% EndUIDataTable %} + +:parameters: +----------+--------+-----------+----------+--+ | sRef | string | mandatory | | | @@ -115,8 +195,8 @@ Twig Tag | sFilter | string | optional | '' | | +----------+--------+-----------+----------+--+ -:DataTable common parameters: - +DataTable common parameters +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+----------+------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------+----------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/Field/Field.rst b/.doc/UI/source/generated/Component/Field/Field.rst index 134dbea13..a9f476b2f 100644 --- a/.doc/UI/source/generated/Component/Field/Field.rst +++ b/.doc/UI/source/generated/Component/Field/Field.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _Field: + Field ===== @@ -27,25 +29,51 @@ Twig Tag :Type: -+------------+------------+ -| FromParams | No comment | -+------------+------------+ -| FromObject | No comment | -+------------+------------+ -| Large | No comment | -+------------+------------+ -| Small | No comment | -+------------+------------+ -| Standard | No comment | -+------------+------------+ ++-------------------------------------+------------+ +| :ref:`FromParams ` | No comment | ++-------------------------------------+------------+ +| :ref:`FromObject ` | No comment | ++-------------------------------------+------------+ +| :ref:`Large ` | No comment | ++-------------------------------------+------------+ +| :ref:`Small ` | No comment | ++-------------------------------------+------------+ +| :ref:`Standard ` | No comment | ++-------------------------------------+------------+ -:Field *FromParams* parameters: +.. _FieldFromParams: + +Field FromParams +^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIField FromParams {aParams:value} %} + Content Goes Here + {% EndUIField %} + +:parameters: +---------+--+-----------+--+--+ | aParams | | mandatory | | | +---------+--+-----------+--+--+ -:Field *FromObject* parameters: +.. _FieldFromObject: + +Field FromObject +^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIField FromObject {sLabel:'value', oInput:value, sLayout:'value'} %} + Content Goes Here + {% EndUIField %} + +:parameters: +---------+---------+-----------+------+--+ | sLabel | string | mandatory | | | @@ -55,7 +83,20 @@ Twig Tag | sLayout | string | optional | NULL | | +---------+---------+-----------+------+--+ -:Field *Large* parameters: +.. _FieldLarge: + +Field Large +^^^^^^^^^^^ + +:syntax: + +:: + + {% UIField Large {sLabel:'value', sValueHtml:'value'} %} + Content Goes Here + {% EndUIField %} + +:parameters: +------------+--------+-----------+----+--+ | sLabel | string | mandatory | | | @@ -63,7 +104,20 @@ Twig Tag | sValueHtml | string | optional | '' | | +------------+--------+-----------+----+--+ -:Field *Small* parameters: +.. _FieldSmall: + +Field Small +^^^^^^^^^^^ + +:syntax: + +:: + + {% UIField Small {sLabel:'value', sValueHtml:'value'} %} + Content Goes Here + {% EndUIField %} + +:parameters: +------------+--------+-----------+----+--+ | sLabel | string | mandatory | | | @@ -71,7 +125,20 @@ Twig Tag | sValueHtml | string | optional | '' | | +------------+--------+-----------+----+--+ -:Field *Standard* parameters: +.. _FieldStandard: + +Field Standard +^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIField Standard {sLabel:'value', sLayout:'value', sId:'value'} %} + Content Goes Here + {% EndUIField %} + +:parameters: +---------+--------+----------+---------+--+ | sLabel | string | optional | '' | | @@ -81,8 +148,8 @@ Twig Tag | sId | string | optional | NULL | | +---------+--------+----------+---------+--+ -:Field common parameters: - +Field common parameters +^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+----------+------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------+----------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/FieldBadge/FieldBadge.rst b/.doc/UI/source/generated/Component/FieldBadge/FieldBadge.rst index f39b8dbb8..12c359f56 100644 --- a/.doc/UI/source/generated/Component/FieldBadge/FieldBadge.rst +++ b/.doc/UI/source/generated/Component/FieldBadge/FieldBadge.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _FieldBadge: + FieldBadge ========== @@ -27,11 +29,24 @@ Twig Tag :Type: -+----------+-----------------------+ -| ForField | @param string $sValue | -+----------+-----------------------+ ++--------------------------------------+-----------------------+ +| :ref:`ForField ` | @param string $sValue | ++--------------------------------------+-----------------------+ -:FieldBadge *ForField* parameters: +.. _FieldBadgeForField: + +FieldBadge ForField +^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIFieldBadge ForField {sValue:'value', oStyle:value} %} + Content Goes Here + {% EndUIFieldBadge %} + +:parameters: +--------+----------+-----------+--+--+ | sValue | string | mandatory | | | @@ -39,8 +54,8 @@ Twig Tag | oStyle | ormStyle | mandatory | | | +--------+----------+-----------+--+--+ -:FieldBadge common parameters: - +FieldBadge common parameters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+----------+------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------+----------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/FieldSet/FieldSet.rst b/.doc/UI/source/generated/Component/FieldSet/FieldSet.rst index 8a731b690..a88dceedc 100644 --- a/.doc/UI/source/generated/Component/FieldSet/FieldSet.rst +++ b/.doc/UI/source/generated/Component/FieldSet/FieldSet.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _FieldSet: + FieldSet ======== @@ -27,11 +29,24 @@ Twig Tag :Type: -+----------+------------+ -| Standard | No comment | -+----------+------------+ ++------------------------------------+------------+ +| :ref:`Standard ` | No comment | ++------------------------------------+------------+ -:FieldSet *Standard* parameters: +.. _FieldSetStandard: + +FieldSet Standard +^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIFieldSet Standard {sLegend:'value', sId:'value'} %} + Content Goes Here + {% EndUIFieldSet %} + +:parameters: +---------+--------+-----------+------+--+ | sLegend | string | mandatory | | | @@ -39,8 +54,8 @@ Twig Tag | sId | string | optional | NULL | | +---------+--------+-----------+------+--+ -:FieldSet common parameters: - +FieldSet common parameters +^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+----------+------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------+----------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/Form/Form.rst b/.doc/UI/source/generated/Component/Form/Form.rst index 4a7893f64..7d29cd9ba 100644 --- a/.doc/UI/source/generated/Component/Form/Form.rst +++ b/.doc/UI/source/generated/Component/Form/Form.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _Form: + Form ==== @@ -27,18 +29,31 @@ Twig Tag :Type: -+----------+------------+ -| Standard | No comment | -+----------+------------+ ++--------------------------------+------------+ +| :ref:`Standard ` | No comment | ++--------------------------------+------------+ -:Form *Standard* parameters: +.. _FormStandard: + +Form Standard +^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIForm Standard {sId:'value'} %} + Content Goes Here + {% EndUIForm %} + +:parameters: +-----+--------+----------+------+--+ | sId | string | optional | NULL | | +-----+--------+----------+------+--+ -:Form common parameters: - +Form common parameters +^^^^^^^^^^^^^^^^^^^^^^ +-------------------+----------+------------------------------------------------------------+ | Action | string | | +-------------------+----------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/Input/FileSelect/FileSelect.rst b/.doc/UI/source/generated/Component/Input/FileSelect/FileSelect.rst index 9a7892510..d32933251 100644 --- a/.doc/UI/source/generated/Component/Input/FileSelect/FileSelect.rst +++ b/.doc/UI/source/generated/Component/Input/FileSelect/FileSelect.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _FileSelect: + FileSelect ========== @@ -25,11 +27,22 @@ Twig Tag :Type: -+----------+------------+ -| Standard | No comment | -+----------+------------+ ++--------------------------------------+------------+ +| :ref:`Standard ` | No comment | ++--------------------------------------+------------+ -:FileSelect *Standard* parameters: +.. _FileSelectStandard: + +FileSelect Standard +^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIFileSelect Type Standard {sName:'value', sId:'value'} %} + +:parameters: +-------+--------+-----------+------+--+ | sName | string | mandatory | | | @@ -37,8 +50,8 @@ Twig Tag | sId | string | optional | NULL | | +-------+--------+-----------+------+--+ -:FileSelect common parameters: - +FileSelect common parameters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+--------+------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------+--------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/Input/Input.rst b/.doc/UI/source/generated/Component/Input/Input.rst index 69978c15a..a218132a5 100644 --- a/.doc/UI/source/generated/Component/Input/Input.rst +++ b/.doc/UI/source/generated/Component/Input/Input.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _Input: + Input ===== @@ -25,15 +27,26 @@ Twig Tag :Type: -+-------------------+------------------------------------------------------------------------------------+ -| ForHidden | No comment | -+-------------------+------------------------------------------------------------------------------------+ -| Standard | No comment | -+-------------------+------------------------------------------------------------------------------------+ -| ForInputWithLabel | @see Field component that is better adapter when dealing with a standard iTop form | -+-------------------+------------------------------------------------------------------------------------+ ++---------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`ForHidden ` | No comment | ++---------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`Standard ` | No comment | ++---------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`ForInputWithLabel ` | @see Field component that is better adapter when dealing with a standard iTop form | ++---------------------------------------------------+------------------------------------------------------------------------------------+ -:Input *ForHidden* parameters: +.. _InputForHidden: + +Input ForHidden +^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIInput Type ForHidden {sName:'value', sValue:'value', sId:'value'} %} + +:parameters: +--------+--------+-----------+------+--+ | sName | string | mandatory | | | @@ -43,7 +56,18 @@ Twig Tag | sId | string | optional | NULL | | +--------+--------+-----------+------+--+ -:Input *Standard* parameters: +.. _InputStandard: + +Input Standard +^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIInput Type Standard {sType:'value', sName:'value', sValue:'value', sId:'value'} %} + +:parameters: +--------+--------+-----------+------+--+ | sType | string | mandatory | | | @@ -55,7 +79,18 @@ Twig Tag | sId | string | optional | NULL | | +--------+--------+-----------+------+--+ -:Input *ForInputWithLabel* parameters: +.. _InputForInputWithLabel: + +Input ForInputWithLabel +^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIInput Type ForInputWithLabel {sLabel:'value', sInputName:'value', sInputValue:'value', sInputId:'value', sInputType:'value'} %} + +:parameters: +-------------+--------+-----------+--------+--+ | sLabel | string | mandatory | | | @@ -69,8 +104,8 @@ Twig Tag | sInputType | string | optional | 'type' | | +-------------+--------+-----------+--------+--+ -:Input common parameters: - +Input common parameters +^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+--------+------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------+--------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/Input/Select/Select.rst b/.doc/UI/source/generated/Component/Input/Select/Select.rst index c64ebdac8..1bfa413fe 100644 --- a/.doc/UI/source/generated/Component/Input/Select/Select.rst +++ b/.doc/UI/source/generated/Component/Input/Select/Select.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _Select: + Select ====== @@ -27,13 +29,26 @@ Twig Tag :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 | -+--------------------+------------------------------------------------------------------------------------------------+ ++------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`ForSelect ` | @param string $sName | ++------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`ForSelectWithLabel ` | If you need to have a real field with a label, you might use a {@link Field} component instead | ++------------------------------------------------------+------------------------------------------------------------------------------------------------+ -:Select *ForSelect* parameters: +.. _SelectForSelect: + +Select ForSelect +^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UISelect ForSelect {sName:'value', sId:'value'} %} + Content Goes Here + {% EndUISelect %} + +:parameters: +-------+--------+-----------+------+--+ | sName | string | mandatory | | | @@ -41,7 +56,20 @@ Twig Tag | sId | string | optional | NULL | | +-------+--------+-----------+------+--+ -:Select *ForSelectWithLabel* parameters: +.. _SelectForSelectWithLabel: + +Select ForSelectWithLabel +^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UISelect ForSelectWithLabel {sName:'value', sLabel:'value', sId:'value'} %} + Content Goes Here + {% EndUISelect %} + +:parameters: +--------+--------+-----------+------+--+ | sName | string | mandatory | | | @@ -51,8 +79,8 @@ Twig Tag | sId | string | optional | NULL | | +--------+--------+-----------+------+--+ -:Select common parameters: - +Select common parameters +^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+--------------+------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------+--------------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/Input/Select/SelectOption.rst b/.doc/UI/source/generated/Component/Input/Select/SelectOption.rst index 83e762cf5..3012e63ac 100644 --- a/.doc/UI/source/generated/Component/Input/Select/SelectOption.rst +++ b/.doc/UI/source/generated/Component/Input/Select/SelectOption.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _SelectOption: + SelectOption ============ @@ -25,11 +27,22 @@ Twig Tag :Type: -+-----------------+------------+ -| ForSelectOption | No comment | -+-----------------+------------+ ++------------------------------------------------------+------------+ +| :ref:`ForSelectOption ` | No comment | ++------------------------------------------------------+------------+ -:SelectOption *ForSelectOption* parameters: +.. _SelectOptionForSelectOption: + +SelectOption ForSelectOption +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UISelectOption Type ForSelectOption {sValue:'value', sLabel:'value', bSelected:true, sId:'value'} %} + +:parameters: +-----------+--------+-----------+------+--+ | sValue | string | mandatory | | | @@ -41,8 +54,8 @@ Twig Tag | sId | string | optional | NULL | | +-----------+--------+-----------+------+--+ -:SelectOption common parameters: - +SelectOption common parameters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+--------+------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------+--------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/Panel/Panel.rst b/.doc/UI/source/generated/Component/Panel/Panel.rst index cd4d68b8c..e511830ff 100644 --- a/.doc/UI/source/generated/Component/Panel/Panel.rst +++ b/.doc/UI/source/generated/Component/Panel/Panel.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _Panel: + Panel ===== @@ -27,27 +29,40 @@ Twig Tag :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 | -+----------------------------+---------------------------------------------------------------+ ++---------------------------------------------------------------------+---------------------------------------------------------------+ +| :ref:`Neutral ` | Make a basis Panel component | ++---------------------------------------------------------------------+---------------------------------------------------------------+ +| :ref:`ForInformation ` | Make a Panel component for informational messages | ++---------------------------------------------------------------------+---------------------------------------------------------------+ +| :ref:`ForSuccess ` | Make a Panel component for successful messages | ++---------------------------------------------------------------------+---------------------------------------------------------------+ +| :ref:`ForWarning ` | Make a Panel component for warning messages | ++---------------------------------------------------------------------+---------------------------------------------------------------+ +| :ref:`ForDanger ` | Make a Panel component for danger messages | ++---------------------------------------------------------------------+---------------------------------------------------------------+ +| :ref:`ForFailure ` | Make a Panel component for failure messages | ++---------------------------------------------------------------------+---------------------------------------------------------------+ +| :ref:`WithBrandingPrimaryColor ` | Make a Panel component with primary color scheme | ++---------------------------------------------------------------------+---------------------------------------------------------------+ +| :ref:`WithBrandingSecondaryColor ` | Make a Panel component with secondary color scheme | ++---------------------------------------------------------------------+---------------------------------------------------------------+ +| :ref:`ForClass ` | Make a Panel component with the specific $sClass color scheme | ++---------------------------------------------------------------------+---------------------------------------------------------------+ -:Panel *Neutral* parameters: +.. _PanelNeutral: + +Panel Neutral +^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIPanel Neutral {sTitle:'value', sSubTitle:'value'} %} + Content Goes Here + {% EndUIPanel %} + +:parameters: +-----------+--------+-----------+------+--+ | sTitle | string | mandatory | | | @@ -55,7 +70,20 @@ Twig Tag | sSubTitle | string | optional | NULL | | +-----------+--------+-----------+------+--+ -:Panel *ForInformation* parameters: +.. _PanelForInformation: + +Panel ForInformation +^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIPanel ForInformation {sTitle:'value', sSubTitle:'value'} %} + Content Goes Here + {% EndUIPanel %} + +:parameters: +-----------+--------+-----------+------+--+ | sTitle | string | mandatory | | | @@ -63,7 +91,20 @@ Twig Tag | sSubTitle | string | optional | NULL | | +-----------+--------+-----------+------+--+ -:Panel *ForSuccess* parameters: +.. _PanelForSuccess: + +Panel ForSuccess +^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIPanel ForSuccess {sTitle:'value', sSubTitle:'value'} %} + Content Goes Here + {% EndUIPanel %} + +:parameters: +-----------+--------+-----------+------+--+ | sTitle | string | mandatory | | | @@ -71,7 +112,20 @@ Twig Tag | sSubTitle | string | optional | NULL | | +-----------+--------+-----------+------+--+ -:Panel *ForWarning* parameters: +.. _PanelForWarning: + +Panel ForWarning +^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIPanel ForWarning {sTitle:'value', sSubTitle:'value'} %} + Content Goes Here + {% EndUIPanel %} + +:parameters: +-----------+--------+-----------+------+--+ | sTitle | string | mandatory | | | @@ -79,7 +133,20 @@ Twig Tag | sSubTitle | string | optional | NULL | | +-----------+--------+-----------+------+--+ -:Panel *ForDanger* parameters: +.. _PanelForDanger: + +Panel ForDanger +^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIPanel ForDanger {sTitle:'value', sSubTitle:'value'} %} + Content Goes Here + {% EndUIPanel %} + +:parameters: +-----------+--------+-----------+------+--+ | sTitle | string | mandatory | | | @@ -87,7 +154,20 @@ Twig Tag | sSubTitle | string | optional | NULL | | +-----------+--------+-----------+------+--+ -:Panel *ForFailure* parameters: +.. _PanelForFailure: + +Panel ForFailure +^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIPanel ForFailure {sTitle:'value', sSubTitle:'value'} %} + Content Goes Here + {% EndUIPanel %} + +:parameters: +-----------+--------+-----------+------+--+ | sTitle | string | mandatory | | | @@ -95,7 +175,20 @@ Twig Tag | sSubTitle | string | optional | NULL | | +-----------+--------+-----------+------+--+ -:Panel *WithBrandingPrimaryColor* parameters: +.. _PanelWithBrandingPrimaryColor: + +Panel WithBrandingPrimaryColor +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIPanel WithBrandingPrimaryColor {sTitle:'value', sSubTitle:'value'} %} + Content Goes Here + {% EndUIPanel %} + +:parameters: +-----------+--------+-----------+------+--+ | sTitle | string | mandatory | | | @@ -103,7 +196,20 @@ Twig Tag | sSubTitle | string | optional | NULL | | +-----------+--------+-----------+------+--+ -:Panel *WithBrandingSecondaryColor* parameters: +.. _PanelWithBrandingSecondaryColor: + +Panel WithBrandingSecondaryColor +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIPanel WithBrandingSecondaryColor {sTitle:'value', sSubTitle:'value'} %} + Content Goes Here + {% EndUIPanel %} + +:parameters: +-----------+--------+-----------+------+--+ | sTitle | string | mandatory | | | @@ -111,7 +217,20 @@ Twig Tag | sSubTitle | string | optional | NULL | | +-----------+--------+-----------+------+--+ -:Panel *ForClass* parameters: +.. _PanelForClass: + +Panel ForClass +^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIPanel ForClass {sClass:'value', sTitle:'value', sSubTitle:'value'} %} + Content Goes Here + {% EndUIPanel %} + +:parameters: +-----------+--------+-----------+------+--------------------------------------+ | sClass | string | mandatory | | Class of the object the panel is for | @@ -121,8 +240,8 @@ Twig Tag | sSubTitle | string | optional | NULL | | +-----------+--------+-----------+------+--------------------------------------+ -:Panel common parameters: - +Panel common parameters +^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------+-----------------+------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------------+-----------------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/Spinner/Spinner.rst b/.doc/UI/source/generated/Component/Spinner/Spinner.rst index 063366dc4..e20d059f0 100644 --- a/.doc/UI/source/generated/Component/Spinner/Spinner.rst +++ b/.doc/UI/source/generated/Component/Spinner/Spinner.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _Spinner: + Spinner ======= @@ -25,18 +27,29 @@ Twig Tag :Type: -+----------+------------+ -| Standard | No comment | -+----------+------------+ ++-----------------------------------+------------+ +| :ref:`Standard ` | No comment | ++-----------------------------------+------------+ -:Spinner *Standard* parameters: +.. _SpinnerStandard: + +Spinner Standard +^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UISpinner Type Standard {sId:'value'} %} + +:parameters: +-----+--------+----------+------+--+ | sId | string | optional | NULL | | +-----+--------+----------+------+--+ -:Spinner common parameters: - +Spinner common parameters +^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+--------+------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------+--------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/Title/Title.rst b/.doc/UI/source/generated/Component/Title/Title.rst index e5281ff61..a119cbde1 100644 --- a/.doc/UI/source/generated/Component/Title/Title.rst +++ b/.doc/UI/source/generated/Component/Title/Title.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _Title: + Title ===== @@ -27,17 +29,30 @@ Twig Tag :Type: -+-----------------+------------+ -| ForPage | No comment | -+-----------------+------------+ -| ForPageWithIcon | No comment | -+-----------------+------------+ -| Neutral | No comment | -+-----------------+------------+ -| Standard | No comment | -+-----------------+------------+ ++-----------------------------------------------+------------+ +| :ref:`ForPage ` | No comment | ++-----------------------------------------------+------------+ +| :ref:`ForPageWithIcon ` | No comment | ++-----------------------------------------------+------------+ +| :ref:`Neutral ` | No comment | ++-----------------------------------------------+------------+ +| :ref:`Standard ` | No comment | ++-----------------------------------------------+------------+ -:Title *ForPage* parameters: +.. _TitleForPage: + +Title ForPage +^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UITitle ForPage {sTitle:'value', sId:'value'} %} + Content Goes Here + {% EndUITitle %} + +:parameters: +--------+--------+-----------+------+--+ | sTitle | string | mandatory | | | @@ -45,7 +60,20 @@ Twig Tag | sId | string | optional | NULL | | +--------+--------+-----------+------+--+ -:Title *ForPageWithIcon* parameters: +.. _TitleForPageWithIcon: + +Title ForPageWithIcon +^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UITitle ForPageWithIcon {sTitle:'value', sIconUrl:'value', sIconCoverMethod:'value', bIsMedallion:true, sId:'value'} %} + Content Goes Here + {% EndUITitle %} + +:parameters: +------------------+--------+-----------+-----------+--+ | sTitle | string | mandatory | | | @@ -59,7 +87,20 @@ Twig Tag | sId | string | optional | NULL | | +------------------+--------+-----------+-----------+--+ -:Title *Neutral* parameters: +.. _TitleNeutral: + +Title Neutral +^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UITitle Neutral {sTitle:'value', iLevel:value, sId:'value'} %} + Content Goes Here + {% EndUITitle %} + +:parameters: +--------+--------+-----------+------+--+ | sTitle | string | mandatory | | | @@ -69,7 +110,20 @@ Twig Tag | sId | string | optional | NULL | | +--------+--------+-----------+------+--+ -:Title *Standard* parameters: +.. _TitleStandard: + +Title Standard +^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UITitle Standard {oTitle:value, iLevel:value, sId:'value'} %} + Content Goes Here + {% EndUITitle %} + +:parameters: +--------+---------+-----------+------+--+ | oTitle | UIBlock | mandatory | | | @@ -79,8 +133,8 @@ Twig Tag | sId | string | optional | NULL | | +--------+---------+-----------+------+--+ -:Title common parameters: - +Title common parameters +^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+----------+------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------+----------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/Toolbar/Toolbar.rst b/.doc/UI/source/generated/Component/Toolbar/Toolbar.rst index bc70a65f1..30fdfa34b 100644 --- a/.doc/UI/source/generated/Component/Toolbar/Toolbar.rst +++ b/.doc/UI/source/generated/Component/Toolbar/Toolbar.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _Toolbar: + Toolbar ======= @@ -27,21 +29,47 @@ Twig Tag :Type: -+-----------+------------+ -| ForAction | No comment | -+-----------+------------+ -| Standard | No comment | -+-----------+------------+ -| ForButton | No comment | -+-----------+------------+ ++-------------------------------------+------------+ +| :ref:`ForAction ` | No comment | ++-------------------------------------+------------+ +| :ref:`Standard ` | No comment | ++-------------------------------------+------------+ +| :ref:`ForButton ` | No comment | ++-------------------------------------+------------+ -:Toolbar *ForAction* parameters: +.. _ToolbarForAction: + +Toolbar ForAction +^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIToolbar ForAction {sId:'value'} %} + Content Goes Here + {% EndUIToolbar %} + +:parameters: +-----+--------+----------+------+--+ | sId | string | optional | NULL | | +-----+--------+----------+------+--+ -:Toolbar *Standard* parameters: +.. _ToolbarStandard: + +Toolbar Standard +^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIToolbar Standard {sId:'value', aContainerClasses:{name:value, name:value}} %} + Content Goes Here + {% EndUIToolbar %} + +:parameters: +-------------------+--------+----------+----------+--+ | sId | string | optional | NULL | | @@ -49,7 +77,20 @@ Twig Tag | aContainerClasses | array | optional | array () | | +-------------------+--------+----------+----------+--+ -:Toolbar *ForButton* parameters: +.. _ToolbarForButton: + +Toolbar ForButton +^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIToolbar ForButton {sId:'value', aContainerClasses:{name:value, name:value}} %} + Content Goes Here + {% EndUIToolbar %} + +:parameters: +-------------------+--------+----------+----------+--+ | sId | string | optional | NULL | | @@ -57,8 +98,8 @@ Twig Tag | aContainerClasses | array | optional | array () | | +-------------------+--------+----------+----------+--+ -:Toolbar common parameters: - +Toolbar common parameters +^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+----------+------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------+----------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Component/Toolbar/ToolbarSpacer/ToolbarSpacer.rst b/.doc/UI/source/generated/Component/Toolbar/ToolbarSpacer/ToolbarSpacer.rst index 9c724f46d..22ebd5182 100644 --- a/.doc/UI/source/generated/Component/Toolbar/ToolbarSpacer/ToolbarSpacer.rst +++ b/.doc/UI/source/generated/Component/Toolbar/ToolbarSpacer/ToolbarSpacer.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _ToolbarSpacer: + ToolbarSpacer ============= @@ -25,18 +27,29 @@ Twig Tag :Type: -+----------+-------------------------+ -| Standard | @param string|null $sId | -+----------+-------------------------+ ++-----------------------------------------+-------------------------+ +| :ref:`Standard ` | @param string|null $sId | ++-----------------------------------------+-------------------------+ -:ToolbarSpacer *Standard* parameters: +.. _ToolbarSpacerStandard: + +ToolbarSpacer Standard +^^^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIToolbarSpacer Type Standard {sId:'value'} %} + +:parameters: +-----+--------+----------+------+--+ | sId | string | optional | NULL | | +-----+--------+----------+------+--+ -:ToolbarSpacer common parameters: - +ToolbarSpacer common parameters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+--------+------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------+--------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Layout/MultiColumn/Column/Column.rst b/.doc/UI/source/generated/Layout/MultiColumn/Column/Column.rst index c854cd42b..d65d3a7cd 100644 --- a/.doc/UI/source/generated/Layout/MultiColumn/Column/Column.rst +++ b/.doc/UI/source/generated/Layout/MultiColumn/Column/Column.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _Column: + Column ====== @@ -27,19 +29,45 @@ Twig Tag :Type: -+----------+------------+ -| Standard | No comment | -+----------+------------+ -| ForBlock | No comment | -+----------+------------+ ++----------------------------------+------------+ +| :ref:`Standard ` | No comment | ++----------------------------------+------------+ +| :ref:`ForBlock ` | No comment | ++----------------------------------+------------+ -:Column *Standard* parameters: +.. _ColumnStandard: + +Column Standard +^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIColumn Standard {sId:'value'} %} + Content Goes Here + {% EndUIColumn %} + +:parameters: +-----+--------+----------+------+--+ | sId | string | optional | NULL | | +-----+--------+----------+------+--+ -:Column *ForBlock* parameters: +.. _ColumnForBlock: + +Column ForBlock +^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIColumn ForBlock {oBlock:value, sId:'value'} %} + Content Goes Here + {% EndUIColumn %} + +:parameters: +--------+---------+-----------+------+--+ | oBlock | UIBlock | mandatory | | | @@ -47,8 +75,8 @@ Twig Tag | sId | string | optional | NULL | | +--------+---------+-----------+------+--+ -:Column common parameters: - +Column common parameters +^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+----------+------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------+----------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Layout/MultiColumn/MultiColumn.rst b/.doc/UI/source/generated/Layout/MultiColumn/MultiColumn.rst index 63b758e1b..5257a2a49 100644 --- a/.doc/UI/source/generated/Layout/MultiColumn/MultiColumn.rst +++ b/.doc/UI/source/generated/Layout/MultiColumn/MultiColumn.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _MultiColumn: + MultiColumn =========== @@ -27,18 +29,31 @@ Twig Tag :Type: -+----------+------------+ -| Standard | No comment | -+----------+------------+ ++---------------------------------------+------------+ +| :ref:`Standard ` | No comment | ++---------------------------------------+------------+ -:MultiColumn *Standard* parameters: +.. _MultiColumnStandard: + +MultiColumn Standard +^^^^^^^^^^^^^^^^^^^^ + +:syntax: + +:: + + {% UIMultiColumn Standard {sId:'value'} %} + Content Goes Here + {% EndUIMultiColumn %} + +:parameters: +-----+--------+----------+------+--+ | sId | string | optional | NULL | | +-----+--------+----------+------+--+ -:MultiColumn common parameters: - +MultiColumn common parameters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------+----------+------------------------------------------------------------+ | AddCSSClass | string | CSS class to add to the generated html block | +-------------------+----------+------------------------------------------------------------+ diff --git a/.doc/UI/source/generated/Layout/UIContentBlock.rst b/.doc/UI/source/generated/Layout/UIContentBlock.rst index 0491e35a3..2e9bf1e7b 100644 --- a/.doc/UI/source/generated/Layout/UIContentBlock.rst +++ b/.doc/UI/source/generated/Layout/UIContentBlock.rst @@ -1,6 +1,8 @@ .. Copyright (C) 2010-2021 Combodo SARL .. http://opensource.org/licenses/AGPL-3.0 +.. _UIContentBlock: + UIContentBlock ============== @@ -28,13 +30,26 @@ Twig Tag :Type: -+----------+-------------------------------------------------------------------+ -| Standard | No comment | -+----------+-------------------------------------------------------------------+ -| ForCode | Used to display a block of code like 
 but allows line break. |
-+----------+-------------------------------------------------------------------+
++------------------------------------------+-------------------------------------------------------------------+
+| :ref:`Standard ` | No comment                                                        |
++------------------------------------------+-------------------------------------------------------------------+
+| :ref:`ForCode `   | Used to display a block of code like 
 but allows line break. |
++------------------------------------------+-------------------------------------------------------------------+
 
-:UIContentBlock *Standard* parameters:
+.. _UIContentBlockStandard:
+
+UIContentBlock Standard
+^^^^^^^^^^^^^^^^^^^^^^^
+
+:syntax:
+
+::
+
+    {% UIContentBlock Standard {sId:'value', aContainerClasses:{name:value, name:value}} %}
+        Content Goes Here
+    {% EndUIContentBlock %}
+
+:parameters:
 
 +-------------------+--------+----------+----------+--+
 | sId               | string | optional | NULL     |  |
@@ -42,7 +57,20 @@ Twig Tag
 | aContainerClasses | array  | optional | array () |  |
 +-------------------+--------+----------+----------+--+
 
-:UIContentBlock *ForCode* parameters:
+.. _UIContentBlockForCode:
+
+UIContentBlock ForCode
+^^^^^^^^^^^^^^^^^^^^^^
+
+:syntax:
+
+::
+
+    {% UIContentBlock ForCode {sCode:'value', sId:'value'} %}
+        Content Goes Here
+    {% EndUIContentBlock %}
+
+:parameters:
 
 +-------+--------+-----------+------+--+
 | sCode | string | mandatory |      |  |
@@ -50,8 +78,8 @@ Twig Tag
 | sId   | string | optional  | NULL |  |
 +-------+--------+-----------+------+--+
 
-:UIContentBlock common parameters:
-
+UIContentBlock common parameters
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 +-------------------+----------+------------------------------------------------------------+
 | AddCSSClass       | string   | CSS class to add to the generated html block               |
 +-------------------+----------+------------------------------------------------------------+