TiddlyWiki5/editions/tw5.com/tiddlers/Upgrading.tid

created: 20131202102427114
modified: 20140419133900452
tags: howto
title: Upgrading
type: text/vnd.tiddlywiki

There are several methods for upgrading an existing TiddlyWiki version 5 document to a new release. There is a [[different procedure|Upgrading TiddlyWiki on Node.js]] for upgrading [[TiddlyWiki on Node.js]].

<<<
Regardless of which method you use, remember the [[The First Rule of Using TiddlyWiki]]:

//You are responsible for looking after your own data; take care to make backups, especially when upgrading the ~TiddlyWiki core//
<<<

<div class="tw-message-box">

<a class="tw-message-icon" href="http://tiddlywiki.com/" target="_blank">{{TiddlyWiki Classic.png}}</a>

!! Upgrading from TiddlyWikiClassic

Remember that TiddlyWiki version 5 is not fully backwards compatible with the older TiddlyWikiClassic. It is recommended that users of TiddlyWikiClassic should not attempt to upgrade their existing files until the new version is more mature.

</div>

! Online upgrading

This process will work on most desktop browsers. Note that none of your personal data leaves your browser with this process.

# Locate your TiddlyWiki file in the file system (ie using Windows Explorer, the Finder on Mac OS X, or your file manager on Linux)
# Visit http://tiddlywiki.com/empty.html in your browser
# Drag your old TiddlyWiki HTML file into the browser window
#* If the file is encrypted you will be prompted for the password
#* Your tiddlers should be imported
# Set a password if you want to use encryption
# Save changes to save the new version

This will download a file called ''empty.html'' to your computer. This file is the upgrade of your old file. You may need to open the location where ''empty.html'' was downloaded, rename ''empty.html'' with the name of the old file you are upgrading, and replace the old file by moving the new file in its place.

//For the moment you'll also need to manually update any plugins that are not included in empty.html://

># Open the control panel to the ''Plugins'' tab in your upgraded wiki
># Check the version numbers of the plugins you are using; any plugins with an older version than the version of [[$:/core]] will probably need updating
># Locate a wiki with the plugins you need to update and open the control panel ''Plugins'' tab
>#* http://tiddlywiki.com/d3demo.html for the D3 plugin
>#* http://tiddlywiki.com/codemirrordemo.html for the CodeMirror plugin
>#* http://tiddlywiki.com/markdowndemo.html for the MarkDown plugin
>#* http://tiddlywiki.com/ for most of the others
># Drag the plugin links one by one back to your own wiki. You should see the version numbers update in the control panel
># Save your wiki

! Offline upgrading

You can also download http://tiddlywiki.com/empty.html locally and perform the same drag-and-drop procedure to upgrade your files.

! Problems with Upgrades

Particularly during the beta, it is possible for a customisation applied in a previous version to break when upgraded to the latest version. Use SafeMode to investigate and fix these problems.
Updated docs 2013-12-02 14:36:38 +00:00			`created: 20131202102427114`
Add more warnings about backups 2014-04-19 13:42:20 +00:00			`modified: 20140419133900452`
Updated docs 2013-12-02 14:36:38 +00:00			`tags: howto`
			`title: Upgrading`
			`type: text/vnd.tiddlywiki`

Add TiddlyWikiClassic upgrading warning 2013-12-29 22:52:46 +00:00			`There are several methods for upgrading an existing TiddlyWiki version 5 document to a new release. There is a [[different procedure\|Upgrading TiddlyWiki on Node.js]] for upgrading [[TiddlyWiki on Node.js]].`

Add more warnings about backups 2014-04-19 13:42:20 +00:00			`<<<`
			`Regardless of which method you use, remember the [[The First Rule of Using TiddlyWiki]]:`

			`//You are responsible for looking after your own data; take care to make backups, especially when upgrading the ~TiddlyWiki core//`
			`<<<`
Revise warning about backing up before upgrading 2014-04-17 15:26:57 +00:00
Add TiddlyWikiClassic upgrading warning 2013-12-29 22:52:46 +00:00			`<div class="tw-message-box">`
Use double linebreaks to indicate content of a widget or html element should be parsed in block mode Fixes #82. The old behaviour was to parse the content of a widget or html element in block mode if the opening tag was followed by a line break. The new behaviour requires two line breaks. This makes it possible to include linebreaks more liberally within wikitext, although care must still be taken to only use double line breaks when the block mode behaviour is desired. The code change here is very simple, just a single line change in html.js. Most of the other changes are to convert various single line breaks into double line breaks. 2014-02-20 21:42:31 +00:00
Add TiddlyWikiClassic upgrading warning 2013-12-29 22:52:46 +00:00			`<a class="tw-message-icon" href="http://tiddlywiki.com/" target="_blank">{{TiddlyWiki Classic.png}}</a>`

			`!! Upgrading from TiddlyWikiClassic`

			`Remember that TiddlyWiki version 5 is not fully backwards compatible with the older TiddlyWikiClassic. It is recommended that users of TiddlyWikiClassic should not attempt to upgrade their existing files until the new version is more mature.`

			`</div>`
Updated docs 2013-12-02 14:36:38 +00:00
Docs update 2013-12-03 11:12:57 +00:00			`! Online upgrading`
Updated docs 2013-12-02 14:36:38 +00:00
Update upgrading instructions 2014-01-26 13:54:08 +00:00			`This process will work on most desktop browsers. Note that none of your personal data leaves your browser with this process.`
Update TiddlyDocs documentation 2013-12-02 20:30:38 +00:00
Update upgrading instructions 2014-01-26 13:54:08 +00:00			`# Locate your TiddlyWiki file in the file system (ie using Windows Explorer, the Finder on Mac OS X, or your file manager on Linux)`
			`# Visit http://tiddlywiki.com/empty.html in your browser`
Docs updates 2013-12-12 09:48:08 +00:00			`# Drag your old TiddlyWiki HTML file into the browser window`
Clarify upgrading instructions for encrypted wikis 2014-01-20 13:38:57 +00:00			`#* If the file is encrypted you will be prompted for the password`
Updated docs 2013-12-02 14:36:38 +00:00			`#* Your tiddlers should be imported`
Clarify upgrading instructions for encrypted wikis 2014-01-20 13:38:57 +00:00			`# Set a password if you want to use encryption`
Remove extraneous full stop 2014-01-19 18:42:08 +00:00			`# Save changes to save the new version`
Improve upgrading instructions Thanks @giffmex 2013-12-11 14:31:57 +00:00
			`This will download a file called ''empty.html'' to your computer. This file is the upgrade of your old file. You may need to open the location where ''empty.html'' was downloaded, rename ''empty.html'' with the name of the old file you are upgrading, and replace the old file by moving the new file in its place.`
Updated docs 2013-12-02 14:36:38 +00:00
Improved upgrading docs 2013-12-06 07:12:35 +00:00			`//For the moment you'll also need to manually update any plugins that are not included in empty.html://`

			`># Open the control panel to the ''Plugins'' tab in your upgraded wiki`
			`># Check the version numbers of the plugins you are using; any plugins with an older version than the version of [[$:/core]] will probably need updating`
			`># Locate a wiki with the plugins you need to update and open the control panel ''Plugins'' tab`
Adjust references to five.tiddlywiki.com 2013-12-15 16:53:10 +00:00			`>#* http://tiddlywiki.com/d3demo.html for the D3 plugin`
			`>#* http://tiddlywiki.com/codemirrordemo.html for the CodeMirror plugin`
			`>#* http://tiddlywiki.com/markdowndemo.html for the MarkDown plugin`
			`>#* http://tiddlywiki.com/ for most of the others`
Improved upgrading docs 2013-12-06 07:12:35 +00:00			`># Drag the plugin links one by one back to your own wiki. You should see the version numbers update in the control panel`
			`># Save your wiki`
Updated docs 2013-12-02 14:36:38 +00:00
Docs update 2013-12-03 11:12:57 +00:00			`! Offline upgrading`
Updated docs 2013-12-02 14:36:38 +00:00
Adjust references to five.tiddlywiki.com 2013-12-15 16:53:10 +00:00			`You can also download http://tiddlywiki.com/empty.html locally and perform the same drag-and-drop procedure to upgrade your files.`
Add support for safe mode 2014-04-19 08:36:08 +00:00
			`! Problems with Upgrades`

			`Particularly during the beta, it is possible for a customisation applied in a previous version to break when upgraded to the latest version. Use SafeMode to investigate and fix these problems.`