Files
smarty/docs/pt_BR/programmers/plugins/plugins-naming-conventions.xml

80 lines
2.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1.1 Maintainer: nobody Status: ready -->
<sect1 id="plugins.naming.conventions">
<title>Convenções de Aparência</title>
<para>
Arquivos e funções de Plugin devem seguir uma convenção de aparência muito específica
a fim de ser localizada pela Smarty.
</para>
<para>
Os arquivos de plugin devem ser nomeados da sequinte forma:
<blockquote>
<para>
<filename>
<replaceable>tipo</replaceable>.<replaceable>nome</replaceable>.php
</filename>
</para>
</blockquote>
</para>
<para>
Onde <literal>tipo</literal> é um dos seguintes tipos de plugin:
<itemizedlist spacing="compact">
<listitem><simpara>function</simpara></listitem>
<listitem><simpara>modifier</simpara></listitem>
<listitem><simpara>block</simpara></listitem>
<listitem><simpara>compiler</simpara></listitem>
<listitem><simpara>prefilter</simpara></listitem>
<listitem><simpara>postfilter</simpara></listitem>
<listitem><simpara>outputfilter</simpara></listitem>
<listitem><simpara>resource</simpara></listitem>
<listitem><simpara>insert</simpara></listitem>
</itemizedlist>
</para>
<para>
E <literal>nome</literal> seria um identificador válido (letras,
números, e underscores apenas).
</para>
<para>
Alguns exemplos: <literal>function.html_select_date.php</literal>,
<literal>resource.db.php</literal>,
<literal>modifier.spacify.php</literal>.
</para>
<para>
As funções de plugin dentro dos arquivos do plugin devem ser nomeadas da seguinte forma:
<blockquote>
<para>
<function>smarty_<replaceable>tipo</replaceable>_<replaceable>nome</replaceable></function>
</para>
</blockquote>
</para>
<para>
O significado de <literal>tipo</literal> e
<literal>nome</literal> são os mesmos de antes.
</para>
<para>
A Smarty mostrará mensagens de erro apropriadas se o arquivo de plugins que é necessário não é encontrado,
ou se o arquivo ou a função de plugin
estão nomeadas inadequadamente.
</para>
</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
-->