• • 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, 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, TWikiInstallationNotes, TWikiNotificationOfChanges, TWikiPlannedFeatures, TWikiUpgradeTo01May2000, TWikiUsernameVsLoginUsername, TWikiWeb, WelcomeGuest, WelcomeVisitor, WikiName, WikiNotation, WikiTopic, WikiWikiClones. Sample delete command:

TWiki Upgrade Notes

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

TWiki Upgrade Notes

(The following upgrade notes apply to the 01 Dec 2000 release. The upgrade notes of this Beta release is pending.)

• • Merge the changes in your current wikicfg.pm into the new wikicfg.pm. We suggest using diff -c to compared the two files if you have made heavy changes to the file, i.e.

• • 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 templates files ( twiki/templates )

• • The following topics in the TWiki.Main web are depreciated (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 to edit these topics in TWiki.Main and replace the content with this line:

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

• Unpack the beta zip file into some working directory:

• • Move the new twiki/pub/twikilogo* image files to your installation, i.e.
    mv ~/tmp/pub/twikilogo* $TWIKIROOT/pub/

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

• • TWikiPreferences moved from TWiki.Main to TWiki.TWiki. Merge your changes to TWikiPreferences into TWiki.TWikiPreferences, then delete $TWIKIROOT/data/Main/TWikiPreferences*.

1. 1. 1. Change the include of the web table to %INCLUDE{"TWiki.TWikiWebsTable"}%

• • The following topics in the TWiki.Main web are depreciated (because they moved to TWiki.TWiki), but still need to be present in TWiki.Main because of existing links to these topics: FileAttachment, TWikiDocumentation, TWikiHistory, TWikiPreferences, TWikiVariables.

• • Check http://TWiki.SourceForge.net/cgi-bin/view/Codev/KnownIssuesOfTWiki05Nov2000 for known issues of TWiki 05 Nov 2000 (production release)

• • The WebSearch topics 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.

• • Move your TWikiWebsTable topic from TWiki.Main to TWiki.TWiki., i.e.
    mv $TWIKIROOT/data/Main/TWikiWebsTable* $TWIKIROOT/data/TWiki

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

• Known Issues
  • Check http://TWiki.SourceForge.net/cgi-bin/view/Codev/KnownIssuesOfTWiki05Nov2000 for known issues of TWiki 05 Nov 2000 (production release)

-- PeterThoeny - 03 Nov 2000

These are the steps you need to perform to upgrade the 01 May 2000 version to the current Beta version: [ We assume

export TWIKIROOT=/some/dir/

• Unpack the beta zip file into some working directory:

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

• Merge and changes in your current wikicfg.pm into the new wikicfg.pm. We suggest using diff -c to compared the two files if you have made heavy changes to the file:

   diff -c wikicfg.pm $TWIKIROOT/bin/wikicfg.pm | less

• Create and populate the TWiki directory below the data directory.

  cd $TWIKIROOT/data/
  mkdir TWiki
  cp ~/tmp/data/TWiki/* TWiki/

• Delete the following files in your TWiki.Main installation:
  • BillClinton , GoodStyle , RegularExpression , TextFormattingFAQ , TextFormattingRules , TWikiAdministration , TWikiCategoryTable , TWikiDocumentation , TWikiEnhancementRequests , TWikiHistory , TWikiImplementationNotes , TWikiInstallationNotes , TWikiNotificationOfChanges , TWikiPlannedFeatures , TWikiPreferences , TWikiUpgradeTo01May2000 , TWikiUsernameVsLoginUsername , TWikiVariables , TWikiWeb , WelcomeGuest , WikiName , WikiNotation , WikiTopic , WikiWikiClones

  cd $TWIKIROOT/data/Main
  rm -f BillClinton* GoodStyle* RegularExpression* TextFormattingFAQ*       TextFormattingRules* TWikiAdministration=* TWikiCategoryTable*        TWikiDocumentation* TWikiEnhancementRequests* TWikiHistory*       TWikiImplementationNotes TWikiInstallationNotes* TWikiNotificationOfChanges*       TWikiPlannedFeatures* TWikiPreferences* TWikiUpgradeTo01May2000*        TWikiUsernameVsLoginUsername* TWikiVariables* TWikiWeb* WelcomeGuest*       WikiName* WikiNotation* WikiTopic* WikiWikiClones*

• Improved search, i.e. search multiple webs.
• The changes script has been retired (related to new search).
• Reorganization of topics: The TWiki.Main web was split up into TWiki.Main and TWiki.TWiki web.

• Unpack the beta zip file into some working directory:
  mkdir -p ~/tmp/
cd ~/tmp
unzip ~/TWiki20000909beta.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 compared 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
  • In wikicfg.pm, change $wikiToolName from "TWikibeta" to "TWiki".
  • 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 templates 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")

• 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")
  • 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, then delete $TWIKIROOT/data/Main/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 topics 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{"TWiki.TWikiWebsTable"}%
  • Move your TWikiWebsTable topic from TWiki.Main to TWiki.TWiki., i.e.
    mv $TWIKIROOT/data/Main/TWikiWebsTable* $TWIKIROOT/data/TWiki
  • The following topics in the TWiki.Main web are depreciated (because they moved to TWiki.TWiki), but still need to be present in TWiki.Main because of existing links to these topics: FileAttachment, TWikiDocumentation, TWikiHistory, TWikiPreferences, TWikiVariables.
    It is recommended to edit these topics in TWiki.Main and replace the content with this line:
    This topic moved to %TWIKIWEB%.%TOPIC% in the %WIKITOOLNAME%.%TWIKIWEB% web.
  • 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.*

• • With links to: TWikiPreferences , TWikiVariables , TWikiUsers , TWikiWebsTable , WelcomeGuest
• Move your TWikiWebsTable topic to TWiki.TWiki.
• Merge your changes to TWikiPreferences into TWiki.TWikiPreferences , then delete Main.TWikiPreferences
• In case you customized TWikiRegistration , merge your changes back into TWiki.TWikiRegistration , then delete Main.TWikiRegistration .
• In case you have authentication: Change .htaccess to reflect the new location of the TWikiRegistration , i.e.
  ErrorDocument 401 /cgi-bin/view/TWiki/TWikiRegistration

• Create a TWiki directory below the data directory.

• Merge and changes in your current wikicfg.pm into the new wikicfg.pm. We suggest using diff -c to compared the two files if you have made heavy changes to the file:

   diff -c wikicfg.pm $TWIKIROOT/bin/wikicfg.pm | less

• Create and populate the TWiki directory below the data directory.

  cd $TWIKIROOT/data/
  mkdir TWiki
  cp ~/tmp/data/TWiki/* TWiki/

  cd $TWIKIROOT/data/Main
  rm -f BillClinton* GoodStyle* RegularExpression* TextFormattingFAQ*       TextFormattingRules* TWikiAdministration=* TWikiCategoryTable*        TWikiDocumentation* TWikiEnhancementRequests* TWikiHistory*       TWikiImplementationNotes TWikiInstallationNotes* TWikiNotificationOfChanges*       TWikiPlannedFeatures* TWikiPreferences* TWikiUpgradeTo01May2000*        TWikiUsernameVsLoginUsername* TWikiVariables* TWikiWeb* WelcomeGuest*       WikiName* WikiNotation* WikiTopic* WikiWikiClones*

• Create a TWiki directory below the data directory.
• Delete the following files in your TWiki.Main installation:
  • BillClinton , GoodStyle , RegularExpression , TextFormattingFAQ , TextFormattingRules , TWikiAdministration , TWikiCategoryTable , TWikiDocumentation , TWikiEnhancementRequests , TWikiHistory , TWikiImplementationNotes , TWikiInstallationNotes , TWikiNotificationOfChanges , TWikiPlannedFeatures , TWikiPreferences , TWikiUpgradeTo01May2000 , TWikiUsernameVsLoginUsername , TWikiVariables , TWikiWeb , WelcomeGuest , WikiName , WikiNotation , WikiTopic , WikiWikiClones
• 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 , WelcomeGuest
• Move your TWikiWebsTable topic to TWiki.TWiki.
• Merge your changes to TWikiPreferences into TWiki.TWikiPreferences , then delete Main.TWikiPreferences
• In case you customized TWikiRegistration , merge your changes back into TWiki.TWikiRegistration , then delete Main.TWikiRegistration .
• In case you have authentication: Change .htaccess to reflect the new location of the TWikiRegistration , i.e.
  ErrorDocument 401 /cgi-bin/view/TWiki/TWikiRegistration

See also:

• TWikiUpgradeTo01May2000

-- PeterThoeny - 20 Aug 2000