Doc : Added informations about LSattr_html_valueWithUnit
authorBenjamin Renard <brenard@easter-eggs.com>
Thu, 12 Dec 2013 10:24:26 +0000 (11:24 +0100)
committerBenjamin Renard <brenard@easter-eggs.com>
Thu, 12 Dec 2013 10:24:26 +0000 (11:24 +0100)
doc/conf/LSattribute/LSattr_html.docbook
doc/conf/LSattribute/LSattr_html/LSattr_html.entities.xml
doc/conf/LSattribute/LSattr_html/LSattr_html_valueWithUnit.docbook [new file with mode: 0644]

index 33ec2f1..ace4f06 100644 (file)
@@ -16,6 +16,7 @@
   &conf-LSattr_html_ssh_key;
   &conf-LSattr_html_text;
   &conf-LSattr_html_textarea;
+  &conf-LSattr_html_valueWithUnit;
   &conf-LSattr_html_url;
   &conf-LSattr_html_xmpp;
   
index 6339df2..5bd36ff 100644 (file)
@@ -13,4 +13,5 @@
 <!ENTITY conf-LSattr_html_text SYSTEM "LSattr_html_text.docbook">
 <!ENTITY conf-LSattr_html_textarea SYSTEM "LSattr_html_textarea.docbook">
 <!ENTITY conf-LSattr_html_url SYSTEM "LSattr_html_url.docbook">
+<!ENTITY conf-LSattr_html_valueWithUnit SYSTEM "LSattr_html_valueWithUnit.docbook">
 <!ENTITY conf-LSattr_html_xmpp SYSTEM "LSattr_html_xmpp.docbook">
diff --git a/doc/conf/LSattribute/LSattr_html/LSattr_html_valueWithUnit.docbook b/doc/conf/LSattribute/LSattr_html/LSattr_html_valueWithUnit.docbook
new file mode 100644 (file)
index 0000000..bf565d3
--- /dev/null
@@ -0,0 +1,31 @@
+<sect4 id="config-LSattr_html_valueWithUnit">
+  <title>LSattr_html_valueWithUnit</title>
+  <para>Ce type est utilisé pour la gestion des attributs dont la valeur est un entier
+  auxquel un facteur peut s'appliquer (par exemple : <literal>Kilo, Méga, ...</literal>).</para>
+
+<programlisting linenumbering="unnumbered">
+<citetitle>Structure</citetitle>...
+<![CDATA['html_options' => array(
+    'units' => array (
+      '[facteur1]' => '[label unit1]',
+      '[facteur2]' => '[label unit2]',
+      [...]
+    )
+  )
+),]]>
+...
+</programlisting>
+
+<variablelist>
+<title>Paramètres de configuration</title>
+
+<varlistentry>
+  <term>units</term>
+  <listitem>
+    <simpara>Tableau associatif dont la clé est un entier correspondant au facteur et la valeur est le label de l'unité. (Par exemple : <literal>1 => Octet, 1024 => Kilo-octet, ...</literal>).</simpara>
+  </listitem>
+</varlistentry>
+
+</variablelist>
+
+</sect4>