TiddlyWiki

NewFeatures

Tue, 18 Aug 2009 00:00:00 GMT

Release 2.5.3 is primarily a bugfix release, but also contains usability enhancements:

Reverted changes to the file system code that were made in 2.5.2
Fixed problem with lack of confirmation prompt when cancelling editing on new and shadow tiddlers
Improved feedback on synchronization and dynamic loading of tiddlers

For the full release notes see:
http://trac.tiddlywiki.org/wiki/History

SimpleSearchPlugin

Tue, 31 Mar 2009 13:05:00 GMT

Name	SimpleSearchPlugin
Description	displays search results as a simple list of matching tiddlers
Authors	FND
Version	0.4.1
Status	stable
Source	http://devpad.tiddlyspot.com/#SimpleSearchPlugin
CodeRepository	http://svn.tiddlywiki.org/Trunk/contributors/FND/plugins/SimpleSearchPlugin.js
License	Creative Commons Attribution-ShareAlike 3.0 License
Keywords	search

Revision History

v0.2.0 (2008-08-18)

initial release

v0.3.0 (2008-08-19)

added Open All button (renders Classic Search option obsolete)
sorting by relevance (title matches before content matches)

v0.4.0 (2008-08-26)

added tag matching

To Do

tag matching optional
animations for container creation and removal
when clicking on search results, do not scroll to the respective tiddler (optional)
use template for search results

Code

if(!version.extensions.SimpleSearchPlugin) { //# ensure that the plugin is only installed once
version.extensions.SimpleSearchPlugin = { installed: true };

if(!config.extensions) { config.extensions = {}; }

config.extensions.SimpleSearchPlugin = {
	heading: "Search Results",
	containerId: "searchResults",
	btnCloseLabel: "close",
	btnCloseTooltip: "dismiss search results",
	btnCloseId: "search_close",
	btnOpenLabel: "Open all",
	btnOpenTooltip: "open all search results",
	btnOpenId: "search_open",

	displayResults: function(matches, query) {
		story.refreshAllTiddlers(true); // update highlighting within story tiddlers
		var el = document.getElementById(this.containerId);
		query = '"""' + query + '"""'; // prevent WikiLinks
		if(el) {
			removeChildren(el);
		} else { //# fallback: use displayArea as parent
			var container = document.getElementById("displayArea");
			el = document.createElement("div");
			el.id = this.containerId;
			el = container.insertBefore(el, container.firstChild);
		}
		var msg = "!" + this.heading + "\n";
		if(matches.length > 0) {
			msg += "''" + config.macros.search.successMsg.format([matches.length.toString(), query]) + ":''\n";
			this.results = [];
			for(var i = 0 ; i < matches.length; i++) {
				this.results.push(matches[i].title);
				msg += "* [[" + matches[i].title + "]]\n";
			}
		} else {
			msg += "''" + config.macros.search.failureMsg.format([query]) + "''"; // XXX: do not use bold here!?
		}
		createTiddlyButton(el, this.btnCloseLabel, this.btnCloseTooltip, config.extensions.SimpleSearchPlugin.closeResults, "button", this.btnCloseId);
		wikify(msg, el);
		if(matches.length > 0) { // XXX: redundant!?
			createTiddlyButton(el, this.btnOpenLabel, this.btnOpenTooltip, config.extensions.SimpleSearchPlugin.openAll, "button", this.btnOpenId);
		}
	},

	closeResults: function() {
		var el = document.getElementById(config.extensions.SimpleSearchPlugin.containerId);
		removeNode(el);
		config.extensions.SimpleSearchPlugin.results = null;
		highlightHack = null;
	},

	openAll: function(ev) {
		story.displayTiddlers(null, config.extensions.SimpleSearchPlugin.results);
		return false;
	}
};

config.shadowTiddlers.StyleSheetSimpleSearch = "/*{{{*/\n" +
	"#" + config.extensions.SimpleSearchPlugin.containerId + " {\n" +
	"\toverflow: auto;\n" +
	"\tpadding: 5px 1em 10px;\n" +
	"\tbackground-color: [[ColorPalette::TertiaryPale]];\n" +
	"}\n\n" +
	"#" + config.extensions.SimpleSearchPlugin.containerId + " h1 {\n" +
	"\tmargin-top: 0;\n" +
	"\tborder: none;\n" +
	"}\n\n" +
	"#" + config.extensions.SimpleSearchPlugin.containerId + " ul {\n" +
	"\tmargin: 0.5em;\n" +
	"\tpadding-left: 1.5em;\n" +
	"}\n\n" +
	"#" + config.extensions.SimpleSearchPlugin.containerId + " .button {\n" +
	"\tdisplay: block;\n" +
	"\tborder-color: [[ColorPalette::TertiaryDark]];\n" +
	"\tpadding: 5px;\n" +
	"\tbackground-color: [[ColorPalette::TertiaryLight]];\n" +
	"}\n\n" +
	"#" + config.extensions.SimpleSearchPlugin.containerId + " .button:hover {\n" +
	"\tborder-color: [[ColorPalette::SecondaryMid]];\n" +
	"\tbackground-color: [[ColorPalette::SecondaryLight]];\n" +
	"}\n\n" +
	"#" + config.extensions.SimpleSearchPlugin.btnCloseId + " {\n" +
	"\tfloat: right;\n" +
	"\tmargin: -5px -1em 5px 5px;\n" +
	"}\n\n" +
	"#" + config.extensions.SimpleSearchPlugin.btnOpenId + " {\n" +
	"\tfloat: left;\n" +
	"\tmargin-top: 5px;\n" +
	"}\n" +
	"/*}}}*/";
store.addNotification("StyleSheetSimpleSearch", refreshStyles);

// override Story.search()
Story.prototype.search = function(text, useCaseSensitive, useRegExp) {
	highlightHack = new RegExp(useRegExp ? text : text.escapeRegExp(), useCaseSensitive ? "mg" : "img");
	var matches = store.search(highlightHack, null, "excludeSearch");
	var q = useRegExp ? "/" : "'";
	config.extensions.SimpleSearchPlugin.displayResults(matches, q + text + q);
};

// override TiddlyWiki.search() to sort by relevance
TiddlyWiki.prototype.search = function(searchRegExp, sortField, excludeTag, match) {
	var candidates = this.reverseLookup("tags", excludeTag, !!match);
	var primary = [];
	var secondary = [];
	var tertiary = [];
	for(var t = 0; t < candidates.length; t++) {
		if(candidates[t].title.search(searchRegExp) != -1) {
			primary.push(candidates[t]);
		} else if(candidates[t].tags.join(" ").search(searchRegExp) != -1) {
			secondary.push(candidates[t]);
		} else if(candidates[t].text.search(searchRegExp) != -1) {
			tertiary.push(candidates[t]);
		}
	}
	var results = primary.concat(secondary).concat(tertiary);
	if(sortField) {
		results.sort(function(a, b) {
			return a[sortField] < b[sortField] ? -1 : (a[sortField] == b[sortField] ? 0 : +1);
		});
	}
	return results;
};

} //# end of "install only once"

DefaultTiddlers

Mon, 09 Mar 2009 00:00:00 GMT

HelloThere NewFeatures [tag[blog]] [sort[created]]

Release 2.4.3

Thu, 08 Jan 2009 00:00:00 GMT

Release 2.4.3 of TiddlyWiki includes some minor enhancements and bug fixes. Here are some of the highlights; see the full change history at TiddlyWiki.org for more details.

Usability

Date-format strings now support escaping of literal characters (ticket #623)
PluginManager wizard now displays Description slices (ticket #739)
Support for <hr> syntax in wiki markup (ticket #741)
Filter expressions no longer omit non-existing tiddlers (ticket #768)
Provided access to context variables tiddler and place for evaluated macro parameters (ticket #444)

Hackability

Extended invokeParamifier to process "option paramifiers" (ticket #823)
Added support for TiddlyWikis with empty noscript tag (ticket #858)
Added removeCookie function (ticket #757)

Bug Fixes

Improved detection of missing links (ticket #67)
Fixed overlapping tiddlers in Firefox (ticket #320)
TagChooser macro now supports excludeLists tag (ticket #515)
RSS feed now uses proper locale value (ticket #591)
Fixed importing under Windows Vista (ticket #635)
Various minor fixes and enhancements

TabMacro

Wed, 20 Aug 2008 09:45:00 GMT

This is an example of a tab:

One Two

Welcome to TiddlyWiki!

TiddlyWiki is a single html file which has all the characteristics of a wiki - including all of the content, the functionality (including editing, saving, tagging and searching) and the style sheet. Because it's a single file, it's very portable - you can email it, put it on a web server or share it via a USB stick.

But it's not just a wiki! It has very powerful plugin capabilities, so it can also be used to build new tools. You have full control over how it looks and behaves. For example, TiddlyWiki is already being used as:

A personal notebook
A GTD ("Getting Things Done") productivity tool
A collaboration tool
For building websites (this site is a TiddlyWiki file!)
For rapid prototyping
...and much more!

You can import and export data to and from all sorts of places. Check out some of the Examples of TiddlyWiki in use, and the Features that are available.

You can see the web functionality of TiddlyWiki by clicking on some of the links on this website. Double click some of the text to see 'edit mode'. For the full range of functions, including editing and saving changes, download and install a copy of the basic version and then follow the guidelines in Getting Started. Have fun!

download

Advanced options >>

WikiWordEscape

Wed, 20 Aug 2008 09:45:00 GMT

Sometimes it's handy to be able to write WikiWords without them being recognised as links (for people's names, for instance). You can do this by preceding the WikiWord with a tilde (~). For example, JamesBond, JavaScript and TiddlyWiki

HelloWorldMacro

Wed, 20 Aug 2008 09:44:00 GMT

Name	HelloWorldMacro
Created by	SimonBaird
Location	http://simonbaird.com/mptw/#HelloWorldMacro
Version	1.1
Requires	TW2.x

Description

It's a Hello World TiddlyWiki macros.

History

11-Jan-06, version 1.1, updated for TW2.0

Examples

Source	Output
`<<helloWorld dude>>`	Error in macro <<helloWorld>>
`<<helloWorld 'to everyone'>>`	Error in macro <<helloWorld>>

(You can use (single or double) quotes or double square brackets for params with spaces)

Notes

This is intended to help you get started with customising your TW. To make the macro work you have to give this tiddler a tag of systemConfig then save and reload. To learn more about customising Tiddlywiki? Look at other people's plugins or... click View, Source in your browser and start reading. :)

Code

config.macros.helloWorld = {};
config.macros.helloWorld.handler = function (place,macroName,params,wikifier,paramString,tiddler) {
	var who = params.length > 0 ? params[0] : "world";
	 wikify("Hello //" + who + "// from the '" + macroName + "' macro in tiddler [[" + tiddler.title + "]].", place);
}

Download

Tue, 19 Aug 2008 16:16:00 GMT

download

Advanced options >>

HelloThere

Tue, 19 Aug 2008 16:15:00 GMT

A personal notebook
A GTD ("Getting Things Done") productivity tool
A collaboration tool
For building websites (this site is a TiddlyWiki file!)
For rapid prototyping
...and much more!

download

Advanced options >>

Advanced download options

Tue, 19 Aug 2008 16:12:00 GMT

When you click on the blue download button, the website will detect your browser and operating system, and trigger a download for either an empty TiddlyWiki file or, if you're running Safari or Opera, a zip file which also includes the TiddlySaver file. This is version 2.5.3 of TiddlyWiki (release notes).

Advanced users may find these download options helpful (right click the link and select "Save as" to download):

Finally, these links may be useful:

Installation instructions for the main browsers
A list of supported Browsers

Browsers

Tue, 19 Aug 2008 16:11:00 GMT

Here is a table of PC / Mac / Linux browsers that work with TiddlyWiki:

Browser	Version	Allows changes to be saved locally?
InternetExplorer	6.0+	Yes
FireFox	1.0+	Yes
Safari	1.0+	Yes, using TiddlySaver plugin
Opera	?	Yes, using TiddlySaver plugin
Netscape Navigator	7.0+	Yes
Camino	1.0+	Yes
Chrome	All	No
Wii	All	No

Please let us know of any additions or corrections.

BlockQuotes

Tue, 19 Aug 2008 08:37:00 GMT

To make quoted bits of text stand out, you can use BlockQuotes within your tiddlers, like this:

JeremyRuston said:

A TiddlyWiki is like a blog because it's divided up into neat little chunks, but it encourages you to read it by hyperlinking rather than sequentially: if you like, a non-linear blog analogue that binds the individual microcontent items into a cohesive whole.

Like BulletPoints and NumberedBulletPoints, you can have multiple levels of BlockQuotes. Just edit this tiddler to see how it's done.

level 1
level 1
level 2
level 2
level 3
level 3
level 2
level 1

Examples

Tue, 19 Aug 2008 08:31:00 GMT

TiddlyWiki is being used for all kinds of things:

Many people are using the GTD ("Getting Things Done") TiddlyWiki variant for personal productivity
There have been some interesting experiments in TiddlyWikiFiction
Garrett Lisi has published his work on Deferential Geometry in a paper named An Exceptionally Simple Theory of Everything
Phil Hawksworth has used TiddlyWiki to create a flexible task management tool called TeamTasks
Paul Downey and Phil Hawksworth have created a note sharing tool called RippleRap
An "electronic wallet" for storing passwords and other confidential information called TiddlyFolio
Video tutorials interspersed with Q&A by UnaMesa
By teachers in Massachusetts to teach mathematics
By schools in South Australia to distribute class materials to students
A music and culture site (in Portugese)
Jonny LeRoy has created a TiddlyWiki based on resizable windows
Miguel Centellas has created an extensive guide to Bolivian politics
BT is using a TiddlyWiki file for their Open source website
Elise Springer, a philospher at Wesleyan University in Connecticut, USA, is using TiddlyWiki for her homepage and for Reasoning Well, a wiki for her Philosophy faculty

Also, see TiddlyWikiAdaptations

HowToUpgrade

Mon, 18 Aug 2008 16:51:00 GMT

The core TiddlyWiki code is regularly updated with bug fixes and new features. If you're using an earlier revision of TiddlyWiki, you should consider upgrading to the latest version.

The steps you need to take depend on which version of TiddlyWiki you are upgrading from. From version 2.4.0 onwards, you can upgrade to the latest version using the 'Upgrade' tab in the BackstageArea, as described below. If you're using an earlier version of TiddlyWiki, you'll need to follow these instructions instead.

Upgrading from TiddlyWiki 2.4.0+ to the most recent version

Open the BackstageArea by clicking the 'backstage' button at the top right
Click on the 'Upgrade' tab
Click on the 'Upgrade' button, and follow the prompts

Installation guidelines: Internet Explorer on Windows XP

Mon, 18 Aug 2008 16:45:00 GMT

Follow these steps to get started! These guidelines are for Internet Explorer 7.0 running on Microsoft Windows XP, Service Pack 3. Hopefully they will be helpful for your setup too.

If these guidelines aren't appropriate, check the other browser-specific guidelines to find some that are right for you.

Step 1 - Download file

You'll need to choose a name and location for your empty TiddlyWiki file - we recommend either your Desktop or My Documents folder. Make sure you leave the "Save as type: HTML Document" default option as it is. Then click 'Save'.

Step 2 - Open folder

Once the download has been completed, don't open the file yet - a minor modification is required before TiddlyWiki will work! Click on 'Open Folder'.

Step 3 - Modify properties

In the folder, right click on the file name and select 'Properties' from the bottom of the contextual menu.

Step 4 - Unblock file

In order to allow saving, you need to Unblock the file. Select 'Unblock' near the bottom of the dialogue box, then click on 'OK'. If the Unblock button doesn't appear, then you don't need to worry about it - click on OK and proceed to step 5.

Step 5 - Open file

Now you've unblocked the file, you can double click on the file name to open the file. Internet Explorer takes special care to block javascript from untrusted sources, so a screen will appear with a yellow bar at the top and a warning in red. Click on the yellow bar (this will make it turn blue, as shown below), and select 'Allow Blocked Content...'.

Step 6 - Allow active content

TiddlyWiki contains 'active content' that, for example, allows animations to function. Approve this active content by clicking on 'Yes'.

Step 7 - Enable saving mechanism

One final hurdle! When you save for the first time, you'll be prompted to allow the activity. Click on 'Yes'.

Step 8 - You're ready to start!

You're now ready to start playing with your TiddlyWiki file - be sure to check out the guidelines in Getting Started!

Installation guidelines: Internet Explorer on Windows

Mon, 18 Aug 2008 16:44:00 GMT

Follow these steps to get started! These guidelines are for Internet Explorer 7.0 running on Microsoft Windows Vista 6.0.0. Hopefully they will be helpful for your setup too.

If these guidelines aren't appropriate, check the other browser-specific guidelines to find some that are right for you.

Step 1 - Download file

You'll need to choose a name and location for your empty TiddlyWiki file - we recommend either your Desktop or Documents folder. Make sure you leave the "Save as type: HTML Document" default option as it is. Then click 'Save'.

Step 2 - Open folder

Once the download has been completed, don't open the file yet - a minor modification is required before TiddlyWiki will work! Click on 'Open Folder'.

Step 3 - Modify properties

In the folder, right click on the file name and select 'Properties' from the bottom of the contextual menu.

Step 4 - Unblock file

Step 5 - Open file

Double click on the file name to open the file. Internet Explorer takes special care to block javascript from untrusted sources, so a screen will appear with a yellow bar at the top and a warning in red. Click on the yellow bar (this will make it turn blue, as shown below), and select 'Allow Blocked Content...'.

Step 6 - Allow active content

TiddlyWiki contains 'active content' that, for example, allows search and tagging to function. Approve this active content by clicking on 'Yes'.

Step 7 - Enable saving mechanism

One final hurdle! When you save for the first time, you'll be prompted to allow the activity. Click on 'Yes'.

Step 8 - You're ready to start!

You're now ready to start playing with your TiddlyWiki file - be sure to check out the guidelines in Getting Started!

Installation guidelines: Internet Explorer on Windows Vista

Mon, 18 Aug 2008 16:44:00 GMT

Step 1 - Download file

Step 2 - Open folder

Once the download has been completed, don't open the file yet - a minor modification is required before TiddlyWiki will work! Click on 'Open Folder'.

Step 3 - Modify properties

In the folder, right click on the file name and select 'Properties' from the bottom of the contextual menu.

Step 4 - Unblock file

Step 5 - Open file

Step 6 - Allow active content

TiddlyWiki contains 'active content' that, for example, allows search and tagging to function. Approve this active content by clicking on 'Yes'.

Step 7 - Enable saving mechanism

One final hurdle! When you save for the first time, you'll be prompted to allow the activity. Click on 'Yes'.

Step 8 - You're ready to start!

You're now ready to start playing with your TiddlyWiki file - be sure to check out the guidelines in Getting Started!

Installation guidelines: Firefox on Ubuntu

Mon, 18 Aug 2008 16:43:00 GMT

Follow these easy steps to get started! Note that these guidelines are for Firefox v3.0.1 running on Ubuntu version 8.0.4 (Hardy Heron).

If these guidelines aren't appropriate, check the other browser-specific guidelines to find some that are right for you.

Step 1 - Download file

You'll need to choose a name and location for your empty TiddlyWiki file - we recommend either your Desktop or Documents folder. Make sure you keep the file type as HTML Document.

Step 2 - Download complete

Empty TiddlyWiki files are very small, and download should be completed quickly. You can now either launch the file from the download pane (shown below, double click on the file name to launch), or open your finder to open the file from there.

Step 3 - Grant authority

When you try to save your changes for the first time, Firefox may ask you to grant access to the file system. You will need to 'Allow' this for TiddlyWiki changes to be saved, and we recommend you tick the 'Remember this decision' checkbox so this dialogue box doesn't appear each time.

Step 4 - You're ready to start!

You're now ready to start playing with your TiddlyWiki file - be sure to check out the guidelines in Getting Started!

Installation guidelines: Firefox on Windows XP

Mon, 18 Aug 2008 16:42:00 GMT

Follow these steps to get started! These guidelines are for Firefox 3.0.1 running on Microsoft Windows XP, Service Pack 3. Hopefully they will be helpful for your setup too.

If these guidelines aren't appropriate, check the other browser-specific guidelines to find some that are right for you.

Step 1 - Download file

You'll need to choose a name and location for your empty TiddlyWiki file - we recommend either your Desktop or My Documents folder. Make sure you leave the "Save as type: Firefox Document" default option as it is. Then click 'Save'.

Step 2 - Open file

Double click on the file name in the Download dialogue box, shown below. This will open your TiddlyWiki file, and you'll be able to start editing immediately - but you'll need to complete Step 3 below to save your changes.

Step 3 - Enable advanced features

When you try to save changes for the first time, this dialogue box will appear. These features will enable the saving mechanism. Tick the 'Remember this decision' checkbox and then click on 'Allow'.

Step 4 - You're ready to start!

You're now ready to start playing with your TiddlyWiki file - be sure to check out the guidelines in Getting Started!

Installation guidelines: Firefox on Mac OS X

Mon, 18 Aug 2008 16:41:00 GMT

Follow these easy steps to get started! Note that these guidelines are for Firefox v3.0.1 running on Mac OS X 10.5.4.

If these guidelines aren't appropriate, check the other browser-specific guidelines to find some that are right for you.

Step 1 - Download file

You'll need to choose a name and location for your empty TiddlyWiki file - we recommend either your Desktop or Documents folder. Make sure you keep the .html file extension and leave the "Save As: Hypertext" default option as it is.

Step 2 - Download complete

Step 3 - Open file

You'll be asked if you're sure you want to open the file - click "Open".

Step 4 - Grant authority

Step 5 - You're ready to start!

You're now ready to start playing with your TiddlyWiki file - be sure to check out the guidelines in Getting Started!