generate_lang_file.php : Hide errors
[ldapsaisie.git] / doc / conf / LSattribute / LSattr_html / LSattr_html_password.docbook
1 <sect4 id="config-LSattr_html_password">
2   <title>LSattr_html_password</title>
3   <para>Ce type est utilisé pour la gestion des attributs dont la valeur est
4   un mot de passe.</para>
5   
6   <programlisting linenumbering="unnumbered">
7 <citetitle>Structure</citetitle>...
8 <![CDATA['html_options' => array(
9   'generationTool' => [booleen],
10   'autoGenerate' => [booleen],
11   'lenght' => [nombre de caractères],
12   'chars' => array ( // Caractères que peut contenir le mot de passe
13     array( // Liste caractère avec un nombre mininum d'apparition supérieur à 1
14       'nb' => [nb caractères],
15       'chars' => '[liste de caractères possibles]'
16     ),
17     '[autre liste de caractères possible]', // Liste caractère avec un nombre 
18                                             // d'apparitions égal à 1
19     ...
20   ),
21   'verify' => [booléen],  // Activation de l'outil de vérification du mot de passe
22   'viewHash' => [booléen],  // Activation de l'outil de visualisation du mot de passe haché
23   'mail' => array( // Configuration de l'envoi du mot de passe par mail
24     'subject' => "[LSformat du sujet du mail]",
25     'msg' => "[LSformat du message du mail]",
26     'mail_attr' => 'mail', // Attribut mail de l'objet
27     'send' => 1,  // Activation par défaut de l'envoi du mot de passe
28     'ask' => 1,   // Laisser le choix à l'utilisateur
29     'canEdit' => 1   // Activation de l'édition du LSformat du message par l'utilisateur
30   )
31 ),]]>
32 ...
33 </programlisting>
34
35 <variablelist>
36 <title>Paramètres de configuration</title>
37
38 <varlistentry>
39   <term>generationTool</term>
40   <listitem>
41     <simpara>Booléen définissant si l'outil de génération de mot de passe est
42     activé.</simpara>
43   </listitem>
44 </varlistentry>
45
46 <varlistentry>
47   <term>autoGenerate</term>
48   <listitem>
49     <simpara>Active la génération automatique du mot de passe lorsque l'attribut
50     n'a encore aucune valeur de définie. Il faut également que l'outil de
51     génération soit activé (<parameter>generationTool</parameter>).</simpara>
52   </listitem>
53 </varlistentry>
54
55 <varlistentry>
56   <term>lenght</term>
57   <listitem>
58     <simpara>Nombre de caractères que devront contenir les mots de passe générés.
59     </simpara>
60   </listitem>
61 </varlistentry>
62
63 <varlistentry>
64   <term>chars</term>
65   <listitem>
66     <para>Tableau contenant une liste de listes de caractères possibles pour
67     composer le mot de passe. Dans chacune de ces listes, au moins un caractère
68     sera utilisé dans le nouveau mot de passe. Il est possible de définir un
69     nombre supérieur de caractères d'une liste devant apparaître dans les mots de
70     passe générés en spécifiant un tableau associatif dont la clé <emphasis>nb
71     </emphasis> associra le nombre entier de caractères et la clé <emphasis>chars
72     </emphasis> la liste de caractères. Une liste de caractères est un chaîne.</para>
73   </listitem>
74 </varlistentry>
75
76 <varlistentry>
77   <term>verify</term>
78   <listitem>
79     <simpara>Booléen définissant si l'outil de vérification du mot de passe est
80     activé. Si celui-ci est activé, l'utilisateur pourra entrer un mot de passe
81     dans le champ et cliquer sur un bouton qui lancera une procédure de
82     vérification du mot de passe via un test de connexion à l'annuaire.</simpara>
83   </listitem>
84 </varlistentry>
85
86 <varlistentry>
87   <term>viewHash</term>
88   <listitem>
89     <simpara>Booléen définissant si l'utilisateur aura accès à la fonctionnalité 
90     de visualisation du mot de passe haché.</simpara>
91   </listitem>
92 </varlistentry>
93
94 <varlistentry>
95   <term>mail</term>
96   <listitem>
97     <para>Paramètres de configuration de l'envoi par mail du mot de passe à
98     l'utilisateur. Lorsque cet outil est activé, lors de la modification/création
99     du mot de passe, l'utilisateur pourra recevoir un mail lui spécifiant son
100     nouveau mot de passe.
101     
102     <variablelist>
103       <title>Paramêtres de configuration</title>
104
105       <varlistentry>
106         <term>send</term>
107         <listitem>
108           <simpara>Booléen définissant si l'envoi du mot de passe est activé par
109           défaut.</simpara>
110         </listitem>
111       </varlistentry>
112       
113       <varlistentry>
114         <term>ask</term>
115         <listitem>
116           <simpara>Booléen définissant si on laisse le choix à l'utilisateur
117           d'activer ou non l'envoi du mot de passe par mail.</simpara>
118         </listitem>
119       </varlistentry>
120       
121       <varlistentry>
122         <term>canEdit</term>
123         <listitem>
124           <simpara>Booléen définissant si on laisse la possibilité à l'utilisateur
125           d'éditer le &LSformat; du message et du sujet.</simpara>
126         </listitem>
127       </varlistentry>
128
129       <varlistentry>
130         <term>subject</term>
131         <listitem>
132           <simpara>&LSformat; du sujet du mail. Ce format sera composé avec la
133           valeur du nouveau mot de passe de l'utilisateur.</simpara>
134         </listitem>
135       </varlistentry>
136       
137       <varlistentry>
138         <term>msg</term>
139         <listitem>
140           <simpara>&LSformat; du message du mail. Ce format sera composé avec la
141           valeur du nouveau mot de passe de l'utilisateur.</simpara>
142         </listitem>
143       </varlistentry>
144       
145       <varlistentry>
146         <term>mail_attr</term>
147         <listitem>
148           <simpara>Le nom de l'attribut listant les mails possibles de
149           l'utilisateur. Par défaut, la première valeur de l'attribut sera
150           utilisée comme adresse mail destinatrice.
151           Si <parameter>canEdit</parameter> est activé, l'utilisateur pourra
152           choisir l'adresse mail destinatrice parmi la liste des valeurs de
153           l'attribut.</simpara>
154         </listitem>
155       </varlistentry>
156       
157     </variablelist>
158     
159     </para>
160   </listitem>
161 </varlistentry>
162
163 </variablelist>
164   
165   
166 </sect4>