Diff: Help/RedirectToPlugin

Differences between current version and previous revision of Help/RedirectToPlugin.

Other diffs: Previous Major Revision, Previous Author

Newer page: version 6 Last edited on 17 January 2022 3:00 by harold
Older page: version 5 Last edited on 15 February 2003 23:46 by harold Revert
@@ -1,29 +1,44 @@
-The RedirectToPlugin can be used to redirect a user to another page.  
-In other words it makes a page an _ alias_ for another page. 
+The **~RedirectTo** [[Help:WikiPlugin|plugin]] can be used to redirect a user to another page.  
+In other words it makes a page an // alias// for another page. 
  
-! Arguments 
+When redirecting to another wiki page, a note is added to the top of the target  
+page saying //(Redirected from SomeRedirectingPage)//.  
+  
+Redirection to external URLs will only work on locked pages.  
+  
+== Arguments ==  
  
 Use only one of these arguments at a time. 
  
-page |  
- The page to redirect to (a wiki page name).  
-href |  
- 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.) 
+{ | class="bordered"  
+|-  
+! Argument  
+! Description  
+! Default value  
+|-  
+| **page**  
+| The page to redirect to (a wiki page name).  
+| none  
+|-  
+| **href**  
+| 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.)  
+| none  
+|}  
+  
+== Caveats ==  
  
-! Caveats  
+For most purposes, the ~RedirectToPlugin invocation makes any other content on the page inaccessible.  
  
-The RedirectToPlugin invocation must be the first thing on a page.  
-For most purposes it makes any other content on the page inaccessible.  
+== Example ==  
  
-! Example  
+A page may be made a alias for the [[HomePage]] by using this code:  
+{{{  
+<<RedirectTo page="HomePage">>  
+}}}  
  
-A page may be made a alias for the HomePage by placing this code at the top:  
-<verbatim>  
-<?plugin RedirectTo page="HomePage" ?>  
-</verbatim>  
+To see the example in action, visit [[HomePageAlias]].  
  
-To see the example in action, visit HomePageAlias.  
-- ----  
-PhpWikiDocumentation 
+<noinclude>  
+----  
+[[ PhpWikiDocumentation]] [[CategoryWikiPlugin]]  
+</noinclude>  

current version

The RedirectTo plugin can be used to redirect a user to another page. In other words it makes a page an alias for another page.

When redirecting to another wiki page, a note is added to the top of the target page saying (Redirected from SomeRedirectingPage).

Redirection to external URLs will only work on locked pages.

Arguments

Use only one of these arguments at a time.

Argument

Description

Default value

page

The page to redirect to (a wiki page name).

none

href

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.)

none

Caveats

For most purposes, the RedirectToPlugin invocation makes any other content on the page inaccessible.

Example

A page may be made a alias for the HomePage by using this code:

<<RedirectTo page="HomePage">>

To see the example in action, visit HomePageAlias.