MovedSkin

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

Click for full screen image

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.

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

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%

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:
https://wiki.gnhlug.org/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

Skin Author: TWiki:Main.PeterThoeny
Copyright: © 2012 Wave Systems Corp.
© 2012-2018 TWiki:Main.PeterThoeny, TWiki.org
© 2012-2018 TWiki:TWiki.TWikiContributor
Sponsor: Wave Systems Corp.
License: GPL (GNU General Public License)
Description: Inform users that a TWiki site has moved to a new location
Screenshot: Click for full screen image
Preview: Preview with this topic
Base Name: moved
Skin Version: 2018-07-05
Change History:
2018-07-05: TWikibug:Item7841: Copyright update to 2018
2016-01-09: TWikibug:Item7708: Copyright update to 2016
2012-12-16: TWikibug:Item7085: Initial version
Dependencies: None
Skin Home: http://TWiki.org/cgi-bin/view/Plugins/MovedSkin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/MovedSkinDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/MovedSkinAppraisal

Related topic: TWikiSkins, TWikiSkinBrowser, UserDocumentationCategory, AdminDocumentationCategory

Edit | Attach | Watch | Print version | History: r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r2 - 2018-07-06 - TWikiContributor
 

Copyright © 1999-2024 by the contributing authors. All material from TWiki is the property of the contributing authors.
Questions, comments, or concerns? Contact GNHLUG.
All use of this site subject to our Legal Notice (includes Terms of Service).