pgsrc/Help%2FMagicPhpWikiURLs

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