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

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:

1. Copy to TWiki2 any topics that you created in the TWiki web.
   • Do the same for

• • • Remove the files you do not want to upgrade: TWikiPreferences.*, Main.TWikiSiteDirectory.*, WebNotify.*, WebPreferences.*, WebStatistics.* and all WebTopic* files.

1. Copy TWiki.Main.TWikiSiteDirectory to TWiki2.Main.TWikiSiteDirectory.

1. Edit $TWIKIROOT/bin/lib/TWiki.cfg and remove the /2 from $scriptUrlPath and $templateDir, ex:

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

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

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

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

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

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

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

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.

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

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

• • 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" />

• • Set the FINALPREFERENCES:

1. Optional: In WebSearch of all webs, replace content with this one line:

1. Optional: In WebChanges of all webs, replace content with this one line:

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

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.

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

• Change passwords^? Change and reset passwords using forms.

1. Move the TWiki logo files, ex:
   mv ~/tmp/pub/*.gif $TWIKIROOT/pub

• Change passwords^? Change and reset passwords using forms.

1. Remember that you now have two TWiki webs:

• • NOTE: Don't worry about the Plugins, they'll work after the switch.

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

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

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

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

• FileAttachment info is now stored as TWiki Meta Data.

Known Issues

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

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.

• • Create a replacement TWikiForms template based on twikicatitems.tmpl in each web that used a Category Table.

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. Test the new TWikiPlugins by checking the Plugins settings in TWikiPreferences.

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

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

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

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.

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.

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

Step 5: Install new CGI scripts

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

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.

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

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

Known Issues of TWiki 01 Sep 2001

• TWikiTemplates - New, more flexible template system.

• TWikiForms - Create multiple input forms per web; data is rendered in HTML tables.

• • InterwikiPlugin (preinstalled) - Link to external sites with text aliases, SiteAlias:Page; rules are defined in InterWikis. (Get more Plugins from the TWiki:Plugins web.)

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

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

Pre-Upgrade Preparation

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

Step 1: Backup & Unpack

1. 1. Move all existing TWiki directories ( bin, pub, data, templates ) to a temporary directory (it's a good idea to do a full back-up first):

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

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

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

Step 4: Set configurations in TWiki.cfg

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

Step 5: Upgrade template files

1. 1. Customized templates and skins need to be upgraded to the new TWiki Template System. This isn't difficult, but you have be familiar with the new template set-up before starting the conversion. The safest way is to use the new templates as a base and to merge your changes back. Changes in new templates:

1. 1. Form Templates replace the TWikiCategoryTables:

Step 6: Upgrade public files

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

Step 7: Upgrade data files

1. 1. Move the tmp/data/TWiki directory to your installation: ( twiki/data )

• Attachments Under Revision Control Changes to files attached to topics - - are now tracked under revision control (RCS).

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

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

• TWiki Plugins - Easily install program enhancements using external plug-in modules. Developers can create plug-ins in Perl, with the TWiki Plugin API.
  • InterwikiPlugin (preinstalled) - Link to external sites with text aliases, SiteAlias:Page; rules are defined in InterWikis. (Get more Plugins from the TWiki:Plugins web.)
• TWikiTemplateSystem - New, more flexible template system.
• TWikiSkins - Overwrite template headers and footers; page content is unaffected.
• TWikiMetaData - New data format
• TWikiFormTemplate - Create multiple input forms per web; data is rendered in HTML tables.
• Rename/move/delete topics Individual pages can be managed through the browser. Deleted topics are stored in a common Trash web.
• Change passwords Change and reset passwords using forms.

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

• HierarchicalNavigation uses new Meta Data variables to link hierarchically, for example, as in Yahoo! and other search sites.

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

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

-- JohnTalintyre^? - 18 Jul 2001

TWiki Upgrade Guide

Overview

Upgrade Requirements

Major Changes from TWiki 01-Dec-2000

Standard Upgrade Procedure

Step 1: Backup & Unpack

Step 2: Upgrade TWiki document files

Step 3: Upgrade CGI scripts

Step 4: Upgrade template files

Step 5: Upgrade public files

Step 6: Upgrade data files

Known Upgrade Issues

Upgrade Requirements

Standard Upgrade Procedure

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

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

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

• TWiki Plugins - Easily install program enhancements using external plug-in modules. Developers can create plug-ins in Perl, with the TWiki Plugin API.
  • InterwikiPlugin (preinstalled) - Link to external sites with text aliases, SiteAlias:Page; rules are defined in InterWikis. (Get more Plugins from the TWiki:Plugins web.)
• TWikiTemplateSystem^? - New, more flexible template system.
• TWikiSkins - Overwrite template headers and footers; page content is unaffected.
• TWikiMetaData - New data format
• TWikiFormTemplate^? - Create multiple input forms per web; data is rendered in HTML tables.
• Rename/move/delete topics Individual pages can be managed through the browser. Deleted topics are stored in a common Trash web.
• Change passwords Change and reset passwords using forms
• TOC (Table of Contents) - %TOC% variable generates a hierarchical table of contents from topic headings: <HI>...<H6>. Set depth.
• 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.

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

1. 1. Unpack the zip file into some working directory:

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

Step 3: Upgrade CGI scripts

1. 1. Rename your original twiki/bin directory: ( twiki/bin )

1. 1. Move the new scripts to your original twiki/bin location, i.e.

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

1. 1. Restore any additional scripts you might have from the old directory, ex:

1. 1. Test your TWiki installation if you can view topics.

1. 1. Rename your original twiki/templates directory: ( twiki/templates )

1. 1. Move the new templates to your original twiki/templates location:

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

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

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

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

1. 1. Optionally move the new twiki/data/Test directory to your installation,

1. 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":

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

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

• To upgrade from a pre-01-Dec-2000 TWiki, make this your first stop: TWikiUpgradeTo01Dec2000.

Major Changes from TWiki 01-Dec-2000

• • InterWikisPlugin - preinstalled

• ChangingPasswords done by Web form

Six-Step Standard Upgrade

• • 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:+

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

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

Standard Six-Step Upgrade

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

Major Changes from 01-Dec-2000

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

Setting Access Control

Known Upgrade Issues