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

created: 20131202102427114
modified: 20141009004937229
tags: Features [[Working with TiddlyWiki]]
title: Upgrading
type: text/vnd.tiddlywiki

There are regular releases of TiddlyWiki with bug fixes and improvements. It's a good idea to keep up to date by regularly upgrading to the latest version.

! Introduction

The process described here is for upgrading standalone TiddlyWiki files. There is a [[different procedure|Upgrading TiddlyWiki on Node.js]] for upgrading [[TiddlyWiki on Node.js]].

<<<
When upgrading, please 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//
<<<

! 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 (i.e. using Windows Explorer, the Finder on Mac OS X, or your file manager on Linux)
# Visit http://tiddlywiki.com/upgrade.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
# Review the list of tiddlers that will be upgraded
# Click ''Upgrade''
# Save changes to save the new version

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

! Offline upgrading

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

! Problems with Upgrades

!! Firefox Security Restrictions

In case you run into this error with the upgrader, upon confirming the upgrade selection :

<<<
Error while saving:

Error:NS_ERROR_DOM_BAD_URI: Access to restricted URI denied
<<<

The upgrade operation falls foul of a security restriction in Firefox. Until this can be resolved, we suggest either using the offline upgrader, or using Chrome to perform the upgrade:

*# Use Chrome to open http://tiddlywiki.com/upgrade.html, then drag your local TiddlyWiki html file to be upgraded into the upgrader window, as described above in ''Online upgrading''
*# After you've saved your upgraded file, you should be able to open it in Firefox and [[save using TiddlyFox|Saving with TiddlyFox]] again
* //See also : [[Saving on TiddlySpot]]//

!! Incompatible Customisations

It is possible for a customisation applied in a previous version to break when upgraded to the latest version. There are two techniques you can use to help track down issues:

* Try repeating the upgrade having selectively unchecked any tiddlers that may be applying customisations to TiddlyWiki
* Use SafeMode to disable all customisations of shadow tiddlers

You can see which shadow tiddlers have been overridden in the ''Filter'' tab of [[advanced search|$:/AdvancedSearch]]. Select "Overridden shadow tiddlers" from the dropdown.
Updated docs 2013-12-02 14:36:38 +00:00			`created: 20131202102427114`
some doc updates 2014-10-21 11:07:49 +00:00			`modified: 20141009004937229`
Lots more docs updates 2014-09-12 15:05:37 +00:00			`tags: Features [[Working with TiddlyWiki]]`
Updated docs 2013-12-02 14:36:38 +00:00			`title: Upgrading`
			`type: text/vnd.tiddlywiki`

Lots of documentation cleanup 2014-09-19 16:18:25 +00:00			`There are regular releases of TiddlyWiki with bug fixes and improvements. It's a good idea to keep up to date by regularly upgrading to the latest version.`

			`! Introduction`

Upgrading docs update 2014-07-17 07:33:19 +00:00			`The process described here is for upgrading standalone TiddlyWiki files. There is a [[different procedure\|Upgrading TiddlyWiki on Node.js]] for upgrading [[TiddlyWiki on Node.js]].`
Add TiddlyWikiClassic upgrading warning 2013-12-29 22:52:46 +00:00
Add more warnings about backups 2014-04-19 13:42:20 +00:00			`<<<`
Upgrading docs update 2014-07-17 07:33:19 +00:00			`When upgrading, please remember the [[The First Rule of Using TiddlyWiki]]:`
Add more warnings about backups 2014-04-19 13:42:20 +00:00
some doc updates 2014-10-21 11:07:49 +00:00			`//You are responsible for looking after your own data; take care to make backups, especially when upgrading the ~TiddlyWiki core//`
Add more warnings about backups 2014-04-19 13:42:20 +00:00			`<<<`
Revise warning about backing up before upgrading 2014-04-17 15:26:57 +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
Fix punctuation 2014-12-21 18:49:24 +00:00			`# Locate your TiddlyWiki file in the file system (i.e. using Windows Explorer, the Finder on Mac OS X, or your file manager on Linux)`
some doc updates 2014-10-21 11:07:49 +00:00			`# Visit http://tiddlywiki.com/upgrade.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`
Docs tweaks 2014-10-24 17:02:34 +00:00			`# Review the list of tiddlers that will be upgraded`
			`# Click ''Upgrade''`
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
Docs updates 2014-07-14 16:58:50 +00:00			`This will download a file called ''upgrade.html'' to your computer. This file is the upgrade of your old file. You may need to open the location where ''upgrade.html'' was downloaded, rename ''upgrade.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
Docs update 2013-12-03 11:12:57 +00:00			`! Offline upgrading`
Updated docs 2013-12-02 14:36:38 +00:00
Docs updates 2014-07-14 16:58:50 +00:00			`You can also download http://tiddlywiki.com/upgrade.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`

Docs tweaks 2014-10-24 17:02:34 +00:00			`!! Firefox Security Restrictions`

some doc updates 2014-10-21 11:07:49 +00:00			`In case you run into this error with the upgrader, upon confirming the upgrade selection :`

			`<<<`
			`Error while saving:`

			`Error:NS_ERROR_DOM_BAD_URI: Access to restricted URI denied`
			`<<<`

Docs tweaks 2014-10-24 17:02:34 +00:00			`The upgrade operation falls foul of a security restriction in Firefox. Until this can be resolved, we suggest either using the offline upgrader, or using Chrome to perform the upgrade:`
some doc updates 2014-10-21 11:07:49 +00:00
Docs tweaks 2014-10-24 17:02:34 +00:00			`*# Use Chrome to open http://tiddlywiki.com/upgrade.html, then drag your local TiddlyWiki html file to be upgraded into the upgrader window, as described above in ''Online upgrading''`
			`*# After you've saved your upgraded file, you should be able to open it in Firefox and [[save using TiddlyFox\|Saving with TiddlyFox]] again`
some doc updates 2014-10-21 11:07:49 +00:00			`* //See also : [[Saving on TiddlySpot]]//`

Docs tweaks 2014-10-24 17:02:34 +00:00			`!! Incompatible Customisations`

Lots of documentation cleanup 2014-09-19 16:18:25 +00:00			`It is possible for a customisation applied in a previous version to break when upgraded to the latest version. There are two techniques you can use to help track down issues:`
Upgrading docs update 2014-07-17 07:33:19 +00:00
			`* Try repeating the upgrade having selectively unchecked any tiddlers that may be applying customisations to TiddlyWiki`
			`* Use SafeMode to disable all customisations of shadow tiddlers`
Lots of documentation cleanup 2014-09-19 16:18:25 +00:00
			`You can see which shadow tiddlers have been overridden in the ''Filter'' tab of [[advanced search\|$:/AdvancedSearch]]. Select "Overridden shadow tiddlers" from the dropdown.`