1 Date: Fri, 10 Sep 2010 13:46:13 +0000
2 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0)
3 Content-Type: application/x-phpwiki;
4 pagename=Help%2FMagicPhpWikiURLs;
5 flags=PAGE_LOCKED%2CEXTERNAL_PAGE;
8 Content-Transfer-Encoding: binary
10 == About phpwiki: URLs ==
12 A special type of URL is available for making links to perform
13 administrative and other special functions in ~PhpWiki. Here is a
14 brief description of how they work.
16 The basic syntax of a phpwiki: URL is
19 **phpwiki:**//pagename//**?**//query-args//
22 If //pagename// is omitted it defaults to the current page.
24 //Query-args// should be a set of parameters in standard HTTP GET
27 The "action=//x//" parameter should almost always be given. It can be one of
28 **browse**, **diff**, **edit**, **viewsource**,
29 **zip**, **dumpserial**, **loadserial**,
30 **remove**, **lock**, **unlock**,
31 **login**, **logout**, **setprefs** or **save**.
32 The default action is **browse**.
34 Some of the actions accept other parameters.
36 | **FullTextSearch**, **TitleSearch** | Accepts **s**=search term, and **size**=input size.
37 | **edit** | Accepts **version**.
38 | **remove** | Accepts **verify**.
39 | **save** | Accepts **editversion**, **minor_edit**, and **content**.
40 | **setprefs** | Accepts **edit_area_width**, **edit_area_height**.
42 === Writing Magic Links in Wiki Pages ===
44 A magic link looks like:
47 **~[** //text// **|** //phpwiki-url// **]**
50 The "//text// **|**" is optional but usually recommended. If given it
51 will provide the label for the link.
53 The //phpwiki-url// is a **phpwiki:** URL as described above.
55 ==== Some examples ====
58 [ Edit the SandBox | phpwiki:SandBox?action=edit ]
60 will generate a link which will take you directly to editing the
61 SandBox, like so: [Edit the SandBox | phpwiki:SandBox?action=edit].
64 * [ Diff the SandBox | phpwiki:SandBox?action=diff ],
65 * [ Lock the HomePage | phpwiki:HomePage?action=lock ],
66 * [ Get a Full Zip Dump | phpwiki:?action=zip&include=all ],
67 * Search for [ Page titles containing 'wiki' | phpwiki:?action=TitleSearch&s=wiki ]
69 === Writing Magic Forms in Wiki Pages ===
71 **//Note://** //The old syntax for Magic forms is no longer supported.
72 They are superseded by// ##<?plugin-form>##.
74 If the plugin is called using **<?plugin-form** instead of **<?plugin**
75 and the plugin supports searching, then it will be rendered as a form.
77 | //size// | If given, specifies the size of the input area.
78 | //s// | Specifies the default value for the input.
82 A search plugin invoked with **<?plugin** instead of **<?plugin-form**
83 simply inserts the search results of the plugin:
86 <<TitleSearch s=wiki noheader=true limit=10>>
89 Search results for Page titles containing 'wiki':
91 <<TitleSearch s=wiki noheader=true limit=10>>
94 <?plugin-form FullTextSearch ?>
99 <?plugin-form FullTextSearch ?>
104 <?plugin-form TitleSearch formsize=12 ?>
109 <?plugin-form TitleSearch formsize=12 ?>
113 [[PhpWikiDocumentation]]