pgsrc/Help%2FRedirectToPlugin

   1 Date: Wed, 19 May 2010 18:15:54 +0000
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0RC-20100415)
   3 X-Rcs-Id: $Id$
   4 Content-Type: application/x-phpwiki;
   5   pagename=Help%2FRedirectToPlugin;
   6   flags=PAGE_LOCKED%2CEXTERNAL_PAGE;
   7   markup=2;
   8   charset=UTF-8
   9 Content-Transfer-Encoding: binary
  10
  11 The **~RedirectTo** [[Help:WikiPlugin|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 {| class="bordered"
  19 |-
  20 ! Argument
  21 ! Description
  22 ! Default value
  23 |-
  24 | **page**
  25 | The page to redirect to (a wiki page name).
  26 | none
  27 |-
  28 | **href**
  29 | An external URL to redirect to.  Redirection to external URLs will only work on locked pages. (If the URL contains funny characters, you'll probably have to put quotes around the URL.)
  30 | none
  31 |}
  32
  33 == Caveats ==
  34
  35 The ~RedirectToPlugin invocation must be the first thing on a page.
  36 For most purposes it makes any other content on the page inaccessible.
  37
  38 == Example ==
  39
  40 A page may be made a alias for the HomePage by placing this code at the top:
  41 {{{
  42 <<RedirectTo page="HomePage">>
  43 }}}
  44
  45 To see the example in action, visit HomePageAlias.
  46
  47 <noinclude>
  48 ----
  49 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
  50 </noinclude>