diff options
Diffstat (limited to 'TWiki')
| -rw-r--r-- | TWiki/TWikiUpgradeGuide.mdwn | 69 |
1 files changed, 51 insertions, 18 deletions
diff --git a/TWiki/TWikiUpgradeGuide.mdwn b/TWiki/TWikiUpgradeGuide.mdwn index 8b334fe6..80975857 100644 --- a/TWiki/TWikiUpgradeGuide.mdwn +++ b/TWiki/TWikiUpgradeGuide.mdwn @@ -2,37 +2,37 @@ # <a name="TWiki_Upgrade_Guide"> TWiki Upgrade Guide </a> -_Upgrading from the 01-Dec-2000 release to the new TWiki 01-Sep-2001_ +_Upgrade from TWiki 01-Dec-2000 to TWiki 01-Sep-2001 (previous to new full release)_ ## <a name="Overview"> Overview </a> -The latest version of TWiki (01-Sep-2001) involves several major new features and numerous enhancements of 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-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. ## <a name="Upgrade_Requirements"> Upgrade Requirements </a> * 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 %TWIKIWEB%.TWikiUpgradeTo01Dec2000. +* **_NOTE:_** To upgrade from a **pre-01-Dec-2000** TWiki, start with %TWIKIWEB%.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. +* 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. ## <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: -* **[[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.) -* **[[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. -* **[[ManagingTopics]]** Individual pages can be managed through the browser. Deleted topics are stored in a common Trash web. -* **[[TWikiUserAuthentication]]** Change and reset passwords using forms +* **[[TWikiDocumentation]]** - Easily install program enhancements using external plug-in modules. Developers can create plug-ins in Perl, with the [[TWikiPlugins]]. + * **[[TWikiDocumentation]]** (preinstalled) - Link to external sites with text aliases, `SiteAlias:Page`; rules are defined in [[InterWikis]]. (Get more Plugins from the TWiki:Plugins web.) +* **[[TWikiDocumentation]]** - New, more flexible template system. +* **[[TWikiDocumentation]]** - Overwrite template headers and footers; page content is unaffected. +* **[[TWikiDocumentation]]** - New data format +* **[[TWikiDocumentation]]** - Create multiple input forms per web; data is rendered in HTML tables. +* **[[TWikiDocumentation]]** Individual pages can be managed through the browser. Deleted topics are stored in a common Trash web. +* **[[TWikiDocumentation]]** Change and reset passwords using forms. * **TOC (Table of Contents)** - <code>%TOC%</code> 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). +* **[[TWIKIWEBTWikiVariables]]** - Text formatting rules to generate automatic links from any combination of words and spaces. +* **\[[%TWIKIWEB%.FileAttachments]\[Attachments Under Revision Control]** Changes to files attached to topics - - 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. -* **HierarchicalNavigation** +* **HierarchicalNavigation** uses new Meta Data variables to link hierarchically, for example, as in Yahoo! and other search sites. The TWiki directory structure remains the same, with one exception, the new `lib/TWiki/Plugins` directory tree to for the main configuration file, library, internal modules and the new Plugin modules. Pre-existing files were formerly in `bin`. @@ -64,9 +64,17 @@ Follow this step-by-step guide to upgrade the 01 Dec 2000 version to the 01 Sep 1. 1. Rename your original `twiki/templates` directory: ( `twiki/templates` ) <br />`mv $TWIKIROOT/templates $TWIKIROOT/templates.old` 2. Move the new templates to your original `twiki/templates` location: <br />`mv ~/tmp/templates $TWIKIROOT/templates` - 3. \_\_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=\_\_ - 4. Restore any additional template subdirectories of your TWiki webs you might have and merge the changes. - 5. Test your TWiki installation to see if you can view topics. + 3. Customized templates and skins need to be upgraded to the [[TWikiDocumentation]]. 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 [[TWikiDocumentation]], but you have to escape unwanted ones. Also, remove empty lines unless you want a `=<p />` tag added. + * Added [[TWikiDocumentation]]. + 4. The Form Templates replace the TWikiCategoryTable: + * [[TWikiDocumentation]] 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. + 5. \_\_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=\_\_ + 6. For each web that has a custom <code>**notedited.tmpl**</code> template, create a [[WebTopicEditTemplate]] to conform with the new [[TWikiDocumentation]] feature. Retired `notedited.tmpl`, `notext.tmpl` and `notwiki.tmpl` templates. + 7. Restore any additional template subdirectories of your TWiki webs you might have and merge the changes. + 8. Test your TWiki installation to see if you can view topics. ### <a name="Step_5_Upgrade_public_files"> Step 5: Upgrade public files </a> @@ -87,7 +95,32 @@ Follow this step-by-step guide to upgrade the 01 Dec 2000 version to the 01 Sep * In case you want to exclude a web from a `web="all"` search: Set this new preference <br />`Set NOSEARCHALL = on` 7. 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. 8. **_Change the `WebHome` topics in all your webs to reflect these changes:_** + 9. If you are using <code>**.htaccess**</code>, add the `rename` script \* You may want to add `[ALLOW|DENY][WEB|TOPIC]RENAME` in some places, like %TWIKIWEB%TWikiPreferences, [[WebPreferences]] and %MAINWEB%.TWikiUsers + +### <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. + +* [[ExtendingTableSyntax]]: 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 %TWIKIWEB%.TextFormattingRules. + +* Use <code>**Net::SMTP**</code> module instead of <code>**sendmail**</code> if installed. + +* Use <code>**<verbatim> ... </verbatim>**</code> tags instead of <code>**<pre> ... </pre>**</code> 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]]. + * 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 [[TWikiDocumentation]] ) + +* 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_Upgrade_Issues"> Known Upgrade Issues </a> * * Check <http://TWiki.org/cgi-bin/view/Codev/KnownIssuesOfTWiki01Sep2001> for known issues of TWiki 01 Sep 2001 (production release) + +* * **_Upgrading requires extensive changes be made to topics in the TWiki web._** + +-- [[Main/JohnTalintyre]] - 18 Jul 2001 <br /> |