Wiki: DebugInfo: MagicPhpWikiURLs


Detailed view of a page, which is probably more useful for debugging than anything else.

Querying backend directly for 'MagicPhpWikiURLs'

get_pagedata('MagicPhpWikiURLs')
 _cached_html 
transformedtext Object
(
    [_type] => pagetype_wikitext Object
        (
        )

    [_basepage] => MagicPhpWikiURLs
    [_content] => Array
        (
            [0] => <div class="wikitext"><h2>About phpwiki: URLs</h2>
<p class="tightenable">A special type of URL is available for making links to perform
administrative and other special functions in 
            [1] => cached_wikilink Object
                (
                    [_page] => PhpWiki
                )

            [2] => .  Here is a
brief description of how they work.</p>
<p class="tightenable">The basic syntax of a phpwiki: URL is</p>
<pre class="tightenable">
<strong>phpwiki:</strong><em>pagename</em><strong>?</strong><em>query-args</em></pre>
<p class="tightenable">If <i>pagename</i> is omitted it defaults to the current page.</p>
<p class="tightenable"><i>Query-args</i> should be a set of parameters in standard HTTP GET
format.</p>
<p class="tightenable">The &quot;action=<em>x</em>&quot; parameter should almost always be given.  It can be one of
<strong>browse</strong>, <strong>diff</strong>, <strong>edit</strong>, <strong>viewsource</strong>,
<strong>zip</strong>, <strong>dumpserial</strong>, <strong>loadserial</strong>,
<strong>remove</strong>, <strong>lock</strong>, <strong>unlock</strong>,
<strong>login</strong>, <strong>logout</strong>, <strong>setprefs</strong> or <strong>save</strong>.
The default action is <strong>browse</strong>.</p>
<p class="tightenable">Some of the actions accept other parameters.</p>
<dl><dt class="tightenable"><strong>
            [3] => cached_wikilink Object
                (
                    [_page] => FullTextSearch
                )

            [4] => </strong>, <strong>
            [5] => cached_wikilink Object
                (
                    [_page] => TitleSearch
                )

            [6] => </strong></dt>
<dd class="tightenable">Accepts <strong>s</strong>=search term, and <strong>size</strong>=input size.</dd>
<dt class="tightenable"><strong>edit</strong></dt>
<dd class="tightenable">Accepts <strong>version</strong>.</dd>
<dt class="tightenable"><strong>remove</strong></dt>
<dd class="tightenable">Accepts <strong>verify</strong>.</dd>
<dt class="tightenable"><strong>save</strong></dt>
<dd class="tightenable">Accepts <strong>editversion</strong>, <strong>minor_edit</strong>, and  <strong>content</strong>.</dd>
<dt class="tightenable"><strong>setprefs</strong></dt>
<dd class="tightenable">Accepts <strong>edit_area_width</strong>, <strong>edit_area_height</strong>.</dd>
</dl>
<h3>Writing Magic Links in Wiki Pages</h3>
<p class="tightenable">A magic link looks like:</p>
<pre class="tightenable">
<strong>[</strong> <em>text</em> <strong>|</strong> <em>phpwiki-url</em> <strong>]</strong></pre>
<p class="tightenable">The &quot;<em>text</em> <b>|</b>&quot; is optional but usually recommended.  If given it
will provide the label for the link.</p>
<p class="tightenable">The <i>phpwiki-url</i> is a <b>phpwiki:</b> URL as described above.</p>
<h4>Some examples</h4>
<pre class="tightenable bottom">
[ Edit the SandBox | phpwiki:SandBox?action=edit ]</pre>
<p class="tightenable top">will generate a link which will take you directly to editing the

            [7] => cached_wikilink Object
                (
                    [_page] => SandBox
                )

            [8] => , like so: 
            [9] => cached_phpwikiurl Object
                (
                    [_url] => phpwiki:SandBox?action=edit
                    [_label] => Edit the SandBox
                )

            [10] => .</p>
<p class="tightenable bottom">Other possibilites:</p>
<ul><li class="tightenable top bottom">
            [11] => cached_phpwikiurl Object
                (
                    [_url] => phpwiki:SandBox?action=diff
                    [_label] => Diff the SandBox
                )

            [12] => ,</li>
<li class="tightenable top bottom">
            [13] => cached_phpwikiurl Object
                (
                    [_url] => phpwiki:HomePage?action=lock
                    [_label] => Lock the HomePage
                )

            [14] => ,</li>
<li class="tightenable top bottom">
            [15] => cached_phpwikiurl Object
                (
                    [_url] => phpwiki:?action=zip&include=all
                    [_label] => Get a Full Zip Dump
                )

            [16] => ,</li>
<li class="tightenable top">Search for 
            [17] => cached_phpwikiurl Object
                (
                    [_url] => phpwiki:?action=TitleSearch&s=wiki
                    [_label] => Page titles containing 'wiki'
                )

            [18] => </li>
</ul>
<h3>Writing Magic Forms in Wiki Pages</h3>
<p class="tightenable"><em><strong>Note</strong>: The old syntax for Magic forms is no longer supported.
They are superseded by <tt>&lt;?plugin-form&gt;</tt>.</em></p>
<p class="tightenable">If the plugin is called using <b>&lt;?plugin-form</b> instead of <b>&lt;?plugin</b>
and the plugin supports searching, then it will be rendered as a form.</p>
<dl><dt class="tightenable"><em>size</em></dt>
<dd class="tightenable">If given, specifies the size of the input area.</dd>
<dt class="tightenable"><em>s</em></dt>
<dd class="tightenable">Specifies the default value for the input.</dd>
</dl>
<h4>Examples:</h4>
<p class="tightenable">A search plugin invoked with <b>&lt;?plugin</b> instead of <b>&lt;?plugin-form</b>
simply inserts the search results of the plugin:</p>
<pre class="tightenable">
&lt;?plugin TitleSearch s=wiki noheader=true ?&gt;</pre>
<p class="tightenable">Search results for Page titles containing 'wiki':</p>

            [19] => cached_plugininvocation Object
                (
                    [_pi] => <?plugin TitleSearch s=wiki noheader=true ?>
                    [_tightenable] => 0
                )

            [20] => <pre class="tightenable">
&lt;?plugin-form FullTextSearch ?&gt;</pre>
<p class="tightenable">gives</p>

            [21] => cached_plugininvocation Object
                (
                    [_pi] => <?plugin-form FullTextSearch ?>
                    [_tightenable] => 0
                )

            [22] => <p class="tightenable">While</p>
<pre class="tightenable">
&lt;?plugin-form TitleSearch formsize=12 ?&gt;</pre>
<p class="tightenable">yields</p>

            [23] => cached_plugininvocation Object
                (
                    [_pi] => <?plugin-form TitleSearch formsize=12 ?>
                    [_tightenable] => 0
                )

            [24] => <hr />
<p class="tightenable bottom">
            [25] => cached_wikilink Object
                (
                    [_page] => PhpWikiDocumentation
                )

            [26] => </p>
</div>

        )

    [_description] => A special type of URL is available for making links to perform administrative and other special functions in PhpWiki.  Here is a brief description of how they work.
)
 hits  797
 locked  yes
get_versiondata('MagicPhpWikiURLs',1)
 %content  !!! About phpwiki: URLs A special type ...
 author  The PhpWiki programming team
 author_id  The PhpWiki programming team
 is_minor_edit   
 markup  2
 mtime  1082385961
 pagetype  wikitext

Copyright © 2007 RobertMelton.com