From a6e9aeaa8b3e005837b8194eab900a4796e3098e Mon Sep 17 00:00:00 2001 From: Benjamin Renard Date: Tue, 19 May 2020 18:12:28 +0200 Subject: [PATCH] Update doc about new possibility of LSattr_html :: select_object to select multiple type of objects --- .../LSattr_html_select_object.docbook | 59 +++++++++++-------- 1 file changed, 34 insertions(+), 25 deletions(-) diff --git a/doc/conf/LSattribute/LSattr_html/LSattr_html_select_object.docbook b/doc/conf/LSattribute/LSattr_html/LSattr_html_select_object.docbook index 15b6416d..b829dc3e 100644 --- a/doc/conf/LSattribute/LSattr_html/LSattr_html_select_object.docbook +++ b/doc/conf/LSattribute/LSattr_html/LSattr_html_select_object.docbook @@ -4,16 +4,19 @@ des références à d'autres &LSobjects;. Chaque référence à un objet correspond à une valeur prise par l'attribut. Les valeurs clés référant à un &LSobject; sont soit la valeur d'un de leurs attributs, soit leur DN. - + Structure... array ( selectable_object => array ( - 'object_type' => '[Type d'LSobject selectionnable]', - 'display_name_format' => '[LSformat du nom d'affichage des LSobjects]', - 'value_attribute' => '[Nom de l'attribut clé des LSobjects]', - 'filter' => '[Filtre de recherche]', - 'onlyAccessible' => '[Booléen]' + array ( + 'object_type' => '[Type d'LSobject selectionnable]', + 'display_name_format' => '[LSformat du nom d'affichage des LSobjects]', + 'value_attribute' => '[Nom de l'attribut clé des LSobjects]', + 'filter' => '[Filtre de recherche]', + 'onlyAccessible' => '[Booléen]' + ), + [...] ), 'ordered' => [Booléen], 'sort' => [Booléen], @@ -28,23 +31,25 @@ selectable_object - Tableau associatif obligatoire contenant en valeur clé le nom des - paramètres de configuration et dont les valeurs attachées sont les valeurs - des paramètres. - - + Tableau dont chaque valeur correspond à un tableau associatif spécifiant + un type d'&LSobject; sélectionnable. Pour chaque type d'objet sélectionnable, les + paramètres suivants doivent être renseignés : + + object_type - Nom du type d'&LSobject; en référence. + Nom du type d'&LSobject; en référence + (Paramètre obligatoire). display_name_format - &LSformat; du nom d'affichage des objets lors de leur sélection. + &LSformat; du nom d'affichage des objets lors de leur sélection + (Paramètre facultatif). @@ -52,23 +57,26 @@ value_attribute Nom de l'attribut des &LSobjects; en référence servant de valeur - clé et permettant de les identifier (Exemple : dn ou - uid). + clé et permettant de les identifier (Paramètre obligatoire, + exemples : dn ou uid). + filter - Filtre de recherche (facultatif) qui sera ajouter au filtre par défaut - lors de la sélection des objets. + Filtre de recherche qui sera ajouter au filtre par défaut lors de la + sélection des objets (Paramètre facultatif). onlyAccessible - 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). + Booléen définissant si seul les LSobjets auxquels l'utilisateur connecté + à accès doivent être considérés comme sélectionnables (Paramètre facultatif, + par défaut: False). @@ -79,10 +87,10 @@ ordered - Booléen définissant si la liste des objets choisis doit être - ordonnable ou non (Faux par défaut). Cela aura pour effet d'activer une - fonctionnalité dynamique de l'interface permettant de remonter ou descendre - dans la liste les objets choisis. + Booléen définissant si la liste des objets choisis doit être ordonnable ou + non (Paramètre facultatif, par défaut: False). + Cela aura pour effet d'activer une fonctionnalité dynamique de l'interface permettant + de remonter ou descendre dans la liste les objets choisis. Cette fonctionnalité désactive automatiquement le trie des objets à l'affichage. @@ -92,7 +100,8 @@ sort 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 (Paramètre facultatif, par défaut: + True). Le trie est effectué sur les libellés des objets choisis. @@ -106,6 +115,6 @@ - - + +