bn8/ldapsaisie
1
0
Fork 0
mirror of https://gitlab.easter-eggs.com/ee/ldapsaisie.git synced 2024-09-29 01:29:55 +02:00
Code Issues Projects Releases Wiki Activity

Update doc about new possibility of LSattr_html :: select_object to select multiple type of objects

Browse source
This commit is contained in:
Benjamin Renard 2020-05-19 18:12:28 +02:00
parent e8095636b5
commit a6e9aeaa8b
1 changed files with 34 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
doc/conf/LSattribute/LSattr_html/LSattr_html_select_object.docbook
View file

@ -9,12 +9,15 @@
<citetitle>Structure</citetitle>... <citetitle>Structure</citetitle>...
<![CDATA['html_options' => array ( <![CDATA['html_options' => array (
selectable_object => array ( selectable_object => array (
array (
'object_type' => '[Type d'LSobject selectionnable]', 'object_type' => '[Type d'LSobject selectionnable]',
'display_name_format' => '[LSformat du nom d'affichage des LSobjects]', 'display_name_format' => '[LSformat du nom d'affichage des LSobjects]',
'value_attribute' => '[Nom de l'attribut clé des LSobjects]', 'value_attribute' => '[Nom de l'attribut clé des LSobjects]',
'filter' => '[Filtre de recherche]', 'filter' => '[Filtre de recherche]',
'onlyAccessible' => '[Booléen]' 'onlyAccessible' => '[Booléen]'
), ),
[...]
),
'ordered' => [Booléen], 'ordered' => [Booléen],
'sort' => [Booléen], 'sort' => [Booléen],
'sortDirection' => '[ASC|DESC]' 'sortDirection' => '[ASC|DESC]'
@ -28,23 +31,25 @@
<varlistentry> <varlistentry>
<term>selectable_object</term> <term>selectable_object</term>
<listitem> <listitem>
<simpara>Tableau associatif obligatoire contenant en valeur clé le nom des <simpara>Tableau dont chaque valeur correspond à un tableau associatif spécifiant
paramètres de configuration et dont les valeurs attachées sont les valeurs un type d'&LSobject; sélectionnable. Pour chaque type d'objet sélectionnable, les
des paramètres.</simpara> paramètres suivants doivent être renseignés :</simpara>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>object_type</term> <term>object_type</term>
<listitem> <listitem>
<simpara>Nom du type d'&LSobject; en référence.</simpara> <simpara>Nom du type d'&LSobject; en référence
<emphasis>(Paramètre obligatoire)</emphasis>.</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>display_name_format</term> <term>display_name_format</term>
<listitem> <listitem>
<simpara>&LSformat; du nom d'affichage des objets lors de leur sélection.</simpara> <simpara>&LSformat; du nom d'affichage des objets lors de leur sélection
<emphasis>(Paramètre facultatif)</emphasis>.</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -52,23 +57,26 @@
<term>value_attribute</term> <term>value_attribute</term>
<listitem> <listitem>
<simpara>Nom de l'attribut des &LSobjects; en référence servant de valeur <simpara>Nom de l'attribut des &LSobjects; en référence servant de valeur
clé et permettant de les identifier (Exemple : <emphasis>dn</emphasis> ou clé et permettant de les identifier <emphasis>(Paramètre obligatoire,
<emphasis>uid</emphasis>).</simpara> exemples : <literal>dn</literal> ou <literal>uid</literal>)</emphasis>.
</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>filter</term> <term>filter</term>
<listitem> <listitem>
<simpara>Filtre de recherche (facultatif) qui sera ajouter au filtre par défaut <simpara>Filtre de recherche qui sera ajouter au filtre par défaut lors de la
lors de la sélection des objets.</simpara> sélection des objets <emphasis>(Paramètre facultatif)</emphasis>.</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>onlyAccessible</term> <term>onlyAccessible</term>
<listitem> <listitem>
<simpara>Booléen falcultatif définissant si seul les LSobjets auxquels l'utilisateur connecté à accès doivent être considérés comme sélectionnables (Faux par défault).</simpara> <simpara>Booléen définissant si seul les LSobjets auxquels l'utilisateur connecté
à accès doivent être considérés comme sélectionnables <emphasis>(Paramètre facultatif,
par défaut: <literal>False</literal>)</emphasis>.</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@ -79,10 +87,10 @@
<varlistentry> <varlistentry>
<term>ordered</term> <term>ordered</term>
<listitem> <listitem>
<simpara>Booléen définissant si la liste des objets choisis doit être <simpara>Booléen définissant si la liste des objets choisis doit être ordonnable ou
ordonnable ou non (Faux par défaut). Cela aura pour effet d'activer une non <emphasis>(Paramètre facultatif, par défaut: <literal>False</literal>)</emphasis>.
fonctionnalité dynamique de l'interface permettant de remonter ou descendre Cela aura pour effet d'activer une fonctionnalité dynamique de l'interface permettant
dans la liste les objets choisis.</simpara> de remonter ou descendre dans la liste les objets choisis.</simpara>
<note><simpara>Cette fonctionnalité désactive automatiquement le trie des <note><simpara>Cette fonctionnalité désactive automatiquement le trie des
objets à l'affichage.</simpara></note> objets à l'affichage.</simpara></note>
</listitem> </listitem>
@ -92,7 +100,8 @@
<term>sort</term> <term>sort</term>
<listitem> <listitem>
<simpara>Booléen définissant si la liste des objets choisis doit être <simpara>Booléen définissant si la liste des objets choisis doit être
triée ou non (Vrai par défaut). Le trie est effectué sur les libellés triée ou non <emphasis>(Paramètre facultatif, par défaut:
<literal>True</literal>)</emphasis>. Le trie est effectué sur les libellés
des objets choisis.</simpara> des objets choisis.</simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>