pgsrc/Help%2FRedirectToPlugin

   1 Date: Sat, 15 Feb 2003 15:46:58 -0800
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.4pre)
   3 Content-Type: application/x-phpwiki;
   4   pagename=Help%2FRedirectToPlugin;
   5   pgsrc_version="1 $Revision: 1.1 $";
   6   flags="";
   7   lastmodified=1045352818;
   8   markup=2;
   9   charset=iso-8859-1
  10 Content-Transfer-Encoding: binary
  11
  12 The RedirectToPlugin can be used to redirect a user to another page.
  13 In other words it makes a page an _alias_ for another page.
  14
  15 ! Arguments
  16
  17 Use only one of these arguments at a time.
  18
  19 page |
  20   The page to redirect to (a wiki page name).
  21 href |
  22   An external URL to redirect to.  Redirection to external URLs will only work
  23   on locked pages.  (If the URL contains funny characters, you'll probably have
  24   to put quotes around the URL.)
  25
  26 ! Caveats
  27
  28 The RedirectToPlugin invocation must be the first thing on a page.
  29 For most purposes it makes any other content on the page inaccessible.
  30
  31 ! Example
  32
  33 A page may be made a alias for the HomePage by placing this code at the top:
  34 <verbatim>
  35 <?plugin RedirectTo page="HomePage" ?>
  36 </verbatim>
  37
  38 To see the example in action, visit HomePageAlias.
  39 -----
  40 PhpWikiDocumentation