void Tue Jul 24 21:55:02 2007 UTC
Modified files:
/phpdoc/en/reference/bbcode constants.xml reference.xml
/phpdoc/en/reference/bbcode/functions bbcode-add-element.xml
bbcode-create.xml
bbcode-destroy.xml
bbcode-parse.xml
Log:
Applied the patch from M. Sokolewicz <[EMAIL PROTECTED]> (thanks a lot for
your Help).
+ Added corrections about file_info reference
+ Added Minor Typo corrections
+ Removed all tabs (i found)
+ Aspelled everything twice, 'should help
Sorry, once more for my previous submission :">
Xavier.
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bbcode/constants.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/bbcode/constants.xml
diff -u phpdoc/en/reference/bbcode/constants.xml:1.1
phpdoc/en/reference/bbcode/constants.xml:1.2
--- phpdoc/en/reference/bbcode/constants.xml:1.1 Tue Jul 24 12:13:12 2007
+++ phpdoc/en/reference/bbcode/constants.xml Tue Jul 24 21:55:02 2007
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<section xml:id="bbcode.constants" xmlns="http://docbook.org/ns/docbook";>
&reftitle.constants;
&extension.constants;
@@ -7,29 +7,29 @@
<varlistentry>
<term>
<constant>BBCODE_TYPE_NOARG</constant>
- (<type>integer</type>)
+ (<type>integer</type>)
</term>
<listitem>
<simpara>
- This BBCode tag does not accept arguments.
+ This BBCode tag does not accept any arguments.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_TYPE_SINGLE</constant>
- (<type>integer</type>)
+ (<type>integer</type>)
</term>
<listitem>
<simpara>
- This BBCode tag does not have corresponding close tag.
+ This BBCode tag does not have a corresponding close tag.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_TYPE_ARG</constant>
- (<type>integer</type>)
+ (<type>integer</type>)
</term>
<listitem>
<simpara>
@@ -40,18 +40,18 @@
<varlistentry>
<term>
<constant>BBCODE_TYPE_OPTARG</constant>
- (<type>integer</type>)
+ (<type>integer</type>)
</term>
<listitem>
<simpara>
- This BBCode tag accepts an optional argument.
+ This BBCode tag accept an optional argument.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_TYPE_ROOT</constant>
- (<type>integer</type>)
+ (<type>integer</type>)
</term>
<listitem>
<simpara>
@@ -62,22 +62,23 @@
<varlistentry>
<term>
<constant>BBCODE_FLAGS_ARG_PARSING</constant>
- (<type>integer</type>)
+ (<type>integer</type>)
</term>
<listitem>
<simpara>
- This BBCode tag require argument subparsing (the argument is reparsed by
the BBCode extension).
+ This BBCode tag require argument sub-parsing (the argument is also parsed
by
+ the BBCode extension).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_FLAGS_CDATA_NOT_ALLOWED</constant>
- (<type>integer</type>)
+ (<type>integer</type>)
</term>
<listitem>
<simpara>
- This BBCode Tag does not accept content (it voids it automaticaly).
+ This BBCode Tag does not accept content (it voids it automatically).
</simpara>
</listitem>
</varlistentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bbcode/reference.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/bbcode/reference.xml
diff -u phpdoc/en/reference/bbcode/reference.xml:1.1
phpdoc/en/reference/bbcode/reference.xml:1.2
--- phpdoc/en/reference/bbcode/reference.xml:1.1 Tue Jul 24 12:13:12 2007
+++ phpdoc/en/reference/bbcode/reference.xml Tue Jul 24 21:55:02 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<!-- Membership: external, pecl -->
<reference xml:id="ref.bbcode" xmlns="http://docbook.org/ns/docbook";>
<title>BBCode Functions</title>
@@ -9,12 +9,12 @@
<section xml:id="bbcode.intro">
&reftitle.intro;
<para>
- The functions of this extensions are aimed to help parse BBCode text in
- order to convert it to HTML or another markup / markdown langage. It
uses
- a one pass parsing and provides great speed improvement over the common
- approach based on regular expressions. Further more, it helps provide
- valid HTML by reordering open / close tags and closing automaticaly
- unclosed tags.
+ This extension aims to help parse BBCode text in
+ order to convert it to HTML or another markup language. It uses
+ one pass parsing and provides great speed improvement over the common
+ approach based on regular expressions. Further more, it helps provide
+ valid HTML by reordering open / close tags and by automatically closing
+ unclosed tags.
</para>
</section>
@@ -29,8 +29,8 @@
<section xml:id="bbcode.resources">
&reftitle.resources;
<para>
- There is one resource used in BBCode extension: a BBCode_Container
- returned by <function>bbcode_create</function>.
+ One resource is used in the BBCode extension: a BBCode_Container
+ returned by <function>bbcode_create</function>.
</para>
</section>
<!-- Information found in constants.xml -->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bbcode/functions/bbcode-add-element.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/bbcode/functions/bbcode-add-element.xml
diff -u phpdoc/en/reference/bbcode/functions/bbcode-add-element.xml:1.1
phpdoc/en/reference/bbcode/functions/bbcode-add-element.xml:1.2
--- phpdoc/en/reference/bbcode/functions/bbcode-add-element.xml:1.1 Tue Jul
24 12:13:12 2007
+++ phpdoc/en/reference/bbcode/functions/bbcode-add-element.xml Tue Jul 24
21:55:02 2007
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.bbcode-add-element"
xmlns="http://docbook.org/ns/docbook";>
<refnamediv>
<refname>bbcode_add_element</refname>
- <refpurpose>Close fileinfo resource</refpurpose>
+ <refpurpose>Adds a bbcode element</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@@ -15,8 +15,7 @@
</methodsynopsis>
<para>
- This function adds a tag to an existing BBCode_Container tag_set see
- <function>bbcode_create</function> for the format needed for tag_rules
+ Adds a tag to an existing BBCode_Container tag_set using tag_rules.
</para>
</refsect1>
@@ -28,7 +27,7 @@
<term><parameter>bbcode_container</parameter></term>
<listitem>
<para>
- BBCode_Container resource returned by
<function>bbcode_create</function>.
+ BBCode_Container resource, returned by
<function>bbcode_create</function>.
</para>
</listitem>
</varlistentry>
@@ -36,7 +35,7 @@
<term><parameter>tag_name</parameter></term>
<listitem>
<para>
- The new tag to add to the BBCode_Container tag set.
+ The new tag to add to the BBCode_Container tag_set.
</para>
</listitem>
</varlistentry>
@@ -44,8 +43,8 @@
<term><parameter>tag_rules</parameter></term>
<listitem>
<para>
- An associative array containing the parsing rules see
- <function>bbcode_create</function> for the keys availables
+ An associative array containing the parsing rules; see
+ <function>bbcode_create</function> for the available keys.
</para>
</listitem>
</varlistentry>
@@ -81,3 +80,4 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
+
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bbcode/functions/bbcode-create.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/bbcode/functions/bbcode-create.xml
diff -u phpdoc/en/reference/bbcode/functions/bbcode-create.xml:1.2
phpdoc/en/reference/bbcode/functions/bbcode-create.xml:1.3
--- phpdoc/en/reference/bbcode/functions/bbcode-create.xml:1.2 Tue Jul 24
12:17:12 2007
+++ phpdoc/en/reference/bbcode/functions/bbcode-create.xml Tue Jul 24
21:55:02 2007
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.bbcode-create"
xmlns="http://docbook.org/ns/docbook";>
<refnamediv>
<refname>bbcode_create</refname>
- <refpurpose>Create a BBCode Ressource</refpurpose>
+ <refpurpose>Create a BBCode Resource</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@@ -13,7 +13,7 @@
</methodsynopsis>
<para>
- This function starts a new BBCode Ressource used to pars BBCode strings
+ This function returns a new BBCode Resource used to parse BBCode strings.
</para>
</refsect1>
@@ -25,74 +25,73 @@
<term><parameter>bbcode_initial_tags</parameter></term>
<listitem>
<para>
- It's an associative array containing tag name as keys and parameters
- needed to correctly parse BBCode as value in an associative array of
- the form:
+ An associative array containing the tag names as keys and parameters
+ required to correctly parse BBCode as their value. The following
key/value
+ pairs are supported:
<itemizedlist>
- <listitem>
- <simpara>
- <varname remap="structfield">flags</varname> optional - a
flag
+ <listitem>
+ <simpara>
+ <varname remap="structfield">flags</varname> optional - a flag
set based on the BBCODE_FLAGS_* constants.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- <varname remap="structfield">type</varname> needed - an int
- indicating the type of tag use the BBCODE_TYPE_* constants
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- <varname remap="structfield">open_tag</varname> needed - the
HTML
- replacement for the open tag.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- <varname remap="structfield">close_tag</varname> needed -
the HTML
- replacement for the close tag.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- <varname remap="structfield">default_arg</varname> optional
-
- it gives the default argument if tag_type is of type OPTARG
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- <varname remap="structfield">content_handling</varname>
optional -
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <varname remap="structfield">type</varname> required - an int
+ indicating the type of tag. Use the BBCODE_TYPE_* constants.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <varname remap="structfield">open_tag</varname> required - the HTML
+ replacement string for the open tag.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <varname remap="structfield">close_tag</varname> required - the HTML
+ replacement string for the close tag.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <varname remap="structfield">default_arg</varname> optional -
+ use this value as the default argument if none is provided and
+ tag_type is of type OPTARG.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <varname remap="structfield">content_handling</varname> optional -
Gives the name of the function used as callback for modification
of the content - currently only supports functions not methods.
- callback layout is: function name($content,$argument){return
- $content;}
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- <varname remap="structfield">param_handling</varname>
optional -
+ callback prototype is string name(string $content, string $argument)
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <varname remap="structfield">param_handling</varname> optional -
Gives the name of the function used as callback for modification
of the argument - currently only supports functions not methods.
- callback layout is: function name($content,$argument){return
- $parameter;}
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- <varname remap="structfield">childs</varname> optional -
List of
+ callback prototype is string name(string $content, string $argument)
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <varname remap="structfield">childs</varname> optional - List of
accepted childs for the tag. The format of the list is a comma
separated string. If the list starts with ! it will be the list of
rejected childs for the tag.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- <varname remap="structfield">parent</varname> optional -
List of
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <varname remap="structfield">parent</varname> optional - List of
accepted childs for the tag. The format of the list is a comma
separated string.
- </simpara>
- </listitem>
- </itemizedlist>
+ </simpara>
+ </listitem>
+ </itemizedlist>
</para>
</listitem>
</varlistentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bbcode/functions/bbcode-destroy.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/bbcode/functions/bbcode-destroy.xml
diff -u phpdoc/en/reference/bbcode/functions/bbcode-destroy.xml:1.1
phpdoc/en/reference/bbcode/functions/bbcode-destroy.xml:1.2
--- phpdoc/en/reference/bbcode/functions/bbcode-destroy.xml:1.1 Tue Jul 24
12:13:12 2007
+++ phpdoc/en/reference/bbcode/functions/bbcode-destroy.xml Tue Jul 24
21:55:02 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.bbcode-destroy"
xmlns="http://docbook.org/ns/docbook";>
<refnamediv>
<refname>bbcode_destroy</refname>
@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>bool</type><methodname>finfo_close</methodname>
+ <type>bool</type><methodname>bbcode_destroy</methodname>
<methodparam><type>resource</type><parameter>bbcode_container</parameter></methodparam>
</methodsynopsis>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bbcode/functions/bbcode-parse.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/bbcode/functions/bbcode-parse.xml
diff -u phpdoc/en/reference/bbcode/functions/bbcode-parse.xml:1.1
phpdoc/en/reference/bbcode/functions/bbcode-parse.xml:1.2
--- phpdoc/en/reference/bbcode/functions/bbcode-parse.xml:1.1 Tue Jul 24
12:13:12 2007
+++ phpdoc/en/reference/bbcode/functions/bbcode-parse.xml Tue Jul 24
21:55:02 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.bbcode_parse" xmlns="http://docbook.org/ns/docbook";>
<refnamediv>
<refname>bbcode_parse</refname>
@@ -15,7 +15,7 @@
<para>
This function parse the string to_parse following the rules in the
- bbcode_container created by bbcode_create
+ bbcode_container created by <function>bbcode_create</function>
</para>
</refsect1>
