From 1e068306f414190419b9b42007637aaedf612054 Mon Sep 17 00:00:00 2001
From: dairiki <dairiki@96ab9672-09ca-45d6-a79d-3d69d39ca109>
Date: Sat, 15 Feb 2003 23:56:05 +0000
Subject: [PATCH] Docs (& demo) for RedirectTo plugin.

git-svn-id: svn://svn.code.sf.net/p/phpwiki/code/trunk@2563 96ab9672-09ca-45d6-a79d-3d69d39ca109
---
 pgsrc/HomePageAlias    | 14 ++++++++++++++
 pgsrc/RedirectToPlugin | 40 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 54 insertions(+)
 create mode 100644 pgsrc/HomePageAlias
 create mode 100644 pgsrc/RedirectToPlugin

diff --git a/pgsrc/HomePageAlias b/pgsrc/HomePageAlias
new file mode 100644
index 000000000..8ff1b4bf5
--- /dev/null
+++ b/pgsrc/HomePageAlias
@@ -0,0 +1,14 @@
+Date: Sat, 15 Feb 2003 15:47:41 -0800
+Mime-Version: 1.0 (Produced by PhpWiki 1.3.4pre)
+Content-Type: application/x-phpwiki;
+  pagename=HomePageAlias;
+  pgsrc_version="1 $Revision: 1.1 $";
+  flags="";
+  lastmodified=1045352861;
+  markup=2;
+  charset=iso-8859-1
+Content-Transfer-Encoding: binary
+
+<?plugin RedirectTo page=HomePage ?>
+
+(This is a demonstration of the RedirectToPlugin.)
diff --git a/pgsrc/RedirectToPlugin b/pgsrc/RedirectToPlugin
new file mode 100644
index 000000000..9475b2484
--- /dev/null
+++ b/pgsrc/RedirectToPlugin
@@ -0,0 +1,40 @@
+Date: Sat, 15 Feb 2003 15:46:58 -0800
+Mime-Version: 1.0 (Produced by PhpWiki 1.3.4pre)
+Content-Type: application/x-phpwiki;
+  pagename=RedirectToPlugin;
+  pgsrc_version="1 $Revision: 1.1 $";
+  flags="";
+  lastmodified=1045352818;
+  markup=2;
+  charset=iso-8859-1
+Content-Transfer-Encoding: binary
+
+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:
+<verbatim>
+<?plugin RedirectTo page="HomePage" ?>
+</verbatim>
+
+To see the example in action, visit HomePageAlias.
+-----
+PhpWikiDocumentation
-- 
2.45.0