**The documentation on this site refers to version 0.22.0 alpha, released 2004-09-19, but the most recent version is 0.24.0 beta, released 2005-01-30.  The differences between the two are negligible.**

====== PEAR::Text_Wiki ======


=====  What Text_Wiki Does =====

The ''Text_Wiki'' package allows you to transform text structured using [[http://c2.com/cgi/wiki|Wiki]] rules into any defined target output format, such as XHTML, RTF, LaTeX, and so on.> **Note:** The current release only supports XHTML and plain-text output.  RTF, LaTeX, DocBook, and so on will be added as the codebase stabilizes and matures.''Text_Wiki'' achieves this level of flexibility by using one class for each part of the transformation process:
  * one class for parsing each markup rule (e.g., bold, code, wikilink, etc)
  * one class for rendering each general format (e.g., XHTML, DocBook, RTC, etc)
  * one class for rendering each rule in each format''Text_Wiki'' comes with its own set of markup rules (see the ]]), but you can write any rules you like to match whatever style you're used to.  ''Text_Wiki'' draws its default rules from a number of codebases, most notably [[http://tavi.sourceforge.net|WikkiTikkiTavi]] and [[http://develnet.org/|coWiki]]; while no code has been directly copied from those codebases, they were indispensible in learning how to process Wiki text.
=====  What Text_Wiki Does Not Do =====

The ''Text_Wiki'' package does not implement storage, saving, editing, diffs, page counts, and so on.  Those functions are more properly the domain of a full Wiki application and environment, which is outside the stated ''Text_Wiki'' goals (i.e., to transform Wiki text according to defined rules for a target output format).  You may wish to examine [[http://wiki.ciaweb.net/yawiki/index.php?wiki=Yawiki|Yawiki]] if you need a full Wiki system and not just a wiki parser.

[[text_wiki:howitworks]]

[[text_wiki:samplepage|Syntax examples]]


====== Methods ======

[[text_wiki:methodaddpath]]

[[text_wiki:methodchangerule]]

[[text_wiki:methoddeleterule]]

[[text_wiki:methoddisablerule]]

[[text_wiki:methodenablerule]]

[[text_wiki:methodgetformatconf]]

[[text_wiki:methodgetparseconf]]

[[text_wiki:methodgetpath]]

[[text_wiki:methodgetrenderconf]]

[[text_wiki:methodgetsource]]

[[text_wiki:methodgettokens]]

[[text_wiki:methodinsertrule]]

[[text_wiki:methodparse]]

[[text_wiki:methodrender]]

[[text_wiki:methodsetformatconf]]

[[text_wiki:methodsetparseconf]]

[[text_wiki:methodsetrenderconf]]

[[text_wiki:methodtextwiki]]

[[text_wiki:methodtransform]]

[[text_wiki:publicmethods]]

====== Rules ======

[[text_wiki:ruleanchor]]

[[text_wiki:ruleblockquote]]

[[text_wiki:rulebold]]

[[text_wiki:rulebreak]]

[[text_wiki:rulecenter]]

[[text_wiki:rulecode]]

[[text_wiki:rulecolortext]]

[[text_wiki:ruledeflist]]

[[text_wiki:ruledelimiter]]

[[text_wiki:ruleembed]]

[[text_wiki:ruleemphasis]]

[[text_wiki:ruleentities]]

[[text_wiki:rulefreelink]]

[[text_wiki:ruleheading]]

[[text_wiki:rulehoriz]]

[[text_wiki:rulehtml]]

[[text_wiki:ruleimage]]

[[text_wiki:ruleinclude]]

[[text_wiki:ruleinterwiki]]

[[text_wiki:ruleitalic]]

[[text_wiki:rulelist]]

[[text_wiki:rulenewline]]

[[text_wiki:ruleparagraph]]

[[text_wiki:rulephpcode]]

[[text_wiki:rulephplookup]]

[[text_wiki:ruleprefilter]]

[[text_wiki:ruleraw]]

[[text_wiki:rulerevise]]

[[text_wiki:rulestrong]]

[[text_wiki:rulesuperscript]]

[[text_wiki:ruletable]]

[[text_wiki:ruletighten]]

[[text_wiki:ruletoc]]

[[text_wiki:ruletranslatehtml]]

[[text_wiki:rulett]]

[[text_wiki:ruleurl]]

[[text_wiki:rulewikilink]]

====== Misc ======

[[text_wiki:smashwordstogether]]

[[text_wiki:todolist]]

[[text_wiki:userdocs]]

[[text_wiki:wikipage]]

[[text_wiki:wikirules]]

[[text_wiki:areamap]]

[[text_wiki:bugreports]]

[[text_wiki:downloadinstall]]