pgsrc/Help%2FMagicPhpWikiURLs

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