Diff: Help/RedirectToPlugin
Note: You are viewing an old revision of this page. View the current version.
Differences between version 5 and previous revision of Help/RedirectToPlugin.
Other diffs: Previous Major Revision, Previous Author
| Newer page: | version 5 | Last edited on 15 February 2003 23:46 | by harold | Revert |
| Older page: | version 4 | Last edited on 22 May 2014 3:01 | by harold | Revert |
@@ -1,44 +1,29 @@
-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.
+The RedirectToPlugin
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 ==
+!
Arguments
Use only one of these arguments at a time.
-{
| 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 ==
+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.)
-For most purposes, the ~RedirectToPlugin invocation makes any other content on the page inaccessible.
+! Caveats
-== Example ==
+The RedirectToPlugin invocation must be the first thing on a page.
+For most purposes it makes any other content on the page inaccessible.
-A page may be made a alias for the [[HomePage]] by using this code:
-{{{
-<<RedirectTo page="HomePage">>
-}}}
+! Example
-To see
the example in action, visit [[HomePageAlias]].
+A page may be made a alias for
the HomePage by placing this code at the top:
+<verbatim>
+<?plugin RedirectTo page="HomePage" ?>
+</verbatim>
-<noinclude>
-----
-[[
PhpWikiDocumentation]] [[CategoryWikiPlugin]]
-</noinclude>
+To see the example in action, visit HomePageAlias.
+-
----
+PhpWikiDocumentation
version 5
The RedirectToPlugin can be used to redirect a user to another page. In other words it makes a page an alias for another page.
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.) |
Caveats
The RedirectToPlugin invocation must be the first thing on a page. For most purposes it makes any other content on the page inaccessible.
Example
A page may be made a alias for the HomePage by placing this code at the top:
<?plugin RedirectTo page="HomePage" ?>
To see the example in action, visit HomePageAlias.
