pgsrc/Help%2FRedirectToPlugin

   1 Date: Mon,  9 Aug 2010 14:00:10 +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 When redirecting to another wiki page, a note is added to the top of the target
  15 page saying  //(Redirected from SomeRedirectingPage)//.
  16
  17
  18 == Arguments ==
  19
  20 Use only one of these arguments at a time.
  21
  22 {| class="bordered"
  23 |-
  24 ! Argument
  25 ! Description
  26 ! Default value
  27 |-
  28 | **page**
  29 | The page to redirect to (a wiki page name).
  30 | none
  31 |-
  32 | **href**
  33 | 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.)
  34 | none
  35 |}
  36
  37 == Caveats ==
  38
  39 The ~RedirectToPlugin invocation must be the first thing on a page.
  40 For most purposes it makes any other content on the page inaccessible.
  41
  42 == Example ==
  43
  44 A page may be made a alias for the HomePage by placing this code at the top:
  45 {{{
  46 <<RedirectTo page="HomePage">>
  47 }}}
  48
  49 To see the example in action, visit [[HomePageAlias]].
  50
  51 <noinclude>
  52 ----
  53 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
  54 </noinclude>