cvs: peardoc /en/package/structures/structures-bibtex intro.xml
| From: | Elmar Pitschke | Date: | Wed, 27 Sep 2006 20:14:15 +0000 |
| Subject: | cvs: peardoc /en/package/structures/structures-bibtex intro.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-8536@lists.php.net to get a copy of this message | ||
hugoki Wed Sep 27 20:14:15 2006 UTC
Modified files:
/peardoc/en/package/structures/structures-bibtex intro.xml
Log:
- Added Documentation about the different options
http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-bibtex/intro.xml?r1=1.5&r2=1.6&diff_format=u
Index: peardoc/en/package/structures/structures-bibtex/intro.xml
diff -u peardoc/en/package/structures/structures-bibtex/intro.xml:1.5
peardoc/en/package/structures/structures-bibtex/intro.xml:1.6
--- peardoc/en/package/structures/structures-bibtex/intro.xml:1.5 Tue Sep 5 20:33:00 2006
+++ peardoc/en/package/structures/structures-bibtex/intro.xml Wed Sep 27 20:14:15 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id="package.structures.structures-bibtex.intro">
<refnamediv>
<refname>Introduction</refname>
@@ -39,6 +39,65 @@
</example>
</refsect1>
+<refsect1 id="package.structures.structures-bibtex.intro.options">
+ <title>Options</title>
+ <para>
+ Options can be set either in the constructor or with the method
<function>setOption</function>. When setting in the constructor the options are given in
an associative array. The options are:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <parameter>stripDelimiter (default: true)</parameter> Stripping the
delimiter surrounding the entries.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <parameter>validate (default: true)</parameter> Validation while
parsing.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <parameter>unwrap (default: false)</parameter> Unwrapping entries
while parsing.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <parameter>wordWrapWidth (default: false)</parameter> If set to a
number higher one that the entries are wrapped after that amount of characters.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <parameter>wordWrapBreak (default: \n)</parameter> String used to
break the line (attached to the line).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <parameter>wordWrapCut (default: 0)</parameter> If set to zero the
line will we wrapped at the next possible space, if set to one the line will be wrapped exactly
after the given amount of characters.
+ </para>
+ </listitem>
+ </itemizedlist>
+ Example of setting options in the constructor:
+ <example>
+ <title>Setting options in the constructor</title>
+ <programlisting role="php">
+ <![CDATA[
+ $bibtex = new Structures_BibTex(array('validate'=>false,
'unwrap'=>true));
+ ]]>
+ </programlisting>
+ </example>
+ Example of setting options using the method <function>setOption</function>:
+ <example>
+ <title>Setting options using setOption</title>
+ <programlisting role="php">
+ <![CDATA[
+ $bibtex = new Structures_BibTex();
+ $bibtex->setOption('validate', false);
+ $bibtex->setOption('unwrap', true);
+ ]]>
+ </programlisting>
+ </example>
+ </para>
+</refsect1>
+
<refsect1 id="package.structures.structures-bibtex.intro.storeddata">
<title>Stored Data</title>
<para>