Doc/LSattribute/HTML/select_list : fixed errors and forgotten parameters in the doc.
[ldapsaisie.git] / doc / conf / LSattribute / LSattr_html / LSattr_html_select_list.docbook
1 <sect4 id="config-LSattr_html_select_list">
2   <title>LSattr_html_select_list</title>
3   <para>Ce type est utilisé pour la gestion des attributs dont les valeurs font
4   partie d'une liste statique ou dynamique. Il est possible de lister des valeurs
5   statiques et également des références à d'autres &LSobjects;. La référence à
6   un objet correspond à une valeur clé, référente à un objet précis, qui peut être
7   soit la valeur d'un de ses attributs, soit son <emphasis>DN</emphasis>.</para>
8   
9   <programlisting linenumbering="unnumbered">
10 <citetitle>Structure</citetitle>...
11 <![CDATA['html_options' => array (
12    'possible_values' => array (
13      '[LSformat de la valeur clé]' => '[LSformat du nom d'affichage]',
14      ...
15      'OTHER_OBJECT' => array (
16        'object_type' => '[Type d'LSobject]',
17        'display_name_format' => '[LSformat du nom d'affichage des LSobjects]',
18        'value_attribute' => '[Nom de l'attribut clé]',
19        'filter' => '[Filtre de recherche des LSobject]',
20        'scope' => '[Scope de la recherche]',
21        'basedn' => '[Basedn de la recherche]'
22      )
23    )
24 ),]]>
25 ...
26 </programlisting>
27
28 <variablelist>
29 <title>Paramètres de configuration</title>
30
31 <varlistentry>
32   <term>possible_values</term>
33   <listitem>
34     <para>Tableau associatif obligatoire contenant en valeur clé le &LSformat;
35     des valeurs clés prisent par l'attribut et en valeurs associées, le &LSformat;
36     des noms d'affichage de ces valeurs. Ces &LSformats; sont composés à partir des
37     valeurs de l'objet courant (attributs, dn, ...).</para>
38     
39     <para>Si la valeur clé est égale à <literal>OTHER_OBJECT</literal>, une liste
40     d'&LSobject; sera insérée dans la liste des valeurs possibles. La valeur
41     associée est alors un tableau associatif dont les valeurs clés sont les noms 
42     des paramètres de configuration de la recherche de ces &LSobjects; et les 
43     valeurs associées, les valeurs des paramètres.</para>
44     
45 <variablelist>
46   <varlistentry>
47     <term>object_type</term>
48     <listitem>
49       <simpara>Nom du type d'&LSobject; en référence.</simpara>
50     </listitem>
51   </varlistentry>
52 </variablelist>
53
54 <variablelist>
55   <varlistentry>
56     <term>display_name_format</term>
57     <listitem>
58       <simpara>&LSformat; du nom d'affichage des objets lors de leur sélection.</simpara>
59     </listitem>
60   </varlistentry>
61 </variablelist>
62
63 <variablelist>
64   <varlistentry>
65     <term>value_attribute</term>
66     <listitem>
67       <simpara>Nom de l'attribut des &LSobjects; en référence servant de valeur
68       clé et permettant de les identifier (Exemple : <emphasis>dn</emphasis> ou
69       <emphasis>uid</emphasis>).</simpara>
70     </listitem>
71   </varlistentry>
72 </variablelist>
73
74 <variablelist>
75   <varlistentry>
76     <term>filter</term>
77     <listitem>
78       <simpara>Filtre falcultatif de la recherche des LSobjets. Il sera dans tous
79       les cas agrémenté des valeurs des <emphasis>objectclass</emphasis> du type
80       d'&LSobject;.</simpara>
81     </listitem>
82   </varlistentry>
83 </variablelist>
84
85 <variablelist>
86   <varlistentry>
87     <term>scope</term>
88     <listitem>
89       <simpara>Scope falcultatif de la recherche des LSobjets.</simpara>
90     </listitem>
91   </varlistentry>
92 </variablelist>
93
94 <variablelist>
95   <varlistentry>
96     <term>basedn</term>
97     <listitem>
98       <simpara>Basedn falcultatif de la recherche des LSobjets.</simpara>
99     </listitem>
100   </varlistentry>
101 </variablelist>
102
103   </listitem>
104 </varlistentry>
105
106 </variablelist>
107   
108   
109 </sect4>