pgsrc/MagicPhpWikiURLs

   1 Mime-Version: 1.0 (Produced by PhpWiki 1.3.2-jeffs-hacks+carsten's-binary-hack)
   2 X-RCS_ID: $Id: MagicPhpWikiURLs,v 1.7 2002-01-12 17:46:02 carstenklapp Exp $
   3 Content-Type: application/x-phpwiki;
   4   pagename=MagicPhpWikiURLs;
   5   flags=PAGE_LOCKED;
   6   lastmodified=1010855478;
   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   __phpwiki:__''pagename''__?__''query-args''
  17
  18 If ''pagename'' is omitted it defaults to the current page.
  19
  20 ''Query-args'' should be a set of parameters in standard
  21 HTTP GET format.
  22
  23 The "action=''x''" parameter should almost always be given.  It can be one of
  24 __browse__, __info__, __diff__, __search__, __edit__,
  25 __zip__, __dumpserial__, __loadserial__,
  26 __remove__, __lock__, __unlock__,
  27 __login__, __logout__, __setprefs__ or __save__.
  28 The default action is __browse__.
  29
  30 Some of the actions accept other parameters.
  31
  32 ;__info__: Accepts __showpagesource__.
  33 ;__search__: Accepts __searchterm__, and __searchtype__.
  34 ;__edit__: Accepts __version__.
  35 ;__remove__: Accepts __verify__.
  36 ;__save__: Accepts __editversion__, __minor_edit__, and  __content__.
  37 ;__setprefs__: Accepts __edit_area_width__, __edit_area_height__.
  38
  39
  40 !! Writing Magic Links in Wiki Pages
  41
  42 A magic link looks like:
  43
  44   __[[__ ''text'' __|__ ''phpwiki-url'' __]__
  45
  46 The "''text'' __|__" is optional but usually recommended.
  47 If given it will provide the label for the link.
  48
  49 The ''phpwiki-url'' is a __phpwiki:__ URL as described above.
  50
  51 !Some examples
  52
  53   [[ Edit the !SandBox | phpwiki:!SandBox?action=edit ]
  54 will generate a link which will take you directly to editing the SandBox, like so:
  55 [ Edit the SandBox | phpwiki:SandBox?action=edit ].
  56
  57 Other possibilites:
  58 * [ Diff the SandBox | phpwiki:SandBox?action=diff ],
  59 * [ Lock the HomePage | phpwiki:HomePage?action=lock ],
  60 * [ Get a Full Zip Dump | phpwiki:?action=zip&include=all ],
  61 * [ Page titles containing 'wiki' | phpwiki:TitleSearch?s=wiki ],
  62
  63 !! Writing Magic Forms in Wiki Pages
  64
  65 ''__Note__: Magic forms are on their way out, I think.  They are being superceded by <''''?plugin-form>s.''
  66
  67 If one of the ''query-args'' has a value like
  68   ''arg''__=__''opt-width''__(__''opt-dflt-val''__)__
  69 the link will be rendered as a form, rather than as an anchor.
  70
  71 ''Opt-width'', if given specifies the size of the input area, while
  72 ''opt-dflt-val'' specifies the default value for the input.
  73 If ''text'' is given in the link, then a submit-button with that
  74 label will be included in the form, otherwise the submit button
  75 will be omitted.
  76
  77 Examples:
  78
  79   [[ Full Search | phpwiki:FullTextSearch?s=() ]
  80 gives
  81 [ Full Search | phpwiki:FullTextSearch?s=() ]
  82
  83 While
  84   [[ phpwiki:TitleSearch?s=12() ]
  85 yields
  86 [ phpwiki:TitleSearch?s=12() ]
  87
  88 Other examples:
  89 [ Browse Page | phpwiki:?action=browse&pagename=() ]
  90 ----
  91 PhpWikiDocumentation