diff options
author | Peter Thoeny <web-hurd@gnu.org> | 2001-09-14 07:53:04 +0000 |
---|---|---|
committer | Peter Thoeny <web-hurd@gnu.org> | 2001-09-14 07:53:04 +0000 |
commit | b315d1e02c390588c201f26c121aee67f62c71bf (patch) | |
tree | b8f749d85b941e71270d3de346e75e999c66e4b8 | |
parent | 45668f1acdfc381975a3c19fc818f3af5ab2ac46 (diff) |
none
-rw-r--r-- | TWiki/TWikiUpgradeGuide.mdwn | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/TWiki/TWikiUpgradeGuide.mdwn b/TWiki/TWikiUpgradeGuide.mdwn index 83f4a915..8076e418 100644 --- a/TWiki/TWikiUpgradeGuide.mdwn +++ b/TWiki/TWikiUpgradeGuide.mdwn @@ -20,17 +20,17 @@ The latest version of TWiki (01-Sep-2001) involves several major new features an The 01 Sep 2001 release includes the following new features and enhancements: -* **[[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. -* **[[TWIKIWEBTWikiVariables]]** - <code>%TOC%</code> variable generates a hierarchical table of contents from topic headings: <HI>...<H6>. Set depth. -* **[[TWIKIWEBTWikiVariables]]** - Text formatting rules to generate automatic links from any combination of words and spaces. -* **[[TWIKIWEBFileAttachment]]** Changes made to files attached to topics are now saved under revision control (RCS). +* **[[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.) +* **[[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. +* **[[TWikiUserAuthentication]]** 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). * **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.) @@ -122,7 +122,7 @@ 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 - [[TWikiDocumentation]] and [[TWikiDocumentation]] (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. 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! 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/` @@ -200,13 +200,13 @@ You can do the following changes using your old TWiki 01-Dec-2000 or new TWiki 0 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. -2. Customized templates and skins need to be upgraded to the new [[TWikiDocumentation]]. 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 [[TWikiDocumentation]], but you have to escape unwanted ones. Also, remove empty lines unless you want a `=<p />` tag added. - * Added [[TWikiDocumentation]]. +2. 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. 3. Form Templates replace the TWikiCategoryTables: - * [[TWikiDocumentation]] based on `twikicatitems.tmpl` in each web that used a Category Table. + * Create a replacement [[TWikiForms]] 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. -4. 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. +4. For each web that has a custom <code>**notedited.tmpl**</code> template, create a [[WebTopicEditTemplate]] to conform with the new #SelectableNewTopicTemplates feature. Retired `notedited.tmpl`, `notext.tmpl` and `notwiki.tmpl` templates. ### <a name="Step_10_Switch_over_to_new_insta"> Step 10: Switch over to new installation </a> @@ -229,7 +229,7 @@ In this step we relocate the working 01-Sep-2001 installation over the old 01-De ### <a name="Step_11_Test_the_TWiki_Plugins"> Step 11: Test the TWiki Plugins </a> -1. Test the new [[TWikiDocumentation]] by checking the Plugins settings in [[TWikiPreferences]]. +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`: * Merge those changes back into `twiki/lib/TWiki/Plugins/Default.pm` @@ -238,7 +238,7 @@ In this step we relocate the working 01-Sep-2001 installation over the old 01-De * 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. -* [[TWIKIWEBTWikiVariables]]: 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. +* [[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]]. * Use <code>**Net::SMTP**</code> module instead of <code>**sendmail**</code> if installed. @@ -250,12 +250,12 @@ In this step we relocate the working 01-Sep-2001 installation over the old 01-De * 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]] ) +* Handling for topic-specific templates like `edit.new.tmpl` has been removed and replaced by template topics in the new [[TWikiTemplates]]. * 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> -* * Check <http://TWiki.org/cgi-bin/view/Codev/KnownIssuesOfTWiki01Sep2001> for known issues of TWiki 01 Sep 2001 (production release) +* * 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 /> |