smarty/docs/en/designers/language-modifiers/language-modifier-indent.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
 <sect1 id="language.modifier.indent">
  <title>indent</title>
  <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>Parameter Position</entry>
      <entry>Type</entry>
      <entry>Required</entry>
      <entry>Default</entry>
      <entry>Description</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>1</entry>
      <entry>integer</entry>
      <entry>No</entry>
      <entry>4</entry>
      <entry>This determines how many characters to indent
       to.</entry>
      </row>
      <row>
       <entry>2</entry>
       <entry>string</entry>
       <entry>No</entry>
       <entry>(one space)</entry>
       <entry>This is the character used to indent with.</entry>
      </row>
     </tbody>
    </tgroup>
  </informaltable>
  <para>
   This indents a string at each line, default is 4. As
   an optional parameter, you can specify the number of characters to
   indent. As an optional second parameter, you can specify the
   character to use to indent with. (Use "\t" for tabs.)
  </para>
  <example>
   <title>indent</title>
   <programlisting role="php">
<![CDATA[
<?php
    
$smarty = new Smarty;
$smarty->assign('articleTitle', 'NJ judge to rule on nude beach.
Sun or rain expected today, dark tonight.
Statistics show that teen pregnancy drops off significantly after 25.');
$smarty->display('index.tpl');

?>
]]>
   </programlisting>
   <para>
    Where index.tpl is:
   </para>
   <programlisting>
<![CDATA[
{$articleTitle}

{$articleTitle|indent}

{$articleTitle|indent:10}

{$articleTitle|indent:1:"\t"}
]]>
   </programlisting>
   <para>
    this will output:
   </para>
   <screen>
<![CDATA[
NJ judge to rule on nude beach.
Sun or rain expected today, dark tonight.
Statistics show that teen pregnancy drops off significantly after 25.

    NJ judge to rule on nude beach.
    Sun or rain expected today, dark tonight.
    Statistics show that teen pregnancy drops off significantly after 25.

          NJ judge to rule on nude beach.
          Sun or rain expected today, dark tonight.
          Statistics show that teen pregnancy drops off significantly after 25.

        NJ judge to rule on nude beach.
        Sun or rain expected today, dark tonight.
        Statistics show that teen pregnancy drops off significantly after 25.
]]>
   </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
-->