LSattr_html :: postaladdress : improve it and add default configuration value
[ldapsaisie.git] / doc / conf / LSattribute / LSattr_html / LSattr_html_postaladdress.docbook
1 <sect4 id="config-LSattr_html_postaladdress">
2   <title>LSattr_html_postaladdress</title>
3   <para>Ce type est utilisé pour la gestion des attributs du type de l'attribut
4   standard <emphasis>postalAddress</emphasis>. Ce type d'attribut permet d'afficher,
5   en plus de l'adresse, un lien composé à partir d'informations de l'objet permettant
6   par exemple d'afficher un lien vers une carte géocalisant l'adresse postale.</para>
7
8   <para>Par défaut, le lien ajouté sera un lien de recherche de l'adresse postale
9   générée à partir de la valeur de l'attribut (en remplaçant les retours à la ligne
10   (<literal>\n</literal>) par des espaces) via le service
11   <ulink url='http://nominatim.openstreetmap.org/'>Nominatim d'OpenStreetMap</ulink>.
12   </para>
13
14   <note><simpara>Dans le cadre du fonctionnement par défaut et pour maîtriser les
15   valeurs stockées dans l'annuaire, il faut coupler ce type d'attribut HTML avec le
16   type d'attribut LDAP
17   <link linkend='config-LSattr_ldap_postaladdress'>postaladdress</link></simpara></note>
18
19 <programlisting linenumbering="unnumbered">
20 <citetitle>Structure</citetitle>...
21 <![CDATA['html_options' => array(
22   'map_url_pattern_format' => '[LSformat]',
23   'map_url_pattern_generate_function' => '[callable]',
24   'map_url_format' => '[LSformat]',
25 ),]]>
26 ...
27 </programlisting>
28
29 <variablelist>
30 <title>Paramètres de configuration</title>
31
32 <varlistentry>
33   <term>map_url_pattern_format</term>
34   <listitem>
35     <simpara>Ce &LSformat; doit permettre de générer la valeur de l'adresse postale
36     qui sera insérée dans l'URL du lien ajouté dans l'interface.</simpara>
37   </listitem>
38 </varlistentry>
39
40 <varlistentry>
41   <term>map_url_pattern_generate_function</term>
42   <listitem>
43     <simpara>Ce paramètre permet de définir une fonction qui sera utilisée à la place
44     du paramètre <literal>map_url_pattern_format</literal> pour générer la valeur de
45     l'adresse postale qui sera insérée dans l'URL du lien ajouté dans l'interface.
46     Cette fonction prendra en paramètre l'objet <emphasis>LSformElement</emphasis>
47     courant et devra retourner une chaîne de caractères correspondant à l'adresse
48     postale à insérer dans le lien de l'interface. Par défaut, la fonction
49     <literal>LSformElement_postaladdress__generate_pattern</literal> est utilisée.
50     </simpara>
51   </listitem>
52 </varlistentry>
53
54 <varlistentry>
55   <term>map_url_format</term>
56   <listitem>
57     <simpara>Ce &LSformat; doit permettre de générer l'URL du lien ajouté dans
58     l'interface. Il sera composé avec les informations de l'objet LDAP, y compris
59     le mot clé <emphasis>%{pattern}</emphasis> correspondant à la valeur de l'adresse
60     postale générée à l'aide des paramètres précédents. Par défaut, la format suivant
61     sera utilisé :
62     <literal>http://nominatim.openstreetmap.org/search.php?q=%{pattern}</literal></simpara>
63   </listitem>
64 </varlistentry>
65
66 </variablelist>
67
68 </sect4>