diff options
| -rw-r--r-- | TWiki/TWikiUpgradeGuide.mdwn | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/TWiki/TWikiUpgradeGuide.mdwn b/TWiki/TWikiUpgradeGuide.mdwn index 8076e418..4ad38e74 100644 --- a/TWiki/TWikiUpgradeGuide.mdwn +++ b/TWiki/TWikiUpgradeGuide.mdwn @@ -6,7 +6,7 @@ _Upgrade from TWiki 01-Dec-2000 to TWiki 01-Sep-2001 (previous to new full relea ## <a name="Overview"> Overview </a> -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. ## <a name="Upgrade_Requirements"> Upgrade Requirements </a> @@ -18,7 +18,7 @@ The latest version of TWiki (01-Sep-2001) involves several major new features an ## <a name="Major_Changes_from_TWiki_01_Dec_"> Major Changes from TWiki 01-Dec-2000 </a> -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 [[TWikiPlugins]]. * [[InterwikiPlugin]] (preinstalled) - Link to external sites with text aliases, `SiteAlias:Page`; rules are defined in [[InterWikis]]. (Get more Plugins from the TWiki:Plugins web.) @@ -27,7 +27,7 @@ The 01 Sep 2001 release includes the following new features and enhancements: * **[[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. -* **[[TWikiUserAuthentication]]** Change and reset passwords using forms. +* **[[Changing_Passwords]]** Change and reset passwords using forms. * **[[TWikiVariables]]** - <code>%TOC%</code> variable generates a hierarchical table of contents from topic headings: <hI>...<h6>. Set depth. * **[[TWikiVariables]]** - Text formatting rules to generate automatic links from any combination of words and spaces. * **[[FileAttachment]]** Changes made to files attached to topics are now saved under revision control (RCS). @@ -122,9 +122,9 @@ Follow this step-by-step guide to upgrade from the 01-Dec-2000 TWiki to the 01-S ### <a name="Pre_Upgrade_Preparation"> Pre-Upgrade Preparation </a> -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/` ### <a name="Step_1_Backup_amp_Unpack"> Step 1: Backup & Unpack </a> @@ -173,9 +173,9 @@ The following steps describe the upgrade on Unix. Windows setup is very similar. ### <a name="Step_8_Update_topics"> Step 8: Update topics </a> -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. -1. Remember that you have now two TWiki webs: +1. Remember that you now have two TWiki webs: * The original `TWiki` web. * The new `TWiki2` web, which gets renamed to `TWiki` when you switch over the installation. 2. In case you customized `TWiki.TWikiRegistration`, merge your changes back into `TWiki2.TWikiRegistration`. @@ -195,7 +195,7 @@ You can do the following changes using your old TWiki 01-Dec-2000 or new TWiki 0 ### <a name="Step_9_Customize_template_files"> Step 9: Customize template files </a> -**_Note:_** Skip this step in case you did not customize your template files. +**_NOTE:_** Skip this step if you did not customize your template files. 1. Remember that you have now two template directories: * The original `twiki/templates`. @@ -210,16 +210,16 @@ You can do the following changes using your old TWiki 01-Dec-2000 or new TWiki 0 ### <a name="Step_10_Switch_over_to_new_insta"> Step 10: Switch over to new installation </a> -In this step we relocate the working 01-Sep-2001 installation over the old 01-Dec-2000 installation, so that we don't need to change the URL. +In this step, you move the working 01-Sep-2001 installation to the old 01-Dec-2000 installation, so that you don't have to change the URL. 1. Test your new 01-Sep-2001 installation under `twiki/bin/2/view` to make sure everything works as expected. - * **_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. 2. Edit `$TWIKIROOT/bin/2/TWiki.cfg` and remove the `/2` from `$scriptUrlPath` and `$templateDir`, ex: <br />`$scriptUrlPath = "/twiki/bin";`<br />`$templateDir = "/home/httpd/twiki/templates";` 3. Rename the `TWiki2` web to `TWiki`, including attachments, ex: <br />`cd $TWIKIROOT/data`<br />`mv TWiki TWiki1`<br />`mv TWiki2 TWiki`<br />`cd $TWIKIROOT/pub`<br />`mv TWiki TWiki1`<br />`mv TWiki2 TWiki` 4. Rename the `templates2` directory to `templates`, ex: <br />`cd $TWIKIROOT`<br />`mv templates templates1`<br />`mv templates2 templates` 5. Move the `lib` directory one level up from `$TWIKIROOT/bin/lib` to `$TWIKIROOT/lib`, ex: <br />`cd $TWIKIROOT`<br />`mv bin/lib .` 6. Copy content of `bin/2` to `bin`, ex: <br />`cd $TWIKIROOT/bin`<br />`cp -p bin/2/* .`<br />`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. +7. 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. 8. Clean up and remove obsolete directories: * Remove directory `$TWIKIROOT/bin/2` * Remove directory `$TWIKIROOT/templates1` @@ -231,22 +231,22 @@ In this step we relocate the working 01-Sep-2001 installation over the old 01-De 1. Test the new [[TWikiPlugins]] by checking the Plugins settings in [[TWikiPreferences]]. * The <code>EmptyPlugin</code>, <code>DefaultPlugin</code>, and <code>InterwikiPlugin</code> should be preinstalled. To check the %TWIKIWEB%.InterwikiPlugin, go to its page. -2. In case you have customized the functions `extendHandleCommonTags`, `extendGetRenderedVersionOutsidePRE` and `extendGetRenderedVersionInsidePRE` in `twiki/bin/wikicfg.pm`: +2. 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` ### <a name="General_Format_Changes"> General Format Changes </a> -* Format changed of <code>**%GMTIME\{"..."\}%**</code> and <code>**%SERVERTIME\{"..."\}%**</code> variables. Format is now <code>**"$hour:$min"**</code> instead of <code>**"hour:min"**</code>. More in %TWIKIWEB%.TWikiVariables. +* The format of the <code>%GMTIME\{"..."\}%</code> and <code>%SERVERTIME\{"..."\}%</code> variables is now <code>**"$hour:$min"**</code> instead of `"hour:min"`. More in %TWIKIWEB%.TWikiVariables. -* [[TWikiVariables]]: Enhanced table syntax might have unwanted side effect: <code>**| \*bold\* |**</code> cells, <code>**| center aligned |**</code> and <code>**| right aligned |**</code> cells, span multiple columns using <code>**| empty cells |||**</code>. More in [[TextFormattingRules]]. +* [[TWikiVariables]]: Enhanced table syntax might have unwanted side effect: <code>| \*bold\* |</code> cells, `| center aligned |` and `| right aligned |` cells, span multiple columns using `| empty cells |||`. More in [[TextFormattingRules]]. -* Use <code>**Net::SMTP**</code> module instead of <code>**sendmail**</code> if installed. +* Use <code>**Net::SMTP**</code> module instead of `sendmail` if installed. -* Use <code>**<verbatim> ... </verbatim>**</code> tags instead of <code>**<pre> ... </pre>**</code> tags where appropriate. More in %TWIKIWEB%.TextFormattingRules. +* Use <code>**<verbatim> ... </verbatim>**</code> tags instead of `<pre> ... </pre>` tags where appropriate. More in %TWIKIWEB%.TextFormattingRules. * New variable <code>**%STARTINCLUDE%**</code> and <code>**%STOPINCLUDE%**</code> variables to control what gets included of a topic. More in %TWIKIWEB%.TWikiVariables. -* [[FileAttachment]] info is now stored as [[TWikiDocumentation]]. +* [[FileAttachment]] info is now stored as [[TWikiMetaData]]. * 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. @@ -254,8 +254,8 @@ In this step we relocate the working 01-Sep-2001 installation over the old 01-De * 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. -## <a name="Known_Issues_of_TWiki_01_Sep_200"> Known Issues of TWiki 01 Sep 2001 </a> +## <a name="Known_Issues"> Known Issues </a> * * Check TWiki:Codev/KnownIssuesOfTWiki01Sep2001 for known issues of TWiki 01 Sep 2001 (production release) --- [[Main/JohnTalintyre]] - 18 Jul 2001 <br /> -- [[Main/PeterThoeny]] - 12 Sep 2001 <br /> +-- [[JohnTalintyre]] - 18 Jul 2001 <br /> -- [[MikeMannix]] - 12 Sep 2001 <br /> -- [[PeterThoeny]] - 12 Sep 2001 <br /> |