TWiki Upgrade Guide

Upgrade from TWiki 01-Dec-2000 to TWiki 01-Sep-2001 (previous to new full release)

Overview

The latest version of TWiki (01-Sep-2001) involves several major new features and numerous enhancements to the last full version (01-Dec-2001). The file system set-up is almost identical, but much of the underlying data structure and processes are new. With all the changes, the upgrade procedure is straightforward, and your existing page data is imported directly.

Upgrade Requirements

• To upgrade from a 01-Dec-2000 standard installation to the new, next generation 01-Sep-2001 TWiki Production Release, follow the instructions below.

• NOTE: To upgrade from a pre-01-Dec-2000 TWiki, start with TWikiUpgradeTo01Dec2000.

• To upgrade from a Beta of the new release, or if you made custom modifications to the application, read through all new reference documentation, then use the procedure below as a guideline.

Major Changes from TWiki 01-Dec-2000

The 01 Sep 2001 release includes the following new features and enhancements:

• TWiki Plugins - Easily install program enhancements using external plug-in modules. Developers can create plug-ins in Perl, with the TWiki Plugin API.
  • InterwikiPlugin (preinstalled) - Link to external sites with text aliases, SiteAlias:Page; rules are defined in InterWikis. (Get more Plugins from the TWiki:Plugins web.)
• TWikiTemplateSystem - New, more flexible template system.
• TWikiSkins - Overwrite template headers and footers; page content is unaffected.
• TWikiMetaData - New data format
• TWikiFormTemplate - Create multiple input forms per web; data is rendered in HTML tables.
• Rename/move/delete topics Individual pages can be managed through the browser. Deleted topics are stored in a common Trash web.
• Change passwords Change and reset passwords using forms.
• TOC (Table of Contents) - %TOC% variable generates a hierarchical table of contents from topic headings: <HI>...<H6>. Set depth.
• Arbitrary Text for WikiWord Links - Text formatting rules to generate automatic links from any combination of words and spaces.
• Attachments Under Revision Control Changes made to files attached to topics are now saved under revision control (RCS).
• Convert to XHTML - Templates and HTML page rendering are in XHTML 1.0 as far as possible without breaking HTML 3.2 compliance.
• HierarchicalNavigation uses new Meta Data variables to link hierarchically.
• SuperAdministrator Group allows you to give one user group - by default, TWikiAdminGroup - superpowers: the ability to overwrite locked topics from the browser interface. (This gets around a potential problem where mistyping topic access definition could result in locking everyone out.)

The TWiki directory structure remains the same, with one exception, the new lib/TWiki/Plugins directory tree to for the main configuration file, library, internal modules and the new Plugin modules. Pre-existing files were formerly in bin.

Standard Upgrade Procedure

Follow this step-by-step guide to upgrade from the 01-Dec-2000 TWiki to the 01-Sep-2001 release, importing your original page data and related files:

Pre-Upgrade Preparation

Two major areas of TWiki functionality - templates and Category Tables (input forms associated with a topic)- are entirely different in the new TWiki. Therefore, if you've customized your templates or use Category Tables, you should read those sections before starting your upgrade. That way, converting old templates and pages to new will be flow along smoothly!

Step 1: Backup & Unpack

1. 1. Move all existing TWiki directories ( bin, pub, data, templates ) to a temporary directory (it's a good idea to do a full back-up first):
      mkdir -p ~/tmp/
mv $TWIKIROOT/* ~/tmp/
   2. Unpack the zip file into your newly empty working directory:
      cd $TWIKIROOT
unzip ~/TWiki20010901.zip

Step 2: Upgrade TWiki document files

1. 1. Move the document files to your TWiki root ( twiki ):
      mv ~/tmp/TWiki*.html $TWIKIROOT
mv ~/tmp/index.html $TWIKIROOT
mv ~/tmp/readme.txt $TWIKIROOT
mv ~/tmp/license.txt $TWIKIROOT

Step 3: Upgrade CGI scripts

1. 1. If necessary, change the script names to include the required extension, ex: .cgi
   2. Restore any additional scripts you might have from the tmp directory, ex:
      mv ~/tmp/bin/somescript $TWIKIROOT/bin/
   3. Set permissions, ex:
      chmod 755 *.cgi
   4. Restore any additional scripts you might have from the tmp directory, ex:
      mv ~/tmp/bin/somescript $TWIKIROOT/bin/
   5. Test your TWiki installation to see if you can view topics.

• • Pay attention to the file and directory permissions (security issue)

Step 4: Set configurations in TWiki.cfg

1. 1. Customize the new lib/TWiki.cfg configuration file, which replaces the wikicfg.pm file. New settings to watch for:
      • SuperAdminCanConfig
   2. Test your TWiki installation to see if you can view topics.
   3. Test the new TWikiPlugins by checking the Plugins settings in TWikiPreferences.
      • The EmptyPlugin, DefaultPlugin, and InterwikiPlugin should be preinstalled. To check the InterwikiPlugin, go to its page.

• • Pay attention to the file and directory permissions (security issue)

Step 5: Upgrade template files

1. 1. Customized templates and skins need to be upgraded to the new TWiki Template System. This isn't difficult, but you have be familiar with the new template set-up before starting the conversion. The safest way is to use the new templates as a base and to merge your changes back. Changes in new templates:
      • Templates are now rendered by TWiki. You can use all TextFormattingRules, but you have to escape unwanted ones. Also, remove empty lines unless you want a =<p /> tag added.
      • Added TWikiMetaData rendering.
   2. Form Templates replace the TWikiCategoryTables:
      • Create a replacement Form Template based on twikicatitems.tmpl in each web that used a Category Table.
      • Searches need to be adjusted to deal with format change - if all topics are upgrades, a more specific search can be done.
   3. For each web that has a custom notedited.tmpl template, create a WebTopicEditTemplate to conform with the new SelectableNewTopicTemplates feature. Retired notedited.tmpl, notext.tmpl and notwiki.tmpl templates.
   4. Test your TWiki installation to see if you can view topics.

Step 6: Upgrade public files

1. 1. Move your own public data files and sub-directories from the original pub directory to the new installation: ( $TWIKIROOT/pub )
      mv ~/tmp/pub/TWiki/somefiles.ext $TWIKIROOT/pub/
mv ~/tmp/pub/TWiki/somedirectory $TWIKIROOT/pub/

Step 7: Upgrade data files

1. 1. Move the tmp/data/TWiki directory to your installation: ( twiki/data )
      mv ~/tmp/data/TWiki $TWIKIROOT/data/
      Pay attention to the file permissions of the TWiki directory and its files. The files must be writable by the cgi-scripts (usually user "nobody")
   2. TWikiRegistration moved from TWiki.Main to TWiki.TWiki. In case you customized TWikiRegistration , merge your changes back into TWiki.TWikiRegistration , then delete $TWIKIROOT/data/Main/TWikiRegistration*.
   3. TWikiPreferences into TWiki.TWikiPreferences.
   4. Merge your changes to the WebPreferences topics in all your webs into WebPreferences
   5. Modify the WebPreferences topics in all your webs to reflect the following:
      • In case you want to exclude a web from a web="all" search: Set this new preference
        Set NOSEARCHALL = on
   6. The WebSearch topic has considerable changes. Copy the one from TWiki.TWiki into all webs, or merge them if you made changes. To copy, do an edit-copy-edit-paste operation.
   7. Change the WebHome topics in all your webs to reflect these changes:
   8. If you are using .htaccess, add the rename script * You may want to add [ALLOW|DENY][WEB|TOPIC]RENAME in some places, like TWikiPreferences, WebPreferences and TWikiUsers

General Format Changes

• Format changed of %GMTIME{"..."}% and %SERVERTIME{"..."}% variables. Format is now "$hour:$min" instead of "hour:min". More in TWikiVariables.

• ExtendingTableSyntax: Enhanced table syntax might have unwanted side effect: | *bold* | cells, |  center aligned  | and |   right aligned | cells, span multiple columns using | empty cells |||. More in TextFormattingRules.

• Use Net::SMTP module instead of sendmail if installed.

• Use <verbatim> ... </verbatim> tags instead of <pre> ... </pre> tags where appropriate. More in TextFormattingRules.

• New variable %STARTINCLUDE% and %STOPINCLUDE% variables to control what gets included of a topic. More in TWikiVariables.

• FileAttachment info is now stored as TWiki Meta Data.
  • Upgrading of imported pagess is done automatically after first edit, on save. "In memory" upgrade is done on topic view.
  • Attachments are now under revision control: $attachAsciiPath in TWiki.cfg defines which file types are stored in ASCII, otherwise, binary format is used. This means that the RCS version used should support binary files.

• Handling for topic-specific templates like edit.new.tmpl has been removed and replaced by template topics in the new TWiki Template System )

• A new file warning.txt file can appear in the data directory. It may contain diagnostic info identifying problems that need fixing. This file could get fairly large if you have a lot of problems your site - you can delete it at any time.

Known Upgrade Issues

• • Check http://TWiki.org/cgi-bin/view/Codev/KnownIssuesOfTWiki01Sep2001 for known issues of TWiki 01 Sep 2001 (production release)

• • Upgrading requires extensive changes be made to topics in the TWiki web.

-- JohnTalintyre? - 18 Jul 2001