De Cock Xavier wrote:
void Tue Jul 24 12:13:12 2007 UTC
Added files:
/phpdoc/en/reference/bbcode .cvsignore configure.xml constants.xml
reference.xml
/phpdoc/en/reference/bbcode/functions bbcode-add-element.xml
bbcode-create.xml
bbcode-destroy.xml
bbcode-parse.xml
Log:
make test_xml && make html were successfull, commiting bbcode documentation
to CVS
* Hope i didn't make too many mistakes :/ *
I don't really know about mistakes, but it would be wise to re-read what
you wrote one last time before commiting it. This commit had a lot of
typos :)
I'll add a diff here so you know what I mean. Also, it's wise to be
consistent (eg. are we talking about a 'tag set' or a tag_set? You use
both interchangingly). I tired of rewriting descriptions after the
second function (sorry). Also, I've changed one file-description from
"Close fileinfo resource" to "Adds a bbcode element". Generally though,
please check your writing before commiting, preferably with a
spelling-checker aswell.
- Tul
P.S. It's great to see documentation written for pecl-extensions though!! :)
diff -u -r bbcode\constants.xml bbcode-2\constants.xml
--- bbcode\constants.xml Tue Jul 24 19:29:23 2007
+++ bbcode-2\constants.xml Tue Jul 24 19:12:47 2007
@@ -11,7 +11,7 @@
</term>
<listitem>
<simpara>
- This BBCode tag does not accept arguments.
+ This BBCode tag does not accept any arguments.
</simpara>
</listitem>
</varlistentry>
@@ -22,7 +22,7 @@
</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>
@@ -33,7 +33,7 @@
</term>
<listitem>
<simpara>
- This BBCode tag need an argument.
+ This BBCode tag needs an argument.
</simpara>
</listitem>
</varlistentry>
@@ -66,7 +66,7 @@
</term>
<listitem>
<simpara>
- This BBCode tag require argument subparsing (the argument is reparsed by
the BBCode extension).
+ This BBCode tag requires argument subparsing (the argument is reparsed by
the BBCode extension).
</simpara>
</listitem>
</varlistentry>
@@ -77,7 +77,7 @@
</term>
<listitem>
<simpara>
- This BBCode Tag does not accept content (it voids it automaticaly).
+ This BBCode Tag does not accept any content (it voids it automaticaly).
</simpara>
</listitem>
</varlistentry>
diff -u -r bbcode\functions\bbcode-add-element.xml
bbcode-2\functions\bbcode-add-element.xml
--- bbcode\functions\bbcode-add-element.xml Tue Jul 24 19:29:37 2007
+++ bbcode-2\functions\bbcode-add-element.xml Tue Jul 24 19:15:42 2007
@@ -3,7 +3,7 @@
<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>
diff -u -r bbcode\functions\bbcode-create.xml
bbcode-2\functions\bbcode-create.xml
--- bbcode\functions\bbcode-create.xml Tue Jul 24 19:29:32 2007
+++ bbcode-2\functions\bbcode-create.xml Tue Jul 24 19:18:28 2007
@@ -3,7 +3,7 @@
<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,9 +25,9 @@
<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>
@@ -37,26 +37,27 @@
</listitem>
<listitem>
<simpara>
- <varname remap="structfield">type</varname> needed - an int
- indicating the type of tag use the BBCODE_TYPE_* constants
+ <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> needed - the
HTML
- replacement for the open tag.
+ <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> needed -
the HTML
- replacement for the close tag.
+ <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
-
- it gives the default argument if tag_type is of type OPTARG
+ use this value as the default argument if none is provided
and
+ tag_type is of type OPTARG.
</simpara>
</listitem>
<listitem>
diff -u -r bbcode\reference.xml bbcode-2\reference.xml
--- bbcode\reference.xml Tue Jul 24 19:29:19 2007
+++ bbcode-2\reference.xml Tue Jul 24 19:13:47 2007
@@ -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 langage. 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 automaticaly closing
+ unclosed tags.
</para>
</section>
@@ -29,7 +29,7 @@
<section xml:id="bbcode.resources">
&reftitle.resources;
<para>
- There is one resource used in BBCode extension: a BBCode_Container
+ One resource is used in the BBCode extension: a BBCode_Container
returned by <function>bbcode_create</function>.
</para>
</section>
