none

1 files changed, 78 insertions, 57 deletions

diff --git a/TWiki/TWikiUpgradeGuide.mdwn b/TWiki/TWikiUpgradeGuide.mdwn
index bf23fe8f..3319ce48 100644
--- a/TWiki/TWikiUpgradeGuide.mdwn
+++ b/TWiki/TWikiUpgradeGuide.mdwn
@@ -1,68 +1,89 @@
-## <a name="TWiki_Upgrade_Notes"> TWiki Upgrade Notes </a>
-
-If you are coming from a version earlier than the 01 Dec 2000 production release, please see [[TWikiUpgradeTo01Dec2000]] first.
-
-The 01 Sep 2001 release has these changes that affect the upgrade of the 01 Dec 2000 version:
+%TOC% %STARTINCLUDE%
 
-*
-
-These are the steps you need to perform to upgrade the 01 Dec 2000 version to the 01 Sep 2001 release: [ We assume `export TWIKIROOT=/some/dir/` ]
+## <a name="TWiki_Upgrade_Notes"> TWiki Upgrade Notes </a>
 
-* **_Backup_** all existing TWiki directories ( `bin`, `pub`, `data`, `templates` )
+### <a name="Upgrading_to_TWiki_01_Sep_2001"> Upgrading to TWiki 01-Sep-2001 </a>
 
-* **_Unpack the zip file_** into some working directory: <br />`mkdir -p ~/tmp/`<br />`cd ~/tmp`<br />`unzip ~/TWiki20001201.zip`
+Upgrade from your 01-Dec-2000 edition to the new, next generation **01-Sep-2001** TWiki Production Release in a few straightforward steps.
 
-* **_Upgrade the TWiki document files_** ( `twiki` )
-  * Move the document files to your TWiki root, i.e. <br />`mv ~/tmp/TWiki*.html $TWIKIROOT`<br />`mv ~/tmp/readme.txt $TWIKIROOT`
+> * **BUT FIRST!** Check these to make sure you're on the right page:
+>   * If you've updated, replaced, or even added files from any of this year's Beta test releases of the new TWiki, head here: %TWIKIWEB%.TWikiBetaUpgradeNotes.
+>   * To upgrade from a pre-01-Dec-2000 TWiki, make this your first stop: %TWIKIWEB%.TWikiUpgradeTo01Dec2000.
 
-* **_Upgrade cgi-bin scripts_** ( `twiki/bin` )
-  * Rename your original `twiki/bin` directory, i.e. <br />`mv $TWIKIROOT/bin $TWIKIROOT/bin.old`
-  * Move the new scripts to your original `twiki/bin` location, i.e. <br />`mv ~/tmp/bin $TWIKIROOT/bin`
-  * Merge the changes in your current `wikicfg.pm` into the new `wikicfg.pm`. We suggest using `diff -c` to compare the two files if you have made heavy changes to the file, i.e. <br />`diff -c $TWIKIROOT/bin.old/wikicfg.pm $TWIKIROOT/bin/wikicfg.pm | less`
-  * Restore any additional scripts you might have from the old directory, i.e. <br />`mv $TWIKIROOT/bin.old/somescript $TWIKIROOT/bin/`<br /> (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. <br />`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 <code>%HTTP\_EQUIV\_ON\_VIEW%</code> you see on top of the topic; this will disappear after upgrading the template files.
+### <a name="Major_Changes_from_Dec_2000"> Major Changes from Dec 2000 </a>
 
-* **_Upgrade template files_** ( `twiki/templates` )
-  * Rename your original `twiki/templates` directory, i.e. <br />`mv $TWIKIROOT/templates $TWIKIROOT/templates.old`
-  * Move the new templates to your original `twiki/templates` location, i.e. <br />`mv ~/tmp/templates $TWIKIROOT/templates`
-  * Merge the changes in your current template files into the new template files. To compare two files use <br />`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.
+The 01 Sep 2001 release has these changes that affect the upgrade of the 01 Dec 2000 version:
 
-* **_Upgrade public files_** ( `twiki/pub` )
-  * Move the new `twiki/pub/TWiki` directory to your installation, i.e. <br />`mv ~/tmp/pub/TWiki $TWIKIROOT/pub/`
-  * Pay attention to the file permissions of the `TWiki` directory and its subdirectory and files. The files must be writable by the cgi-scripts (usually user "nobody")
-  * Move the new `twiki/pub/twikilogo*` image files to your installation, i.e. <br />`mv ~/tmp/pub/twikilogo* $TWIKIROOT/pub/`
+* Everything's been rewritten - you won't recognize a thing! (not)
 
-* **_Upgrade data files_** ( `twiki/data` )
-  * Move the new `twiki/data/TWiki` directory to your installation, i.e. <br />`mv ~/tmp/data/TWiki $TWIKIROOT/data/`<br /> Pay attention to the file permissions of the `TWiki` directory and its files. The files must be writable by the cgi-scripts (usually user "nobody")
-  * Optionally move the new `twiki/data/Test` directory to your installation, i.e. <br />`mv ~/tmp/data/Test $TWIKIROOT/data/`<br /> (Pay attention to the file permissions)
-  * Move these new TWiki.Main web topics to your TWiki.Main web: `TWikiGroups`, `TWikiAdminGroup`, and if needed also `OfficeLocations` , i.e. <br />`mv ~/tmp/data/Main/TWikiGroups.* $TWIKIROOT/data/Main`<br /> (Pay attention to the file permissions)
-  * The following topics in the TWiki.Main web are obsolete and can be deleted: `BillClinton`, `GoodStyle`, `RegularExpression`, `TextFormattingFAQ`, `TextFormattingRules`, `TWikiAdministration`, `TWikiCategoryTable`, `TWikiEnhancementRequests`, `TWikiImplementationNotes`, `TWikiInstallationNotes`, `TWikiNotificationOfChanges`, `TWikiPlannedFeatures`, `TWikiUpgradeTo01May2000`, `TWikiUsernameVsLoginUsername`, `TWikiWeb`, `WelcomeGuest`, `WelcomeVisitor`, `WikiName`, `WikiNotation`, `WikiTopic`, `WikiWikiClones`. Sample delete command: <br />`rm -f $TWIKIROOT/data/Main/BillClinton.*`
-  * The following topics are new and most be copied to all of your TWiki webs: `WebChanges`, `WebIndex`. <br />`cp -p $TWIKIROOT/data/TWiki/WebChanges.txt* $TWIKIROOT/data/Main`<br />`cp -p $TWIKIROOT/data/TWiki/WebIndex.txt* $TWIKIROOT/data/Main`<br /> Repeat this for all your webs. Pay attention to the file permissions.
-  * `TWikiRegistration` moved from TWiki.Main to TWiki.TWiki. In case you customized `TWikiRegistration` , merge your changes back into `TWiki.TWikiRegistration` , then delete `$TWIKIROOT/data/Main/TWikiRegistration*`.
-  * `TWikiPreferences` moved from TWiki.Main to TWiki.TWiki. Merge your changes to `TWikiPreferences` into `TWiki.TWikiPreferences`.
-  * Modify the `WebPreferences` topics in all your webs to reflect the following:
-    * `WEBTOPICLIST` should use `WebChanges` for `"Changes"`, and `WebIndex` for `"Index"`, i.e. <br />`| <a href="WebChanges">Changes</a>`<br />`| <a href="WebIndex">Index</a>`
-    * In case you want to exclude a web from a `web="all"` search: Set this new preference <br />`Set NOSEARCHALL = on`
-  * The `WebSearch` topic has considerable changes. Copy the one from `TWiki.TWiki` into all webs, or merge them if you made changes. To copy, do an edit-copy-edit-paste operation.
-  * Change the `WebHome` topics in all your webs to reflect these changes:
-    1. The "Changes" link should point to `WebChanges`.
-    2. The "Topic index" link should point to `WebIndex`.
-    3. Change the include of the web table to <code>%INCLUDE\{"%TWIKIWEB%.TWikiWebsTable"\}%</code>
-  * Merge your `TWikiWebsTable` topic in TWiki.Main with the `TWikiWebsTable` topic in TWiki.TWiki. Note the new variable to query the color of a web. Delete the old `TWikiWebsTable` topic in TWiki.Main after merge is complete.
-  * The following topics in the TWiki.Main web are deprecated (because they moved to TWiki.TWiki), but still need to be present in TWiki.Main because of existing links to them: `FileAttachment`, `TWikiDocumentation`, `TWikiHistory`, `TWikiPreferences`, `TWikiVariables`. <br /> It is recommended that you edit these topics in TWiki.Main and replace the content with this line: <br /><code>This topic moved to %TWIKIWEB%.%TOPIC% in the %WIKITOOLNAME%.%TWIKIWEB% web.</code>
-  * In all your webs, change references to topics that moved to the TWiki.TWiki web:
-    * Change topics: `TWikiUsers` , `WebNotify` , `WebHome`
-    * With links to: `TWikiPreferences` , `TWikiVariables` , `TWikiUsers` , `TWikiWebsTable` and `WelcomeGuest`
+### <a name="Upgrading_the_Site"> Upgrading the Site </a>
 
-* **_TWiki Access Control_**
-  * Read [[TWikiAccessControl]], in case you want to use the new authorization feature based on groups.
+Follow this step-by-step guide to upgrade the 01 Dec 2000 version to the 01 Sep 2001 release, and transfer all of your original data: [ We assume `export TWIKIROOT=/some/dir/` ]
 
-* **_Known Issues_**
-  * Check <http://TWiki.org/cgi-bin/view/Codev/KnownIssuesOfTWiki01Sep2001> for known issues of TWiki 01 Sep 2001 (production release)
+> #### <a name="Step_1_Backup_amp_Unpack"> Step 1: Backup &amp; Unpack </a>
+>
+> 1. **_Backup_** all existing TWiki directories ( `bin`, `pub`, `data`, `templates` )
+>
+> * **_Unpack the zip file_** into some working directory: <br />`mkdir -p ~/tmp/`<br />`cd ~/tmp`<br />`unzip ~/TWiki20001201.zip`
+>
+> #### <a name="Step_2_Upgrade_TWiki_document_fi"> Step 2: Upgrade TWiki document files </a>
+>
+> * * Move the document files to your TWiki root: ( `twiki` ) <br />`mv ~/tmp/TWiki*.html $TWIKIROOT`<br />`mv ~/tmp/readme.txt $TWIKIROOT`
+>
+> #### <a name="Step_3_Upgrade_cgi_bin_scripts"> Step 3: Upgrade cgi-bin scripts </a>
+>
+> * * Rename your original `twiki/bin` directory: ( `twiki/bin` ) <br />`mv $TWIKIROOT/bin $TWIKIROOT/bin.old`
+>   * Move the new scripts to your original `twiki/bin` location, i.e. <br />`mv ~/tmp/bin $TWIKIROOT/bin`
+>   * Merge the changes in your current `wikicfg.pm` into the new `wikicfg.pm`. We suggest using `diff -c` to compare the two files if you have made heavy changes to the file, i.e. <br />`diff -c $TWIKIROOT/bin.old/wikicfg.pm $TWIKIROOT/bin/wikicfg.pm | less`
+>   * Restore any additional scripts you might have from the old directory, i.e. <br />`mv $TWIKIROOT/bin.old/somescript $TWIKIROOT/bin/`<br /> (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. <br />`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 <code>%HTTP\_EQUIV\_ON\_VIEW%</code> you see on top of the topic; this will disappear after upgrading the template files.
+>
+> #### <a name="Step_4_Upgrade_template_files"> Step 4: Upgrade template files </a>
+>
+> * * Rename your original `twiki/templates` directory: ( `twiki/templates` ) <br />`mv $TWIKIROOT/templates $TWIKIROOT/templates.old`
+>   * Move the new templates to your original `twiki/templates` location, i.e. <br />`mv ~/tmp/templates $TWIKIROOT/templates`
+>   * Merge the changes in your current template files into the new template files. To compare two files use <br />`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.
+>
+> #### <a name="Step_5_Upgrade_public_files"> Step 5: Upgrade public files </a>
+>
+> * * Move the new `twiki/pub/TWiki` directory to your installation: ( `twiki/pub` ) <br />`mv ~/tmp/pub/TWiki $TWIKIROOT/pub/`
+>   * Pay attention to the file permissions of the `TWiki` directory and its subdirectory and files. The files must be writable by the cgi-scripts (usually user "nobody")
+>   * Move the new `twiki/pub/twikilogo*` image files to your installation, i.e. <br />`mv ~/tmp/pub/twikilogo* $TWIKIROOT/pub/`
+>
+> #### <a name="Step_6_Upgrade_data_files"> Step 6: Upgrade data files </a>
+>
+> * * Move the new `twiki/data/TWiki` directory to your installation: ( `twiki/data` ) <br />`mv ~/tmp/data/TWiki $TWIKIROOT/data/`<br /> Pay attention to the file permissions of the `TWiki` directory and its files. The files must be writable by the cgi-scripts (usually user "nobody")
+>   * Optionally move the new `twiki/data/Test` directory to your installation, i.e. <br />`mv ~/tmp/data/Test $TWIKIROOT/data/`<br /> (Pay attention to the file permissions)
+>   * Move these new TWiki.Main web topics to your TWiki.Main web: `TWikiGroups`, `TWikiAdminGroup`, and if needed also `OfficeLocations` , i.e. <br />`mv ~/tmp/data/Main/TWikiGroups.* $TWIKIROOT/data/Main`<br /> (Pay attention to the file permissions)
+>   * The following topics in the TWiki.Main web are obsolete and can be deleted: `BillClinton`, `GoodStyle`, `RegularExpression`, `TextFormattingFAQ`, `TextFormattingRules`, `TWikiAdministration`, `TWikiCategoryTable`, `TWikiEnhancementRequests`, `TWikiImplementationNotes`, `TWikiInstallationNotes`, `TWikiNotificationOfChanges`, `TWikiPlannedFeatures`, `TWikiUpgradeTo01May2000`, `TWikiUsernameVsLoginUsername`, `TWikiWeb`, `WelcomeGuest`, `WelcomeVisitor`, `WikiName`, `WikiNotation`, `WikiTopic`, `WikiWikiClones`. Sample delete command: <br />`rm -f $TWIKIROOT/data/Main/BillClinton.*`
+>   * The following topics are new and most be copied to all of your TWiki webs: `WebChanges`, `WebIndex`. <br />`cp -p $TWIKIROOT/data/TWiki/WebChanges.txt* $TWIKIROOT/data/Main`<br />`cp -p $TWIKIROOT/data/TWiki/WebIndex.txt* $TWIKIROOT/data/Main`<br /> Repeat this for all your webs. Pay attention to the file permissions.
+>   * `TWikiRegistration` moved from TWiki.Main to TWiki.TWiki. In case you customized `TWikiRegistration` , merge your changes back into `TWiki.TWikiRegistration` , then delete `$TWIKIROOT/data/Main/TWikiRegistration*`.
+>   * `TWikiPreferences` moved from TWiki.Main to TWiki.TWiki. Merge your changes to `TWikiPreferences` into `TWiki.TWikiPreferences`.
+>   * Modify the `WebPreferences` topics in all your webs to reflect the following:
+>     * `WEBTOPICLIST` should use `WebChanges` for `"Changes"`, and `WebIndex` for `"Index"`, i.e. <br />`| <a href="WebChanges">Changes</a>`<br />`| <a href="WebIndex">Index</a>`
+>     * In case you want to exclude a web from a `web="all"` search: Set this new preference <br />`Set NOSEARCHALL = on`
+>   * The `WebSearch` topic has considerable changes. Copy the one from `TWiki.TWiki` into all webs, or merge them if you made changes. To copy, do an edit-copy-edit-paste operation.
+>   * Change the `WebHome` topics in all your webs to reflect these changes:
+>     1. The "Changes" link should point to `WebChanges`.
+>     2. The "Topic index" link should point to `WebIndex`.
+>     3. Change the include of the web table to <code>%INCLUDE\{"%TWIKIWEB%.TWikiWebsTable"\}%</code>
+>   * Merge your `TWikiWebsTable` topic in TWiki.Main with the `TWikiWebsTable` topic in TWiki.TWiki. Note the new variable to query the color of a web. Delete the old `TWikiWebsTable` topic in TWiki.Main after merge is complete.
+>   * The following topics in the TWiki.Main web are deprecated (because they moved to TWiki.TWiki), but still need to be present in TWiki.Main because of existing links to them: `FileAttachment`, `TWikiDocumentation`, `TWikiHistory`, `TWikiPreferences`, `TWikiVariables`. <br /> It is recommended that you edit these topics in TWiki.Main and replace the content with this line: <br /><code>This topic moved to %TWIKIWEB%.%TOPIC% in the %WIKITOOLNAME%.%TWIKIWEB% web.</code>
+>   * In all your webs, change references to topics that moved to the TWiki.TWiki web:
+>     * Change topics: `TWikiUsers` , `WebNotify` , `WebHome`
+>     * With links to: `TWikiPreferences` , `TWikiVariables` , `TWikiUsers` , `TWikiWebsTable` and `WelcomeGuest`
+>
+> ### <a name="TWiki_Access_Control"> TWiki Access Control </a>
+>
+> * * Read [[TWikiAccessControl]], in case you want to use the new authorization feature based on groups.
+>
+> ### <a name="Known_Issues"> Known Issues </a>
+>
+> * * Check <http://TWiki.org/cgi-bin/view/Codev/KnownIssuesOfTWiki01Sep2001> for known issues of TWiki 01 Sep 2001 (production release)
 
--- [[PeterThoeny]] - 25 Aug 2001 <br />
+-- [[MikeMannix]] - 26 Aug 2001 <br />