cvs: peardoc /en/packages it.xml

mj Thu Jan 3 10:20:10 2002 EDT Modified files: /peardoc/en/packages it.xml Log: * Typos * Correct parameter definition. Index: peardoc/en/packages/it.xml diff -u peardoc/en/packages/it.xml:1.1 peardoc/en/packages/it.xml:1.2 --- peardoc/en/packages/it.xml:1.1 Wed Jan 2 13:06:07 2002 +++ peardoc/en/packages/it.xml Thu Jan 3 10:20:09 2002 @@ -1,4 +1,4 @@ -<!-- $Id: it.xml,v 1.1 2002/01/02 18:06:07 alexmerz Exp $ --> +<!-- $Id: it.xml,v 1.2 2002/01/03 15:20:09 mj Exp $ --> <reference id="packages.it"> <title>IntegratedTemplate</title> @@ -7,7 +7,7 @@ <partintro> <para> The PEAR::IntegratedTemplate package is a light-weight template system. - it provides placeholder and block support. + It provides placeholder and block support. </para> </partintro> <!-- Partintro --> @@ -25,19 +25,19 @@ <title>Placeholder</title> <para> The format of placeholder is - <programlisting role="php"> + <programlisting> {[0-9A-Za-z_-]+} </programlisting> - This means, the name of the placeholder can consists of upper- and lowercase - letters, underscores and hypens. The name must placed between curly - brackets without any spaces. Valid name are i.e.: + This means, the name of the placeholder can consist of upper- and lowercase + letters, underscores and hypens. The name must be placed between curly + brackets without any spaces. Valid names are i.e.: <simplelist> - <member>{Placeholder}</member> - <member>{place2_holder}</member> - <member>{PLACEHOLDER1}</member> - <member>{Place-Holder}</member> + <member>{Placeholder}</member> + <member>{place2_holder}</member> + <member>{PLACEHOLDER1}</member> + <member>{Place-Holder}</member> </simplelist> - Non-valid names are i.e. + Non-valid names are i.e. <simplelist> <member>{ Placeholder 3 } (spaces)</member> <member>{place*holder} (char isn't permitted)</member> @@ -48,7 +48,7 @@ <title>Blocks</title> <para> The format of a block is - <programlisting role="php"> + <programlisting> <![CDATA[ <!-- BEGIN [0-9A-Za-z_-]+ --> ... block content ... @@ -60,7 +60,7 @@ required. </para> <para> - The nesting of blocks is permitted, but be carefully while + The nesting of blocks is permitted, but be careful while parsing. You have to set and parse the deepest inner block first and then set and parse from inner to outer. </para> @@ -70,7 +70,7 @@ <title>Usage Example</title> <example> <title>The template</title> - <programlisting role="php"> + <programlisting> <![CDATA[ <html> <table border> @@ -128,7 +128,7 @@ </example> <example> <title>The output</title> - <programlisting role="php"> + <programlisting> <![CDATA[ <html> <table border> @@ -169,7 +169,7 @@ <funcprototype> <funcdef>void <function>IntegratedTemplate::IntegratedTemplate</function></funcdef> - <paramdef>[string <parameter>$root</parameter>]</paramdef> + <paramdef>string <parameter><optional>$root</optional></parameter></paramdef> </funcprototype> </funcsynopsis> <para> @@ -196,7 +196,7 @@ <funcprototype> <funcdef>string <function>IntegratedTemplate::get</function></funcdef> - <paramdef>[string <parameter>$block</parameter>]</paramdef> + <paramdef>string <parameter><optional>$block</optional></parameter></paramdef> </funcprototype> </funcsynopsis> <para> @@ -221,10 +221,8 @@ <funcprototype> <funcdef>void <function>IntegratedTemplate::parse</function></funcdef> - <paramdef> - [string <parameter>$block</parameter>], - [boolean <parameter>$flag_recursion</parameter>] - </paramdef> + <paramdef>string <parameter><optional>$block</optional></parameter></paramdef> + <paramdef>boolean <parameter><optional>$flag_recursion</optional></parameter></paramdef> </funcprototype> </funcsynopsis> <para> @@ -254,8 +252,7 @@ <funcprototype> <funcdef>void <function>IntegratedTemplate::parseCurrentBlock</function></funcdef> - <paramdef> - </paramdef> + <paramdef></paramdef> </funcprototype> </funcsynopsis> <para> @@ -269,10 +266,8 @@ <funcprototype> <funcdef>void <function>IntegratedTemplate::setVariable</function></funcdef> - <paramdef> - mixed <parameter>$placeholder</parameter>, - [string <parameter>$variable</parameter>] - </paramdef> + <paramdef>mixed <parameter>$placeholder</parameter></paramdef> + <paramdef>string <parameter><optional>$variable</optional></parameter></paramdef> </funcprototype> </funcsynopsis> <para> @@ -306,9 +301,7 @@ <funcprototype> <funcdef>boolean <function>IntegratedTemplate::setCurrentBlock</function></funcdef> - <paramdef> - [string <parameter>$block</parameter>] - </paramdef> + <paramdef>string <parameter><optional>$block</optional></parameter></paramdef> </funcprototype> </funcsynopsis> <para> @@ -386,10 +379,10 @@ </funcprototype> </funcsynopsis> <para> - Clears all datafields of the object and rebuild the internal blocklist - LoadTemplatefile() and setTemplate() automatically call this functionwhen - a new template is given. Don't use this functionunless you know what - you're doing. + Clears all datafields of the object and rebuilds the internal + blocklist. LoadTemplatefile() and setTemplate() automatically + call this function when a new template is given. Don't use this + function unless you know what you're doing. </para> </refsect1> @@ -404,9 +397,8 @@ </funcprototype> </funcsynopsis> <para> - Clears all datafields of the object. - Don't use this function unless you know what you're - doing. + Clears all datafields of the object. Don't use this function + unless you know what you're doing. </para> </refsect1> @@ -444,11 +436,9 @@ <funcprototype> <funcdef>boolean <function>IntegratedTemplate::loadTemplatefile</function></funcdef> - <paramdef> - string <parameter>$filename</parameter>, - [boolean <parameter>$removeUnknownVariables</parameter>], - [boolean <parameter>$removeEmptyBlocks</parameter>] - </paramdef> + <paramdef>string <parameter>$filename</parameter></paramdef> + <paramdef>boolean <parameter><optional>$removeUnknownVariables</optional></parameter></paramdef> + <paramdef>boolean <parameter><optional>$removeEmptyBlocks</optional></parameter></paramdef> </funcprototype> </funcsynopsis> <para> @@ -534,7 +524,7 @@ <funcdef>void <function>IntegratedTemplate::show</function></funcdef> <paramdef> - [string <parameter>$block</parameter>] + string <parameter><optional>$block</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> @@ -571,14 +561,14 @@ <title>Description</title> <para> IntegratedTemplateExtension was created as a wrapper class for - the <ulink url="&url.phplib">PHPLIB</ulink> template system. it - helps you to migrate PHPLIB-based projects to PEAR-based. + the <ulink url="&url.phplib">PHPLIB</ulink> template system. It + helps you to migrate PHPLIB-based projects to PEAR-based ones. </para> <para> <acronym>ITX</acronym> is API-compatible, but based on <link linkend="packages.it.it">IntegratedTemplate</link>. Due to the different concepts of processing and organizing - blocks in a template, the behavior of itx can differ in + blocks in a template, the behaviour of itx can differ in some situations. </para> <para>