diff --git a/muk_web_searchpanel/README.rst b/muk_web_searchpanel/README.rst index 1dcdc9c..51f0e6a 100644 --- a/muk_web_searchpanel/README.rst +++ b/muk_web_searchpanel/README.rst @@ -89,14 +89,17 @@ are specified as direct children of the ``searchpanel`` with tag name ``field``, and the following attributes: * ``name`` (mandatory) the name of the field to filter on -* ``select`` determines the behavior and display. Possible values are - - ``one`` (default) at most one value can be selected. Supported field types are many2one and selection. - - ``multi`` several values can be selected (checkboxes). Supported field types are many2one, many2many and selection. +* ``select`` determines the behavior and display. * ``groups``: restricts to specific users * ``string``: determines the label to display * ``icon``: specifies which icon is used * ``color``: determines the icon color +Possible values for the ``select`` attribute are + +* ``one`` (default) at most one value can be selected. Supported field types are many2one and selection. +* ``multi`` several values can be selected (checkboxes). Supported field types are many2one, many2many and selection. + Additional optional attributes are available in the ``multi`` case: * ``domain``: determines conditions that the comodel records have to satisfy. @@ -105,12 +108,12 @@ A domain might be used to express a dependency on another field (with select="on of the search panel. Consider .. code-block:: xml + - In the above example, the range of values for manager_id (manager names) available at screen will depend on the value currently selected for the field ``department_id``. diff --git a/muk_web_searchpanel/doc/index.rst b/muk_web_searchpanel/doc/index.rst index 1dcdc9c..51f0e6a 100644 --- a/muk_web_searchpanel/doc/index.rst +++ b/muk_web_searchpanel/doc/index.rst @@ -89,14 +89,17 @@ are specified as direct children of the ``searchpanel`` with tag name ``field``, and the following attributes: * ``name`` (mandatory) the name of the field to filter on -* ``select`` determines the behavior and display. Possible values are - - ``one`` (default) at most one value can be selected. Supported field types are many2one and selection. - - ``multi`` several values can be selected (checkboxes). Supported field types are many2one, many2many and selection. +* ``select`` determines the behavior and display. * ``groups``: restricts to specific users * ``string``: determines the label to display * ``icon``: specifies which icon is used * ``color``: determines the icon color +Possible values for the ``select`` attribute are + +* ``one`` (default) at most one value can be selected. Supported field types are many2one and selection. +* ``multi`` several values can be selected (checkboxes). Supported field types are many2one, many2many and selection. + Additional optional attributes are available in the ``multi`` case: * ``domain``: determines conditions that the comodel records have to satisfy. @@ -105,12 +108,12 @@ A domain might be used to express a dependency on another field (with select="on of the search panel. Consider .. code-block:: xml + - In the above example, the range of values for manager_id (manager names) available at screen will depend on the value currently selected for the field ``department_id``.