<<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.31 - 17 Dec 2002 - PeterThoeny)

TWiki Upgrade Guide

Line: 314 to 314

-- MikeMannix? - 05 May 2002
Added:
>
>
META TOPICMOVED PeterThoeny date="1040114770" from="TWiki.TWikiUpgradeGuide" to="TWiki.TWikiUpgradeTo01Dec2001"
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.30 - 05 May 2002 - MikeMannix?)

TWiki Upgrade Guide

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

Deleted:
<
<

Overview


This guide describes how to upgrade either from TWiki 01-Dec-2000 or TWiki 01-Sep-2001 to TWiki 01-Dec-2001.

  • The latest version of TWiki (01-Dec-2001) is a small incremental release over the 01-Sep-2001 version.
Line: 83 to 81

  1. Update data/TWiki files: (in case you want the updated docs)
    • Using your browser, merge the new TWiki.TWikiRegistration topic (or TWiki.TWikiRegistrationPub in case you used that one) into your existing TWiki.TWikiRegistration topic.
    • In the temporary twiki/data/TWiki directory where you unzipped the installation package:
Changed:
<
<
      • Remove the files you do not want to upgrade: TWikiPreferences.*, Main.TWikiSiteDirectory.*, WebNotify.*, WebPreferences.*, WebStatistics.* and all WebTopic* files.
      • In case the cgi-scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody and need to be changed the user of your cgi-scripts, i.e. www-data. A simple way to switch the locker of the RCS files is to use sed:
>
>
      • Remove the files you do not want to upgrade: TWikiPreferences.*, WebNotify.*, WebPreferences.*, WebStatistics.* and all WebTopic* files.
      • In case the cgi-scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody and need to be changed to the user of your cgi-scripts, e.g., www-data. A simple way to switch the locker of the RCS files is to use sed:


for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
    • Move all remaining *.txt and *.txt,v files from the temporary data/TWiki directory to your $TWIKIROOT/data/TWiki directory.
  1. Update pub/TWiki files:
Line: 153 to 151

  1. Move the TWiki logo files, ex:
    mv ~/tmp/pub/*.gif $TWIKIROOT/pub
  2. Pay attention to the file permissions of the TWiki2 and Know2 directories and its files. The files must be writable by the cgi-scripts (usually user nobody).
Changed:
<
<
  1. In case the cgi-scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody and need to be changed the user of your cgi-scripts, i.e. www-data. A simple way to switch the locker of the RCS files is to use sed:
>
>
  1. In case the cgi-scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody and need to be changed to the user of your cgi-scripts, e.g., www-data. A simple way to switch the locker of the RCS files is to use sed:


for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done

Step 5: Install new CGI scripts

Line: 199 to 197

    • The original TWiki web.
    • The new TWiki2 web, which gets renamed to TWiki when you switch over the installation.
  1. In case you customized TWiki.TWikiRegistration, merge your changes back into TWiki2.TWikiRegistration.
Changed:
<
<
  1. Copy TWiki.Main.TWikiSiteDirectory to TWiki2.Main.TWikiSiteDirectory.
    • Do the same for any other topics you might have created in the TWiki web.
>
>
  1. Copy to TWiki2 any topics that you created in the TWiki web.
    • Do the same for

  1. In TWiki2.TWikiPreferences, merge the old TWiki.TWikiPreferences settings and customize it.
    • Add your webs to WIKIWEBLIST
    • Set the WIKIWEBMASTER
Line: 238 to 236

  1. Form Templates replace the TWikiCategoryTables:
    • Create a replacement WebForm topic based on twikicatitems.tmpl in each web that uses a Category Table. See details in TWikiForms and compare with the settings in the Know2.WebPreferences topic.
Changed:
<
<

NOTE: Do not remove the twikicatitems.tmpl file, it is still used for topics that are of the old format.
>
>

ALERT! Do not remove the twikicatitems.tmpl file, it is still used for topics that are of the old format.

    • Searches need to be adjusted to deal with format change. It is possible to define a regular expression search that can deal at the same time with topics in the old format and new format.
      • Example: List all topics in the Know web that have a TopicClassification? of PublicFAQ?:
        %SEARCH{ "[T]opicClassification.*?(td..td|value\=).*?[P]ublicFAQ" casesensitive="on" regex="on" nosearch="on" web="Know"}%
        (The [T] and [P] is done so that search does not find the topic where this search string is located in!)
      • Example: Create a link that lists all topics in the Know web with a TopicClassification? of PublicFAQ?:
        [[%SCRIPTURL%/search%SCRIPTSUFFIX%/Know/?scope=text
        &search=%5BT%5DopicClassification.*%3F%28td..td%7C
        value%5C%3D%29.*%3F%5BP%5DublicFAQ&regex=on][All Public FAQ]]

        All Public FAQ
Line: 312 to 310

-- JohnTalintyre? - 18 Jul 2001

Deleted:
<
<
-- MikeMannix? - 12 Sep 2001

-- PeterThoeny - 03 Dec 2001
Added:
>
>
-- MikeMannix? - 05 May 2002
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.29 - 07 Apr 2002 - PeterThoeny)

TWiki Upgrade Guide

Line: 83 to 83

  1. Update data/TWiki files: (in case you want the updated docs)
    • Using your browser, merge the new TWiki.TWikiRegistration topic (or TWiki.TWikiRegistrationPub in case you used that one) into your existing TWiki.TWikiRegistration topic.
    • In the temporary twiki/data/TWiki directory where you unzipped the installation package:
Changed:
<
<
      • Remove the files you do not want to upgrade: TWikiPreferences.*, TWikiWebsTable.*, WebNotify.*, WebPreferences.*, WebStatistics.* and all WebTopic* files.
>
>
      • Remove the files you do not want to upgrade: TWikiPreferences.*, Main.TWikiSiteDirectory.*, WebNotify.*, WebPreferences.*, WebStatistics.* and all WebTopic* files.

      • In case the cgi-scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody and need to be changed the user of your cgi-scripts, i.e. www-data. A simple way to switch the locker of the RCS files is to use sed:
        for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
    • Move all remaining *.txt and *.txt,v files from the temporary data/TWiki directory to your $TWIKIROOT/data/TWiki directory.
Line: 199 to 199

    • The original TWiki web.
    • The new TWiki2 web, which gets renamed to TWiki when you switch over the installation.
  1. In case you customized TWiki.TWikiRegistration, merge your changes back into TWiki2.TWikiRegistration.
Changed:
<
<
  1. Copy TWiki.TWikiWebsTable to TWiki2.TWikiWebsTable.
>
>
  1. Copy TWiki.Main.TWikiSiteDirectory to TWiki2.Main.TWikiSiteDirectory.

    • Do the same for any other topics you might have created in the TWiki web.
  1. In TWiki2.TWikiPreferences, merge the old TWiki.TWikiPreferences settings and customize it.
    • Add your webs to WIKIWEBLIST
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.28 - 16 Mar 2002 - PeterThoeny)

TWiki Upgrade Guide

Line: 250 to 250

  1. Test your new 01-Dec-2001 installation under twiki/bin/2/view to make sure everything works as expected.
    • NOTE: Don't worry about the Plugins, they'll work after the switch.
Changed:
<
<
  1. Edit $TWIKIROOT/bin/2/TWiki.cfg and remove the /2 from $scriptUrlPath and $templateDir, ex:
>
>
  1. Edit $TWIKIROOT/bin/lib/TWiki.cfg and remove the /2 from $scriptUrlPath and $templateDir, ex:


$scriptUrlPath    = "/twiki/bin";
$templateDir      = "/home/httpd/twiki/templates";
  1. Rename the TWiki2 web to TWiki, including attachments, ex:
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.27 - 05 Dec 2001 - PeterThoeny)

TWiki Upgrade Guide

Line: 62 to 62

A new twiki/lib/TWiki/Plugins directory contains the new Plugin modules.
Changed:
<
<

Standard Upgrade Procedure from 01-Sep-2000 to 01-Dec-2001 Release

>
>

Standard Upgrade Procedure from 01-Sep-2001 to 01-Dec-2001 Release


This incremental update can be performed easily.

Changed:
<
<
The following steps describe the upgrade assuming that $TWIKIROOT is the root of your current 01-Sep-2000 release.
>
>
The following steps describe the upgrade assuming that $TWIKIROOT is the root of your current 01-Sep-2001 release.

  1. Back up and prepare:
    • Back up all existing TWiki directories $TWIKIROOT/bin, $TWIKIROOT/pub, $TWIKIROOT/data, $TWIKIROOT/templates.
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.26 - 04 Dec 2001 - PeterThoeny)

TWiki Upgrade Guide

Line: 309 to 309

Known Issues

Added:
>
>

-- JohnTalintyre? - 18 Jul 2001
-- MikeMannix? - 12 Sep 2001

 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.25 - 04 Dec 2001 - PeterThoeny)

TWiki Upgrade Guide

Changed:
<
<
Upgrade from TWiki 01-Dec-2000 to TWiki 01-Sep-2001 (previous to new full release)
>
>
Upgrade from TWiki 01-Dec-2000 or TWiki 01-Sep-2001 to TWiki 01-Dec-2001 (previous to new full release)

Overview

Changed:
<
<
The latest version of TWiki (01-Sep-2001) involves several major new features and numerous enhancements to the last full version (01-Dec-2000). The file system set-up is almost identical, but much of the underlying data structure and processes is new. With all the changes, the upgrade procedure is straightforward, and your existing page data is imported directly.
>
>
This guide describes how to upgrade either from TWiki 01-Dec-2000 or TWiki 01-Sep-2001 to TWiki 01-Dec-2001.

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

Upgrade Requirements

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

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

Major Changes from TWiki 01-Sep-2001

The latest 01-Dec-2001 release includes the following new features and enhancements compared to the 01-Sep-2001 release:

  • FormattedSearch - New format="" parameter in %SEARCH{}% variable for database like reporting.
  • Various bug fixes

Major Changes from TWiki 01-Dec-2000

Changed:
<
<
The 01-Sep-2001 release includes the following new features and enhancements:
>
>
The 01-Sep-2001 release includes the following new features and enhancements compared to the 01-Dec-2000 release:

Line: 36 to 46

  • HierarchicalNavigation uses new Meta Data variables to link hierarchically.
  • Convert to XHTML - Pages are rendered for display in XHTML 1.0, as far as possible without breaking HTML 3.2 compliance.
Added:
>
>

TWiki Directory Structure and File Names

The TWiki directory structure remains the same, with one exception, the TWiki configuration file and Perl modules have been moved from the twiki/bin directory into it's own twiki/lib directory tree. The following files have been renamed and moved:

Changed:
<
<
From TWiki 01-Dec-2000: To TWiki 01-Sep-2001:
>
>
From TWiki 01-Dec-2000: To TWiki 01-Dec-2001:

twiki/bin/wikicfg.pm twiki/lib/TWiki.cfg
twiki/bin/wiki.pm twiki/lib/TWiki.pm
twiki/bin/wikiaccess.pm twiki/lib/TWiki/Access.pm
Line: 50 to 61

A new twiki/lib/TWiki/Plugins directory contains the new Plugin modules.

Changed:
<
<

Standard Upgrade Procedure

>
>

Standard Upgrade Procedure from 01-Sep-2000 to 01-Dec-2001 Release

This incremental update can be performed easily.

The following steps describe the upgrade assuming that $TWIKIROOT is the root of your current 01-Sep-2000 release.

  1. Back up and prepare:
    • Back up all existing TWiki directories $TWIKIROOT/bin, $TWIKIROOT/pub, $TWIKIROOT/data, $TWIKIROOT/templates.
    • Create a temporary directory and unpack the ZIP file there.
  2. Update files in TWiki root:
    • Overwrite all *.html and *.txt files in $TWIKIROOT with the new ones.
  3. Update template files:
    • Overwrite all template files in $TWIKIROOT/templates with the new ones.
  4. Update script files:
    • Overwrite all script files in $TWIKIROOT/bin with the new ones.
  5. Update library files:
    • Overwrite the TWiki.pm library in $TWIKIROOT/lib with the new one.
    • Overwrite all *.pm library files in $TWIKIROOT/lib/TWiki and $TWIKIROOT/lib/TWiki/Plugins with the new ones.
  6. Update data/TWiki files: (in case you want the updated docs)
    • Using your browser, merge the new TWiki.TWikiRegistration topic (or TWiki.TWikiRegistrationPub in case you used that one) into your existing TWiki.TWikiRegistration topic.
    • In the temporary twiki/data/TWiki directory where you unzipped the installation package:
      • Remove the files you do not want to upgrade: TWikiPreferences.*, TWikiWebsTable.*, WebNotify.*, WebPreferences.*, WebStatistics.* and all WebTopic* files.
      • In case the cgi-scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody and need to be changed the user of your cgi-scripts, i.e. www-data. A simple way to switch the locker of the RCS files is to use sed:
        for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
    • Move all remaining *.txt and *.txt,v files from the temporary data/TWiki directory to your $TWIKIROOT/data/TWiki directory.
  7. Update pub/TWiki files:
    • Move the new pub/TWiki/TWikiDocGraphics directory into your $TWIKIROOT/pub/TWiki directory.

Standard Upgrade Procedure from 01-Dec-2000 to 01-Dec-2001 Release


The idea is to have the new and old installation work in parallel so that you can test the new installation before switching over. That way you can make the switch on your live TWiki installation within one minute without affecting the users.

Before Switch: After Switch:
Changed:
<
<
Current 01-Dec-2000: New 01-Sep-2001: Obsolete 01-Dec-2000: New 01-Sep-2001:
>
>
Current 01-Dec-2000: New 01-Dec-2001: Obsolete 01-Dec-2000: New 01-Dec-2001:

twiki/templates/ twiki/templates2/ twiki/templates1/ twiki/templates/
twiki/bin/ twiki/bin/2/ (overwritten) twiki/bin/
(N/A) twiki/bin/lib/ (N/A) twiki/lib/
twiki/data/TWiki twiki/data/TWiki2 twiki/data/TWiki1 twiki/data/TWiki
(other directories do not change)
Changed:
<
<
Alternatively you could move the existing installation away, install the 01-Sep-2001 release into it's place and move your webs and pub files back.
>
>
Alternatively you could move the existing installation away, install the 01-Dec-2001 release into it's place and move your webs and pub files back.

Changed:
<
<
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:
>
>
Follow this step-by-step guide to upgrade from the 01-Dec-2000 TWiki to the 01-Dec-2001 release, importing your original page data and related files:

Pre-Upgrade Preparation

Line: 77 to 118

  1. Back up all existing TWiki directories twiki/bin, twiki/pub, twiki/data, twiki/templates.
  2. Create a temporary directory and unpack the ZIP file there:
    mkdir -p ~/tmp/
Changed:
<
<

cp -p ~/downloads/TWiki20010901.zip ~/tmp/
>
>

cp -p ~/downloads/TWiki20011201.zip ~/tmp/


cd ~/tmp/
Changed:
<
<

unzip ~/tmp/TWiki20010901.zip
>
>

unzip ~/tmp/TWiki20011201.zip

Step 2: Upgrade TWiki document files

Line: 113 to 154


mv ~/tmp/pub/*.gif $TWIKIROOT/pub
  1. Pay attention to the file permissions of the TWiki2 and Know2 directories and its files. The files must be writable by the cgi-scripts (usually user nobody).
  2. In case the cgi-scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody and need to be changed the user of your cgi-scripts, i.e. www-data. A simple way to switch the locker of the RCS files is to use sed:
Changed:
<
<

for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
>
>

for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done

Step 5: Install new CGI scripts

Line: 152 to 193

Step 8: Update topics

Changed:
<
<
You can do the following changes using your old TWiki 01-Dec-2000 or new TWiki 01-Sep-2001 installation. Pointing your browser to the old installation for edit-copy-edit-paste operations is recommended, so that users don't get surprised by meta data content showing up in topics.
>
>
You can do the following changes using your old TWiki 01-Dec-2000 or new TWiki 01-Dec-2001 installation. Pointing your browser to the old installation for edit-copy-edit-paste operations is recommended, so that users don't get surprised by meta data content showing up in topics.

  1. Remember that you now have two TWiki webs:
    • The original TWiki web.
Line: 205 to 246

Step 10: Switch over to new installation

Changed:
<
<
In this step, you move the working 01-Sep-2001 installation to the old 01-Dec-2000 installation, so that users don't have to change the URL.
>
>
In this step, you move the working 01-Dec-2001 installation to the old 01-Dec-2000 installation, so that users don't have to change the URL.

Changed:
<
<
  1. Test your new 01-Sep-2001 installation under twiki/bin/2/view to make sure everything works as expected.
>
>
  1. Test your new 01-Dec-2001 installation under twiki/bin/2/view to make sure everything works as expected.

    • NOTE: Don't worry about the Plugins, they'll work after the switch.
  1. Edit $TWIKIROOT/bin/2/TWiki.cfg and remove the /2 from $scriptUrlPath and $templateDir, ex:
    $scriptUrlPath    = "/twiki/bin";
Line: 230 to 271


cd $TWIKIROOT/bin
cp -p bin/2/* .
cp -p bin/2/.htaccess .
Changed:
<
<
  1. Point your browser to the original URL and make sure the relocated 01-Sep-2001 installation works as expected: check browsing, searching and user registration.
>
>
  1. Point your browser to the original URL and make sure the relocated 01-Dec-2001 installation works as expected: check browsing, searching and user registration.

  1. Clean up and remove obsolete directories:
    • Remove directory $TWIKIROOT/bin/2
    • Remove directory $TWIKIROOT/templates1
Line: 267 to 308

Known Issues

Changed:
<
<
>
>

-- JohnTalintyre? - 18 Jul 2001
-- MikeMannix? - 12 Sep 2001

Changed:
<
<
-- PeterThoeny - 02 Oct 2001
>
>
-- PeterThoeny - 03 Dec 2001
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.24 - 03 Oct 2001 - PeterThoeny)

TWiki Upgrade Guide

Line: 198 to 198

  1. Form Templates replace the TWikiCategoryTables:
    • Create a replacement WebForm topic based on twikicatitems.tmpl in each web that uses a Category Table. See details in TWikiForms and compare with the settings in the Know2.WebPreferences topic.
      NOTE: Do not remove the twikicatitems.tmpl file, it is still used for topics that are of the old format.
Changed:
<
<
    • Searches need to be adjusted to deal with format change - if all topics are upgrades, a more specific search can be done.
>
>
    • Searches need to be adjusted to deal with format change. It is possible to define a regular expression search that can deal at the same time with topics in the old format and new format.
      • Example: List all topics in the Know web that have a TopicClassification? of PublicFAQ?:
        %SEARCH{ "[T]opicClassification.*?(td..td|value\=).*?[P]ublicFAQ" casesensitive="on" regex="on" nosearch="on" web="Know"}%
        (The [T] and [P] is done so that search does not find the topic where this search string is located in!)
      • Example: Create a link that lists all topics in the Know web with a TopicClassification? of PublicFAQ?:
        [[%SCRIPTURL%/search%SCRIPTSUFFIX%/Know/?scope=text
        &search=%5BT%5DopicClassification.*%3F%28td..td%7C
        value%5C%3D%29.*%3F%5BP%5DublicFAQ&regex=on][All Public FAQ]]

        All Public FAQ

  1. For each web that has a custom notedited.tmpl template, create an equivalent WebTopicEditTemplate to conform with the new TemplateTopics. The new format replaces the notedited.tmpl, notext.tmpl and notwiki.tmpl templates.

Step 10: Switch over to new installation

Line: 269 to 271

-- JohnTalintyre? - 18 Jul 2001
-- MikeMannix? - 12 Sep 2001

Changed:
<
<
-- PeterThoeny - 12 Sep 2001
>
>
-- PeterThoeny - 02 Oct 2001
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.23 - 18 Sep 2001 - PeterThoeny)

TWiki Upgrade Guide

Line: 167 to 167

  1. In WebPreferences of all webs, add or change the following web preferences: (see TWiki.WebPreferences)
    • Add a NOSEARCHALL in case you want to exclude the web from a web="all" search:
      * Set NOSEARCHALL = on
Changed:
<
<
    • Modify WEBTOPICLIST, ex:
      * Set WEBTOPICLIST = [[%HOMETOPIC%][Home]] %SEP% [[WebChanges][Changes]] %SEP% [[WebIndex][Index]] %SEP% [[WebSearch][Search]] %SEP% Go <input type="text" name="topic" size="16" />
>
>
    • In WEBTOPICLIST, remove the %WEB% . {} decoration from the list (it is now in the templates), ex:
      * Set WEBTOPICLIST = <a href="WebHome">Home</a>
        | <a href="WebChanges">Changes</a>
        | <a href="WebIndex">Index</a>
        | <a href="WebSearch">Search</a>
        | Go <input type="text" name="topic" size="16" />

    • Add a these new preferences:
      * Set DENYWEBVIEW =
      * Set ALLOWWEBVIEW =
      * Set DENYWEBRENAME =
      * Set ALLOWWEBRENAME =
Changed:
<
<
    • Set FINALPREFERENCES:
>
>
    • Set the FINALPREFERENCES:


* Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
Changed:
<
<
  1. In WebSearch of all webs, replace content with this one line:
>
>
  1. Optional: In WebSearch of all webs, replace content with this one line:


%INCLUDE{"%TWIKIWEB%.WebSearch"}%
Changed:
<
<
  1. In WebChanges of all webs, replace content with this one line:
>
>
  1. Optional: In WebChanges of all webs, replace content with this one line:


%INCLUDE{"%TWIKIWEB%.WebChanges"}%

Step 9: Customize template files

Line: 192 to 196

    • 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.
  1. Form Templates replace the TWikiCategoryTables:
Changed:
<
<
    • Create a replacement TWikiForms template based on twikicatitems.tmpl in each web that used a Category Table.
>
>
    • Create a replacement WebForm topic based on twikicatitems.tmpl in each web that uses a Category Table. See details in TWikiForms and compare with the settings in the Know2.WebPreferences topic.
      NOTE: Do not remove the twikicatitems.tmpl file, it is still used for topics that are of the old format.

    • Searches need to be adjusted to deal with format change - if all topics are upgrades, a more specific search can be done.
  1. For each web that has a custom notedited.tmpl template, create an equivalent WebTopicEditTemplate to conform with the new TemplateTopics. The new format replaces the notedited.tmpl, notext.tmpl and notwiki.tmpl templates.

Step 10: Switch over to new installation

Changed:
<
<
In this step, you move the working 01-Sep-2001 installation to the old 01-Dec-2000 installation, so that you don't have to change the URL.
>
>
In this step, you move the working 01-Sep-2001 installation to the old 01-Dec-2000 installation, so that users don't have to change the URL.

  1. Test your new 01-Sep-2001 installation under twiki/bin/2/view to make sure everything works as expected.
    • NOTE: Don't worry about the Plugins, they'll work after the switch.
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.22 - 18 Sep 2001 - MikeMannix?)

TWiki Upgrade Guide

Line: 194 to 194

  1. Form Templates replace the TWikiCategoryTables:
    • Create a replacement TWikiForms 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.
Changed:
<
<
  1. 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.
>
>
  1. For each web that has a custom notedited.tmpl template, create an equivalent WebTopicEditTemplate to conform with the new TemplateTopics. The new format replaces the notedited.tmpl, notext.tmpl and notwiki.tmpl templates.

Step 10: Switch over to new installation

 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.21 - 18 Sep 2001 - MikeMannix?)

TWiki Upgrade Guide

Line: 21 to 21

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

Changed:
<
<
  • TWikiPlugins - Easily install program enhancements using external plug-in modules. Developers can create plug-ins in Perl, with the TWiki Plugin API.
  • TWikiTemplates - New, more flexible template system.
  • TWikiSkins - Overwrite template headers and footers; page content is unaffected.
  • TWikiMetaData - New data format
  • TWikiForms - Create multiple input forms per web; data is rendered in HTML tables.
  • ManagingTopics Individual topics can be renamed, moved and deleted 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.)
>
>
  • TWikiPlugins - Easily install program enhancements using external plug-in modules. Developers can create plug-ins in Perl, with the TWiki Plugin API.
  • TWikiTemplates - New, more flexible template system.
  • TWikiSkins - Overwrite template headers and footers; page content is unaffected.
  • TWikiMetaData - New data format
  • TWiki.TWikiForms - Create multiple input forms per web; data is rendered in HTML tables.
  • ManagingTopics - Individual topics can be renamed, moved and deleted 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: <h1>...<h6>.
  • 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).
  • SuperAdministrator Group - Lets you to make the members of one user group - by default, TWikiAdminGroup - into TWiki superusers, with the ability to overwrite locked topics from the browser interface. (This gets around the problem of topic lockouts, caused by typos in access privilege definitions.)
  • HierarchicalNavigation uses new Meta Data variables to link hierarchically.
  • Convert to XHTML - Pages are rendered for display in XHTML 1.0, as far as possible without breaking HTML 3.2 compliance.

TWiki Directory Structure and File Names

 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.20 - 15 Sep 2001 - PeterThoeny)

TWiki Upgrade Guide

Line: 28 to 28

  • TWikiMetaData - New data format
  • TWikiForms - Create multiple input forms per web; data is rendered in HTML tables.
  • ManagingTopics Individual topics can be renamed, moved and deleted through the browser. Deleted topics are stored in a common Trash web.
Changed:
<
<
  • Change passwords? Change and reset passwords using forms.
>
>
  • Change passwords? Change and reset passwords using forms.

Line: 109 to 109


mv ~/tmp/data/Trash $TWIKIROOT/data
  1. Move the MIME types file, ex:
    mv ~/tmp/data/mime.types $TWIKIROOT/data
Added:
>
>
  1. Move the TWiki logo files, ex:
    mv ~/tmp/pub/*.gif $TWIKIROOT/pub

  1. Pay attention to the file permissions of the TWiki2 and Know2 directories and its files. The files must be writable by the cgi-scripts (usually user nobody).
  2. In case the cgi-scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody and need to be changed the user of your cgi-scripts, i.e. www-data. A simple way to switch the locker of the RCS files is to use sed:
    for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.19 - 15 Sep 2001 - MikeMannix?)

TWiki Upgrade Guide

Line: 7 to 7

Overview

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

Upgrade Requirements

Line: 19 to 19

Major Changes from TWiki 01-Dec-2000

Changed:
<
<
The 01 Sep 2001 release includes the following new features and enhancements:
>
>
The 01-Sep-2001 release includes the following new features and enhancements:

Line: 28 to 28

  • TWikiMetaData - New data format
  • TWikiForms - Create multiple input forms per web; data is rendered in HTML tables.
  • ManagingTopics Individual topics can be renamed, moved and deleted through the browser. Deleted topics are stored in a common Trash web.
Changed:
<
<
>
>
  • Change passwords? Change and reset passwords using forms.

Line: 68 to 68

Pre-Upgrade Preparation

Changed:
<
<
Two major areas of TWiki functionality - TWikiTemplates and TWikiForms (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!
>
>
Two major areas of TWiki functionality - TWikiTemplates and TWikiForms (input forms associated with a topic)- are entirely different in the new TWiki. If you've customized your templates or use Category Tables, read those sections before starting your upgrade.

Changed:
<
<
The following steps describe the upgrade on Unix. Windows setup is very similar. We assume $TWIKIROOT to be the root of your current 01-Dec-2000 release, i.e. export TWIKIROOT=/some/dir/
>
>
The following steps describe the upgrade on Unix. Windows setup is very similar. It's assumed that $TWIKIROOT is the root of your current 01-Dec-2000 release, ex: export TWIKIROOT=/some/dir/

Step 1: Backup & Unpack

Line: 150 to 150

Step 8: Update topics

Changed:
<
<
You can do the following changes using your old TWiki 01-Dec-2000 or new TWiki 01-Sep-2001 installation. Pointing your browser to the old installation for edit-copy-edit-paste operations is recommended so that users don't get surprized by meta-data content showing up in topics.
>
>
You can do the following changes using your old TWiki 01-Dec-2000 or new TWiki 01-Sep-2001 installation. Pointing your browser to the old installation for edit-copy-edit-paste operations is recommended, so that users don't get surprised by meta data content showing up in topics.

Changed:
<
<
  1. Remember that you have now two TWiki webs:
>
>
  1. Remember that you now have two TWiki webs:

    • The original TWiki web.
    • The new TWiki2 web, which gets renamed to TWiki when you switch over the installation.
  1. In case you customized TWiki.TWikiRegistration, merge your changes back into TWiki2.TWikiRegistration.
Line: 181 to 181

Step 9: Customize template files

Changed:
<
<
Note: Skip this step in case you did not customize your template files.
>
>
NOTE: Skip this step if you did not customize your template files.

  1. Remember that you have now two template directories:
    • The original twiki/templates.
Line: 196 to 196

Step 10: Switch over to new installation

Changed:
<
<
In this step we relocate the working 01-Sep-2001 installation over the old 01-Dec-2000 installation, so that we don't need to change the URL.
>
>
In this step, you move the working 01-Sep-2001 installation to the old 01-Dec-2000 installation, so that you don't have to change the URL.

  1. Test your new 01-Sep-2001 installation under twiki/bin/2/view to make sure everything works as expected.
Changed:
<
<
    • Note: Don't worry about the Plugins, they will work after the switch.
>
>
    • NOTE: Don't worry about the Plugins, they'll work after the switch.

  1. Edit $TWIKIROOT/bin/2/TWiki.cfg and remove the /2 from $scriptUrlPath and $templateDir, ex:
    $scriptUrlPath    = "/twiki/bin";
    $templateDir      = "/home/httpd/twiki/templates";
Line: 221 to 221


cd $TWIKIROOT/bin
cp -p bin/2/* .
cp -p bin/2/.htaccess .
Changed:
<
<
  1. Point your browser to the original URL and make sure the relocated 01-Sep-2001 installation works as expected, i.e. check browsing, searching and user registration.
>
>
  1. Point your browser to the original URL and make sure the relocated 01-Sep-2001 installation works as expected: check browsing, searching and user registration.

  1. Clean up and remove obsolete directories:
    • Remove directory $TWIKIROOT/bin/2
    • Remove directory $TWIKIROOT/templates1
Line: 233 to 233

  1. 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.
Changed:
<
<
  1. In case you have customized the functions extendHandleCommonTags, extendGetRenderedVersionOutsidePRE and extendGetRenderedVersionInsidePRE in twiki/bin/wikicfg.pm:
>
>
  1. If you have customized the functions extendHandleCommonTags, extendGetRenderedVersionOutsidePRE and extendGetRenderedVersionInsidePRE in twiki/bin/wikicfg.pm:

    • Merge those changes back into twiki/lib/TWiki/Plugins/Default.pm

General Format Changes

Changed:
<
<
  • Format changed of %GMTIME{"..."}% and %SERVERTIME{"..."}% variables. Format is now "$hour:$min" instead of "hour:min". More in TWikiVariables.
>
>
  • The format of the %GMTIME{"..."}% and %SERVERTIME{"..."}% variables is now "$hour:$min" instead of "hour:min". More in TWikiVariables.

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

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

Changed:
<
<
  • Use <verbatim> ... </verbatim> tags instead of <pre> ... </pre> tags where appropriate. More in TextFormattingRules.
>
>
  • 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.

Changed:
<
<
>
>

    • 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.
Line: 256 to 256

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

Known Issues of TWiki 01 Sep 2001

>
>

Known Issues


Changed:
<
<
-- JohnTalintyre? - 18 Jul 2001
-- PeterThoeny - 12 Sep 2001
>
>
-- JohnTalintyre? - 18 Jul 2001
-- MikeMannix? - 12 Sep 2001
-- PeterThoeny - 12 Sep 2001
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.18 - 14 Sep 2001 - PeterThoeny)

TWiki Upgrade Guide

Line: 21 to 21

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

Changed:
<
<
>
>

  • 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.)
Line: 68 to 68

Pre-Upgrade Preparation

Changed:
<
<
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!
>
>
Two major areas of TWiki functionality - TWikiTemplates and TWikiForms (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!

The following steps describe the upgrade on Unix. Windows setup is very similar. We assume $TWIKIROOT to be the root of your current 01-Dec-2000 release, i.e. export TWIKIROOT=/some/dir/

Line: 186 to 186

  1. Remember that you have now two template directories:
    • The original twiki/templates.
    • The new twiki/templates2, which gets renamed to twiki/templates when you switch over the installation.
Changed:
<
<
  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:
>
>
  1. Customized templates and skins need to be upgraded to the new TWikiTemplates. 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.

  1. Form Templates replace the TWikiCategoryTables:
Changed:
<
<
>
>
    • Create a replacement TWikiForms 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.
Changed:
<
<
  1. 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.
>
>
  1. 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.

Step 10: Switch over to new installation

Line: 231 to 231

Step 11: Test the TWiki Plugins

Changed:
<
<
  1. Test the new TWikiPlugins by checking the Plugins settings in TWikiPreferences.
>
>
  1. 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.
  1. In case you have customized the functions extendHandleCommonTags, extendGetRenderedVersionOutsidePRE and extendGetRenderedVersionInsidePRE in twiki/bin/wikicfg.pm:
    • Merge those changes back into twiki/lib/TWiki/Plugins/Default.pm
Line: 240 to 240

  • Format changed of %GMTIME{"..."}% and %SERVERTIME{"..."}% variables. Format is now "$hour:$min" instead of "hour:min". More in TWikiVariables.
Changed:
<
<
  • 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.
>
>
  • 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.
Line: 252 to 252

    • 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.
Changed:
<
<
  • Handling for topic-specific templates like edit.new.tmpl has been removed and replaced by template topics in the new TWiki Template System )
>
>
  • Handling for topic-specific templates like edit.new.tmpl has been removed and replaced by template topics in the new TWikiTemplates.

  • 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 Issues of TWiki 01 Sep 2001

Changed:
<
<
>
>

-- JohnTalintyre? - 18 Jul 2001
-- PeterThoeny - 12 Sep 2001

 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.17 - 12 Sep 2001 - PeterThoeny)

TWiki Upgrade Guide

Line: 36 to 36

  • 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.)
Changed:
<
<
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.
>
>

TWiki Directory Structure and File Names

The TWiki directory structure remains the same, with one exception, the TWiki configuration file and Perl modules have been moved from the twiki/bin directory into it's own twiki/lib directory tree. The following files have been renamed and moved:

From TWiki 01-Dec-2000: To TWiki 01-Sep-2001:
twiki/bin/wikicfg.pm twiki/lib/TWiki.cfg
twiki/bin/wiki.pm twiki/lib/TWiki.pm
twiki/bin/wikiaccess.pm twiki/lib/TWiki/Access.pm
twiki/bin/wikiprefs.pm twiki/lib/TWiki/Prefs.pm
twiki/bin/wikisearch.pm twiki/lib/TWiki/Search.pm
twiki/bin/wikistore.pm twiki/lib/TWiki/Store.pm

A new twiki/lib/TWiki/Plugins directory contains the new Plugin modules.


Standard Upgrade Procedure

Added:
>
>
The idea is to have the new and old installation work in parallel so that you can test the new installation before switching over. That way you can make the switch on your live TWiki installation within one minute without affecting the users.

Before Switch: After Switch:
Current 01-Dec-2000: New 01-Sep-2001: Obsolete 01-Dec-2000: New 01-Sep-2001:
twiki/templates/ twiki/templates2/ twiki/templates1/ twiki/templates/
twiki/bin/ twiki/bin/2/ (overwritten) twiki/bin/
(N/A) twiki/bin/lib/ (N/A) twiki/lib/
twiki/data/TWiki twiki/data/TWiki2 twiki/data/TWiki1 twiki/data/TWiki
(other directories do not change)

Alternatively you could move the existing installation away, install the 01-Sep-2001 release into it's place and move your webs and pub files back.


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!

Added:
>
>
The following steps describe the upgrade on Unix. Windows setup is very similar. We assume $TWIKIROOT to be the root of your current 01-Dec-2000 release, i.e. export TWIKIROOT=/some/dir/

Step 1: Backup & Unpack

Changed:
<
<
    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
>
>
  1. Back up all existing TWiki directories twiki/bin, twiki/pub, twiki/data, twiki/templates.
  2. Create a temporary directory and unpack the ZIP file there:
    mkdir -p ~/tmp/
    cp -p ~/downloads/TWiki20010901.zip ~/tmp/
    cd ~/tmp/
    unzip ~/tmp/TWiki20010901.zip

Step 2: Upgrade TWiki document files

    1. Move the document files to your TWiki root ( twiki ):
Changed:
<
<

mv ~/tmp/TWiki*.html $TWIKIROOT
mv ~/tmp/index.html $TWIKIROOT
mv ~/tmp/readme.txt $TWIKIROOT
mv ~/tmp/license.txt $TWIKIROOT
>
>

mv ~/tmp/TWiki*.html $TWIKIROOT
mv ~/tmp/index.html $TWIKIROOT
mv ~/tmp/readme.txt $TWIKIROOT
mv ~/tmp/license.txt $TWIKIROOT

Step 3: Install new template files

  1. Move & rename the template directory to a temporary twiki/templates2 directory, ex:
    mv ~/tmp/templates $TWIKIROOT/templates2
  2. Pay attention to the file and directory permissions (security issue). Set file permissions, ex:
    chmod 644 *.cgi

Step 4: Install new data and pub files

  1. Move the TWiki web to a temporary TWiki2 twiki/data/TWiki2 directory. Do the same to files attached to this web, ex:
    mv ~/tmp/data/TWiki $TWIKIROOT/data/TWiki2
    mv ~/tmp/pub/TWiki $TWIKIROOT/pub/TWiki2
  2. Move & rename the Know web to a temporary twiki/data/Know2 directory, ex:
    mv ~/tmp/data/Know $TWIKIROOT/data/Know2
    mv ~/tmp/pub/Know $TWIKIROOT/pub/Know2
  3. Move the _default and Trash web, ex:
    mv ~/tmp/data/_default $TWIKIROOT/data
    mv ~/tmp/data/Trash $TWIKIROOT/data
  4. Move the MIME types file, ex:
    mv ~/tmp/data/mime.types $TWIKIROOT/data
  5. Pay attention to the file permissions of the TWiki2 and Know2 directories and its files. The files must be writable by the cgi-scripts (usually user nobody).
  6. In case the cgi-scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody and need to be changed the user of your cgi-scripts, i.e. www-data. A simple way to switch the locker of the RCS files is to use sed:
    for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done

Changed:
<
<

Step 3: Upgrade CGI scripts

>
>

Step 5: Install new CGI scripts


Added:
>
>
  1. Move & rename the CGI script directory to a temporary twiki/bin/2 directory, ex:
    mv ~/tmp/bin $TWIKIROOT/bin/2

    1. If necessary, change the script names to include the required extension, ex: .cgi
Changed:
<
<
    1. Restore any additional scripts you might have from the tmp directory, ex:
      mv ~/tmp/bin/somescript $TWIKIROOT/bin/
    2. Set permissions, ex:
      chmod 755 *.cgi
    3. Restore any additional scripts you might have from the tmp directory, ex:
      mv ~/tmp/bin/somescript $TWIKIROOT/bin/
    4. 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. 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. Copy any additional scripts you might have from the 01-Dec-2000 release, ex:
    cp -p $TWIKIROOT/bin/somescript $TWIKIROOT/bin/2
  2. In case you use basic authentication, rename .htaccess.txt to .htaccess and customize it, ex:
    cd $TWIKIROOT/bin/2
    mv .htaccess.txt .htaccess
    diff ../.htaccess .
    and merge the content
  3. Pay attention to the file and directory permissions (security issue). Set permissions, ex:
    chmod 755 *.cgi

Step 6: Install new Perl library files

  1. Move the lib directory to a temporary twiki/bin/lib directory, ex:
    mv ~/tmp/lib $TWIKIROOT/bin
  2. Pay attention to the file and directory permissions (security issue). Set permissions, ex:
    chmod 644 *.pm

Step 7: Set configurations and test installation

  1. Merge the content of the old twiki/bin/wikicfg.pm into the new twiki/lib/TWiki.cfg configuration file. Use the diff command to find out the differences, ex:
    cd $TWIKIROOT/bin/lib
    diff ../wikicfg.pm TWiki.cfg
  2. Make sure to set the correct temporary location of templates and scripts, ex:
    $scriptUrlPath    = "/twiki/bin/2";
    $templateDir      = "/home/httpd/twiki/templates2";
  3. Do not merge the functions extendHandleCommonTags, extendGetRenderedVersionOutsidePRE, extendGetRenderedVersionInsidePRE from the old twiki/bin/wikicfg.pm. This is now handled by the Default plugin twiki/lib/TWiki/Plugins/Default.pm
  4. Test your new TWiki installation to see if you can view topics. Point your browser to the old installation and fix the URL to see the new installation, ex:
    • Old URL: http://localhost/cgi-bin/view
    • New URL: http://localhost/cgi-bin/2/view

Step 8: Update topics

You can do the following changes using your old TWiki 01-Dec-2000 or new TWiki 01-Sep-2001 installation. Pointing your browser to the old installation for edit-copy-edit-paste operations is recommended so that users don't get surprized by meta-data content showing up in topics.

  1. Remember that you have now two TWiki webs:
    • The original TWiki web.
    • The new TWiki2 web, which gets renamed to TWiki when you switch over the installation.
  2. In case you customized TWiki.TWikiRegistration, merge your changes back into TWiki2.TWikiRegistration.
  3. Copy TWiki.TWikiWebsTable to TWiki2.TWikiWebsTable.
    • Do the same for any other topics you might have created in the TWiki web.
  4. In TWiki2.TWikiPreferences, merge the old TWiki.TWikiPreferences settings and customize it.
    • Add your webs to WIKIWEBLIST
    • Set the WIKIWEBMASTER
    • Set the SMTPMAILHOST
  5. In WebPreferences of all webs, add or change the following web preferences: (see TWiki.WebPreferences)
    • Add a NOSEARCHALL in case you want to exclude the web from a web="all" search:
      * Set NOSEARCHALL = on
    • Modify WEBTOPICLIST, ex:
      * Set WEBTOPICLIST = [[%HOMETOPIC%][Home]] %SEP% [[WebChanges][Changes]] %SEP% [[WebIndex][Index]] %SEP% [[WebSearch][Search]] %SEP% Go <input type="text" name="topic" size="16" />
    • Add a these new preferences:
      * Set DENYWEBVIEW =
      * Set ALLOWWEBVIEW =
      * Set DENYWEBRENAME =
      * Set ALLOWWEBRENAME =
    • Set FINALPREFERENCES:
      * Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
  6. In WebSearch of all webs, replace content with this one line:
    %INCLUDE{"%TWIKIWEB%.WebSearch"}%
  7. In WebChanges of all webs, replace content with this one line:
    %INCLUDE{"%TWIKIWEB%.WebChanges"}%

Step 9: Customize template files

Note: Skip this step in case you did not customize your template files.

  1. Remember that you have now two template directories:
    • The original twiki/templates.
    • The new twiki/templates2, which gets renamed to twiki/templates when you switch over the installation.

    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:
Line: 96 to 193

      • 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.
    1. 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.
Deleted:
<
<
    1. Test your TWiki installation to see if you can view topics.

Changed:
<
<

Step 6: Upgrade public files

>
>

Step 10: Switch over to new installation

In this step we relocate the working 01-Sep-2001 installation over the old 01-Dec-2000 installation, so that we don't need to change the URL.

  1. Test your new 01-Sep-2001 installation under twiki/bin/2/view to make sure everything works as expected.
    • Note: Don't worry about the Plugins, they will work after the switch.
  2. Edit $TWIKIROOT/bin/2/TWiki.cfg and remove the /2 from $scriptUrlPath and $templateDir, ex:
    $scriptUrlPath    = "/twiki/bin";
    $templateDir      = "/home/httpd/twiki/templates";
  3. Rename the TWiki2 web to TWiki, including attachments, ex:
    cd $TWIKIROOT/data
    mv TWiki TWiki1
    mv TWiki2 TWiki
    cd $TWIKIROOT/pub
    mv TWiki TWiki1
    mv TWiki2 TWiki
  4. Rename the templates2 directory to templates, ex:
    cd $TWIKIROOT
    mv templates templates1
    mv templates2 templates
  5. Move the lib directory one level up from $TWIKIROOT/bin/lib to $TWIKIROOT/lib, ex:
    cd $TWIKIROOT
    mv bin/lib .
  6. Copy content of bin/2 to bin, ex:
    cd $TWIKIROOT/bin
    cp -p bin/2/* .
    cp -p bin/2/.htaccess .
  7. Point your browser to the original URL and make sure the relocated 01-Sep-2001 installation works as expected, i.e. check browsing, searching and user registration.
  8. Clean up and remove obsolete directories:
    • Remove directory $TWIKIROOT/bin/2
    • Remove directory $TWIKIROOT/templates1
    • Remove directory $TWIKIROOT/data/TWiki1
    • Remove directory $TWIKIROOT/pub/TWiki1
    • Remove temporary directory, ex: ~/tmp

Changed:
<
<
    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. 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
>
>

Step 11: Test the TWiki Plugins

  1. 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.
  2. In case you have customized the functions extendHandleCommonTags, extendGetRenderedVersionOutsidePRE and extendGetRenderedVersionInsidePRE in twiki/bin/wikicfg.pm:
    • Merge those changes back into twiki/lib/TWiki/Plugins/Default.pm

General Format Changes

Line: 141 to 256

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

Changed:
<
<

Known Upgrade Issues

>
>

Known Issues of TWiki 01 Sep 2001


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

-- JohnTalintyre? - 18 Jul 2001

>
>
-- JohnTalintyre? - 18 Jul 2001
-- PeterThoeny - 12 Sep 2001
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.16 - 12 Sep 2001 - MikeMannix?)

TWiki Upgrade Guide

Line: 23 to 23

Changed:
<
<
>
>

Changed:
<
<
  • TWikiFormTemplate - Create multiple input forms per web; data is rendered in HTML tables.
>
>
  • TWikiForms - Create multiple input forms per web; data is rendered in HTML tables.

 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.15 - 09 Sep 2001 - MikeMannix?)

TWiki Upgrade Guide

Line: 22 to 22

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.
Changed:
<
<
>
>

Changed:
<
<
  • TOC (Table of Contents) - %TOC% variable generates a hierarchical table of contents from topic headings: <HI>...<H6>. Set depth.
>
>
  • TOC (Table of Contents) - %TOC% variable generates a hierarchical table of contents from topic headings: <HI>...<H6>. Set depth.

Changed:
<
<
  • Attachments Under Revision Control Changes to files attached to topics - - are now tracked under revision control (RCS).
  • ConvertToXHTML10 - 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, for example, as in Yahoo! and other search sites.
>
>
  • 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

Changed:
<
<
Follow this step-by-step guide to upgrade the 01 Dec 2000 version to the 01 Sep 2001 release, and import your original page data:
>
>
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:

Changed:
<
<

Step 1: Backup & Unpack

>
>

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!


Changed:
<
<
    1. Backup all existing TWiki directories ( bin, pub, data, templates )
>
>

Step 1: Backup & Unpack


Changed:
<
<
    1. Unpack the zip file into some working directory:
>
>
    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/
Changed:
<
<

cd ~/tmp
unzip ~/TWiki20001201.zip
>
>

mv $TWIKIROOT/* ~/tmp/
    1. Unpack the zip file into your newly empty working directory:
      cd $TWIKIROOT
      unzip ~/TWiki20010901.zip

Step 2: Upgrade TWiki document files

Line: 60 to 65

Step 3: Upgrade CGI scripts

Changed:
<
<
    1. Rename your original twiki/bin directory: ( twiki/bin )
      mv $TWIKIROOT/bin $TWIKIROOT/bin.old
    2. Move the new scripts to your original twiki/bin location, i.e.
      mv ~/tmp/bin $TWIKIROOT/bin
    3. Merge the changes in your current wikicfg.pm into the new wikicfg.pm. We suggest using diff -c to compare the two files if you have made heavy changes to the file:
      diff -c $TWIKIROOT/bin.old/wikicfg.pm $TWIKIROOT/bin/wikicfg.pm | less
    4. Restore any additional scripts you might have from the old directory, ex:
      mv $TWIKIROOT/bin.old/somescript $TWIKIROOT/bin/
    5. Test your TWiki installation if you can view topics.
>
>
    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. 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)
Changed:
<
<

Step 4: Upgrade template files

>
>

Step 5: Upgrade template files


Changed:
<
<
    1. Rename your original twiki/templates directory: ( twiki/templates )
      mv $TWIKIROOT/templates $TWIKIROOT/templates.old
    2. Move the new templates to your original twiki/templates location:
      mv ~/tmp/templates $TWIKIROOT/templates
    3. Customized templates and skins need to be upgraded to the new template format. The safest way is to use the new templates as a base and to merge your changes back. Changes in new templates:
      • Changed format from HTML to XHTML.
>
>
    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:

Changed:
<
<
    1. The Form Templates replace the TWikiCategoryTable:
>
>
    1. 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.
Deleted:
<
<
    1. __Merge the changes in your current template files into the new template files. To compare two files use
      =diff -c $TWIKIROOT/templates.old/view.tmpl $TWIKIROOT/templates/view.tmpl | less=__

    1. 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.
Deleted:
<
<
    1. Restore any additional template subdirectories of your TWiki webs you might have and merge the changes.

    1. Test your TWiki installation to see if you can view topics.
Changed:
<
<

Step 5: Upgrade public files

    1. Move the new twiki/pub/TWiki directory to your installation: ( twiki/pub )
      mv ~/tmp/pub/TWiki $TWIKIROOT/pub/
    2. Move the new twiki/pub/twikilogo* image files to your installation:
      mv ~/tmp/pub/twikilogo* $TWIKIROOT/pub
>
>

Step 6: Upgrade public files


Changed:
<
<
    • Pay attention to the file permissions of the TWiki directory and its subdirectory and files. The files must be writable by the CGI scripts (usually user "nobody").
>
>
    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/

Changed:
<
<

Step 6: Upgrade data files

>
>

Step 7: Upgrade data files


Changed:
<
<
    1. Move the new twiki/data/TWiki directory to your installation: ( twiki/data )
>
>
    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")
Deleted:
<
<
    1. Optionally move the new twiki/data/Test directory to your installation,
      mv ~/tmp/data/Test $TWIKIROOT/data/
      (Pay attention to the file permissions)

    1. 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*.
    2. TWikiPreferences into TWiki.TWikiPreferences.
    3. Merge your changes to the WebPreferences topics in all your webs into WebPreferences
    4. Modify the WebPreferences topics in all your webs to reflect the following:
Changed:
<
<
      • WEBTOPICLIST should use WebChanges for "Changes", and WebIndex for "Index":
        | <a href="WebChanges">Changes</a>
        | <a href="WebIndex">Index</a>
>
>

      • In case you want to exclude a web from a web="all" search: Set this new preference
        Set NOSEARCHALL = on
    1. 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.
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.14 - 08 Sep 2001 - MikeMannix?)

TWiki Upgrade Guide

Line: 31 to 31

  • 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.
Changed:
<
<
  • [[TWiki.FileAttachments][Attachments Under Revision Control] Changes to files attached to topics - - are now tracked under revision control (RCS).
>
>

  • ConvertToXHTML10 - 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, for example, as in Yahoo! and other search sites.
Line: 120 to 120

    1. 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.
    2. Change the WebHome topics in all your webs to reflect these changes:
    3. If you are using .htaccess, add the rename script
Changed:
<
<
* You may want to add [ALLOW|DENY][WEB|TOPIC]RENAME in some places, like TWikiTWikiPreferences?, WebPreferences and TWikiUsers
>
>
* 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.
Changed:
<
<
  • 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.
>
>
  • 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.
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.13 - 08 Sep 2001 - MikeMannix?)

TWiki Upgrade Guide

Changed:
<
<
Upgrading from the 01-Dec-2000 release to the new TWiki 01-Sep-2001
>
>
Upgrade from TWiki 01-Dec-2000 to TWiki 01-Sep-2001 (previous to new full release)

Overview

Changed:
<
<
The latest version of TWiki (01-Sep-2001) involves several major new features and numerous enhancements of 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.
>
>
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.
Changed:
<
<
>
>

Changed:
<
<
  • To upgrade from a Beta of the new release, or if you've made custom modifications, read through the documentation and use the procedure below as a guideline.
>
>
  • 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:

Changed:
<
<
  • TWiki Plugins - Easily install program enhancements using external plug-in modules. Developers can create plug-ins in Perl, with the TWiki Plugin API.
  • 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.
Changed:
<
<
  • ArbitraryTextForWikiWordLinks - Text formatting rules to form links from any combination of words and spaces.
  • AttachmentsUnderRevisionControl Changes to files attached to topics - FileAttachments - are now tracked under revision control (RCS).
>
>
  • Arbitrary Text for WikiWord Links - Text formatting rules to generate automatic links from any combination of words and spaces.
  • [[TWiki.FileAttachments][Attachments Under Revision Control] Changes to files attached to topics - - are now tracked under revision control (RCS).

  • ConvertToXHTML10 - Templates and HTML page rendering are in XHTML 1.0 as far as possible without breaking HTML 3.2 compliance.
Changed:
<
<
  • HierarchicalNavigation
>
>
  • HierarchicalNavigation uses new Meta Data variables to link hierarchically, for example, as in Yahoo! and other search sites.

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.

Line: 78 to 78


mv $TWIKIROOT/templates $TWIKIROOT/templates.old
    1. Move the new templates to your original twiki/templates location:
      mv ~/tmp/templates $TWIKIROOT/templates
Added:
>
>
    1. Customized templates and skins need to be upgraded to the new template format. The safest way is to use the new templates as a base and to merge your changes back. Changes in new templates:
      • Changed format from HTML to XHTML.
      • 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. The Form Templates replace the TWikiCategoryTable:
      • 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.

    1. __Merge the changes in your current template files into the new template files. To compare two files use
      =diff -c $TWIKIROOT/templates.old/view.tmpl $TWIKIROOT/templates/view.tmpl | less=__
Added:
>
>
    1. 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.

    1. Restore any additional template subdirectories of your TWiki webs you might have and merge the changes.
    2. Test your TWiki installation to see if you can view topics.
Line: 111 to 119


Set NOSEARCHALL = on
    1. 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.
    2. Change the WebHome topics in all your webs to reflect these changes:
Added:
>
>
    1. If you are using .htaccess, add the rename script * You may want to add [ALLOW|DENY][WEB|TOPIC]RENAME in some places, like TWikiTWikiPreferences?, 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

Added:
>
>

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

-- JohnTalintyre? - 18 Jul 2001

 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.12 - 07 Sep 2001 - MikeMannix?)

TOC: No TOC in "TWiki.TWikiUpgradeTo01Dec2001"
Changed:
<
<

TWiki Upgrade Guide

>
>

TWiki Upgrade Guide


Upgrading from the 01-Dec-2000 release to the new TWiki 01-Sep-2001

Changed:
<
<

Overview

>
>

Overview


The latest version of TWiki (01-Sep-2001) involves several major new features and numerous enhancements of 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.

Changed:
<
<

Upgrade Requirements

>
>

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.
Line: 17 to 17

  • To upgrade from a Beta of the new release, or if you've made custom modifications, read through the documentation and use the procedure below as a guideline.
Changed:
<
<

Major Changes from TWiki 01-Dec-2000

>
>

Major Changes from TWiki 01-Dec-2000


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

Line: 37 to 37

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.

Changed:
<
<

Standard Upgrade Procedure

>
>

Standard Upgrade Procedure


Follow this step-by-step guide to upgrade the 01 Dec 2000 version to the 01 Sep 2001 release, and import your original page data:

Changed:
<
<

Step 1: Backup & Unpack

>
>

Step 1: Backup & Unpack


    1. Backup all existing TWiki directories ( bin, pub, data, templates )
Line: 50 to 50


cd ~/tmp
unzip ~/TWiki20001201.zip
Changed:
<
<

Step 2: Upgrade TWiki document files

>
>

Step 2: Upgrade TWiki document files


    1. Move the document files to your TWiki root ( twiki ):
      mv ~/tmp/TWiki*.html $TWIKIROOT
Line: 58 to 58


mv ~/tmp/readme.txt $TWIKIROOT
mv ~/tmp/license.txt $TWIKIROOT
Changed:
<
<

Step 3: Upgrade CGI scripts

>
>

Step 3: Upgrade CGI scripts


    1. Rename your original twiki/bin directory: ( twiki/bin )
      mv $TWIKIROOT/bin $TWIKIROOT/bin.old
Line: 72 to 72

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

Step 4: Upgrade template files

>
>

Step 4: Upgrade template files


    1. Rename your original twiki/templates directory: ( twiki/templates )
      mv $TWIKIROOT/templates $TWIKIROOT/templates.old
Line: 83 to 83

    1. Restore any additional template subdirectories of your TWiki webs you might have and merge the changes.
    2. Test your TWiki installation to see if you can view topics.
Changed:
<
<

Step 5: Upgrade public files

>
>

Step 5: Upgrade public files


    1. Move the new twiki/pub/TWiki directory to your installation: ( twiki/pub )
      mv ~/tmp/pub/TWiki $TWIKIROOT/pub/
Line: 92 to 92

    • Pay attention to the file permissions of the TWiki directory and its subdirectory and files. The files must be writable by the CGI scripts (usually user "nobody").
Changed:
<
<

Step 6: Upgrade data files

>
>

Step 6: Upgrade data files


    1. Move the new twiki/data/TWiki directory to your installation: ( twiki/data )
      mv ~/tmp/data/TWiki $TWIKIROOT/data/
Line: 112 to 112

    1. 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.
    2. Change the WebHome topics in all your webs to reflect these changes:
Changed:
<
<

Known Upgrade Issues

>
>

Known Upgrade Issues


 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.11 - 06 Sep 2001 - MikeMannix?)

TWiki Upgrade Guide

Changed:
<
<
Upgrading from the TWiki 01-Dec-2000 to the new 01-Sep-2001 release
>
>
Upgrading from the 01-Dec-2000 release to the new TWiki 01-Sep-2001

Overview

Changed:
<
<
The latest version of TWiki (01-Sep-2001) involves several major new features and numerous enhancements from the last full version (01-Dec-2001). The file system set-up is almost identical, but much of the underlying data structure and procedures are new. With all the changes, the upgrade procedure is straightforward, and your existing page data is imported directly.
>
>
The latest version of TWiki (01-Sep-2001) involves several major new features and numerous enhancements of 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.

Changed:
<
<

Upgrade Requirements for TWiki 01-Sep-2001

>
>

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.
Line: 37 to 37

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.

Changed:
<
<

Six-Step Standard Upgrade

>
>

Standard Upgrade Procedure


Follow this step-by-step guide to upgrade the 01 Dec 2000 version to the 01 Sep 2001 release, and import your original page data:

 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.10 - 06 Sep 2001 - MikeMannix?)

TWiki Upgrade Guide

Changed:
<
<
Upgrade application and content from last official release 01-Dec-2000 to current 01-Sep-2001
>
>
Upgrading from the TWiki 01-Dec-2000 to the new 01-Sep-2001 release

Overview

Changed:
<
<
Major changes, numerous enhancements, basic structure similar.... Beta on their own...easy. Upgrade involves a changing and merging of files and configs...
>
>
The latest version of TWiki (01-Sep-2001) involves several major new features and numerous enhancements from the last full version (01-Dec-2001). The file system set-up is almost identical, but much of the underlying data structure and procedures are new. With all the changes, the upgrade procedure is straightforward, and your existing page data is imported directly.

Upgrade Requirements for TWiki 01-Sep-2001

Changed:
<
<
Upgrade from your 01-Dec-2000 edition to the new, next generation 01-Sep-2001 TWiki Production Release in a few straightforward steps.
>
>
  • To upgrade from a 01-Dec-2000 standard installation to the new, next generation 01-Sep-2001 TWiki Production Release, follow the instructions below.

  • To upgrade from a Beta of the new release, or if you've made custom modifications, read through the documentation and use the procedure below as a guideline.

Major Changes from TWiki 01-Dec-2000

Changed:
<
<
The 01 Sep 2001 release includes several new areas of functionality, and existing features have been significantly revised and enhanced. These changes affect the upgrade of the 01 Dec 2000 version:
>
>
The 01 Sep 2001 release includes the following new features and enhancements:

Changed:
<
<
  • TWikiPlugins major enhancement, allows easy installation and removal of program enhancements using external plug-in modules, standardized creation of Plugins with the Plugins API
    • InterWikisPlugin - preinstalled
  • AttachmentsUnderRevisionControl In the previous version, changes to topics were tracked under revision control (RCS); now, topic Attachments are also tracked.
  • ManagingTopics/Move/Delete Topic In the previous version, managing topics required access to the TWiki file system (Telnet or FTP); now, moving, renaming, deleting can be done through the browser. Deleted topics are act move and stored in a common Trash web.
  • TOC (Table of Contents) Automatically generates a hierarchical Table of Contents from topic headings: <HI>...<H6>. Set depth...
  • ArbitraryTextForWikiWordLinks
  • ChangingPasswords done by Web form
  • TWikiFormTemplate
  • TWikiTemplateSystem all new template set-up
  • TWikiSkins
  • SuperAdminCanEdit
  • TWikiMetaData
  • ConvertToXHTML10
>
>
  • TWiki Plugins - Easily install program enhancements using external plug-in modules. Developers can create plug-ins in Perl, with the TWiki Plugin API.
  • 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.
  • ArbitraryTextForWikiWordLinks - Text formatting rules to form links from any combination of words and spaces.
  • AttachmentsUnderRevisionControl Changes to files attached to topics - FileAttachments - are now tracked under revision control (RCS).
  • ConvertToXHTML10 - Templates and HTML page rendering are in XHTML 1.0 as far as possible without breaking HTML 3.2 compliance.

  • HierarchicalNavigation
Changed:
<
<
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.
>
>
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.

Six-Step Standard Upgrade

Changed:
<
<
Follow this step-by-step guide to upgrade the 01 Dec 2000 version to the 01 Sep 2001 release, and transfer all of your original data: [ We assume export TWIKIROOT=/some/dir/ ]
>
>
Follow this step-by-step guide to upgrade the 01 Dec 2000 version to the 01 Sep 2001 release, and import your original page data:

Deleted:
<
<

Step 1: Backup & Unpack

Changed:
<
<
  1. Backup all existing TWiki directories ( bin, pub, data, templates )
>
>
    1. Backup all existing TWiki directories ( bin, pub, data, templates )

Changed:
<
<
  • Unpack the zip file into some working directory:
>
>
    1. Unpack the zip file into some working directory:


mkdir -p ~/tmp/
cd ~/tmp
unzip ~/TWiki20001201.zip

Step 2: Upgrade TWiki document files

Changed:
<
<
    • Move the document files to your TWiki root: ( twiki )
>
>
    1. Move the document files to your TWiki root ( twiki ):


mv ~/tmp/TWiki*.html $TWIKIROOT
Added:
>
>

mv ~/tmp/index.html $TWIKIROOT


mv ~/tmp/readme.txt $TWIKIROOT
Added:
>
>

mv ~/tmp/license.txt $TWIKIROOT

Changed:
<
<

Step 3: Upgrade cgi-bin scripts

>
>

Step 3: Upgrade CGI scripts


Changed:
<
<
    • Rename your original twiki/bin directory: ( twiki/bin )
>
>
    1. Rename your original twiki/bin directory: ( twiki/bin )


mv $TWIKIROOT/bin $TWIKIROOT/bin.old
Changed:
<
<
    • Move the new scripts to your original twiki/bin location, i.e.
>
>
    1. Move the new scripts to your original twiki/bin location, i.e.


mv ~/tmp/bin $TWIKIROOT/bin
Changed:
<
<
    • Merge the changes in your current wikicfg.pm into the new wikicfg.pm. We suggest using diff -c to compare the two files if you have made heavy changes to the file, i.e.
>
>
    1. Merge the changes in your current wikicfg.pm into the new wikicfg.pm. We suggest using diff -c to compare the two files if you have made heavy changes to the file:


diff -c $TWIKIROOT/bin.old/wikicfg.pm $TWIKIROOT/bin/wikicfg.pm | less
Changed:
<
<
    • Restore any additional scripts you might have from the old directory, i.e.
>
>
    1. Restore any additional scripts you might have from the old directory, ex:


mv $TWIKIROOT/bin.old/somescript $TWIKIROOT/bin/
Changed:
<
<

(Note that the changes script is obsolete.)
    • In case you have basic authentication:
      • The TWikiRegistration topic moved from the TWiki.Main web to the TWiki.TWiki web. Change .htaccess to reflect the new location, i.e.
        ErrorDocument 401 /cgi-bin/view/TWiki/TWikiRegistration
>
>
    1. Test your TWiki installation if you can view topics.


    • Pay attention to the file and directory permissions (security issue)
Deleted:
<
<
    • Test your TWiki installation if you can view topics. (Ignore the %HTTP_EQUIV_ON_VIEW% you see on top of the topic; this will disappear after upgrading the template files.

Step 4: Upgrade template files

Changed:
<
<
    • Rename your original twiki/templates directory: ( twiki/templates )
>
>
    1. Rename your original twiki/templates directory: ( twiki/templates )


mv $TWIKIROOT/templates $TWIKIROOT/templates.old
Changed:
<
<
    • Move the new templates to your original twiki/templates location, i.e.
>
>
    1. Move the new templates to your original twiki/templates location:


mv ~/tmp/templates $TWIKIROOT/templates
Changed:
<
<
    • Merge the changes in your current template files into the new template files. To compare two files use
      diff -c $TWIKIROOT/templates.old/view.tmpl $TWIKIROOT/templates/view.tmpl | less
    • Restore any additional template subdirectories of your TWiki webs you might have and merge the changes.
    • Test your TWiki installation if you can view topics.
>
>
    1. __Merge the changes in your current template files into the new template files. To compare two files use
      =diff -c $TWIKIROOT/templates.old/view.tmpl $TWIKIROOT/templates/view.tmpl | less=__
    2. Restore any additional template subdirectories of your TWiki webs you might have and merge the changes.
    3. Test your TWiki installation to see if you can view topics.

Step 5: Upgrade public files

Changed:
<
<
    • Move the new twiki/pub/TWiki directory to your installation: ( twiki/pub )
>
>

    1. Move the new twiki/pub/TWiki directory to your installation: ( twiki/pub )


mv ~/tmp/pub/TWiki $TWIKIROOT/pub/
Changed:
<
<
    • Pay attention to the file permissions of the TWiki directory and its subdirectory and files. The files must be writable by the cgi-scripts (usually user "nobody")
    • Move the new twiki/pub/twikilogo* image files to your installation, i.e.
      mv ~/tmp/pub/twikilogo* $TWIKIROOT/pub/
>
>
    1. Move the new twiki/pub/twikilogo* image files to your installation:
      mv ~/tmp/pub/twikilogo* $TWIKIROOT/pub

    • Pay attention to the file permissions of the TWiki directory and its subdirectory and files. The files must be writable by the CGI scripts (usually user "nobody").

Step 6: Upgrade data files

Changed:
<
<
    • Move the new twiki/data/TWiki directory to your installation: ( twiki/data )
>
>

    1. Move the new twiki/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")
Changed:
<
<
    • Optionally move the new twiki/data/Test directory to your installation, i.e.
>
>
    1. Optionally move the new twiki/data/Test directory to your installation,


mv ~/tmp/data/Test $TWIKIROOT/data/
(Pay attention to the file permissions)
Changed:
<
<
    • Move these new TWiki.Main web topics to your TWiki.Main web: TWikiGroups, TWikiAdminGroup, and if needed also OfficeLocations , i.e.
      mv ~/tmp/data/Main/TWikiGroups.* $TWIKIROOT/data/Main
      (Pay attention to the file permissions)
    • The following topics in the TWiki.Main web are obsolete and can be deleted: BillClinton, GoodStyle, RegularExpression, TextFormattingFAQ, TextFormattingRules, ManagingWebs, TWikiCategoryTable, TWikiEnhancementRequests, TWikiImplementationNotes, TWikiInstallationGuide, WebNotification, TWikiPlannedFeatures, TWikiUpgradeTo01May2000, TWikiUsernameVsLoginUsername, TWikiSite, WelcomeGuest, WelcomeVisitor, WikiName, WikiNotation, WikiTopic, WikiWikiClones. Sample delete command:+
      rm -f $TWIKIROOT/data/Main/BillClinton.*
    • The following topics are new and most be copied to all of your TWiki webs: WebChanges, WebIndex.
      cp -p $TWIKIROOT/data/TWiki/WebChanges.txt* $TWIKIROOT/data/Main
      cp -p $TWIKIROOT/data/TWiki/WebIndex.txt* $TWIKIROOT/data/Main
      Repeat this for all your webs. Pay attention to the file permissions.
    • 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*.
    • TWikiPreferences moved from TWiki.Main to TWiki.TWiki. Merge your changes to TWikiPreferences into TWiki.TWikiPreferences.
    • Modify the WebPreferences topics in all your webs to reflect the following:
      • WEBTOPICLIST should use WebChanges for "Changes", and WebIndex for "Index", i.e.
>
>
    1. 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*.
    2. TWikiPreferences into TWiki.TWikiPreferences.
    3. Merge your changes to the WebPreferences topics in all your webs into WebPreferences
    4. Modify the WebPreferences topics in all your webs to reflect the following:
      • WEBTOPICLIST should use WebChanges for "Changes", and WebIndex for "Index":


| <a href="WebChanges">Changes</a>
| <a href="WebIndex">Index</a>
      • In case you want to exclude a web from a web="all" search: Set this new preference
        Set NOSEARCHALL = on
Changed:
<
<
    • 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.
    • Change the WebHome topics in all your webs to reflect these changes:
      1. The "Changes" link should point to WebChanges.
      2. The "Topic index" link should point to WebIndex.
      3. Change the include of the web table to %INCLUDE{"%TWIKIWEB%.TWikiWebsTable"}%
    • Merge your TWikiWebsTable topic in TWiki.Main with the TWikiWebsTable topic in TWiki.TWiki. Note the new variable to query the color of a web. Delete the old TWikiWebsTable topic in TWiki.Main after merge is complete.
    • The following topics in the TWiki.Main web are deprecated (because they moved to TWiki.TWiki), but still need to be present in TWiki.Main because of existing links to them: FileAttachment, TWikiDocumentation, TWikiHistory, TWikiPreferences, TWikiVariables.
      It is recommended that you edit these topics in TWiki.Main and replace the content with this line:
      This topic moved to %TWIKIWEB%.%TOPIC% in the %WIKITOOLNAME%.%TWIKIWEB% web.
    • In all your webs, change references to topics that moved to the TWiki.TWiki web:
      • Change topics: TWikiUsers , WebNotify , WebHome
      • With links to: TWikiPreferences , TWikiVariables , TWikiUsers , TWikiWebsTable and WelcomeGuest

Setting Access Control

    • Read TWikiAccessControl, in case you want to use the new authorization feature based on groups.
>
>
    1. 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.
    2. Change the WebHome topics in all your webs to reflect these changes:

Known Upgrade Issues

Deleted:
<
<

-- MikeMannix? - 26 Aug 2001

 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.9 - 03 Sep 2001 - MikeMannix?)

TWiki Upgrade Guide

Changed:
<
<

Upgrading to TWiki 01-Sep-2001

>
>
Upgrade application and content from last official release 01-Dec-2000 to current 01-Sep-2001

Overview

Major changes, numerous enhancements, basic structure similar.... Beta on their own...easy. Upgrade involves a changing and merging of files and configs...

Upgrade Requirements for TWiki 01-Sep-2001


Upgrade from your 01-Dec-2000 edition to the new, next generation 01-Sep-2001 TWiki Production Release in a few straightforward steps.

Added:
>
>

Changed:
<
<

Major Changes from 01-Dec-2000

>
>

Major Changes from TWiki 01-Dec-2000


The 01 Sep 2001 release includes several new areas of functionality, and existing features have been significantly revised and enhanced. These changes affect the upgrade of the 01 Dec 2000 version:

  • TWikiPlugins major enhancement, allows easy installation and removal of program enhancements using external plug-in modules, standardized creation of Plugins with the Plugins API
Added:
>
>
    • InterWikisPlugin - preinstalled

  • AttachmentsUnderRevisionControl In the previous version, changes to topics were tracked under revision control (RCS); now, topic Attachments are also tracked.
  • ManagingTopics/Move/Delete Topic In the previous version, managing topics required access to the TWiki file system (Telnet or FTP); now, moving, renaming, deleting can be done through the browser. Deleted topics are act move and stored in a common Trash web.
  • TOC (Table of Contents) Automatically generates a hierarchical Table of Contents from topic headings: <HI>...<H6>. Set depth...
  • ArbitraryTextForWikiWordLinks
Changed:
<
<
  • ChangingTWikiPasswords done by Web form
>
>
  • ChangingPasswords done by Web form

  • TWikiFormTemplate
  • TWikiTemplateSystem all new template set-up
  • TWikiSkins
Line: 27 to 35

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.

Changed:
<
<

Picking the Right Upgrade Path

Check these to make sure you're on the right page:

  • If you've updated, replaced, or even added files from any of this year's Beta test releases of the new TWiki, head here: TWikiBetaUpgradeNotes?.
  • To upgrade from a pre-01-Dec-2000 TWiki, make this your first stop: TWikiUpgradeTo01Dec2000.

Standard Six-Step Upgrade

>
>

Six-Step Standard Upgrade


Follow this step-by-step guide to upgrade the 01 Dec 2000 version to the 01 Sep 2001 release, and transfer all of your original data: [ We assume export TWIKIROOT=/some/dir/ ]

Line: 98 to 100

    • Move these new TWiki.Main web topics to your TWiki.Main web: TWikiGroups, TWikiAdminGroup, and if needed also OfficeLocations , i.e.
      mv ~/tmp/data/Main/TWikiGroups.* $TWIKIROOT/data/Main
      (Pay attention to the file permissions)
Changed:
<
<
    • The following topics in the TWiki.Main web are obsolete and can be deleted: BillClinton, GoodStyle, RegularExpression, TextFormattingFAQ, TextFormattingRules, ManagingWebs, TWikiCategoryTable, TWikiEnhancementRequests, TWikiImplementationNotes, TWikiInstallationGuide, WebNotification, TWikiPlannedFeatures, TWikiUpgradeTo01May2000, TWikiUsernameVsLoginUsername, TWikiSite, WelcomeGuest, WelcomeVisitor, WikiName, WikiNotation, WikiTopic, WikiWikiClones. Sample delete command:
>
>
    • The following topics in the TWiki.Main web are obsolete and can be deleted: BillClinton, GoodStyle, RegularExpression, TextFormattingFAQ, TextFormattingRules, ManagingWebs, TWikiCategoryTable, TWikiEnhancementRequests, TWikiImplementationNotes, TWikiInstallationGuide, WebNotification, TWikiPlannedFeatures, TWikiUpgradeTo01May2000, TWikiUsernameVsLoginUsername, TWikiSite, WelcomeGuest, WelcomeVisitor, WikiName, WikiNotation, WikiTopic, WikiWikiClones. Sample delete command:+


rm -f $TWIKIROOT/data/Main/BillClinton.*
    • The following topics are new and most be copied to all of your TWiki webs: WebChanges, WebIndex.
      cp -p $TWIKIROOT/data/TWiki/WebChanges.txt* $TWIKIROOT/data/Main
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.8 - 01 Sep 2001 - MikeMannix?)

TWiki Upgrade Guide

Line: 13 to 13

  • TWikiPlugins major enhancement, allows easy installation and removal of program enhancements using external plug-in modules, standardized creation of Plugins with the Plugins API
  • AttachmentsUnderRevisionControl In the previous version, changes to topics were tracked under revision control (RCS); now, topic Attachments are also tracked.
Changed:
<
<
  • RenameTopic/Move/Delete Topic In the previous version, managing topics required access to the TWiki file system (Telnet or FTP); now, moving, renaming, deleting can be done through the browser. Deleted topics are act move and stored in a common Trash web.
>
>
  • ManagingTopics/Move/Delete Topic In the previous version, managing topics required access to the TWiki file system (Telnet or FTP); now, moving, renaming, deleting can be done through the browser. Deleted topics are act move and stored in a common Trash web.

  • TOC (Table of Contents) Automatically generates a hierarchical Table of Contents from topic headings: <HI>...<H6>. Set depth...
  • ArbitraryTextForWikiWordLinks
  • ChangingTWikiPasswords done by Web form
Line: 98 to 98

    • Move these new TWiki.Main web topics to your TWiki.Main web: TWikiGroups, TWikiAdminGroup, and if needed also OfficeLocations , i.e.
      mv ~/tmp/data/Main/TWikiGroups.* $TWIKIROOT/data/Main
      (Pay attention to the file permissions)
Changed:
<
<
    • The following topics in the TWiki.Main web are obsolete and can be deleted: BillClinton, GoodStyle, RegularExpression, TextFormattingFAQ, TextFormattingRules, TWikiAdministration, TWikiCategoryTable, TWikiEnhancementRequests, TWikiImplementationNotes, TWikiInstallationGuide, TWikiNotificationOfChanges, TWikiPlannedFeatures, TWikiUpgradeTo01May2000, TWikiUsernameVsLoginUsername, TWikiSite, WelcomeGuest, WelcomeVisitor, WikiName, WikiNotation, WikiTopic, WikiWikiClones. Sample delete command:
>
>
    • The following topics in the TWiki.Main web are obsolete and can be deleted: BillClinton, GoodStyle, RegularExpression, TextFormattingFAQ, TextFormattingRules, ManagingWebs, TWikiCategoryTable, TWikiEnhancementRequests, TWikiImplementationNotes, TWikiInstallationGuide, WebNotification, TWikiPlannedFeatures, TWikiUpgradeTo01May2000, TWikiUsernameVsLoginUsername, TWikiSite, WelcomeGuest, WelcomeVisitor, WikiName, WikiNotation, WikiTopic, WikiWikiClones. Sample delete command:


rm -f $TWIKIROOT/data/Main/BillClinton.*
    • The following topics are new and most be copied to all of your TWiki webs: WebChanges, WebIndex.
      cp -p $TWIKIROOT/data/TWiki/WebChanges.txt* $TWIKIROOT/data/Main
Line: 135 to 135

-- MikeMannix? - 26 Aug 2001

Deleted:
<
<
META TOPICMOVED MikeMannix? date="999319954" from="TWiki.TWikiUpgradeNotes" to="TWiki.TWikiUpgradeGuide"
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.7 - 01 Sep 2001 - MikeMannix?)

TWiki Upgrade Guide

Line: 6 to 6

Upgrading to TWiki 01-Sep-2001

Upgrade from your 01-Dec-2000 edition to the new, next generation 01-Sep-2001 TWiki Production Release in a few straightforward steps.

Deleted:
<
<

Major Changes from 01-Dec-2000

Line: 34 to 33

  • If you've updated, replaced, or even added files from any of this year's Beta test releases of the new TWiki, head here: TWikiBetaUpgradeNotes?.
  • To upgrade from a pre-01-Dec-2000 TWiki, make this your first stop: TWikiUpgradeTo01Dec2000.
Changed:
<
<

Standard 6-Step Full Upgrade

>
>

Standard Six-Step Upgrade


Follow this step-by-step guide to upgrade the 01 Dec 2000 version to the 01 Sep 2001 release, and transfer all of your original data: [ We assume export TWIKIROOT=/some/dir/ ]

Line: 99 to 98

    • Move these new TWiki.Main web topics to your TWiki.Main web: TWikiGroups, TWikiAdminGroup, and if needed also OfficeLocations , i.e.
      mv ~/tmp/data/Main/TWikiGroups.* $TWIKIROOT/data/Main
      (Pay attention to the file permissions)
Changed:
<
<
    • The following topics in the TWiki.Main web are obsolete and can be deleted: BillClinton, GoodStyle, RegularExpression, TextFormattingFAQ, TextFormattingRules, TWikiAdministration, TWikiCategoryTable, TWikiEnhancementRequests, TWikiImplementationNotes, TWikiInstallationNotes, TWikiNotificationOfChanges, TWikiPlannedFeatures, TWikiUpgradeTo01May2000, TWikiUsernameVsLoginUsername, TWikiSite, WelcomeGuest, WelcomeVisitor, WikiName, WikiNotation, WikiTopic, WikiWikiClones. Sample delete command:
>
>
    • The following topics in the TWiki.Main web are obsolete and can be deleted: BillClinton, GoodStyle, RegularExpression, TextFormattingFAQ, TextFormattingRules, TWikiAdministration, TWikiCategoryTable, TWikiEnhancementRequests, TWikiImplementationNotes, TWikiInstallationGuide, TWikiNotificationOfChanges, TWikiPlannedFeatures, TWikiUpgradeTo01May2000, TWikiUsernameVsLoginUsername, TWikiSite, WelcomeGuest, WelcomeVisitor, WikiName, WikiNotation, WikiTopic, WikiWikiClones. Sample delete command:


rm -f $TWIKIROOT/data/Main/BillClinton.*
    • The following topics are new and most be copied to all of your TWiki webs: WebChanges, WebIndex.
      cp -p $TWIKIROOT/data/TWiki/WebChanges.txt* $TWIKIROOT/data/Main
Line: 136 to 135

-- MikeMannix? - 26 Aug 2001

Added:
>
>
META TOPICMOVED MikeMannix? date="999319954" from="TWiki.TWikiUpgradeNotes" to="TWiki.TWikiUpgradeGuide"
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.6 - 31 Aug 2001 - MikeMannix?)

TWiki Upgrade Guide

Line: 7 to 7

Upgrade from your 01-Dec-2000 edition to the new, next generation 01-Sep-2001 TWiki Production Release in a few straightforward steps.

Deleted:
<
<
  • BUT FIRST! Check these to make sure you're on the right page:
    • If you've updated, replaced, or even added files from any of this year's Beta test releases of the new TWiki, head here: TWikiBetaUpgradeNotes?.
    • To upgrade from a pre-01-Dec-2000 TWiki, make this your first stop: TWikiUpgradeTo01Dec2000.

Changed:
<
<

Major Changes from Dec 2000

>
>

Major Changes from 01-Dec-2000


The 01 Sep 2001 release includes several new areas of functionality, and existing features have been significantly revised and enhanced. These changes affect the upgrade of the 01 Dec 2000 version:

Line: 32 to 28

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.

Changed:
<
<

Upgrading the Site

>
>

Picking the Right Upgrade Path

Check these to make sure you're on the right page:

  • If you've updated, replaced, or even added files from any of this year's Beta test releases of the new TWiki, head here: TWikiBetaUpgradeNotes?.
  • To upgrade from a pre-01-Dec-2000 TWiki, make this your first stop: TWikiUpgradeTo01Dec2000.

Standard 6-Step Full Upgrade


Follow this step-by-step guide to upgrade the 01 Dec 2000 version to the 01 Sep 2001 release, and transfer all of your original data: [ We assume export TWIKIROOT=/some/dir/ ]

Line: 124 to 126

      • Change topics: TWikiUsers , WebNotify , WebHome
      • With links to: TWikiPreferences , TWikiVariables , TWikiUsers , TWikiWebsTable and WelcomeGuest
Changed:
<
<

TWiki Access Control

>
>

Setting Access Control


    • Read TWikiAccessControl, in case you want to use the new authorization feature based on groups.
Changed:
<
<

Known Issues

>
>

Known Upgrade Issues


Added:
>
>

-- MikeMannix? - 26 Aug 2001
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.5 - 30 Aug 2001 - MikeMannix?)

TOC: No TOC in "TWiki.TWikiUpgradeTo01Dec2001"
Changed:
<
<

TWiki Upgrade Notes

>
>

TWiki Upgrade Guide


Upgrading to TWiki 01-Sep-2001

Line: 16 to 16

The 01 Sep 2001 release includes several new areas of functionality, and existing features have been significantly revised and enhanced. These changes affect the upgrade of the 01 Dec 2000 version:

Changed:
<
<
  • TWikiPlugins major enhancement, allows easy installation and removal of program enhancements using external plug-in modules
>
>
  • TWikiPlugins major enhancement, allows easy installation and removal of program enhancements using external plug-in modules, standardized creation of Plugins with the Plugins API

  • AttachmentsUnderRevisionControl In the previous version, changes to topics were tracked under revision control (RCS); now, topic Attachments are also tracked.
Changed:
<
<
  • RenameTopic/MoveTopic In the previous version, renaming topics and moving topics between webs could not be done through the browser interface, it required access to the TWiki installtion files; now, moving and renaming is available from the lower toolbar.
  • SectionTitles and TOC
>
>
  • RenameTopic/Move/Delete Topic In the previous version, managing topics required access to the TWiki file system (Telnet or FTP); now, moving, renaming, deleting can be done through the browser. Deleted topics are act move and stored in a common Trash web.
  • TOC (Table of Contents) Automatically generates a hierarchical Table of Contents from topic headings: <HI>...<H6>. Set depth...

  • ArbitraryTextForWikiWordLinks
Changed:
<
<
  • ChangingTWikiPasswords
  • FormTemplateSystem
>
>
  • ChangingTWikiPasswords done by Web form
  • TWikiFormTemplate
  • TWikiTemplateSystem all new template set-up
  • TWikiSkins

  • SuperAdminCanEdit
Added:
>
>
  • TWikiMetaData

  • ConvertToXHTML10
  • HierarchicalNavigation
Changed:
<
<
  • TWiki standard directory structure: The basic directory layout remains the same, with the addition of one new lib/TWiki/Plugins directory to handle internal modules and the new Plugin modules
>
>

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.


Upgrading the Site

 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.4 - 30 Aug 2001 - MikeMannix?)
Deleted:
<
<
META TOPICPARENT TWikiDocumentation

TWiki Upgrade Notes

Line: 94 to 93

    • Move these new TWiki.Main web topics to your TWiki.Main web: TWikiGroups, TWikiAdminGroup, and if needed also OfficeLocations , i.e.
      mv ~/tmp/data/Main/TWikiGroups.* $TWIKIROOT/data/Main
      (Pay attention to the file permissions)
Changed:
<
<
    • The following topics in the TWiki.Main web are obsolete and can be deleted: BillClinton, GoodStyle, RegularExpression, TextFormattingFAQ, TextFormattingRules, TWikiAdministration, TWikiCategoryTable, TWikiEnhancementRequests, TWikiImplementationNotes, TWikiInstallationNotes, TWikiNotificationOfChanges, TWikiPlannedFeatures, TWikiUpgradeTo01May2000, TWikiUsernameVsLoginUsername, TWikiWeb, WelcomeGuest, WelcomeVisitor, WikiName, WikiNotation, WikiTopic, WikiWikiClones. Sample delete command:
>
>
    • The following topics in the TWiki.Main web are obsolete and can be deleted: BillClinton, GoodStyle, RegularExpression, TextFormattingFAQ, TextFormattingRules, TWikiAdministration, TWikiCategoryTable, TWikiEnhancementRequests, TWikiImplementationNotes, TWikiInstallationNotes, TWikiNotificationOfChanges, TWikiPlannedFeatures, TWikiUpgradeTo01May2000, TWikiUsernameVsLoginUsername, TWikiSite, WelcomeGuest, WelcomeVisitor, WikiName, WikiNotation, WikiTopic, WikiWikiClones. Sample delete command:


rm -f $TWIKIROOT/data/Main/BillClinton.*
    • The following topics are new and most be copied to all of your TWiki webs: WebChanges, WebIndex.
      cp -p $TWIKIROOT/data/TWiki/WebChanges.txt* $TWIKIROOT/data/Main
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.3 - 28 Aug 2001 - MikeMannix?)

META TOPICPARENT TWikiDocumentation
TOC: No TOC in "TWiki.TWikiUpgradeTo01Dec2001"
Line: 15 to 15

Major Changes from Dec 2000

Changed:
<
<
The 01 Sep 2001 release has these changes that affect the upgrade of the 01 Dec 2000 version:
>
>
The 01 Sep 2001 release includes several new areas of functionality, and existing features have been significantly revised and enhanced. These changes affect the upgrade of the 01 Dec 2000 version:

Changed:
<
<
  • Everything's been rewritten - you won't recognize a thing! (not)
>
>
  • TWikiPlugins major enhancement, allows easy installation and removal of program enhancements using external plug-in modules
  • AttachmentsUnderRevisionControl In the previous version, changes to topics were tracked under revision control (RCS); now, topic Attachments are also tracked.
  • RenameTopic/MoveTopic In the previous version, renaming topics and moving topics between webs could not be done through the browser interface, it required access to the TWiki installtion files; now, moving and renaming is available from the lower toolbar.
  • SectionTitles and TOC
  • ArbitraryTextForWikiWordLinks
  • ChangingTWikiPasswords
  • FormTemplateSystem
  • SuperAdminCanEdit
  • ConvertToXHTML10
  • HierarchicalNavigation
  • TWiki standard directory structure: The basic directory layout remains the same, with the addition of one new lib/TWiki/Plugins directory to handle internal modules and the new Plugin modules

Upgrading the Site

 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.2 - 27 Aug 2001 - MikeMannix?)

META TOPICPARENT TWikiDocumentation
Added:
>
>
TOC: No TOC in "TWiki.TWikiUpgradeTo01Dec2001"

TWiki Upgrade Notes

Changed:
<
<
If you are coming from a version earlier than the 01 Dec 2000 production release, please see TWikiUpgradeTo01Dec2000 first.
>
>

Upgrading to TWiki 01-Sep-2001

Upgrade from your 01-Dec-2000 edition to the new, next generation 01-Sep-2001 TWiki Production Release in a few straightforward steps.

  • BUT FIRST! Check these to make sure you're on the right page:
    • If you've updated, replaced, or even added files from any of this year's Beta test releases of the new TWiki, head here: TWikiBetaUpgradeNotes?.
    • To upgrade from a pre-01-Dec-2000 TWiki, make this your first stop: TWikiUpgradeTo01Dec2000.

Major Changes from Dec 2000


The 01 Sep 2001 release has these changes that affect the upgrade of the 01 Dec 2000 version:

Changed:
<
<
>
>
  • Everything's been rewritten - you won't recognize a thing! (not)

Upgrading the Site


Changed:
<
<
These are the steps you need to perform to upgrade the 01 Dec 2000 version to the 01 Sep 2001 release: [ We assume export TWIKIROOT=/some/dir/ ]
>
>
Follow this step-by-step guide to upgrade the 01 Dec 2000 version to the 01 Sep 2001 release, and transfer all of your original data: [ We assume export TWIKIROOT=/some/dir/ ]

Changed:
<
<
  • Backup all existing TWiki directories ( bin, pub, data, templates )
>
>

Step 1: Backup & Unpack

  1. Backup all existing TWiki directories ( bin, pub, data, templates )

  • Unpack the zip file into some working directory:
    mkdir -p ~/tmp/
    cd ~/tmp
    unzip ~/TWiki20001201.zip
Changed:
<
<
  • Upgrade the TWiki document files ( twiki )
    • Move the document files to your TWiki root, i.e.
>
>

Step 2: Upgrade TWiki document files

    • Move the document files to your TWiki root: ( twiki )


mv ~/tmp/TWiki*.html $TWIKIROOT
mv ~/tmp/readme.txt $TWIKIROOT
Changed:
<
<
  • Upgrade cgi-bin scripts ( twiki/bin )
    • Rename your original twiki/bin directory, i.e.
>
>

Step 3: Upgrade cgi-bin scripts

    • Rename your original twiki/bin directory: ( twiki/bin )


mv $TWIKIROOT/bin $TWIKIROOT/bin.old
    • Move the new scripts to your original twiki/bin location, i.e.
      mv ~/tmp/bin $TWIKIROOT/bin
Line: 38 to 56

    • Pay attention to the file and directory permissions (security issue)
    • Test your TWiki installation if you can view topics. (Ignore the %HTTP_EQUIV_ON_VIEW% you see on top of the topic; this will disappear after upgrading the template files.
Changed:
<
<
  • Upgrade template files ( twiki/templates )
    • Rename your original twiki/templates directory, i.e.
>
>

Step 4: Upgrade template files

    • Rename your original twiki/templates directory: ( twiki/templates )


mv $TWIKIROOT/templates $TWIKIROOT/templates.old
    • Move the new templates to your original twiki/templates location, i.e.
      mv ~/tmp/templates $TWIKIROOT/templates
Line: 48 to 67

    • Restore any additional template subdirectories of your TWiki webs you might have and merge the changes.
    • Test your TWiki installation if you can view topics.
Changed:
<
<
  • Upgrade public files ( twiki/pub )
    • Move the new twiki/pub/TWiki directory to your installation, i.e.
>
>

Step 5: Upgrade public files

    • Move the new twiki/pub/TWiki directory to your installation: ( twiki/pub )


mv ~/tmp/pub/TWiki $TWIKIROOT/pub/
    • Pay attention to the file permissions of the TWiki directory and its subdirectory and files. The files must be writable by the cgi-scripts (usually user "nobody")
    • Move the new twiki/pub/twikilogo* image files to your installation, i.e.
      mv ~/tmp/pub/twikilogo* $TWIKIROOT/pub/
Changed:
<
<
  • Upgrade data files ( twiki/data )
    • Move the new twiki/data/TWiki directory to your installation, i.e.
>
>

Step 6: Upgrade data files

    • Move the new twiki/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")
    • Optionally move the new twiki/data/Test directory to your installation, i.e.
Line: 92 to 111

      • Change topics: TWikiUsers , WebNotify , WebHome
      • With links to: TWikiPreferences , TWikiVariables , TWikiUsers , TWikiWebsTable and WelcomeGuest
Changed:
<
<
  • TWiki Access Control
>
>

TWiki Access Control


    • Read TWikiAccessControl, in case you want to use the new authorization feature based on groups.
Changed:
<
<
>
>

Known Issues


Changed:
<
<
-- PeterThoeny - 25 Aug 2001
>
>
-- MikeMannix? - 26 Aug 2001
 <<O>>  Difference Topic TWikiUpgradeTo01Dec2001 (r1.1 - 25 Aug 2001 - PeterThoeny)
Line: 1 to 1
Added:
>
>
META TOPICPARENT TWikiDocumentation

TWiki Upgrade Notes

If you are coming from a version earlier than the 01 Dec 2000 production release, please see TWikiUpgradeTo01Dec2000 first.

The 01 Sep 2001 release has these changes that affect the upgrade of the 01 Dec 2000 version:

These are the steps you need to perform to upgrade the 01 Dec 2000 version to the 01 Sep 2001 release: [ We assume export TWIKIROOT=/some/dir/ ]

  • Backup all existing TWiki directories ( bin, pub, data, templates )

  • Unpack the zip file into some working directory:
    mkdir -p ~/tmp/
    cd ~/tmp
    unzip ~/TWiki20001201.zip

  • Upgrade the TWiki document files ( twiki )
    • Move the document files to your TWiki root, i.e.
      mv ~/tmp/TWiki*.html $TWIKIROOT
      mv ~/tmp/readme.txt $TWIKIROOT

  • Upgrade cgi-bin scripts ( twiki/bin )
    • Rename your original twiki/bin directory, i.e.
      mv $TWIKIROOT/bin $TWIKIROOT/bin.old
    • Move the new scripts to your original twiki/bin location, i.e.
      mv ~/tmp/bin $TWIKIROOT/bin
    • Merge the changes in your current wikicfg.pm into the new wikicfg.pm. We suggest using diff -c to compare the two files if you have made heavy changes to the file, i.e.
      diff -c $TWIKIROOT/bin.old/wikicfg.pm $TWIKIROOT/bin/wikicfg.pm | less
    • Restore any additional scripts you might have from the old directory, i.e.
      mv $TWIKIROOT/bin.old/somescript $TWIKIROOT/bin/
      (Note that the changes script is obsolete.)
    • In case you have basic authentication:
      • The TWikiRegistration topic moved from the TWiki.Main web to the TWiki.TWiki web. Change .htaccess to reflect the new location, i.e.
        ErrorDocument 401 /cgi-bin/view/TWiki/TWikiRegistration
    • Pay attention to the file and directory permissions (security issue)
    • Test your TWiki installation if you can view topics. (Ignore the %HTTP_EQUIV_ON_VIEW% you see on top of the topic; this will disappear after upgrading the template files.

  • Upgrade template files ( twiki/templates )
    • Rename your original twiki/templates directory, i.e.
      mv $TWIKIROOT/templates $TWIKIROOT/templates.old
    • Move the new templates to your original twiki/templates location, i.e.
      mv ~/tmp/templates $TWIKIROOT/templates
    • Merge the changes in your current template files into the new template files. To compare two files use
      diff -c $TWIKIROOT/templates.old/view.tmpl $TWIKIROOT/templates/view.tmpl | less
    • Restore any additional template subdirectories of your TWiki webs you might have and merge the changes.
    • Test your TWiki installation if you can view topics.

  • Upgrade public files ( twiki/pub )
    • Move the new twiki/pub/TWiki directory to your installation, i.e.
      mv ~/tmp/pub/TWiki $TWIKIROOT/pub/
    • Pay attention to the file permissions of the TWiki directory and its subdirectory and files. The files must be writable by the cgi-scripts (usually user "nobody")
    • Move the new twiki/pub/twikilogo* image files to your installation, i.e.
      mv ~/tmp/pub/twikilogo* $TWIKIROOT/pub/

  • Upgrade data files ( twiki/data )
    • Move the new twiki/data/TWiki directory to your installation, i.e.
      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")
    • Optionally move the new twiki/data/Test directory to your installation, i.e.
      mv ~/tmp/data/Test $TWIKIROOT/data/
      (Pay attention to the file permissions)
    • Move these new TWiki.Main web topics to your TWiki.Main web: TWikiGroups, TWikiAdminGroup, and if needed also OfficeLocations , i.e.
      mv ~/tmp/data/Main/TWikiGroups.* $TWIKIROOT/data/Main
      (Pay attention to the file permissions)
    • The following topics in the TWiki.Main web are obsolete and can be deleted: BillClinton, GoodStyle, RegularExpression, TextFormattingFAQ, TextFormattingRules, TWikiAdministration, TWikiCategoryTable, TWikiEnhancementRequests, TWikiImplementationNotes, TWikiInstallationNotes, TWikiNotificationOfChanges, TWikiPlannedFeatures, TWikiUpgradeTo01May2000, TWikiUsernameVsLoginUsername, TWikiWeb, WelcomeGuest, WelcomeVisitor, WikiName, WikiNotation, WikiTopic, WikiWikiClones. Sample delete command:
      rm -f $TWIKIROOT/data/Main/BillClinton.*
    • The following topics are new and most be copied to all of your TWiki webs: WebChanges, WebIndex.
      cp -p $TWIKIROOT/data/TWiki/WebChanges.txt* $TWIKIROOT/data/Main
      cp -p $TWIKIROOT/data/TWiki/WebIndex.txt* $TWIKIROOT/data/Main
      Repeat this for all your webs. Pay attention to the file permissions.
    • 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*.
    • TWikiPreferences moved from TWiki.Main to TWiki.TWiki. Merge your changes to TWikiPreferences into TWiki.TWikiPreferences.
    • Modify the WebPreferences topics in all your webs to reflect the following:
      • WEBTOPICLIST should use WebChanges for "Changes", and WebIndex for "Index", i.e.
        | <a href="WebChanges">Changes</a>
        | <a href="WebIndex">Index</a>
      • In case you want to exclude a web from a web="all" search: Set this new preference
        Set NOSEARCHALL = on
    • 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.
    • Change the WebHome topics in all your webs to reflect these changes:
      1. The "Changes" link should point to WebChanges.
      2. The "Topic index" link should point to WebIndex.
      3. Change the include of the web table to %INCLUDE{"%TWIKIWEB%.TWikiWebsTable"}%
    • Merge your TWikiWebsTable topic in TWiki.Main with the TWikiWebsTable topic in TWiki.TWiki. Note the new variable to query the color of a web. Delete the old TWikiWebsTable topic in TWiki.Main after merge is complete.
    • The following topics in the TWiki.Main web are deprecated (because they moved to TWiki.TWiki), but still need to be present in TWiki.Main because of existing links to them: FileAttachment, TWikiDocumentation, TWikiHistory, TWikiPreferences, TWikiVariables.
      It is recommended that you edit these topics in TWiki.Main and replace the content with this line:
      This topic moved to %TWIKIWEB%.%TOPIC% in the %WIKITOOLNAME%.%TWIKIWEB% web.
    • In all your webs, change references to topics that moved to the TWiki.TWiki web:
      • Change topics: TWikiUsers , WebNotify , WebHome
      • With links to: TWikiPreferences , TWikiVariables , TWikiUsers , TWikiWebsTable and WelcomeGuest

  • TWiki Access Control
    • Read TWikiAccessControl, in case you want to use the new authorization feature based on groups.

-- PeterThoeny - 25 Aug 2001

Revision r1.1 - 25 Aug 2001 - 08:38 - PeterThoeny
Revision r1.31 - 17 Dec 2002 - 08:46 - PeterThoeny