diff --git a/reference/bbcode/constants.xml b/reference/bbcode/constants.xml index b14e55694f..9982289385 100644 --- a/reference/bbcode/constants.xml +++ b/reference/bbcode/constants.xml @@ -1,5 +1,5 @@ - +
&reftitle.constants; &extension.constants; @@ -7,29 +7,29 @@ BBCODE_TYPE_NOARG - (integer) + (integer) - This BBCode tag does not accept arguments. + This BBCode tag does not accept any arguments. BBCODE_TYPE_SINGLE - (integer) + (integer) - This BBCode tag does not have corresponding close tag. + This BBCode tag does not have a corresponding close tag. BBCODE_TYPE_ARG - (integer) + (integer) @@ -40,18 +40,18 @@ BBCODE_TYPE_OPTARG - (integer) + (integer) - This BBCode tag accepts an optional argument. + This BBCode tag accept an optional argument. BBCODE_TYPE_ROOT - (integer) + (integer) @@ -62,22 +62,23 @@ BBCODE_FLAGS_ARG_PARSING - (integer) + (integer) - 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). BBCODE_FLAGS_CDATA_NOT_ALLOWED - (integer) + (integer) - This BBCode Tag does not accept content (it voids it automaticaly). + This BBCode Tag does not accept content (it voids it automatically). diff --git a/reference/bbcode/functions/bbcode-add-element.xml b/reference/bbcode/functions/bbcode-add-element.xml index efa696ad2e..d803f4854e 100644 --- a/reference/bbcode/functions/bbcode-add-element.xml +++ b/reference/bbcode/functions/bbcode-add-element.xml @@ -1,9 +1,9 @@ - + bbcode_add_element - Close fileinfo resource + Adds a bbcode element &reftitle.description; @@ -15,8 +15,7 @@ - This function adds a tag to an existing BBCode_Container tag_set see - bbcode_create for the format needed for tag_rules + Adds a tag to an existing BBCode_Container tag_set using tag_rules. @@ -28,7 +27,7 @@ bbcode_container - BBCode_Container resource returned by bbcode_create. + BBCode_Container resource, returned by bbcode_create. @@ -36,7 +35,7 @@ tag_name - The new tag to add to the BBCode_Container tag set. + The new tag to add to the BBCode_Container tag_set. @@ -44,8 +43,8 @@ tag_rules - An associative array containing the parsing rules see - bbcode_create for the keys availables + An associative array containing the parsing rules; see + bbcode_create for the available keys. @@ -81,3 +80,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + diff --git a/reference/bbcode/functions/bbcode-create.xml b/reference/bbcode/functions/bbcode-create.xml index 9fd794a17d..8352cbd217 100644 --- a/reference/bbcode/functions/bbcode-create.xml +++ b/reference/bbcode/functions/bbcode-create.xml @@ -1,9 +1,9 @@ - + bbcode_create - Create a BBCode Ressource + Create a BBCode Resource &reftitle.description; @@ -13,7 +13,7 @@ - This function starts a new BBCode Ressource used to pars BBCode strings + This function returns a new BBCode Resource used to parse BBCode strings. @@ -25,74 +25,73 @@ bbcode_initial_tags - 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: - - - flags optional - a flag + + + flags optional - a flag set based on the BBCODE_FLAGS_* constants. - - - - - type needed - an int - indicating the type of tag use the BBCODE_TYPE_* constants - - - - - open_tag needed - the HTML - replacement for the open tag. - - - - - close_tag needed - the HTML - replacement for the close tag. - - - - - default_arg optional - - it gives the default argument if tag_type is of type OPTARG - - - - - content_handling optional - + + + + + type required - an int + indicating the type of tag. Use the BBCODE_TYPE_* constants. + + + + + open_tag required - the HTML + replacement string for the open tag. + + + + + close_tag required - the HTML + replacement string for the close tag. + + + + + default_arg optional - + use this value as the default argument if none is provided and + tag_type is of type OPTARG. + + + + + content_handling 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;} - - - - - param_handling optional - + callback prototype is string name(string $content, string $argument) + + + + + param_handling 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;} - - - - - childs optional - List of + callback prototype is string name(string $content, string $argument) + + + + + childs 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. - - - - - parent optional - List of + + + + + parent optional - List of accepted childs for the tag. The format of the list is a comma separated string. - - - + + + diff --git a/reference/bbcode/functions/bbcode-destroy.xml b/reference/bbcode/functions/bbcode-destroy.xml index aa98f5f12c..dc3c7fdf54 100644 --- a/reference/bbcode/functions/bbcode-destroy.xml +++ b/reference/bbcode/functions/bbcode-destroy.xml @@ -1,5 +1,5 @@ - + bbcode_destroy @@ -8,7 +8,7 @@ &reftitle.description; - boolfinfo_close + boolbbcode_destroy resourcebbcode_container diff --git a/reference/bbcode/functions/bbcode-parse.xml b/reference/bbcode/functions/bbcode-parse.xml index eead5af357..aa2049867d 100644 --- a/reference/bbcode/functions/bbcode-parse.xml +++ b/reference/bbcode/functions/bbcode-parse.xml @@ -1,5 +1,5 @@ - + bbcode_parse @@ -15,7 +15,7 @@ This function parse the string to_parse following the rules in the - bbcode_container created by bbcode_create + bbcode_container created by bbcode_create diff --git a/reference/bbcode/reference.xml b/reference/bbcode/reference.xml index c952ec26b4..3d55191299 100644 --- a/reference/bbcode/reference.xml +++ b/reference/bbcode/reference.xml @@ -1,5 +1,5 @@ - + BBCode Functions @@ -9,12 +9,12 @@
&reftitle.intro; - 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.
@@ -29,8 +29,8 @@
&reftitle.resources; - There is one resource used in BBCode extension: a BBCode_Container - returned by bbcode_create. + One resource is used in the BBCode extension: a BBCode_Container + returned by bbcode_create.