Wiki: DebugInfo: WikiPlugin

transformedtext Object
(
    [_type] => pagetype_wikitext Object
        (
        )

    [_basepage] => WikiPlugin
    [_content] => Array
        (
            [0] => <div class="wikitext"><p class="tightenable top">
            [1] => cached_wikilink Object
                (
                    [_page] => PhpWiki
                )

            [2] =>  supports plugins since 1.3.x</p>
<p class="tightenable">WikiPlugins allow one to easily add new types of dynamic content (as
well as other functionality) to wiki pages within 
            [3] => cached_wikilink Object
                (
                    [_page] => PhpWiki
                )

            [4] => .  In this
very wiki, the 
            [5] => cached_wikilink Object
                (
                    [_page] => RecentChanges
                )

            [6] => , 
            [7] => cached_wikilink Object
                (
                    [_page] => BackLinks
                )

            [8] => , 
            [9] => cached_wikilink Object
                (
                    [_page] => LikePages
                )

            [10] =>  and most other indexing
scheme pages are all implemented using plugins.</p>
<p class="tightenable">Sooner or later the old-style phpwiki: 
            [11] => cached_wikilink Object
                (
                    [_page] => MagicPhpWikiURLs
                )

            [12] =>  will be replaced
by plugins too.</p>
<h2>Example</h2>
<p class="tightenable">Currently, one invokes a plugin by putting something like:</p>
<pre class="tightenable">
&lt;?plugin BackLinks?&gt;</pre>
<p class="tightenable">into a regular wiki-page.  That particular example produces as list of
pages which link to the current page.  Here it is:</p>

            [13] => cached_plugininvocation Object
                (
                    [_pi] => <?plugin BackLinks?>
                    [_tightenable] => 0
                )

            [14] => <p class="tightenable">(This is great for Category and Topic pages.  You can use this to get
an automatic in-line listing of pages in the Category or Topic.)</p>
<h2>Details</h2>
<p class="tightenable">Plugins can take certain named arguments (most do).  The values of
these arguments can be determined four different ways.  In order of
precedence:</p>
<ol><li class="tightenable"><p class="tightenable top bottom">The plugin invocation can specify the value for an argument, like so:</p>
<pre class="tightenable top bottom">
&lt;?plugin BackLinks page=OtherPage ?&gt;</pre>
</li>
<li class="tightenable"><p class="tightenable top">The argument can be specified via an HTTP query argument.  This
doesn't happen (is not allowed) unless the argument is mentioned in
the plugin invocation:</p>
<pre class="tightenable bottom">
&lt;?plugin BackLinks page ?&gt;</pre>
</li>
<li class="tightenable"><p class="tightenable top">Default values specified in the plugin invocation:</p>
<pre class="tightenable bottom">
&lt;?plugin BackLinks page||=OtherPage ?&gt;</pre>
</li>
<li class="tightenable"><p class="tightenable top bottom">The plugin must supply default values for each argument it uses.
Such default args may be overriden by URL arguments like so:</p>
<pre class="tightenable top bottom">
  BackLinks?page=ThisPage&amp;sortby=-mtime</pre>
<p class="tightenable top bottom">(The 
            [15] => cached_wikilink Object
                (
                    [_page] => BackLinks
                )

            [16] =>  plugin uses the current page as the default value for
the <em>page</em> argument.)</p>
</li>
</ol>
<h2>There exist four basic types of plugins:</h2>
<p class="tightenable">All this plugins derive from 
            [17] => cached_wikilink Object
                (
                    [_page] => WikiPlugin
                )

            [18] =>  class extending the run method
which returns a object tree of HTML objects, and may react on any
provided arguments from the WikiPage (see the args below) or
optionally overridden by arguments from the url (GET or POST args) (if defined via '||=').</p>
<blockquote class="tightenable"><p class="tightenable top"><b>plugin-form</b> is used to display a input type=text box for the default argument.</p>
<p class="tightenable"><b>plugin-head</b> is used to pass special headers to the HTTP output only,
which might be needed for framesets, redirection (
            [19] => cached_wikilink Object
                (
                    [_page] => RedirectToPlugin
                )

            [20] => ) and inserting
global javascript. plugin-head is not called inside the body.</p>
<p class="tightenable bottom"><b>plugin-link</b> <i>describe me</i></p>
</blockquote>
<pre class="tightenable">
&lt;?plugin PluginName [args...] ?&gt;</pre>
<pre class="tightenable">
&lt;?plugin-form PluginName [args...] ?&gt;</pre>
<pre class="tightenable">
&lt;?plugin-link PluginName [args...] ?&gt;</pre>
<pre class="tightenable">
&lt;?plugin-head PluginName [args...] ?&gt;</pre>
<h2>Existing Plugins</h2>
<p class="tightenable">See 
            [21] => cached_wikilink Object
                (
                    [_page] => PluginManager
                )

            [22] =>  for the actual list. Most plugins have their own description page with the name <b>Plugin</b> appended.</p>
<ul><li class="tightenable bottom">
            [23] => cached_wikilink Object
                (
                    [_page] => AllPages
                )

            [24] => </li>
<li class="tightenable top bottom">
            [25] => cached_wikilink Object
                (
                    [_page] => AllUsers
                )

            [26] => </li>
<li class="tightenable top bottom">
            [27] => cached_wikilink Object
                (
                    [_page] => AuthorHistoryPlugin
                    [_label] => AuthorHistory
                )

            [28] => </li>
<li class="tightenable top bottom">
            [29] => cached_wikilink Object
                (
                    [_page] => BackLinks
                )

            [30] => </li>
<li class="tightenable top bottom">
            [31] => cached_wikilink Object
                (
                    [_page] => CacheTest
                )

            [32] => </li>
<li class="tightenable top bottom">
            [33] => cached_wikilink Object
                (
                    [_page] => CalendarPlugin
                    [_label] => Calendar
                )

            [34] => </li>
<li class="tightenable top bottom">
            [35] => cached_wikilink Object
                (
                    [_page] => CalendarListPlugin
                    [_label] => CalendarList
                )

            [36] => </li>
<li class="tightenable top bottom">
            [37] => cached_wikilink Object
                (
                    [_page] => CommentPlugin
                    [_label] => Comment
                )

            [38] => </li>
<li class="tightenable top bottom">
            [39] => cached_wikilink Object
                (
                    [_page] => EditMetaDataPlugin
                    [_label] => EditMetaData
                )

            [40] => </li>
<li class="tightenable top bottom">
            [41] => cached_wikilink Object
                (
                    [_page] => ExternalSearchPlugin
                    [_label] => ExternalSearch
                )

            [42] => </li>
<li class="tightenable top bottom">
            [43] => cached_wikilink Object
                (
                    [_page] => FrameIncludePlugin
                    [_label] => FrameInclude
                )

            [44] => </li>
<li class="tightenable top bottom">
            [45] => cached_wikilink Object
                (
                    [_page] => FullTextSearch
                )

            [46] => </li>
<li class="tightenable top bottom">
            [47] => cached_wikilink Object
                (
                    [_page] => FuzzyPages
                )

            [48] => </li>
<li class="tightenable top bottom">
            [49] => cached_wikilink Object
                (
                    [_page] => HelloWorldPlugin
                    [_label] => HelloWorld
                )

            [50] => </li>
<li class="tightenable top bottom">
            [51] => cached_wikilink Object
                (
                    [_page] => IncludePagePlugin
                    [_label] => IncludePage
                )

            [52] => </li>
<li class="tightenable top bottom">
            [53] => cached_wikilink Object
                (
                    [_page] => IncludeSiteMap
                )

            [54] => </li>
<li class="tightenable top bottom">
            [55] => cached_wikilink Object
                (
                    [_page] => InterWikiSearch
                )

            [56] => </li>
<li class="tightenable top bottom">
            [57] => cached_wikilink Object
                (
                    [_page] => LikePages
                )

            [58] => </li>
<li class="tightenable top bottom">
            [59] => cached_wikilink Object
                (
                    [_page] => ListSubpages
                )

            [60] => </li>
<li class="tightenable top bottom">
            [61] => cached_wikilink Object
                (
                    [_page] => MostPopular
                )

            [62] => </li>
<li class="tightenable top bottom">
            [63] => cached_wikilink Object
                (
                    [_page] => OldStyleTablePlugin
                    [_label] => OldStyleTable
                )

            [64] => </li>
<li class="tightenable top bottom">
            [65] => cached_wikilink Object
                (
                    [_page] => OrphanedPages
                )

            [66] => </li>
<li class="tightenable top bottom">
            [67] => cached_wikilink Object
                (
                    [_page] => PageDump
                )

            [68] => </li>
<li class="tightenable top bottom">
            [69] => cached_wikilink Object
                (
                    [_page] => PageGroupTest
                    [_label] => PageGroup
                )

            [70] => </li>
<li class="tightenable top bottom">
            [71] => cached_wikilink Object
                (
                    [_page] => PageHistory
                )

            [72] => </li>
<li class="tightenable top bottom">
            [73] => cached_wikilink Object
                (
                    [_page] => PageInfo
                )

            [74] => </li>
<li class="tightenable top bottom">
            [75] => cached_wikilink Object
                (
                    [_page] => PageTrail
                )

            [76] => </li>
<li class="tightenable top bottom">
            [77] => cached_wikilink Object
                (
                    [_page] => PhotoAlbumPlugin
                    [_label] => PhotoAlbum
                )

            [78] => </li>
<li class="tightenable top bottom">
            [79] => cached_wikilink Object
                (
                    [_page] => PhpHighlightPlugin
                    [_label] => PhpHighlight
                )

            [80] => </li>
<li class="tightenable top bottom">
            [81] => cached_wikilink Object
                (
                    [_page] => PhpWeatherPlugin
                    [_label] => PhpWeather
                )

            [82] => </li>
<li class="tightenable top bottom">
            [83] => cached_wikilink Object
                (
                    [_page] => PluginManager
                )

            [84] => </li>
<li class="tightenable top bottom">
            [85] => cached_wikilink Object
                (
                    [_page] => PrevNext
                )

            [86] => </li>
<li class="tightenable top bottom">
            [87] => cached_wikilink Object
                (
                    [_page] => RandomPage
                )

            [88] => </li>
<li class="tightenable top bottom">
            [89] => cached_wikilink Object
                (
                    [_page] => RawHtmlPlugin
                    [_label] => RawHtml
                )

            [90] => </li>
<li class="tightenable top bottom">
            [91] => cached_wikilink Object
                (
                    [_page] => RecentChanges
                )

            [92] => </li>
<li class="tightenable top bottom">
            [93] => cached_wikilink Object
                (
                    [_page] => RecentChangesCached
                )

            [94] => </li>
<li class="tightenable top bottom">
            [95] => cached_wikilink Object
                (
                    [_page] => RedirectToPlugin
                    [_label] => RedirectTo
                )

            [96] => </li>
<li class="tightenable top bottom">
            [97] => cached_wikilink Object
                (
                    [_page] => RichTablePlugin
                    [_label] => RichTable
                )

            [98] => </li>
<li class="tightenable top bottom">
            [99] => cached_wikilink Object
                (
                    [_page] => SiteMap
                )

            [100] => </li>
<li class="tightenable top bottom">
            [101] => cached_wikilink Object
                (
                    [_page] => SystemInfoPlugin
                    [_label] => SystemInfo
                )

            [102] => </li>
<li class="tightenable top bottom">
            [103] => cached_wikilink Object
                (
                    [_page] => TexToPng
                )

            [104] => </li>
<li class="tightenable top bottom">
            [105] => cached_wikilink Object
                (
                    [_page] => TitleSearch
                )

            [106] => </li>
<li class="tightenable top bottom">
            [107] => cached_wikilink Object
                (
                    [_page] => TranscludePlugin
                    [_label] => Transclude
                )

            [108] => </li>
<li class="tightenable top bottom">
            [109] => cached_wikilink Object
                (
                    [_page] => UnfoldSubpagesPlugin
                    [_label] => UnfoldSubpages
                )

            [110] => </li>
<li class="tightenable top bottom">
            [111] => cached_wikilink Object
                (
                    [_page] => UpLoad
                )

            [112] => </li>
<li class="tightenable top bottom">
            [113] => cached_wikilink Object
                (
                    [_page] => UserPreferences
                )

            [114] => </li>
<li class="tightenable top bottom">
            [115] => cached_wikilink Object
                (
                    [_page] => VisualWiki
                )

            [116] => </li>
<li class="tightenable top bottom">
            [117] => cached_wikilink Object
                (
                    [_page] => WantedPages
                )

            [118] => </li>
<li class="tightenable top bottom">
            [119] => cached_wikilink Object
                (
                    [_page] => PhpWikiAdministration/Chmod
                    [_label] => WikiAdminChmod
                )

            [120] => </li>
<li class="tightenable top bottom">
            [121] => cached_wikilink Object
                (
                    [_page] => PhpWikiAdministration/Remove
                    [_label] => WikiAdminRemove
                )

            [122] => </li>
<li class="tightenable top bottom">
            [123] => cached_wikilink Object
                (
                    [_page] => PhpWikiAdministration/Rename
                    [_label] => WikiAdminRename
                )

            [124] => </li>
<li class="tightenable top bottom">
            [125] => cached_wikilink Object
                (
                    [_page] => PhpWikiAdministration/Replace
                    [_label] => WikiAdminSearchReplace
                )

            [126] => </li>
<li class="tightenable top bottom">
            [127] => cached_wikilink Object
                (
                    [_page] => PhpWikiAdministration
                    [_anchor] => Page Explorer
                    [_label] => WikiAdminSelect
                )

            [128] => </li>
<li class="tightenable top bottom">
            [129] => cached_wikilink Object
                (
                    [_page] => PhpWikiAdministration
                    [_anchor] => PhpWiki Internals
                    [_label] => WikiAdminUtils
                )

            [130] => </li>
<li class="tightenable top bottom">
            [131] => cached_wikilink Object
                (
                    [_page] => WikiBlogPlugin
                    [_label] => WikiBlog
                )

            [132] => </li>
<li class="tightenable top bottom">
            [133] => cached_wikilink Object
                (
                    [_page] => WikiForm
                )

            [134] => </li>
<li class="tightenable top bottom">_
            [135] => cached_wikilink Object
                (
                    [_page] => AuthInfo
                )

            [136] => </li>
<li class="tightenable top bottom">_
            [137] => cached_wikilink Object
                (
                    [_page] => BackendInfo
                )

            [138] => </li>
<li class="tightenable top bottom">_
            [139] => cached_wikilink Object
                (
                    [_page] => PreferencesInfo
                )

            [140] => </li>
<li class="tightenable top">text2png</li>
</ul>
<h2>More Ideas for Plugins</h2>
<ul><li class="tightenable bottom">Integrate Search form with individual 
            [141] => cached_wikilink Object
                (
                    [_page] => InterWiki
                )

            [142] =>  map entries
e.g. Search Php Website for:[ ] (Search)</li>
<li class="tightenable top bottom">Various other indexing schemes.</li>
<li class="tightenable top bottom">Diff</li>
<li class="tightenable top bottom">
            [143] => cached_wikilink Object
                (
                    [_page] => PdfOut
                )

            [144] => : action handler for 
            [145] => cached_wikilink Object
                (
                    [_page] => PrintAsPdf
                )

            [146] =>  or 
            [147] => cached_wikilink Object
                (
                    [_page] => DumpToPdf
                )

            [148] => </li>
<li class="tightenable top">Insert XML/RSS/RDF news content from <tt>location=xxx</tt> where location
is a parameter to the plugin, maybe include some formatting control
of the output generated.</li>
</ul>
<hr />
<p class="tightenable">Pages in this category:</p>

            [149] => cached_plugininvocation Object
                (
                    [_pi] => <?plugin BackLinks page=[pagename] noheader=1?>
                    [_tightenable] => 0
                )

            [150] => <ul><li class="tightenable bottom">
            [151] => cached_wikilink Object
                (
                    [_page] => FullTextSearch
                )

            [152] => : 
            [153] => cached_wikilink Object
                (
                    [_page] => FindPage
                )

            [154] => </li>
<li class="tightenable top">
            [155] => cached_wikilink Object
                (
                    [_page] => TitleSearch
                )

            [156] => : 
            [157] => cached_wikilink Object
                (
                    [_page] => LikePages
                )

            [158] =>  (match_head, match_tail).</li>
</ul>
<hr />
<p class="tightenable">
            [159] => cached_wikilink Object
                (
                    [_page] => PhpWikiDocumentation
                )

            [160] => </p>
<p class="tightenable">&lt;small&gt;
            [161] => cached_wikilink Object
                (
                    [_page] => P
                )

            [162] => 

            [163] => cached_wikilink Object
                (
                    [_page] => |
                )

            [164] => </p>
<p class="tightenable">obedience torturing dogboy cuckolded 
            [165] => cached_externallink Object
                (
                    [_url] => http://web.archive.org/web/20060708155957/http://www.bfu.bg/site/files/?cla6/femdomsubmissive
                    [_label] => cruella
                )

            [166] =>  sissy</p>
<p class="tightenable">big natural tits tits com little nipples celebrity nipples 
            [167] => cached_externallink Object
                (
                    [_url] => http://web.archive.org/web/20060707153111/http://www.bfu.bg/site/files/?cla6/bobsnipples
                    [_label] => long hard nipples
                )

            [168] =>  longest nipples</p>
<p class="tightenable">dirty schoolgirls sexy asian schoolgirls schoolgirls teen schoolgirls in panties 
            [169] => cached_externallink Object
                (
                    [_url] => http://web.archive.org/web/20060202101352/http://www.network54.com/index/56797
                    [_label] => schoolgirl
                )

            [170] =>  kogal</p>
<p class="tightenable">lesbians sex porn lesbian ass lesbian porn movies lesbian sex video 
            [171] => cached_externallink Object
                (
                    [_url] => http://web.archive.org/web/20060202100902/http://www.network54.com/index/56740
                    [_label] => sluts lesbians
                )

            [172] =>  oregon lesbians</p>
<p class="tightenable">buy dvd online dvd manga dvd filme dvd filme 
            [173] => cached_externallink Object
                (
                    [_url] => http://web.archive.org/web/20060202093732/http://www.network54.com/index/56706
                    [_label] => film to dvd
                )

            [174] =>  top dvds</p>
<p class="tightenable">girls in spandex leggings ass spandex mens leggings 
            [175] => cached_externallink Object
                (
                    [_url] => http://web.archive.org/web/20060206150238/http://www.network54.com/index/56759
                    [_label] => spandex leggings
                )

            [176] =>  lycra shirt</p>
<p class="tightenable">smelly feet fetish hentai foot fetish foot fetish gallery feet fetish 
            [177] => cached_externallink Object
                (
                    [_url] => http://web.archive.org/web/20060206124336/http://www.network54.com/index/56715
                    [_label] => foot fetish clip
                )

            [178] =>  feet nylon fetish</p>
<p class="tightenable">corporal punishment corporal punishment caning dvd whipping cream 
            [179] => cached_externallink Object
                (
                    [_url] => http://web.archive.org/web/20060203031734/http://www.network54.com/index/56790
                    [_label] => caning severe
                )

            [180] =>  caned</p>
<p class="tightenable bottom">&lt;/small&gt;</p>
</div>

        )

    [_description] => WikiPlugins allow one to easily add new types of dynamic content (as well as other functionality) to wiki pages within PhpWiki.  In this very wiki, the RecentChanges, BackLinks, LikePages and most other indexing scheme pages are all implemented using plugins.
)