TWiki.TWikiUpgradeTo01Dec2001 (r1.1 vs. r1.31)

Diffs

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

TWiki Upgrade Guide

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^?)

Line: 83 to 81
	TWiki Upgrade Guide 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.
	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. Update pub/TWiki files:
Line: 153 to 151
	Move the TWiki logo files, ex: `mv ~/tmp/pub/*.gif $TWIKIROOT/pub` 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:
< <	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:
> >	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. In case you customized `TWiki.TWikiRegistration`, merge your changes back into `TWiki2.TWikiRegistration`.
Changed:
< <	Copy `TWiki.Main.TWikiSiteDirectory` to `TWiki2.Main.TWikiSiteDirectory`. Do the same for any other topics you might have created in the `TWiki` web.
> >	Copy to `TWiki2` any topics that you created in the `TWiki` web. Do the same for
	In `TWiki2.TWikiPreferences`, merge the old `TWiki.TWikiPreferences` settings and customize it. Add your webs to WIKIWEBLIST Set the WIKIWEBMASTER
Line: 238 to 236
	Added TWikiMetaData rendering. 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.
> >	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
	Check TWiki:Codev/KnownIssuesOfTWiki01Sep2001 for known issues of TWiki 01 Sep 2001 (production release) -- 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)

Line: 83 to 83
	TWiki Upgrade Guide TWiki Upgrade Guide
	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. In case you customized `TWiki.TWikiRegistration`, merge your changes back into `TWiki2.TWikiRegistration`.
Changed:
< <	Copy `TWiki.TWikiWebsTable` to `TWiki2.TWikiWebsTable`.
> >	Copy `TWiki.Main.TWikiSiteDirectory` to `TWiki2.Main.TWikiSiteDirectory`.
	Do the same for any other topics you might have created in the `TWiki` web. 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)

Line: 250 to 250
	TWiki Upgrade Guide TWiki Upgrade Guide
	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:
< <	Edit `$TWIKIROOT/bin/2/TWiki.cfg` and remove the `/2` from `$scriptUrlPath` and `$templateDir`, ex:
> >	Edit `$TWIKIROOT/bin/lib/TWiki.cfg` and remove the `/2` from `$scriptUrlPath` and `$templateDir`, ex:
	`$scriptUrlPath = "/twiki/bin";` `$templateDir = "/home/httpd/twiki/templates";` Rename the `TWiki2` web to `TWiki`, including attachments, ex:

<<O>> Difference Topic TWikiUpgradeTo01Dec2001 (r1.27 - 05 Dec 2001 - PeterThoeny)

Line: 62 to 62
	TWiki Upgrade Guide TWiki Upgrade Guide
	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.
	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)

Line: 309 to 309
	TWiki Upgrade Guide TWiki Upgrade Guide
	Known Issues Check TWiki:Codev/KnownIssuesOfTWiki01Dec2001 for known issues of TWiki 01 Dec 2001 (production release)
Added:
> >	Check TWiki:Codev/KnownIssuesOfTWiki01Sep2001 for known issues of TWiki 01 Sep 2001 (production release)
	-- JohnTalintyre^? - 18 Jul 2001 -- MikeMannix^? - 12 Sep 2001

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

TWiki Upgrade Guide

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.

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

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

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:

TWikiPlugins - Easily install program enhancements using external plug-in modules. Developers can create plug-ins in Perl, with the TWiki Plugin API.
- InterwikiPlugin (preinstalled) - Link to external sites with text aliases, SiteAlias:Page; rules are defined in InterWikis. (Get more Plugins from the TWiki:Plugins web.)

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.

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.
Update files in TWiki root:
- Overwrite all *.html and *.txt files in $TWIKIROOT with the new ones.
Update template files:
- Overwrite all template files in $TWIKIROOT/templates with the new ones.
Update script files:
- Overwrite all script files in $TWIKIROOT/bin with the new ones.
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.
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.
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

Back up all existing TWiki directories twiki/bin, twiki/pub, twiki/data, twiki/templates.
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

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

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:

<
<

Test your new 01-Sep-2001 installation under twiki/bin/2/view to make sure everything works as expected.

>
>

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.

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:

<
<

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.

>
>

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.

Clean up and remove obsolete directories:
- Remove directory $TWIKIROOT/bin/2
- Remove directory $TWIKIROOT/templates1

Line: 267 to 308

Known Issues

Changed:

<
<

Check TWiki:Codev/KnownIssuesOfTWiki01Sep2001 for known issues of TWiki 01 Sep 2001 (production release)

>
>

Check TWiki:Codev/KnownIssuesOfTWiki01Dec2001 for known issues of TWiki 01 Dec 2001 (production release)

-- 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)

Line: 198 to 198
	TWiki Upgrade Guide TWiki Upgrade Guide
	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
	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




  TWiki Upgrade Guide
  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" />
->
>
+ 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 =
-<
<
+ Set FINALPREFERENCES:
->
>
+ Set the FINALPREFERENCES:
  * Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
-<
<
+ In WebSearch of all webs, replace content with this one line:
->
>
+ Optional: In WebSearch of all webs, replace content with this one line:
  %INCLUDE{"%TWIKIWEB%.WebSearch"}%
-<
<
+ In WebChanges of all webs, replace content with this one line:
->
>
+ Optional: In WebChanges of all webs, replace content with this one line:
  %INCLUDE{"%TWIKIWEB%.WebChanges"}%

  Step 9: Customize template files
  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.





 Form Templates replace the TWikiCategoryTables:
-<
<
+ 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.





 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
-<
<
+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.
  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^?)

Line: 194 to 194
	TWiki Upgrade Guide TWiki Upgrade Guide
	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:
< <	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.
> >	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^?)

Line: 21 to 21
	TWiki Upgrade Guide TWiki Upgrade Guide
	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. InterwikiPlugin (preinstalled) - Link to external sites with text aliases, `SiteAlias:Page`; rules are defined in InterWikis. (Get more Plugins from the TWiki:Plugins web.) 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. InterwikiPlugin (preinstalled) - Link to external sites with text aliases, `SiteAlias:Page`; rules are defined in InterWikis. (Get more Plugins from the TWiki:Plugins web.) 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)

Line: 28 to 28
	TWiki Upgrade Guide TWiki Upgrade Guide
	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.
	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).
Line: 109 to 109
	`mv ~/tmp/data/Trash $TWIKIROOT/data` Move the MIME types file, ex: `mv ~/tmp/data/mime.types $TWIKIROOT/data`
Added:
> >	Move the TWiki logo files, ex: `mv ~/tmp/pub/*.gif $TWIKIROOT/pub`
	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`). 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




  TWiki Upgrade Guide
   Overview
-<
<
+The latest version of TWiki (01-Sep-2001) involves several major new features and numerous enhancements to the last full version (01-Dec-2001). The file system set-up is almost identical, but much of the underlying data structure and processes are new. With all the changes, the upgrade procedure is straightforward, and your existing page data is imported directly.
->
>
+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
    Major Changes from TWiki 01-Dec-2000
-<
<
+The 01 Sep 2001 release includes the following new features and enhancements:
->
>
+The 01-Sep-2001 release includes the following new features and enhancements:
  TWikiPlugins - Easily install program enhancements using external plug-in modules. Developers can create plug-ins in Perl, with the TWiki Plugin API.

 InterwikiPlugin (preinstalled) - Link to external sites with text aliases, SiteAlias:Page; rules are defined in InterWikis. (Get more Plugins from the TWiki:Plugins web.)
  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.
->
>
+ 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).
   Pre-Upgrade Preparation
-<
<
+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.
-<
<
+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
   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.
->
>
+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.
-<
<
+ Remember that you have now two TWiki webs:
->
>
+ 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.





 In case you customized TWiki.TWikiRegistration, merge your changes back into TWiki2.TWikiRegistration.
   Step 9: Customize template files
-<
<
+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.
  Remember that you have now two template directories:

 The original twiki/templates.
   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.
->
>
+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.
  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.
->
>
+ NOTE: Don't worry about the Plugins, they'll work after the switch.
  Edit $TWIKIROOT/bin/2/TWiki.cfg and remove the /2 from $scriptUrlPath and $templateDir, ex:
     
 $scriptUrlPath    = "/twiki/bin";
     
 $templateDir      = "/home/httpd/twiki/templates";
  cd $TWIKIROOT/bin
     
 cp -p bin/2/* .
     
 cp -p bin/2/.htaccess .
-<
<
+ 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.
->
>
+ 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.
  Clean up and remove obsolete directories:

 Remove directory $TWIKIROOT/bin/2

 Remove directory $TWIKIROOT/templates1
  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.
-<
<
+ In case you have customized the functions extendHandleCommonTags, extendGetRenderedVersionOutsidePRE and extendGetRenderedVersionInsidePRE in twiki/bin/wikicfg.pm:
->
>
+ 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
-<
<
+ 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.
-<
<
+ 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.
->
>
+ Use Net::SMTP module instead of sendmail if installed.
-<
<
+ 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.
-<
<
+ FileAttachment info is now stored as TWiki Meta Data.
->
>
+ 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.
  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
->
>
+  Known Issues
  Check TWiki:Codev/KnownIssuesOfTWiki01Sep2001 for known issues of TWiki 01 Sep 2001 (production release)
-<
<
+-- 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)

Line: 21 to 21
	TWiki Upgrade Guide TWiki Upgrade Guide
	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. InterwikiPlugin (preinstalled) - Link to external sites with text aliases, `SiteAlias:Page`; rules are defined in InterWikis. (Get more Plugins from the TWiki:Plugins web.) 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. Rename/move/delete topics Individual pages can be managed through the browser. Deleted topics are stored in a common Trash web. Change passwords Change and reset passwords using forms. TOC (Table of Contents) - `%TOC%` variable generates a hierarchical table of contents from topic headings: <HI>...<H6>. Set depth. Arbitrary Text for WikiWord Links - Text formatting rules to generate automatic links from any combination of words and spaces. Attachments Under Revision Control Changes made to files attached to topics are now saved under revision control (RCS).
> >	TWikiPlugins - Easily install program enhancements using external plug-in modules. Developers can create plug-ins in Perl, with the TWiki Plugin API. InterwikiPlugin (preinstalled) - Link to external sites with text aliases, `SiteAlias:Page`; rules are defined in InterWikis. (Get more Plugins from the TWiki:Plugins web.) 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.

TWiki Upgrade Guide

TWiki Upgrade Guide

Overview

Step 5: Install new CGI scripts

TWiki Upgrade Guide

TWiki Upgrade Guide

TWiki Upgrade Guide

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

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

TWiki Upgrade Guide

Known Issues

TWiki Upgrade Guide

Overview

Upgrade Requirements

Major Changes from TWiki 01-Sep-2001

Major Changes from TWiki 01-Dec-2000

TWiki Directory Structure and File Names

Standard Upgrade Procedure

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

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

Pre-Upgrade Preparation

Step 2: Upgrade TWiki document files

Step 5: Install new CGI scripts

Step 8: Update topics

Step 10: Switch over to new installation

Known Issues

TWiki Upgrade Guide

Step 10: Switch over to new installation

TWiki Upgrade Guide

Step 9: Customize template files

Step 10: Switch over to new installation

TWiki Upgrade Guide

Step 10: Switch over to new installation

TWiki Upgrade Guide

TWiki Directory Structure and File Names

TWiki Upgrade Guide

TWiki Upgrade Guide

Overview

Upgrade Requirements

Major Changes from TWiki 01-Dec-2000

Pre-Upgrade Preparation

Step 1: Backup & Unpack

Step 8: Update topics

Step 9: Customize template files

Step 10: Switch over to new installation

General Format Changes

Known Issues of TWiki 01 Sep 2001

Known Issues

TWiki Upgrade Guide