smarty/docs/fr/designers/language-custom-functions/language-function-html-image.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1.10 Maintainer: yannick Status: ready -->

<sect1 id="language.function.html.image">
 <title>{html_image}</title>
 <para>
  <varname>{html_image}</varname> est une
  <link linkend="language.custom.functions">fonction utilisateur</link> qui génère la balise
  HTML pour une image. La hauteur et la longueur de l'image sont calculés
  automatiquement depuis le fichier image si aucune n'est spécifiée.
 </para>
 <informaltable frame="all">
  <tgroup cols="5">
   <colspec colname="param" align="center" />
   <colspec colname="type" align="center" />
   <colspec colname="required" align="center" />
   <colspec colname="default" align="center" />
   <colspec colname="desc" />
   <thead>
    <row>
     <entry>Nom attribut</entry>
     <entry>Type</entry>
     <entry>Requis</entry>
     <entry>Défaut</entry>
     <entry>Description</entry>
    </row>
   </thead>
   <tbody>
    <row>
     <entry>file</entry>
     <entry>chaîne de caractères</entry>
     <entry>Oui</entry>
     <entry><emphasis>n/a</emphasis></entry>
     <entry>nom/chemin des images</entry>
    </row>
    <row>
     <entry>height</entry>
     <entry>chaîne de caractères</entry>
     <entry>Non</entry>
     <entry><emphasis>Hauteur de l'image actuelle</emphasis></entry>
     <entry>Hauteur de l'image à afficher</entry>
    </row>
    <row>
     <entry>width</entry>
     <entry>chaîne de caractères</entry>
     <entry>Non</entry>
     <entry><emphasis>Longueur de l'image actuelle</emphasis></entry>
     <entry>Longueur de l'image à afficher</entry>
    </row>
    <row>
     <entry>basedir</entry>
     <entry>chaîne de caractères</entry>
     <entry>non</entry>
     <entry><emphasis>racine du serveur web</emphasis></entry>
     <entry>Répertoire depuis lequel baser le calcul des
     chemins relatifs</entry>
   </row>
   <row>
    <entry>alt</entry>
    <entry>chaîne de caractères</entry>
    <entry>non</entry>
    <entry><emphasis><quote></quote></emphasis></entry>
    <entry>Description alternative de l'image</entry>
   </row>
   <row>
    <entry>href</entry>
    <entry>chaîne de caractères</entry>
    <entry>non</entry>
    <entry><emphasis>n/a</emphasis></entry>
    <entry>valeur de l'attribut href, indiquant le lien vers l'image</entry>
    </row>
    <row>
     <entry>path_prefix</entry>
     <entry>chaîne de caractères</entry>
     <entry>non</entry>
     <entry><emphasis>n/a</emphasis></entry>
     <entry>Préfixe pour le chemin de la sortie</entry>
    </row>
   </tbody>
  </tgroup>
 </informaltable>

 <itemizedlist>
  <listitem><para>
    <parameter>basedir</parameter> est le dossier de base dans lequel
    les images sont basées. S'il n'est pas fourni, la variable d'environnement
    <varname>$_ENV['DOCUMENT_ROOT']</varname> sera utilisée.
    Si <link linkend="variable.security"><parameter>$security</parameter></link>
    est activé, le chemin vers l'image doit être présent dans le
    <link linkend="variable.secure.dir">dossier de sécurité</link>.
   </para></listitem>

  <listitem><para>
    <parameter>href</parameter> est la valeur de l'attribut href de l'image.
    Si le lien est fourni, une balise <literal>&lt;a href="LINKVALUE"&gt;&lt;a&gt;</literal>
    sera placée autour de la balise de l'image.
   </para> </listitem>

  <listitem><para>
    <parameter>path_prefix</parameter> est un préfixe optionnel que vous pouvez fournir.
    Il est utile si vous voulez fournir un nom de serveur différent pour l'image.
   </para></listitem>

  <listitem><para>
    Tous les paramètres qui ne sont pas dans la liste ci-dessus sont affichés
    sous la forme d'une paire nom/valeur dans la balise
    <literal>&lt;img&gt;</literal> créée.
   </para></listitem>
</itemizedlist>

 <note>
  <title>Note technique</title>
  <para>
   <varname>{html_image}</varname> requiert un accès au disque dur pour lire l'image et
   calculer ses dimensions. Si vous n'utilisez pas un <link linkend="caching">cache</link>,
   il est généralement préférable d'éviter d'utiliser <varname>{html_image}</varname>
   et de laisser les balises images statiques pour de meilleures
   performances.
  </para>
 </note>
 <example>
  <title>Exemple avec {html_image}</title>
  <programlisting>
<![CDATA[
{html_image file='pumpkin.jpg'}
{html_image file='/path/from/docroot/pumpkin.jpg'}
{html_image file='../path/relative/to/currdir/pumpkin.jpg'}
]]>
  </programlisting>
  <para>
   L'affichage possible du template ci-dessus pourrait être :
  </para>
  <screen>
<![CDATA[
<img src="pumpkin.jpg" alt="" width="44" height="68" />
<img src="/path/from/docroot/pumpkin.jpg" alt="" width="44" height="68" />
<img src="../path/relative/to/currdir/pumpkin.jpg" alt="" width="44" height="68" />
]]>
  </screen>
 </example>
</sect1>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->