Difference: MovedSkin (1 vs. 2)

Revision 22018-07-06 - TWikiContributor

MovedSkin

<--
   Contributions to this skin are appreciated. Please update the skin page at
   http://twiki.org/cgi-bin/view/Plugins/MovedSkin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/MovedSkinDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Page contents

Inform users that a TWiki site has moved to a new location

Overview

Sometimes a TWiki site is migrated to a new location with a new URL. For convenience users visiting the old site should find the new site. When this skin is installed and enabled at the old TWiki site, users will see a yellow moved message box instead of page content. A configurable MOVEDMESSAGE is set to inform users of the new location.

For scheduled downtime & temporary maintenance it is better to use the read-only skin mode of the TopMenuSkin or PatternSkin instead of this MovedSkin. For this, define a BROADCASTMESSAGE setting and a Set READONLYSKINMODE = 1 setting in Main.TWikiPreferences.

Screenshot

Installation

Note: You do not need to install anything in the browser to use this skin. The following instructions are for the administrator who installs the skin on the TWiki server.

For an automated installation, run the configure script, follow "Find More Extensions" in the in the Extensions section, and look for the MovedSkin.
- See the installation supplement on TWiki.org for more information.

Or, follow these manual installation steps:

Download the ZIP file from the Plugins home (see below).

Unzip MovedSkin.zip in your twiki installation directory. Content:

File:	Description:
`data/TWiki/MovedSkin.txt`	Skin topic
`pub/TWiki/MovedSkin/*.png`	Screenshots
`templates/view.moved.tmpl`	Skin template file
`lib/TWiki/Contrib/MovedSkin.pm`	Skin Perl module

Set the ownership of the extracted directories and files to the webserver user.

Skin testing:
- Test if installed: http://twiki.oats.inaf.it/twiki/bin/view/TWiki/MovedSkin?skin=moved.

Enabling Moved Message

1. Define a MOVEDMESSAGE setting in Main.TWikiPreferences so that the moved message takes effect site-wide. Example:

* Set MOVEDMESSAGE = __NOTE:__ The %WIKITOOLNAME% site has been moved to a new location. The page you are trying to access is now at: %BR%%BR% http://twiki.example.com/do/view/%WEB%/%TOPIC%. %BR% Please update your bookmarks. %BR%%BR% Questions? Ask %WIKIWEBMASTER%

<-- 
 Set MOVEDMESSAGE = NOTE: The TWiki site has been moved to a new location. The page you are trying to access is now at: 
 
  http://twiki.example.com/do/view/TWiki/MovedSkin. 
  Please update your bookmarks. 
 
  Questions? Ask andrea.bignamini@inaf.it
 
-->

The view/%WEB%/%TOPIC% makes sure that the user ends up the new location of the current page.

If you want the page to redirect automatically to the new site you can add a meta tag to the MOVEDMESSAGE setting. This example redirects after 5 seconds:

<meta http-equiv="refresh" content="5;url=http://twiki.example.com/do/view/%WEB%/%TOPIC%" />

2. Test the yellow moved message box:
http://twiki.oats.inaf.it/twiki/bin/view/TWiki/MovedSkin?skin=moved.

3. Active the skin site-wide by changing the SKIN setting in Main.TWikiPreferences:

* Set SKIN = moved

TWikiSkins has details on skin activation.

Skin Info

<--
Needed by TWiki.org skin package reports: 
 Set SHORTDESCRIPTION = Inform users that a TWiki site has moved to a new location
 
Notes to skin maintainer on table rows: 
 Screenshot: Attach a 600x130 pixel screenshot and a full screen shot to the Skin topic, then update the href and img src to reflect the names.
  The Description, Screenshot and Base Name rows are needed by the TWikiSkinBrowser
 
-->

Skin Author:

TWiki:Main.PeterThoeny

Changed:

<
<

, TWiki.org

>
>