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

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<sect1 id="language.function.html.image">
 <title>{html_image}</title>
  <para>
   <varname>{html_image}</varname> adalah sebuah
   <link linkend="language.custom.functions">fungsi kustom</link>
   yang membuat sebuah tag HTML <literal>&lt;img&gt;</literal>.
   <parameter>height</parameter> dan <parameter>width</parameter>
   secara otomatis dihitung dari gile gambar jika tidak disediakan.
 </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>Nama Atribut</entry>
     <entry>Tipe</entry>
     <entry>Diperlukan</entry>
     <entry>Default</entry>
     <entry>Deskripsi</entry>
    </row>
   </thead>
   <tbody>
    <row>
     <entry>file</entry>
     <entry>string</entry>
     <entry>Ya</entry>
     <entry><emphasis>n/a</emphasis></entry>
     <entry>nama/path ke gambar</entry>
    </row>
    <row>
     <entry>height</entry>
     <entry>string</entry>
     <entry>Tidak</entry>
     <entry><emphasis>tinggi asli gambar</emphasis></entry>
     <entry>Tinggi untuk menampilkan gambar</entry>
    </row>
    <row>
     <entry>width</entry>
     <entry>string</entry>
     <entry>Tidak</entry>
     <entry><emphasis>panjang asli gambar</emphasis></entry>
     <entry>Panjang untuk menampilkan gambar</entry>
    </row>
    <row>
     <entry>basedir</entry>
     <entry>string</entry>
     <entry>Tidak</entry>
     <entry><emphasis>akar doc server web</emphasis></entry>
     <entry>Direktori yang jadi basis path relatifnya</entry>
    </row>
    <row>
     <entry>alt</entry>
     <entry>string</entry>
     <entry>Tidak</entry>
     <entry><emphasis><quote></quote></emphasis></entry>
     <entry>Deskripsi alternatif dari gambar</entry>
    </row>
    <row>
     <entry>href</entry>
     <entry>string</entry>
     <entry>Tidak</entry>
     <entry><emphasis>n/a</emphasis></entry>
     <entry>nilai href untuk menghubungkan gambar</entry>
    </row>
    <row>
     <entry>path_prefix</entry>
     <entry>string</entry>
     <entry>Tidak</entry>
     <entry><emphasis>n/a</emphasis></entry>
     <entry>Prefiks untuk path output</entry>
    </row>
   </tbody>
  </tgroup>
 </informaltable>

<itemizedlist>
<listitem><para>
  <parameter>basedir</parameter> adalah basis direktori yang menjadi dasar
  path relatif ke gambar. Jika tidak disediakan, akar dokumen server web,
  <varname>$_ENV['DOCUMENT_ROOT']</varname> dipakai sebagai basis.
  Jika <link linkend="variable.security"><parameter>$security</parameter></link>
  dihidupkan, path ke gambar harus di dalam
  <link linkend="variable.secure.dir">direktori aman</link>.
 </para></listitem>

 <listitem><para>
  <parameter>href</parameter> adalah nilai href untuk menghubungkan gambar.
  Jika link tidak disediakan, tag <literal>&lt;a href="LINKVALUE"&gt;&lt;a&gt;</literal>
  ditempatkan sekitar tag gambar.
 </para> </listitem>

 <listitem><para>
  <parameter>path_prefix</parameter> adalah string prefiks opsional yang 
  dapat anda berikan path output.
  Ini berguna jika anda ingin menyediakan nama server yang berbeda untuk gambar.
 </para></listitem>

 <listitem><para>
  Semua parameters yang tidak dalam daftar di atas dicetak sebagai pasangan
  nama/nilai di dalam tag <literal>&lt;img&gt;</literal> yang dibuat.
 </para></listitem>
</itemizedlist>

 <note>
  <title>Catatan Teknis</title>
  <para>
   <varname>{html_image}</varname> membutuhkan mencari ke disk untuk membaca
   gambar dan menghitung tingi serta panjangnya. Jika anda tidak memakai 
   <link linkend="caching">caching</link> template,
   umumnya lebih baik untuk menghindari <varname>{html_image}</varname> dan 
   membiarkan tag gambar statis untuk performansi optimal.
  </para>
 </note>

 <example>
  <title>contoh {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>
    Contoh tampilan dari template di atas akan seperti:
  </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
-->