pgsrc/Help%2FRedirectToPlugin

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