TiddlyWiki

HowToUpgrade

Tue, 04 Dec 2007 21:57:00 GMT

The core TiddlyWiki code is regularly updated with bug fixes and new features. If you're using an earlier revision of TiddlyWiki, here's the simple way to upgrade to the latest version:

Download a fresh, empty version of TiddlyWiki by right-clicking on this link, selecting 'Save target' or 'Save link' and saving it in a convenient location as (say) "mynewtiddlywiki.html"
Open the new TiddlyWiki file in your browser
Choose import from the BackstageArea at the top of the window (you may need to click the 'backstage' button at the upper right to show the BackstageArea)
Click the browse button and select your original TiddlyWiki file (say, "mytiddlywiki.html") from the file browser
Click the open button on the import wizard; a list of all of your tiddlers is displayed
Click on the top-left checkbox to select all the tiddlers in the list
Scroll down to the bottom of the wizard and ensure that the checkbox labelled Keep these tiddlers linked to this server... is clear
Click the import button

The most likely cause of the upgrade process not working properly is that one of the Plugins you're using is not compatible with a change in the new release. If so, you can repeat the process omitting the troublesome plugins.

Customisation

Tue, 27 Nov 2007 00:00:00 GMT

You can customise the appearance and behaviour of TiddlyWiki to almost any degree you want:

Use the ColorPalette to change the basic colour scheme
Create a CustomStyleSheet for finer grained control over the appearance
Customise the PageTemplate, ViewTemplate or EditTemplate to change the composition of the page and the layout of individual tiddlers
Use off-the-shelf themes from TiddlyThemes
Visit the Configuration summary to see all the special configuration tiddlers
Install Plugins to extend the core functionality (find them at TiddlyVault or you can try writing or adapting your own)
Use TiddlyBookmarklets for low level hacking of TiddlyWiki documents

There are also a bunch of TiddlyWikiTools that you can use to enhance TiddlyWiki.

Czech

Tue, 27 Nov 2007 00:00:00 GMT

Česká TiddlyWiki:

GettingStarted

Tue, 27 Nov 2007 00:00:00 GMT

The easiest way to learn about TiddlyWiki is to use it! Try clicking on various links and see what happens - you cannot damage tiddlywiki.com or your browser. (Use the close all button over on the right to clear all the displayed tiddlers and start again).

There is an extensive Community documentation wiki, including an invaluable FAQ. Other useful guides include:

Dave Gifford's TiddlyWiki for the Rest of Us and his slideshow introduction
Morris Gray's TW Help - TiddlyWiki help file for beginners
Dmitri Popov's TiddlyWiki quick reference card
Screencasts from JimVentola and LeonKilat.

When you're ready to create your own TiddlyWiki on your computer, follow the instructions in DownloadSoftware and SaveChanges. There is also a free hosted service at http://tiddlyspot.com/ that makes it easier to share your TiddlyWiki with others (for more demanding applications there are several other ServerSide solutions available).

Plugins

Tue, 27 Nov 2007 00:00:00 GMT

TiddlyWiki can be extended by InstallingPlugins that implement new Macros, Themes, Tweaks or other features. The easiest way of InstallingPlugins is to use ImportTiddlers. Like other features that need to modify TiddlyWiki files, it only works when TiddlyWiki is loaded from a file:// URL.

DaveGifford oversees an extensive catalogue of available plugins at TiddlyVault.

Some of the leading plugin sites from independent developers are here tagged as systemServer which also makes them available in ImportTiddlers.

ChrisKlimas has written The Macrocodex, some superb documentation on writing plugins and macros for TiddlyWiki.

MainFeatures

Thu, 18 Oct 2007 13:20:00 GMT

Out of the box, TiddlyWiki offers:

Works with all major desktop browsers on Windows, Macintosh and Linux and many mobile browsers such as the Apple iPhone and the Nokia 770/N800
- You can SaveChanges with FireFox, Opera, InternetExplorer for Windows, Safari, and Camino
The BackstageArea for handy access to authoring tools including importing and synchronisation of tiddlers with external files and servers
Full text formatting including MonospacedText, ExtendedFormatting, NonWikiWordLinks, WikiWordEscape, PrettyLinks, SubHeadings, BulletPoints, NumberedBulletPoints, Tables, BlockQuotes, HorizontalRules and the ability to use a CustomCssClass and InlineHTML
...EmbeddedImages
Macros providing rich interactive features, including Sparklines and Gradients
InterfaceOptions and AdvancedOptions, including the ability to GenerateAnRssFeed, SaveBackups and AutoSave
KeyboardShortcuts so you can finish editing a tiddler with Control-Enter or abandon it with Escape
Extensive StartupParameters to control the behaviour of TiddlyWiki through specially crafted URLs
There are translations of TiddlyWiki available in many languages, including Chinese, French, German, Spanish, Portuguese

The Community around TiddlyWiki has extended this basic functionality with a wide range of Plugins and TiddlyWikiAdaptations.

NewFeatures

Thu, 18 Oct 2007 13:20:00 GMT

TiddlyWiki has been improved in several other areas for release 2.2. Here are some of the highlights; see the full release note at tiddlywiki.org for more details.

Usability

There's a slew of significant usability enhancements including:

The new BackstageArea to separate off authoring specific functionality
Popup previews of tiddler contents in the plugin manager, sync manager, and ImportTiddlers
'More' command to simplify tiddler toolbars
"Yellow note" annotations to indicate the purpose of special tiddlers such as shadow tiddlers
New <<options>> macro to allow access to the complete set of available configuration options
New "size" and "execution time" columns in the plugin manager
Improved NewTiddler and NewJournal macros that can accept custom fields
Embolden tags in the tag listing that are also defined as tiddlers

Performance

New DomScrubbing feature to deal with memory leaks
Revised storage format using <PRE> tags to permit whitespace and new lines to be preserved without requiring escaping
Greatly enhanced animation engine that performs better on slower hardware

Hackability

As usual, several of the new features are intended to make life easier for plugin writers and other TiddlyWiki hackers:

A new ServerConnectivity architecture
New PluginLoadOrder mechanism for controlling the execution order of plugins
Better startup timing instrumentation
Rearranged shadow tiddlers into their own, unencoded store area
Refactored saveChanges() to make it easier to add new save mechanisms
Added paramifier for overriding current read-only state (eg, http://www.tiddlywiki.com/beta/#readOnly:no)
...and by popular request, we've started to reformat the TiddlyWiki source code to use the more conventional K&R layout standard

Internationalisation

TiddlyWiki benefits from an extensive set of translations. There are several enhancements in this release to make it easier to maintain translations.

Feedback

Fri, 24 Aug 2007 16:37:00 GMT

If you've any comments, corrections or observations about TiddlyWiki, the best way to get our attention is to post to the Community groups — or write a blog entry.

DefaultTiddlers

Fri, 24 Aug 2007 15:13:00 GMT

HelloThere GettingStarted MainFeatures Feedback

Community

Fri, 24 Aug 2007 14:58:00 GMT

TiddlyWiki today is the result of the efforts of dozens of people around the world generously contributing their time and skill. The core of the TiddlyWiki development community is http://www.tiddlywiki.org. It hosts the master copy of the TiddlyWiki source code, and a system for tracking bugs and enhancement requests. The community welcomes contributions.

There are two GoogleGroups for discussions about TiddlyWiki. They are the best places to ask questions about TiddlyWIki, and to connect with other enthusiasts:

A TiddlyWiki group for general discussion, bug reports and announcements at http://groups.google.com/group/TiddlyWiki
A TiddlyWikiDev group for discussion about TiddlyWiki development at http://groups.google.com/group/TiddlyWikiDev

For non-English language speakers,

TiddlyWikiFR, in French, at http://groups.google.com/group/TiddlyWikiFR
TiddlyWiki 華語支援論壇, in Chinese, at http://groups.google.com/group/TiddlyWiki-zh
TiddlyWikiPT, in Brazilian Portuguese, at http://groups.google.com.br/group/tiddlywikipt

Many TiddlyWiki hackers hang out on our IRC room, #tiddlywiki on irc.freenode.net.

TiddlyWiki is legally owned by The UnaMesa Foundation.

TiddlyWikiTools

Fri, 24 Aug 2007 14:58:00 GMT

SaqImtiaz and KalleAlm have just released a release candidate of TiddlySnip, a Firefox extension that lets you use your TiddlyWiki as a scrapbook. Simply select text, right click and choose TiddlySnip selection. Next time you open your TiddlyWiki file, your snippets will be there, already tagged and organised.

The first add-on tool for TiddlyWiki was IsaoSonobe's TiddlyWikiPod that let's you transfer the contents of a TiddlyWiki to an iPod (well, not an iPod shuffle).

MarkusKoch has released a script that allows Postnuke to publish content in TiddlyWiki format (Postnuke is a popular full-blown open source content management system).

The 33ad blog features a neat tool by JeremyKelley to create a calendar in TiddlyWiki table format: http://33ad.org/tools/gtdtwcal.php

See TiddlyBookmarklets for some ideas about using bookmarklets to extend and hack TiddlyWiki.

TiddlyBookmarklets

Fri, 24 Aug 2007 14:54:00 GMT

Bookmarklets can be useful for TiddlyWiki hackers. They are browser bookmarks that contain embedded JavaScript that can reach into the currently loaded TiddlyWiki page to manipulate them and extract data.

Drag these links to your bookmark/favourites bar, or right click on them and choose "add to bookmarks" or "add to favourites":

Scrub shadow tiddlers - deletes any overridden shadow tiddlers, reverting them to their default values. Handy when you’ve gone mad with PageTemplate customisations and your TiddlyWiki document won’t display properly
Scrub tiddler fields - all the extended fields from a TiddlyWiki document, including that pesky “changecount” field
Rescue raw TiddlyWiki content - opens a new window containing the raw content of a TiddlyWiki. Handy when you’ve inadvertently been editing an online version of TiddlyWiki that isn’t letting you save changes in the usual way

If you're creating your own bookmarklets, this editor and these tips are useful resources.

TiddlySaver

Mon, 13 Aug 2007 17:01:00 GMT

The TiddlySaver Java applet allows TiddlyWiki from a file:// URL to save changes Safari, Opera and other browsers.

It is a small file named "TiddlySaver.jar" that must be placed in the same directory as your TiddlyWiki file. Before you can use it, you need to give it the necessary privileges by editting your .java.policy file.

For Windows, the file will be at C:\Documents and Settings\your-user-name\.java.policy. Add the following lines (substituting the directory of your TiddlyWiki file as appropriate):

grant codeBase "file:${user.home}/My Documents/tiddlywiki-folder/*" {
  permission java.io.FilePermission "${user.home}${/}My Documents${/}tiddlywiki-folder${/}*", "read,write";
};

On Mac OS X, the file is found at /Users/your-user-name/.java.policy:

grant codeBase "file:${user.home}/Documents/tiddlywiki-folder/*" {
  permission java.io.FilePermission "${user.home}${/}Documents${/}tiddlywiki-folder${/}*", "read,write";
};

It can be tricky creating files whose name starts with a period, so you can use this pre-built .java.policy file. The same file is suitable for Macs too, just edit it and delete the "My " bit, leaving just "Documents". Make sure you save it in the right place for each operating system!

If you have trouble setting up the permissions correctly, you can try granting broader permissions to the applet like this:

grant codeBase "file://localhost/home/users/Desktop/
TiddlySaver.jar"
 { permission java.security.AllPermission; };

Note that there is currently a bug that prevents TiddlySaver from working if you have specified a backup directory in AdvancedOptions.

ServerSide

Mon, 13 Aug 2007 12:55:00 GMT

Out of the box, TiddlyWiki doesn't have a ServerSide back end. In many applications that's a great strength because it means that you can work with TiddlyWiki without having to be connected to the Internet or, because it's SelfContained, installing any software.

In other applications, a ServerSide can be very useful, particularly if you want to edit a TiddlyWiki while it's online, or you need lots of people to be able to edit a TiddlyWiki at the same time. The development Community has come up with several ServerSide implementations that are suitable for a range of applications. The most popular and up-to-date ones that you can download and install on your own servers are:

ZiddlyWiki from BobMcElrath and TimMorgan
ccTiddly from CoolCold
MiniTiddlyServer from SeanHess and SaqImtiaz
PrinceTiddlyWiki from BramChen
PhpTiddlyWiki from PatrickCurry

TiddlySpot offers a fantastic, free hosted version of TiddlyWiki with some very cool features (although at present it does not support simultaneous editting by multiple users). It's based on Bidix's remarkable UploadPlugin.

There are also some TiddlyWikiAdaptations that have taken some of the code and ideas from TiddlyWiki and diverged off to do their own thing.

TiddlyWiki

Fri, 03 Aug 2007 11:26:00 GMT

TiddlyWiki is a complete wiki in a single HTML file. It contains the entire text of the wiki, and all the JavaScript, CSS and HTML goodness to be able to display it, and let you edit it or search it. Without needing a server.

TiddlyWiki is published under an OpenSourceLicense and maintained by a busy Community of independent developers.

PluginFormat

Tue, 31 Jul 2007 23:31:00 GMT

It is recommended that Plugins start with some standard information in TiddlerSlicing format. For example, see the ExamplePlugin:

|''Name:''|ExamplePlugin|
|''Description:''|To demonstrate how to write TiddlyWiki plugins|
|''Version:''|2.0.2|
|''Date:''|Jul 12, 2006|
|''Source:''|http://www.tiddlywiki.com/#ExamplePlugin|
|''Author:''|JeremyRuston (jeremy (at) osmosoft (dot) com)|
|''License:''|[[BSD open source license]]|
|''~CoreVersion:''|2.1.0|
|''Browser:''|Firefox 1.0.4+; Firefox 1.5; InternetExplorer 6.0|

At the moment, only CoreVersion affects how Plugins are processed: if the CoreVersion is specified for a plugin, TiddlyWiki will only execute the plugin if the core code version matches or exceeds the version specified. For example, if you specify a CoreVersion of 2.2, version 2.1.x of TiddlyWiki will refuse to execute the plugin.

To indicate an error, plugins should just throw an exception. The text of the exception will be displayed in the PluginManager.

VisualTWServer

Thu, 05 Jul 2007 16:25:00 GMT

URL:	http://visualtw.ouvaton.org/VisualTW.html
Author:	Pascal

JeremyRuston

Tue, 05 Jun 2007 13:19:00 GMT

I'm the original creator of TiddlyWiki (nowadays, it's more of a group effort). I work at BT where I am Head of Open Source Innovation.

I can be reached at jeremy (at) osmosoft (dot) com, and I regularly read and reply to messages on the TiddlyWiki Google Groups. I blog at http://jermolene.wordpress.com/ and you can also find me on Flickr and del.icio.us.

MainMenu

Tue, 05 Jun 2007 11:30:00 GMT

HelloThere
TiddlyWiki
MainFeatures
GettingStarted
Customisation
Community
DownloadSoftware
Plugins
RSS

^{TiddlyWiki 2.3.0
© 2007 UnaMesa}

Donations

Tue, 05 Jun 2007 11:28:00 GMT

TiddlyWiki is now owned by UnaMesa, a non-profit foundation. Part of it's purpose is to provide a means for people who enjoy using TiddlyWiki to usefully reward the members of the community who have helped to create it, and so we will be exploring ways of accepting and distributing donations. For the moment, we don't have a formal scheme, but would encourage people to donate directly to individuals where they can.

On a personal note (writes JeremyRuston), in the two years that I had a personal donation account before I took up a commercial position with BT, just under a 100 people donated a total of nearly £1500 via PayPal. Knowing how much effort it is to make such a payment, I'm truly grateful to everyone who took the trouble, many thanks. I used the money to buy camera equipment, a hobby that I couldn't have pursued at the time otherwise.