|
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
The following steps describe the upgrade assuming that $TWIKIROOT is the root of your current 01-Sep-2000 release.
| >
> |
The following steps describe the upgrade assuming that $TWIKIROOT is the root of your current 01-Sep-2001 release. |
|
|
| Changed: |
<
< |
Upgrade from TWiki 01-Dec-2000 to TWiki 01-Sep-2001 (previous to new full release)
| >
> |
Upgrade from TWiki 01-Dec-2000 or TWiki 01-Sep-2001 to TWiki 01-Dec-2001 (previous to new full release)
|
| Changed: |
<
< |
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.
| >
> |
This guide describes how to upgrade either from TWiki 01-Dec-2000 or TWiki 01-Sep-2001 to TWiki 01-Dec-2001.
- The latest version of TWiki (01-Dec-2001) is a small incremental release over the 01-Sep-2001 version.
- The 01-Sep-2001 version 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.
|
| Changed: |
<
< |
- To upgrade from a 01-Dec-2000 standard installation to the new, next generation 01-Sep-2001 TWiki Production Release, follow the instructions below.
| >
> |
- To upgrade from a 01-Dec-2000 or 01-Sep-2001 standard installation to the latest 01-Dec-2001 TWiki Production Release, follow the instructions below.
|
| Added: |
>
> |
The latest 01-Dec-2001 release includes the following new features and enhancements compared to the 01-Sep-2001 release:
- FormattedSearch - New
format="" parameter in %SEARCH{}% variable for database like reporting.
- Various bug fixes
|
| Changed: |
<
< |
The 01-Sep-2001 release includes the following new features and enhancements:
| >
> |
The 01-Sep-2001 release includes the following new features and enhancements compared to the 01-Dec-2000 release:
|
| Added: |
>
> |
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
| >
> |
This incremental update can be performed easily.
The following steps describe the upgrade assuming that $TWIKIROOT is the root of your current 01-Sep-2000 release.
- Back up and prepare:
- Back up all existing TWiki directories
$TWIKIROOT/bin, $TWIKIROOT/pub, $TWIKIROOT/data, $TWIKIROOT/templates.
- Create a temporary directory and unpack the ZIP file there.
- Update files in TWiki root:
- Overwrite all
*.html and *.txt files in $TWIKIROOT with the new ones.
- Update template files:
- Overwrite all template files in
$TWIKIROOT/templates with the new ones.
- Update script files:
- Overwrite all script files in
$TWIKIROOT/bin with the new ones.
- Update library files:
- Overwrite the
TWiki.pm library in $TWIKIROOT/lib with the new one.
- Overwrite all
*.pm library files in $TWIKIROOT/lib/TWiki and $TWIKIROOT/lib/TWiki/Plugins with the new ones.
- Update data/TWiki files: (in case you want the updated docs)
- Using your browser, merge the new TWiki.TWikiRegistration topic (or TWiki.TWikiRegistrationPub in case you used that one) into your existing TWiki.TWikiRegistration topic.
- In the temporary
twiki/data/TWiki directory where you unzipped the installation package:
- Remove the files you do not want to upgrade:
TWikiPreferences.*, TWikiWebsTable.*, WebNotify.*, WebPreferences.*, WebStatistics.* and all WebTopic* files.
- In case the cgi-scripts are not running as user
nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody and need to be changed the user of your cgi-scripts, i.e. www-data. A simple way to switch the locker of the RCS files is to use sed:
for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
- Move all remaining
*.txt and *.txt,v files from the temporary data/TWiki directory to your $TWIKIROOT/data/TWiki directory.
- Update pub/TWiki files:
- Move the new
pub/TWiki/TWikiDocGraphics directory into your $TWIKIROOT/pub/TWiki directory.
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
Alternatively you could move the existing installation away, install the 01-Sep-2001 release into it's place and move your webs and pub files back.
| >
> |
Alternatively you could move the existing installation away, install the 01-Dec-2001 release into it's place and move your webs and pub files back.
|
| Changed: |
<
< |
Follow this step-by-step guide to upgrade from the 01-Dec-2000 TWiki to the 01-Sep-2001 release, importing your original page data and related files:
| >
> |
Follow this step-by-step guide to upgrade from the 01-Dec-2000 TWiki to the 01-Dec-2001 release, importing your original page data and related files:
|
| Changed: |
<
< |
cp -p ~/downloads/TWiki20010901.zip ~/tmp/
| >
> |
cp -p ~/downloads/TWiki20011201.zip ~/tmp/
|
| Changed: |
<
< |
unzip ~/tmp/TWiki20010901.zip
| >
> |
unzip ~/tmp/TWiki20011201.zip
|
| Changed: |
<
< |
for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
| >
> |
for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
|
| Changed: |
<
< |
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.
| >
> |
You can do the following changes using your old TWiki 01-Dec-2000 or new TWiki 01-Dec-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.
|
| Changed: |
<
< |
In this step, you move the working 01-Sep-2001 installation to the old 01-Dec-2000 installation, so that users don't have to change the URL.
| >
> |
In this step, you move the working 01-Dec-2001 installation to the old 01-Dec-2000 installation, so that users don't have to change the URL.
|
| Changed: |
<
< |
- Test your new 01-Sep-2001 installation under
twiki/bin/2/view to make sure everything works as expected.
| >
> |
- Test your new 01-Dec-2001 installation under
twiki/bin/2/view to make sure everything works as expected.
|
| Changed: |
<
< |
- 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.
| >
> |
- Point your browser to the original URL and make sure the relocated 01-Dec-2001 installation works as expected: check browsing, searching and user registration.
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
-- PeterThoeny - 02 Oct 2001
| >
> |
-- PeterThoeny - 03 Dec 2001
|
|
|
| Changed: |
<
< |
-
- Searches need to be adjusted to deal with format change - if all topics are upgrades, a more specific search can be done.
| >
> |
-
- Searches need to be adjusted to deal with format change. It is possible to define a regular expression search that can deal at the same time with topics in the old format and new format.
- Example: List all topics in the Know web that have a TopicClassification? of PublicFAQ?:
%SEARCH{ "[T]opicClassification.*?(td..td|value\=).*?[P]ublicFAQ" casesensitive="on" regex="on" nosearch="on" web="Know"}%
(The [T] and [P] is done so that search does not find the topic where this search string is located in!)
- Example: Create a link that lists all topics in the Know web with a TopicClassification? of PublicFAQ?:
[[%SCRIPTURL%/search%SCRIPTSUFFIX%/Know/?scope=text
&search=%5BT%5DopicClassification.*%3F%28td..td%7C
value%5C%3D%29.*%3F%5BP%5DublicFAQ®ex=on][All Public FAQ]]
All Public FAQ
|
| Changed: |
<
< |
-- PeterThoeny - 12 Sep 2001
| >
> |
-- PeterThoeny - 02 Oct 2001
|
|
|
| Changed: |
<
< |
-
- Modify WEBTOPICLIST, ex:
* Set WEBTOPICLIST = [[%HOMETOPIC%][Home]] %SEP% [[WebChanges][Changes]] %SEP% [[WebIndex][Index]] %SEP% [[WebSearch][Search]] %SEP% Go <input type="text" name="topic" size="16" />
| >
> |
-
- In WEBTOPICLIST, remove the
%WEB% . {} decoration from the list (it is now in the templates), ex:
* Set WEBTOPICLIST = <a href="WebHome">Home</a>
| <a href="WebChanges">Changes</a>
| <a href="WebIndex">Index</a>
| <a href="WebSearch">Search</a>
| Go <input type="text" name="topic" size="16" />
|
| Changed: |
<
< |
| >
> |
-
- Set the FINALPREFERENCES:
|
| Changed: |
<
< |
- In
WebSearch of all webs, replace content with this one line:
| >
> |
- Optional: In
WebSearch of all webs, replace content with this one line:
|
| Changed: |
<
< |
- In
WebChanges of all webs, replace content with this one line:
| >
> |
- Optional: In
WebChanges of all webs, replace content with this one line:
|
| Changed: |
<
< |
-
- Create a replacement TWikiForms template based on
twikicatitems.tmpl in each web that used a Category Table.
| >
> |
-
- Create a replacement
WebForm topic based on twikicatitems.tmpl in each web that uses a Category Table. See details in TWikiForms and compare with the settings in the Know2.WebPreferences topic.
NOTE: Do not remove the twikicatitems.tmpl file, it is still used for topics that are of the old format.
|
| Changed: |
<
< |
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.
| >
> |
In this step, you move the working 01-Sep-2001 installation to the old 01-Dec-2000 installation, so that users don't have to change the URL. |
|
|
| Changed: |
<
< |
- For each web that has a custom
notedited.tmpl template, create a WebTopicEditTemplate to conform with the new #SelectableNewTopicTemplates feature. Retired notedited.tmpl, notext.tmpl and notwiki.tmpl templates.
| >
> |
- For each web that has a custom
notedited.tmpl template, create an equivalent WebTopicEditTemplate to conform with the new TemplateTopics. The new format replaces the notedited.tmpl, notext.tmpl and notwiki.tmpl templates.
|
|
|
| Changed: |
<
< |
- TWikiPlugins - Easily install program enhancements using external plug-in modules. Developers can create plug-ins in Perl, with the TWiki Plugin API.
- 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.
- Change passwords? Change and reset passwords using forms.
- TOC (Table of Contents) -
%TOC% variable generates a hierarchical table of contents from topic headings: <hI>...<h6>. Set depth.
- Arbitrary Text for WikiWord Links - Text formatting rules to generate automatic links from any combination of words and spaces.
- Attachments Under Revision Control 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.)
| >
> |
- TWikiPlugins - Easily install program enhancements using external plug-in modules. Developers can create plug-ins in Perl, with the TWiki Plugin API.
- TWikiTemplates - New, more flexible template system.
- TWikiSkins - Overwrite template headers and footers; page content is unaffected.
- TWikiMetaData - New data format
- TWiki.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.
- Change passwords - Change and reset passwords using forms.
- TOC (Table of Contents) -
%TOC% variable generates a hierarchical table of contents from topic headings: <h1>...<h6>.
- Arbitrary Text for WikiWord Links - Text formatting rules to generate automatic links from any combination of words and spaces.
- Attachments Under Revision Control - Changes made to files attached to topics are now saved under revision control (RCS).
- SuperAdministrator Group - Lets you to make the members of one user group - by default, TWikiAdminGroup - into TWiki superusers, with the ability to overwrite locked topics from the browser interface. (This gets around the problem of topic lockouts, caused by typos in access privilege definitions.)
- HierarchicalNavigation uses new Meta Data variables to link hierarchically.
- Convert to XHTML - Pages are rendered for display in XHTML 1.0, as far as possible without breaking HTML 3.2 compliance.
|
|
|
| Changed: |
<
< |
- Change passwords? Change and reset passwords using forms.
| >
> |
- Change passwords? Change and reset passwords using forms.
|
| Added: |
>
> |
- Move the TWiki logo files, ex:
mv ~/tmp/pub/*.gif $TWIKIROOT/pub
|
|
|
| Changed: |
<
< |
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.
|
| Changed: |
<
< |
The 01 Sep 2001 release includes the following new features and enhancements:
| >
> |
The 01-Sep-2001 release includes the following new features and enhancements:
|
| Changed: |
<
< |
| >
> |
- Change passwords? Change and reset passwords using forms.
|
| Changed: |
<
< |
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.
|
| Changed: |
<
< |
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/
|
| Changed: |
<
< |
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.
|
| Changed: |
<
< |
- Remember that you have now two TWiki webs:
| >
> |
- Remember that you now have two TWiki webs:
|
| Changed: |
<
< |
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.
|
| Changed: |
<
< |
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.
|
| Changed: |
<
< |
-
- 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.
|
| Changed: |
<
< |
- 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.
| >
> |
- 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.
|
| Changed: |
<
< |
- In case you have customized the functions
extendHandleCommonTags, extendGetRenderedVersionOutsidePRE and extendGetRenderedVersionInsidePRE in twiki/bin/wikicfg.pm:
| >
> |
- If you have customized the functions
extendHandleCommonTags, extendGetRenderedVersionOutsidePRE and extendGetRenderedVersionInsidePRE in twiki/bin/wikicfg.pm:
|
| Changed: |
<
< |
- Format changed of
%GMTIME{"..."}% and %SERVERTIME{"..."}% variables. Format is now "$hour:$min" instead of "hour:min". More in TWikiVariables.
| >
> |
- The format of the
%GMTIME{"..."}% and %SERVERTIME{"..."}% variables is now "$hour:$min" instead of "hour:min". More in TWikiVariables.
|
| Changed: |
<
< |
- ExtendingTableSyntax: Enhanced table syntax might have unwanted side effect:
| *bold* | cells, | center aligned | and | right aligned | cells, span multiple columns using | empty cells |||. More in TextFormattingRules.
| >
> |
- ExtendingTableSyntax: Enhanced table syntax might have unwanted side effect:
| *bold* | cells, | center aligned | and | right aligned | cells, span multiple columns using | empty cells |||. More in TextFormattingRules.
|
| Changed: |
<
< |
- Use
Net::SMTP module instead of sendmail if installed.
| >
> |
- Use
Net::SMTP module instead of sendmail if installed.
|
| Changed: |
<
< |
- Use
<verbatim> ... </verbatim> tags instead of <pre> ... </pre> tags where appropriate. More in TextFormattingRules.
| >
> |
- Use
<verbatim> ... </verbatim> tags instead of <pre> ... </pre> tags where appropriate. More in TextFormattingRules.
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
-- JohnTalintyre? - 18 Jul 2001
-- PeterThoeny? - 12 Sep 2001
| >
> |
-- JohnTalintyre - 18 Jul 2001
-- MikeMannix - 12 Sep 2001
-- PeterThoeny - 12 Sep 2001
|
|
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
Two major areas of TWiki functionality - templates and Category Tables (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!
|
| Changed: |
<
< |
- Customized templates and skins need to be upgraded to the new TWiki Template System. 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:
| >
> |
- 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.
|
| Changed: |
<
< |
| >
> |
-
- Create a replacement TWikiForms template based on
twikicatitems.tmpl in each web that used a Category Table.
|
| Changed: |
<
< |
- For each web that has a custom
notedited.tmpl template, create a WebTopicEditTemplate to conform with the new SelectableNewTopicTemplates feature. Retired notedited.tmpl, notext.tmpl and notwiki.tmpl templates.
| >
> |
- For each web that has a custom
notedited.tmpl template, create a WebTopicEditTemplate to conform with the new #SelectableNewTopicTemplates feature. Retired notedited.tmpl, notext.tmpl and notwiki.tmpl templates.
|
| Changed: |
<
< |
- Test the new TWikiPlugins by checking the Plugins settings in TWikiPreferences.
| >
> |
- Test the new TWikiPlugins by checking the Plugins settings in TWikiPreferences.
|
| Changed: |
<
< |
- ExtendingTableSyntax: Enhanced table syntax might have unwanted side effect:
| *bold* | cells, | center aligned | and | right aligned | cells, span multiple columns using | empty cells |||. More in TextFormattingRules.
| >
> |
- ExtendingTableSyntax: Enhanced table syntax might have unwanted side effect:
| *bold* | cells, | center aligned | and | right aligned | cells, span multiple columns using | empty cells |||. More in TextFormattingRules.
|
| Changed: |
<
< |
- Handling for topic-specific templates like
edit.new.tmpl has been removed and replaced by template topics in the new TWiki Template System )
| >
> |
- Handling for topic-specific templates like
edit.new.tmpl has been removed and replaced by template topics in the new TWikiTemplates.
|
| Changed: |
<
< |
| >
> |
|
|
|
| Changed: |
<
< |
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.
| >
> |
The TWiki directory structure remains the same, with one exception, the TWiki configuration file and Perl modules have been moved from the twiki/bin directory into it's own twiki/lib directory tree. The following files have been renamed and moved:
| From TWiki 01-Dec-2000: | To TWiki 01-Sep-2001: |
|---|
twiki/bin/wikicfg.pm | twiki/lib/TWiki.cfg |
twiki/bin/wiki.pm | twiki/lib/TWiki.pm |
twiki/bin/wikiaccess.pm | twiki/lib/TWiki/Access.pm |
twiki/bin/wikiprefs.pm | twiki/lib/TWiki/Prefs.pm |
twiki/bin/wikisearch.pm | twiki/lib/TWiki/Search.pm |
twiki/bin/wikistore.pm | twiki/lib/TWiki/Store.pm |
A new twiki/lib/TWiki/Plugins directory contains the new Plugin modules.
|
| Added: |
>
> |
The idea is to have the new and old installation work in parallel so that you can test the new installation before switching over. That way you can make the switch on your live TWiki installation within one minute without affecting the users.
| Before Switch: | After Switch: |
|---|
| Current 01-Dec-2000: | New 01-Sep-2001: | Obsolete 01-Dec-2000: | New 01-Sep-2001: |
|---|
twiki/templates/ | twiki/templates2/ | twiki/templates1/ | twiki/templates/ |
twiki/bin/ | twiki/bin/2/ | (overwritten) | twiki/bin/ |
| (N/A) | twiki/bin/lib/ | (N/A) | twiki/lib/ |
twiki/data/TWiki | twiki/data/TWiki2 | twiki/data/TWiki1 | twiki/data/TWiki |
| (other directories do not change) |
Alternatively you could move the existing installation away, install the 01-Sep-2001 release into it's place and move your webs and pub files back.
|
| Added: |
>
> |
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/
|
| Changed: |
<
< |
-
- Move all existing TWiki directories (
bin, pub, data, templates ) to a temporary directory (it's a good idea to do a full back-up first):
mkdir -p ~/tmp/
mv $TWIKIROOT/* ~/tmp/
- Unpack the zip file into your newly empty working directory:
cd $TWIKIROOT
unzip ~/TWiki20010901.zip
| >
> |
- Back up all existing TWiki directories
twiki/bin, twiki/pub, twiki/data, twiki/templates.
- Create a temporary directory and unpack the ZIP file there:
mkdir -p ~/tmp/
cp -p ~/downloads/TWiki20010901.zip ~/tmp/
cd ~/tmp/
unzip ~/tmp/TWiki20010901.zip
|
| Changed: |
<
< |
mv ~/tmp/TWiki*.html $TWIKIROOT
mv ~/tmp/index.html $TWIKIROOT
mv ~/tmp/readme.txt $TWIKIROOT
mv ~/tmp/license.txt $TWIKIROOT
| >
> |
mv ~/tmp/TWiki*.html $TWIKIROOT
mv ~/tmp/index.html $TWIKIROOT
mv ~/tmp/readme.txt $TWIKIROOT
mv ~/tmp/license.txt $TWIKIROOT
- Move & rename the template directory to a temporary
twiki/templates2 directory, ex:
mv ~/tmp/templates $TWIKIROOT/templates2
- Pay attention to the file and directory permissions (security issue). Set file permissions, ex:
chmod 644 *.cgi
- Move the TWiki web to a temporary TWiki2
twiki/data/TWiki2 directory. Do the same to files attached to this web, ex:
mv ~/tmp/data/TWiki $TWIKIROOT/data/TWiki2
mv ~/tmp/pub/TWiki $TWIKIROOT/pub/TWiki2
- Move & rename the Know web to a temporary
twiki/data/Know2 directory, ex:
mv ~/tmp/data/Know $TWIKIROOT/data/Know2
mv ~/tmp/pub/Know $TWIKIROOT/pub/Know2
- Move the _default and Trash web, ex:
mv ~/tmp/data/_default $TWIKIROOT/data
mv ~/tmp/data/Trash $TWIKIROOT/data
- Move the MIME types file, ex:
mv ~/tmp/data/mime.types $TWIKIROOT/data
- Pay attention to the file permissions of the
TWiki2 and Know2 directories and its files. The files must be writable by the cgi-scripts (usually user nobody).
- In case the cgi-scripts are not running as user
nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody and need to be changed the user of your cgi-scripts, i.e. www-data. A simple way to switch the locker of the RCS files is to use sed:
for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
|
| Changed: |
<
< |
Step 3: Upgrade CGI scripts
| >
> |
Step 5: Install new CGI scripts
|
| Added: |
>
> |
- Move & rename the CGI script directory to a temporary
twiki/bin/2 directory, ex:
mv ~/tmp/bin $TWIKIROOT/bin/2
|
| Changed: |
<
< |
-
- Restore any additional scripts you might have from the
tmp directory, ex:
mv ~/tmp/bin/somescript $TWIKIROOT/bin/
- Set permissions, ex:
chmod 755 *.cgi
- Restore any additional scripts you might have from the
tmp directory, ex:
mv ~/tmp/bin/somescript $TWIKIROOT/bin/
- Test your TWiki installation to see if you can view topics.
-
- Pay attention to the file and directory permissions (security issue)
-
- Customize the new
lib/TWiki.cfg configuration file, which replaces the wikicfg.pm file. New settings to watch for:
- Test your TWiki installation to see if you can view topics.
- Test the new TWikiPlugins by checking the Plugins settings in TWikiPreferences.
- The
EmptyPlugin, DefaultPlugin, and InterwikiPlugin should be preinstalled. To check the InterwikiPlugin, go to its page.
-
- Pay attention to the file and directory permissions (security issue)
| >
> |
- Copy any additional scripts you might have from the 01-Dec-2000 release, ex:
cp -p $TWIKIROOT/bin/somescript $TWIKIROOT/bin/2
- In case you use basic authentication, rename
.htaccess.txt to .htaccess and customize it, ex:
cd $TWIKIROOT/bin/2
mv .htaccess.txt .htaccess
diff ../.htaccess .
and merge the content
- Pay attention to the file and directory permissions (security issue). Set permissions, ex:
chmod 755 *.cgi
- Move the lib directory to a temporary
twiki/bin/lib directory, ex:
mv ~/tmp/lib $TWIKIROOT/bin
- Pay attention to the file and directory permissions (security issue). Set permissions, ex:
chmod 644 *.pm
- Merge the content of the old
twiki/bin/wikicfg.pm into the new twiki/lib/TWiki.cfg configuration file. Use the diff command to find out the differences, ex:
cd $TWIKIROOT/bin/lib
diff ../wikicfg.pm TWiki.cfg
- Make sure to set the correct temporary location of templates and scripts, ex:
$scriptUrlPath = "/twiki/bin/2";
$templateDir = "/home/httpd/twiki/templates2";
- Do not merge the functions
extendHandleCommonTags, extendGetRenderedVersionOutsidePRE, extendGetRenderedVersionInsidePRE from the old twiki/bin/wikicfg.pm. This is now handled by the Default plugin twiki/lib/TWiki/Plugins/Default.pm
- Test your new TWiki installation to see if you can view topics. Point your browser to the old installation and fix the URL to see the new installation, ex:
- Old URL:
http://localhost/cgi-bin/view
- New URL:
http://localhost/cgi-bin/2/view
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.
- Remember that you have now two TWiki webs:
- The original
TWiki web.
- The new
TWiki2 web, which gets renamed to TWiki when you switch over the installation.
- In case you customized
TWiki.TWikiRegistration, merge your changes back into TWiki2.TWikiRegistration.
- Copy
TWiki.TWikiWebsTable to TWiki2.TWikiWebsTable.
- Do the same for any other topics you might have created in the
TWiki web.
- In
TWiki2.TWikiPreferences, merge the old TWiki.TWikiPreferences settings and customize it.
- Add your webs to WIKIWEBLIST
- Set the WIKIWEBMASTER
- Set the SMTPMAILHOST
- In
WebPreferences of all webs, add or change the following web preferences: (see TWiki.WebPreferences)
- Add a NOSEARCHALL in case you want to exclude the web from a
web="all" search:
* Set NOSEARCHALL = on
- Modify WEBTOPICLIST, ex:
* Set WEBTOPICLIST = [[%HOMETOPIC%][Home]] %SEP% [[WebChanges][Changes]] %SEP% [[WebIndex][Index]] %SEP% [[WebSearch][Search]] %SEP% Go <input type="text" name="topic" size="16" />
- Add a these new preferences:
* Set DENYWEBVIEW =
* Set ALLOWWEBVIEW =
* Set DENYWEBRENAME =
* Set ALLOWWEBRENAME =
- Set FINALPREFERENCES:
* Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
- In
WebSearch of all webs, replace content with this one line:
%INCLUDE{"%TWIKIWEB%.WebSearch"}%
- In
WebChanges of all webs, replace content with this one line:
%INCLUDE{"%TWIKIWEB%.WebChanges"}%
Note: Skip this step in case you did not customize your template files.
- 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.
|
| Deleted: |
<
< |
-
- Test your TWiki installation to see if you can view topics.
|
| Changed: |
<
< |
| >
> |
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.
- 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.
- Edit
$TWIKIROOT/bin/2/TWiki.cfg and remove the /2 from $scriptUrlPath and $templateDir, ex:
$scriptUrlPath = "/twiki/bin";
$templateDir = "/home/httpd/twiki/templates";
- Rename the
TWiki2 web to TWiki, including attachments, ex:
cd $TWIKIROOT/data
mv TWiki TWiki1
mv TWiki2 TWiki
cd $TWIKIROOT/pub
mv TWiki TWiki1
mv TWiki2 TWiki
- Rename the
templates2 directory to templates, ex:
cd $TWIKIROOT
mv templates templates1
mv templates2 templates
- Move the
lib directory one level up from $TWIKIROOT/bin/lib to $TWIKIROOT/lib, ex:
cd $TWIKIROOT
mv bin/lib .
- Copy content of
bin/2 to bin, ex:
cd $TWIKIROOT/bin
cp -p bin/2/* .
cp -p bin/2/.htaccess .
- 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.
- Clean up and remove obsolete directories:
- Remove directory
$TWIKIROOT/bin/2
- Remove directory
$TWIKIROOT/templates1
- Remove directory
$TWIKIROOT/data/TWiki1
- Remove directory
$TWIKIROOT/pub/TWiki1
- Remove temporary directory, ex:
~/tmp
|
| Changed: |
<
< |
-
- Move your own public data files and sub-directories from the original
pub directory to the new installation: ( $TWIKIROOT/pub )
mv ~/tmp/pub/TWiki/somefiles.ext $TWIKIROOT/pub/
mv ~/tmp/pub/TWiki/somedirectory $TWIKIROOT/pub/
-
- Move the
tmp/data/TWiki directory to your installation: ( twiki/data )
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")
-
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 into TWiki.TWikiPreferences.
- Merge your changes to the
WebPreferences topics in all your webs into WebPreferences
- Modify the
WebPreferences topics in all your webs to reflect the following:
-
- In case you want to exclude a web from a
web="all" search: Set this new preference
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:
- If you are using
.htaccess, add the rename script
* You may want to add [ALLOW|DENY][WEB|TOPIC]RENAME in some places, like TWikiPreferences, WebPreferences and TWikiUsers
| >
> |
- Test the new TWikiPlugins by checking the Plugins settings in TWikiPreferences.
- The
EmptyPlugin, DefaultPlugin, and InterwikiPlugin should be preinstalled. To check the InterwikiPlugin, go to its page.
- 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
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
-
- Upgrading requires extensive changes be made to topics in the TWiki web.
-- JohnTalintyre? - 18 Jul 2001
| >
> |
-- JohnTalintyre? - 18 Jul 2001
-- PeterThoeny? - 12 Sep 2001
|
|
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
- TWikiFormTemplate - Create multiple input forms per web; data is rendered in HTML tables.
| >
> |
- TWikiForms - Create multiple input forms per web; data is rendered in HTML tables.
|
|
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
- TOC (Table of Contents) -
%TOC% variable generates a hierarchical table of contents from topic headings: <HI>...<H6>. Set depth.
| >
> |
- TOC (Table of Contents) -
%TOC% variable generates a hierarchical table of contents from topic headings: <HI>...<H6>. Set depth.
|
| Changed: |
<
< |
- 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 uses new Meta Data variables to link hierarchically, for example, as in Yahoo! and other search sites.
| >
> |
- Attachments Under Revision Control 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.)
|
| Changed: |
<
< |
Follow this step-by-step guide to upgrade the 01 Dec 2000 version to the 01 Sep 2001 release, and import your original page data:
| >
> |
Follow this step-by-step guide to upgrade from the 01-Dec-2000 TWiki to the 01-Sep-2001 release, importing your original page data and related files:
|
| Changed: |
<
< |
| >
> |
Two major areas of TWiki functionality - templates and Category Tables (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!
|
| Changed: |
<
< |
-
- Backup all existing TWiki directories (
bin, pub, data, templates )
| >
> |
|
| Changed: |
<
< |
-
- Unpack the zip file into some working directory:
| >
> |
-
- Move all existing TWiki directories (
bin, pub, data, templates ) to a temporary directory (it's a good idea to do a full back-up first):
|
| Changed: |
<
< |
cd ~/tmp
unzip ~/TWiki20001201.zip
| >
> |
mv $TWIKIROOT/* ~/tmp/
-
- Unpack the zip file into your newly empty working directory:
cd $TWIKIROOT
unzip ~/TWiki20010901.zip
|
| Changed: |
<
< |
-
- Rename your original
twiki/bin directory: ( twiki/bin )
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 compare the two files if you have made heavy changes to the file:
diff -c $TWIKIROOT/bin.old/wikicfg.pm $TWIKIROOT/bin/wikicfg.pm | less
- Restore any additional scripts you might have from the old directory, ex:
mv $TWIKIROOT/bin.old/somescript $TWIKIROOT/bin/
- Test your TWiki installation if you can view topics.
| >
> |
-
- If necessary, change the script names to include the required extension, ex:
.cgi
- Restore any additional scripts you might have from the
tmp directory, ex:
mv ~/tmp/bin/somescript $TWIKIROOT/bin/
- Set permissions, ex:
chmod 755 *.cgi
- Restore any additional scripts you might have from the
tmp directory, ex:
mv ~/tmp/bin/somescript $TWIKIROOT/bin/
- Test your TWiki installation to see if you can view topics.
-
- Pay attention to the file and directory permissions (security issue)
-
- Customize the new
lib/TWiki.cfg configuration file, which replaces the wikicfg.pm file. New settings to watch for:
- Test your TWiki installation to see if you can view topics.
- Test the new TWikiPlugins by checking the Plugins settings in TWikiPreferences.
- The
EmptyPlugin, DefaultPlugin, and InterwikiPlugin should be preinstalled. To check the InterwikiPlugin, go to its page.
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
-
- Rename your original
twiki/templates directory: ( twiki/templates )
mv $TWIKIROOT/templates $TWIKIROOT/templates.old
- Move the new templates to your original
twiki/templates location:
mv ~/tmp/templates $TWIKIROOT/templates
- Customized templates and skins need to be upgraded to the new template format. 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.
| >
> |
-
- Customized templates and skins need to be upgraded to the new TWiki Template System. 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:
|
| Changed: |
<
< |
-
- The Form Templates replace the TWikiCategoryTable:
| >
> |
-
- Form Templates replace the TWikiCategoryTables:
|
| Deleted: |
<
< |
-
- __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=__
|
| Deleted: |
<
< |
-
- Restore any additional template subdirectories of your TWiki webs you might have and merge the changes.
|
| Changed: |
<
< |
-
- Move the new
twiki/pub/TWiki directory to your installation: ( twiki/pub )
mv ~/tmp/pub/TWiki $TWIKIROOT/pub/
- Move the new
twiki/pub/twikilogo* image files to your installation:
mv ~/tmp/pub/twikilogo* $TWIKIROOT/pub
| >
> |
|
| Changed: |
<
< |
-
- 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 your own public data files and sub-directories from the original
pub directory to the new installation: ( $TWIKIROOT/pub )
mv ~/tmp/pub/TWiki/somefiles.ext $TWIKIROOT/pub/
mv ~/tmp/pub/TWiki/somedirectory $TWIKIROOT/pub/
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
-
- Move the new
twiki/data/TWiki directory to your installation: ( twiki/data )
| >
> |
-
- Move the
tmp/data/TWiki directory to your installation: ( twiki/data )
|
| Deleted: |
<
< |
-
- Optionally move the new
twiki/data/Test directory to your installation,
mv ~/tmp/data/Test $TWIKIROOT/data/
(Pay attention to the file permissions)
|
| Changed: |
<
< |
-
-
-
WEBTOPICLIST should use WebChanges for "Changes", and WebIndex for "Index":
| <a href="WebChanges">Changes</a>
| <a href="WebIndex">Index</a>
| >
> |
|
|
|
| Changed: |
<
< |
- [[TWiki.FileAttachments][Attachments Under Revision Control] Changes to files attached to topics - - are now tracked under revision control (RCS).
| >
> |
|
| Changed: |
<
< |
* You may want to add [ALLOW|DENY][WEB|TOPIC]RENAME in some places, like TWikiTWikiPreferences?, WebPreferences and TWikiUsers
| >
> |
* You may want to add [ALLOW|DENY][WEB|TOPIC]RENAME in some places, like TWikiPreferences, WebPreferences and TWikiUsers
|
| Changed: |
<
< |
- ExtendingTableSyntax?: Enhanced table syntax might have unwanted side effect:
| *bold* | cells, | center aligned | and | right aligned | cells, span multiple columns using | empty cells |||. More in TextFormattingRules.
| >
> |
- ExtendingTableSyntax: Enhanced table syntax might have unwanted side effect:
| *bold* | cells, | center aligned | and | right aligned | cells, span multiple columns using | empty cells |||. More in TextFormattingRules.
|
|
|
| Changed: |
<
< |
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)
|
| Changed: |
<
< |
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.
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
- 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.
|
| Changed: |
<
< |
- TWiki Plugins - Easily install program enhancements using external plug-in modules. Developers can create plug-ins in Perl, with the TWiki Plugin API.
- 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.
- Rename/move/delete topics Individual pages can be managed through the browser. Deleted topics are stored in a common Trash web.
- Change passwords Change and reset passwords using forms
| >
> |
|
| Changed: |
<
< |
- 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).
| >
> |
- Arbitrary Text for WikiWord Links - Text formatting rules to generate automatic links from any combination of words and spaces.
- [[TWiki.FileAttachments][Attachments Under Revision Control] Changes to files attached to topics - - are now tracked under revision control (RCS).
|
| Changed: |
<
< |
| >
> |
- HierarchicalNavigation uses new Meta Data variables to link hierarchically, for example, as in Yahoo! and other search sites.
|
| Added: |
>
> |
-
- Customized templates and skins need to be upgraded to the new template format. 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 TextFormattingRules, but you have to escape unwanted ones. Also, remove empty lines unless you want a
=<p /> tag added.
- Added TWikiMetaData rendering.
- The Form Templates replace the TWikiCategoryTable:
- Create a replacement Form 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.
|
| Added: |
>
> |
-
- For each web that has a custom
notedited.tmpl template, create a WebTopicEditTemplate to conform with the new SelectableNewTopicTemplates feature. Retired notedited.tmpl, notext.tmpl and notwiki.tmpl templates.
|
| Added: |
>
> |
-
- If you are using
.htaccess, add the rename script
* You may want to add [ALLOW|DENY][WEB|TOPIC]RENAME in some places, like TWikiTWikiPreferences?, WebPreferences and TWikiUsers
- Format changed of
%GMTIME{"..."}% and %SERVERTIME{"..."}% variables. Format is now "$hour:$min" instead of "hour:min". More in TWikiVariables.
- ExtendingTableSyntax?: Enhanced table syntax might have unwanted side effect:
| *bold* | cells, | center aligned | and | right aligned | cells, span multiple columns using | empty cells |||. More in TextFormattingRules.
- Use
Net::SMTP module instead of sendmail if installed.
- Use
<verbatim> ... </verbatim> tags instead of <pre> ... </pre> tags where appropriate. More in TextFormattingRules.
- New variable
%STARTINCLUDE% and %STOPINCLUDE% variables to control what gets included of a topic. More in TWikiVariables.
- FileAttachment info is now stored as TWiki Meta Data.
- 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 TWiki Template System )
- 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.
|
| Added: |
>
> |
-
- Upgrading requires extensive changes be made to topics in the TWiki web.
-- JohnTalintyre? - 18 Jul 2001
|
| |