Classe: Text_Wiki_Rule  - X-Ref

Baseline rule class for extension into a "real" wiki rule.

Text_Wiki_Rule classes do not stand on their own; they are called by a
Text_Wiki object, typcially in the transform()method. Each rule class
performs three main activities: parse, process, and render.

The parse() method takes a regex and applies it to the whole block of
source text at one time. Each match is sent as $matches to the
process() method.

The process() method acts on the matched text from the source, and
then processes the source text is some way.  This may mean the
creation of a delimited token using addToken().  In every case, the
process() method returns the text that should replace the matched text
from parse().

Finally, the render*() methods take any token created by the rule and
creates output text matching a specific format.  Individual rules may
or may not have options for specific formats.

Typically, the extended rule only needs to define the process() and
render() methods; the parse() method is generally the same from rule
to rule, and has been included here.  However, there is no reason that
rules cannot override these methods, so long as the new methods operate
in substantially the same manner; similarly, the rule need not generate
any tokens at all, and may use a specialized parse() method to filter
the source text.  See the default rule classes for many examples.