pgsrc/Help%2FMagicPhpWikiURLs

   1 Date: Wed, 28 May 2008 19:06:22 +0200
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
   3 Content-Type: application/x-phpwiki;
   4   pagename=Help%2FMagicPhpWikiURLs;
   5   flags=PAGE_LOCKED;
   6   markup=2;
   7   charset=iso-8859-1
   8 Content-Transfer-Encoding: binary
   9
  10 !!! About phpwiki: URLs
  11
  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.
  15
  16 The basic syntax of a phpwiki: URL is
  17
  18 <pre>
  19 __phpwiki:__''pagename''__?__''query-args''
  20 </pre>
  21
  22 If _pagename_ is omitted it defaults to the current page.
  23
  24 _Query-args_ should be a set of parameters in standard HTTP GET
  25 format.
  26
  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__.
  33
  34 Some of the actions accept other parameters.
  35
  36 __FullTextSearch__, __TitleSearch__:
  37
  38   Accepts __s__=search term, and __size__=input size.
  39
  40 __edit__:
  41
  42   Accepts __version__.
  43
  44 __remove__:
  45
  46   Accepts __verify__.
  47
  48 __save__:
  49
  50   Accepts __editversion__, __minor_edit__, and  __content__.
  51
  52 __setprefs__:
  53
  54   Accepts __edit_area_width__, __edit_area_height__.
  55
  56 !! Writing Magic Links in Wiki Pages
  57
  58 A magic link looks like:
  59
  60 <pre>
  61 __~[__ ''text'' __|__ ''phpwiki-url'' __]__
  62 </pre>
  63
  64 The "''text'' *|*" is optional but usually recommended.  If given it
  65 will provide the label for the link.
  66
  67 The _phpwiki-url_ is a *phpwiki:* URL as described above.
  68
  69 !Some examples
  70
  71 <verbatim>
  72 [ Edit the SandBox | phpwiki:SandBox?action=edit ]
  73 </verbatim>
  74 will generate a link which will take you directly to editing the
  75 SandBox, like so: [Edit the SandBox | phpwiki:SandBox?action=edit].
  76
  77 Other possibilites:
  78 * [ Diff the SandBox | phpwiki:SandBox?action=diff ],
  79 * [ Lock the HomePage | phpwiki:HomePage?action=lock ],
  80 * [ Get a Full Zip Dump | phpwiki:?action=zip&include=all ],
  81 * Search for [ Page titles containing 'wiki' | phpwiki:?action=TitleSearch&s=wiki ]
  82
  83 !! Writing Magic Forms in Wiki Pages
  84
  85 ''__Note__: The old syntax for Magic forms is no longer supported.
  86 They are superseded by =<?plugin-form>=.''
  87
  88 If the plugin is called using *<?plugin-form* instead of *<?plugin*
  89 and the plugin supports searching, then it will be rendered as a form.
  90
  91 ''size'':
  92
  93   If given, specifies the size of the input area.
  94
  95 ''s'':
  96
  97   Specifies the default value for the input.
  98
  99 !!! Examples:
 100
 101 A search plugin invoked with *<?plugin* instead of *<?plugin-form*
 102 simply inserts the search results of the plugin:
 103
 104 <verbatim>
 105 <?plugin TitleSearch s=wiki noheader=true ?>
 106 </verbatim>
 107
 108 Search results for Page titles containing 'wiki':
 109
 110 <?plugin TitleSearch s=wiki noheader=true ?>
 111
 112 <verbatim>
 113 <?plugin-form FullTextSearch ?>
 114 </verbatim>
 115
 116 gives
 117
 118 <?plugin-form FullTextSearch ?>
 119
 120 While
 121
 122 <verbatim>
 123 <?plugin-form TitleSearch formsize=12 ?>
 124 </verbatim>
 125
 126 yields
 127
 128 <?plugin-form TitleSearch formsize=12 ?>
 129
 130 ----
 131
 132 [PhpWikiDocumentation]