php-doc-en/reference/bbcode/constants.xml
Torben Wilson af4410a7e1 Normalized the sgml-default-dtd-file local-variable line for those
still using this, after discussion on the phpdoc list.
From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced.



git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
2009-09-25 07:04:39 +00:00

338 lines
8.2 KiB
XML

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision$ -->
<appendix xml:id="bbcode.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
<variablelist>
<varlistentry>
<term>
<constant>BBCODE_TYPE_NOARG</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
This BBCode tag does not accept any arguments.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_TYPE_SINGLE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
This BBCode tag does not have a corresponding close tag.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_TYPE_ARG</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
This BBCode tag need an argument.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_TYPE_OPTARG</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
This BBCode tag accept an optional argument.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_TYPE_ROOT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
This BBCode tag is the special tag root (nesting level 0).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_FLAGS_ARG_PARSING</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
This BBCode tag require argument sub-parsing (the argument is also parsed by
the BBCode extension). As Of 0.10.2 another parser can be used as argument parser.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_FLAGS_CDATA_NOT_ALLOWED</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
This BBCode Tag does not accept content (it voids it automatically).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_FLAGS_SMILEYS_ON</constant>
(<type>integer</type>) - since 0.10.2
</term>
<listitem>
<simpara>
This BBCode Tag accepts smileys.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_FLAGS_SMILEYS_OFF</constant>
(<type>integer</type>) - since 0.10.2
</term>
<listitem>
<simpara>
This BBCode Tag does not accept smileys.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_FLAGS_ONE_OPEN_PER_LEVEL</constant>
(<type>integer</type>) - since 0.10.2
</term>
<listitem>
<simpara>
This BBCode Tag automatically closes if another tag of
the same type is found at the same nesting level.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_FLAGS_REMOVE_IF_EMPTY</constant>
(<type>integer</type>) - since 0.10.2
</term>
<listitem>
<simpara>
This BBCode Tag is automatically removed
if content is empty it allows to produce lighter HTML.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_FLAGS_DENY_REOPEN_CHILD</constant>
(<type>integer</type>) - since 0.10.3
</term>
<listitem>
<simpara>
This BBCode Tag does not allow unclosed children to
reopen when automatically closed.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_ARG_DOUBLE_QUOTE</constant>
(<type>integer</type>) - since 0.10.2
</term>
<listitem>
<simpara>
This is a parser option allowing argument quoting with
double quotes (")
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_ARG_SINGLE_QUOTE</constant>
(<type>integer</type>) - since 0.10.2
</term>
<listitem>
<simpara>
This is a parser option allowing argument quoting with
single quotes (')
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_ARG_HTML_QUOTE</constant>
(<type>integer</type>) - since 0.10.2
</term>
<listitem>
<simpara>
This is a parser option allowing argument quoting with
HTML version of double quotes (&amp;quot;)
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_ARG_QUOTE_ESCAPING</constant>
(<type>integer</type>) - since 1.0.2
</term>
<listitem>
<simpara>
This is a parser option allowing argument quotes to be
escaped this permit the quote delimiter to be found in
the string escaping character is \ it can escape any
quoting character or itself, if found in front of a non
escapable character, it will be dropped.
Default behaviour is not to use escaping.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_AUTO_CORRECT</constant>
(<type>integer</type>) - since 0.10.2
</term>
<listitem>
<simpara>
This is a parser option changing the way errors are
treated. It automatically closes tag in the order they
are opened. And treat tags with only an open tag as if
there were a close tag present.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_CORRECT_REOPEN_TAGS</constant>
(<type>integer</type>) - since 0.10.2
</term>
<listitem>
<simpara>
This is a parser option changing the way errors are
treated. It automatically reopens tag if close tags are
not in the good order.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_DISABLE_TREE_BUILD</constant>
(<type>integer</type>) - since 0.10.2
</term>
<listitem>
<simpara>
This is a parser option disabling the BBCode parsing
it can be useful if only the "smiley" replacement must
be used.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_DEFAULT_SMILEYS_ON</constant>
(<type>integer</type>) - since 0.10.2
</term>
<listitem>
<simpara>
This is a parser option setting smileys to ON if no
flag is given at tag level.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_DEFAULT_SMILEYS_OFF</constant>
(<type>integer</type>) - since 0.10.2
</term>
<listitem>
<simpara>
This is a parser option setting smileys to OFF if no
flag is given at tag level.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_FORCE_SMILEYS_OFF</constant>
(<type>integer</type>) - since 0.10.2
</term>
<listitem>
<simpara>
This is a parser option disabling completely the
smileys parsing.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_SMILEYS_CASE_INSENSITIVE</constant>
(<type>integer</type>) - since 0.10.3
</term>
<listitem>
<simpara>
Use a case insensitive Detection for smileys
instead of a simple binary search.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_SET_FLAGS_SET</constant>
(<type>integer</type>) - since 0.10.2
</term>
<listitem>
<simpara>
This permits to SET the complete flag set on a parser.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_SET_FLAGS_ADD</constant>
(<type>integer</type>) - since 0.10.2
</term>
<listitem>
<simpara>
This permits to switch a flag set ON on a parser.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>BBCODE_SET_FLAGS_REMOVE</constant>
(<type>integer</type>) - since 0.10.2
</term>
<listitem>
<simpara>
This permits to switch a flag set OFF on a parser.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->