pgsrc/Help%2FMagicPhpWikiURLs

   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;
   6   charset=UTF-8
   7 Content-Transfer-Encoding: binary
   8
   9 == About phpwiki: URLs ==
  10
  11 A special type of URL is available for making links to perform
  12 administrative and other special functions in ~PhpWiki.  Here is a
  13 brief description of how they work.
  14
  15 The basic syntax of a phpwiki: URL is
  16
  17 <pre>
  18 **phpwiki:**//pagename//**?**//query-args//
  19 </pre>
  20
  21 If //pagename// is omitted it defaults to the current page.
  22
  23 //Query-args// should be a set of parameters in standard HTTP GET
  24 format.
  25
  26 The "action=//x//" parameter should almost always be given.  It can be one of
  27 **browse**, **diff**, **edit**, **viewsource**,
  28 **zip**, **dumpserial**, **loadserial**,
  29 **remove**, **lock**, **unlock**,
  30 **login**, **logout**, **setprefs** or **save**.
  31 The default action is **browse**.
  32
  33 Some of the actions accept other parameters.
  34
  35 | **FullTextSearch**, **TitleSearch** | Accepts **s**=search term, and **size**=input size.
  36 | **edit**                            | Accepts **version**.
  37 | **remove**                          | Accepts **verify**.
  38 | **save**                            | Accepts **editversion**, **minor_edit**, and  **content**.
  39 | **setprefs**                        | Accepts **edit_area_width**, **edit_area_height**.
  40
  41 === Writing Magic Links in Wiki Pages ===
  42
  43 A magic link looks like:
  44
  45 <pre>
  46 **~[** //text// **|** //phpwiki-url// **]**
  47 </pre>
  48
  49 The "//text// **|**" is optional but usually recommended.  If given it
  50 will provide the label for the link.
  51
  52 The //phpwiki-url// is a **phpwiki:** URL as described above.
  53
  54 ==== Some examples ====
  55
  56 {{{
  57 [ Edit the SandBox | phpwiki:SandBox?action=edit ]
  58 }}}
  59 will generate a link which will take you directly to editing the
  60 SandBox, like so: [Edit the SandBox | phpwiki:SandBox?action=edit].
  61
  62 Other possibilites:
  63 * [ Diff the SandBox | phpwiki:SandBox?action=diff ],
  64 * [ Lock the HomePage | phpwiki:HomePage?action=lock ],
  65 * [ Get a Full Zip Dump | phpwiki:?action=zip&include=all ],
  66 * Search for [ Page titles containing 'wiki' | phpwiki:?action=TitleSearch&s=wiki ]
  67
  68 === Writing Magic Forms in Wiki Pages ===
  69
  70 **//Note://** //The old syntax for Magic forms is no longer supported.
  71 They are superseded by// ##<?plugin-form>##.
  72
  73 If the plugin is called using **<?plugin-form** instead of **<?plugin**
  74 and the plugin supports searching, then it will be rendered as a form.
  75
  76 | //size// | If given, specifies the size of the input area.
  77 | //s//    | Specifies the default value for the input.
  78
  79 ==== Examples ====
  80
  81 A search plugin invoked with **<?plugin** instead of **<?plugin-form**
  82 simply inserts the search results of the plugin:
  83
  84 {{{
  85 <<TitleSearch s=wiki noheader=true limit=10>>
  86 }}}
  87
  88 Search results for Page titles containing 'wiki':
  89
  90 <<TitleSearch s=wiki noheader=true limit=10>>
  91
  92 {{{
  93 <?plugin-form FullTextSearch ?>
  94 }}}
  95
  96 gives
  97
  98 <?plugin-form FullTextSearch ?>
  99
 100 While
 101
 102 {{{
 103 <?plugin-form TitleSearch formsize=12 ?>
 104 }}}
 105
 106 yields
 107
 108 <?plugin-form TitleSearch formsize=12 ?>
 109
 110 <noinclude>
 111 ----
 112 [[PhpWikiDocumentation]]
 113 </noinclude>