TiddlyWiki

TiddlyWiki5

Tue, 20 Mar 2012 10:42:54 GMT

TiddlyWiki5 is a complete rewrite of TiddlyWiki to take advantage of HTML5 and node.js. It is under development on GitHub:

https://github.com/Jermolene/TiddlyWiki5

There is also an online demo you can play with:

http://tiddlywiki.com/tiddlywiki5

HelloThere

Tue, 20 Mar 2012 10:38:30 GMT

Welcome to TiddlyWiki, a reusable non-linear personal web notebook. It's a unique wiki that people love using to keep ideas and information organised. It was originally created by JeremyRuston and is now a thriving open source project with a busy Community of independent developers.

TiddlyWiki is written in HTML, CSS and JavaScript to run on any reasonably modern browser without needing any ServerSide logic. It allows anyone to create personal SelfContained hypertext documents that can be published to a WebServer, sent by email, stored in a DropBox or kept on a USB thumb drive to make a WikiOnAStick. Because it doesn't need to be installed and configured it makes a great GuerillaWiki. This is revision 2.6.5 of TiddlyWiki, and is published under an OpenSourceLicense.

A major update in the form of TiddlyWiki5 is now under active development.

TiddlyWiki

Tue, 20 Mar 2012 10:34:20 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 machinery to be able to display it, and let you edit it or search it - without needing a server. Of course, there are also some useful ServerSide adaptations out there.

Unlike most wikis, TiddlyWiki isn't about group collaboration; it is a wiki in the sense of elevating linking be a part of the punctuation of writing. You can easily publish a TiddlyWiki you have created by placing the single file on a web server (for instance the homepage hosting provided by many ISPs). If you need full group collaboration features, there are several HostedOptions to choose from.

TiddlyWiki was originally created by JeremyRuston and is now a thriving open source project with a busy Community of independent developers. Osmosoft, part of BT, is the leading contributor to the project.

MainMenu

Sun, 11 Mar 2012 21:55:39 GMT

HelloThere

GettingStarted
Customisation
Examples

Reference
Help and Support
Community
RSS

download

^{TiddlyWiki 2.6.5
© 2011 UnaMesa}

Browsers

Wed, 07 Mar 2012 16:02:34 GMT

Here is a table of web 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	Yes, using TiddlySaver plugin
iPhone	All	Yes. See iTW
Wii	All	No
luakit	All	Yes

See also the TiddlyWiki apps available for smartphones.

Please let us know of any additions or corrections.

luakit

Wed, 07 Mar 2012 16:02:00 GMT

luakit is a powerful customizable web browser for Linux. In their own words:

Luakit is a highly configurable, micro-browser framework based on the WebKit web content engine and the GTK+ toolkit. It is very fast, extensible by Lua and licensed under the GNU GPLv3 license.

It is primarily targeted at power users, developers and any people with too much time on their hands who want to have fine-grained control over their web browsers behaviour and interface.

'perlguy' has written up his customizations to get TiddlyWiki working: https://github.com/perlguy/luakit-tiddlywiki

DefaultTiddlers shadows

Fri, 27 Jan 2012 13:31:13 GMT

This tiddler contains a list of tiddlers that are opened automatically when you load the tiddlywiki.
The default is:

[[GettingStarted]]

An example could be:

[[HelloThere]]
[[Reference]]
[[Features]]

Note you can also put filters into your DefaultTiddlers tiddler. For instance to open all tiddlers tagged with blog on startup:

[tag[blog]]

SplashScreenPlugin

Fri, 13 Jan 2012 17:27:18 GMT

Name:	SplashScreenPlugin
Description:	Provides a splash screen that consists of the rendered default tiddlers
Author:	Martin Budden
CodeRepository:	http://svn.tiddlywiki.org/Trunk/contributors/MartinBudden/plugins/SplashScreenPlugin.js
Version:	0.1.5
Date:	April 17, 2008
Comments:	Please make comments at http://groups.google.co.uk/group/TiddlyWikiDev
License:	Creative Commons Attribution-ShareAlike 3.0 License
CoreVersion:	2.4

Description

Provides a splash screen that consists of the default tiddlers while TiddlyWiki is loading

Usage

TODO describe how to use the plugin - how a user should include it in their TiddlyWiki, parameters to the plugin etc

if(!version.extensions.SplashScreenPlugin) {
version.extensions.SplashScreenPlugin = {installed:true};

//config.macros.splashScreen = {};
//config.macros.splashScreen.init = function()
version.extensions.SplashScreenPlugin.setup = function()
{
	if(store.tiddlerExists("MarkupPostHead"))
		return;

	var text = "<!--{{{-->\n";
	text += "<style type=\"text/css\">\n";
	text += "#contentWrapper {display:none;}\n";
	text += "#splashScreen {display:block;}\n";

	var sc = store.getTiddlerText("StyleSheetColors");
	sc += "\n" + store.getTiddlerText("StyleSheetLayout") + "\n";
	sc += "\n#splashScreen {display:block;}\n";
	sc += "\n" + store.getTiddlerText("StyleSheet") + "\n";
	sc = sc.replace(/#/mg,"#s_");

	var slices = ["Background","Foreground",
		"PrimaryPale","PrimaryLight","PrimaryMid","PrimaryDark",
		"SecondaryPale","SecondaryLight","SecondaryMid","SecondaryDark",
		"TertiaryPale","TertiaryLight","TertiaryMid","TertiaryDark",
		"Error"];
	for(var i in slices) {
		s = store.getTiddlerSlice("ColorPalette",i);
		sc = sc.replace("[[ColorPalette::"+i+"]]",s);
	}

	text += sc;
	text += "#s_messageArea {display:none;}\n";
	text += "\n</style>\n";
	text += "<!--}}}-->\n";
	var tiddler = store.createTiddler("MarkupPostHead");
	tiddler.set(tiddler.title,text,config.options.txtUserName,null,"excludeLists excludeSearch");

	var sitetitle = store.getTiddlerText("SiteTitle");
	var sitesubtitle = store.getTiddlerText("SiteSubtitle");
	var pt = store.getTiddlerText("PageTemplate");
	pt = pt.replace(/<span class='siteTitle' refresh='content' tiddler='SiteTitle'><\/span>/mg,"<span class=\"siteTitle\">"+sitetitle+"</span>");
	pt = pt.replace(/<span class='siteSubtitle' refresh='content' tiddler='SiteSubtitle'><\/span>/mg,"<span class=\"siteSubtitle\">"+sitesubtitle+"</span>");
	pt = pt.replace(/<!--\{\{\{-->/mg,"").replace(/<!--\}\}\}-->/mg,"");
	pt = pt.replace(/<div id='/mg,"<div id='s_");

	text = "";
	var filter = store.getTiddlerText("SplashTiddlers") || store.getTiddlerText("DefaultTiddlers");
	tiddlers = store.filterTiddlers(filter);
	for(i=0;i<tiddlers.length;i++) {
		tiddler = tiddlers[i];
		var title = tiddler.title;
		var tiddlerElem = createTiddlyElement(null,"div","tempId"+tiddler.title,"tiddler");
		tiddlerElem.style.display = "none";
		tiddlerElem.setAttribute("refresh","tiddler");
		var template = story.chooseTemplateForTiddler(title);
		var t = story.getTemplateForTiddler(title,template,tiddler);
		t = t.replace(/<div class=['"]toolbar[^<]*<\/div>/mg,"<div class=\"toolbar\"><br /></div>");
		t = t.replace(/<div class=['"]tagging['"][^>]*><\/div>\n/mg,"");
		t = t.replace(/<div class=['"]tagged['"][^>]*><\/div>\n/mg,"");
		tiddlerElem.innerHTML = t;
		applyHtmlMacros(tiddlerElem,tiddler);
		text += '<div id="splashId_' + tiddler.title + '" class="tiddler">\n';
		t = tiddlerElem.innerHTML;
		// remove all tiddler links
		t = t.replace(/<a tiddlylink=[^>]*>([^<]*)<\/a>/mg,"$1");
		t = t.replace(/<a tiddlyfields=[^>]*>([^<]*)<\/a>/mg,"$1");
		text += t + '\n</div>\n';
	}
	text = text.replace(/<!--\{\{\{-->/mg,"").replace(/<!--\}\}\}-->/mg,"");

	var splash = "<!--{{{-->\n\n";
	splash += "<div id=\"splashScreen\">\n";
	pt = pt.replace(/<div id='s_tiddlerDisplay'><\/div>/mg,"<div id=\"s_tiddlerDisplay\">"+text+"</div>");
	splash += pt;

	splash += "</div>\n";
	splash += "<!--}}}-->\n\n";
	splash += '<script type="text/javascript">\ndocument.getElementById("splashScreen").style.display="none";\n</script>\n';

	tiddler = store.createTiddler("MarkupPreBody");
	tiddler.set(tiddler.title,splash,config.options.txtUserName,null,"excludeLists excludeSearch");

	store.setDirty(true);
};

version.extensions.SplashScreenPlugin.saveChanges = window.saveChanges;
window.saveChanges = function()
{
	version.extensions.SplashScreenPlugin.setup();
	version.extensions.SplashScreenPlugin.saveChanges();
}

} //# end of 'install only once'

timeline macro

Fri, 16 Dec 2011 16:48:08 GMT

To create a chronological list of recent edits:

<<timeline field maxlength dateformat template:title groupTemplate:title filter:filter>>

All the parameters are optional:

field determines which field to use as the basis for the list. It is usually modified or created
maxlength is an integer that limits the maximum number of tiddlers to include in the list
dateformat is a date format string that determines the format of the dates
template names the tiddler to use as the template for list entries
- The default template is <<view title link>> to cause the display of the tiddler title as a link to the tiddler
groupTemplate names the tiddler to use as the template for grouping entries in the list
- The default groupTemplate is <<view %0 date '%1'>>, where %0 is the name of the field being displayed and %1 is the dateformat selected in the third argument
filter is a tiddler filter that is used to filter the tiddlers that appear in the list

For example:

<<timeline created 5>>>

displays as:

20 March 2012
TiddlyWiki5

7 March 2012
luakit

13 January 2012
SplashScreenPlugin

14 November 2011
Mathematics

3 November 2011
SideBarOptions

<<timeline modified 5>>

displays as:

11 March 2012
MainMenu

7 March 2012
Browsers

MacrosContent

Fri, 16 Dec 2011 16:37:43 GMT

allTags
closeAll
list
newJournal
newTiddler
permaview
saveChanges
search
slider
tabs
tag
tagging
tags
tiddler
timeline
today
version
view

list macro

Wed, 14 Dec 2011 16:44:12 GMT

The <<list>> macro creates a list of tiddlers of a given type. It takes the following parameters:

<<list {type} [template:<templateTiddlerName>] [emptyMessage:"<message for when the list is empty>"]>>

The template tiddlers allows you to customise the text that is displayed about each tiddler. If it is not provided, then the default of "<<view title link>>" is used, which just includes the title of the tiddler as a link. You could add the author to each entry in the list by setting the template to a tiddler with the text "<<view title link>> by <<view modified link>>".

The empty message parameter allows you to specify text to be displayed if the list of tiddlers is empty.

The following types are supported:

all

To list all tiddlers

<<list all>>

filter

List tiddlers that match a certain filter. The following example lists all plugins.

<<list filter [tag[systemConfig]]>>

Missing

To list tiddlers that have links to them but are not defined:

<<list missing>>

Orphans

To list tiddlers that are not linked to from any other tiddlers:

<<list orphans>>

Shadowed

To list tiddlers shadowed with default contents:

<<list shadowed>>

Touched

Show tiddlers that have been modified locally:

<<list touched>>

view macro types

Wed, 14 Dec 2011 15:57:04 GMT

Text

Renders the field exactly how it is stored.
For example

<<view modified text>>
<<view title text>>

gives:

201112141557
view macro types

Link

Renders the value of the field as a link

<<view title link>>

gives

view macro types

Date

Applicable to the modified and created fields. Note a further parameter - a date format can be used.

<<view created date>>
<<view modified date "YYYY">>

gives:

15 February 2011
2011

See Date Formats for possible date format strings.

Wikified

Treats the string as wikitext.
e.g.

<<view customfield wikified>>

An optional third parameter can be used to transform the text before it is wikified. For example:

<<view customfield wikified "//$1//"

The result of this example would be to make the field display in italics.

TiddlySpace specific

See TiddlySpace View Types

MicroContent

Sat, 26 Nov 2011 13:22:01 GMT

MicroContent and MicroCopy being fashionable words for self-contained fragments of content that are smaller than an entire pages.

Usually MicroContent is presented through some kind of aggregation that reduces the perceptual shock and resource cost of context switching (eg the way that blogs aggregating several entries onto a page, or Flickr presents a bunch of photos in an album). TiddlyWiki aggregates MicroContent items called tiddlers into pages that are loaded in one gulp and progressively displayed as the user clicks hypertext links to read them.

Mathematics

Mon, 14 Nov 2011 12:28:29 GMT

There are several ways to incorporate mathematical formulae into TiddlyWiki, both of which let you to type ordinary LaTeX into a tiddler:
1. Use the jsMath library via Bob McElrath's TiddlyJsMath plugin
2. Use the MathJax library via PluginMathJax

An alternative is to use a service like CodeCogs that enables you to generate images of equations from LaTeX source that can be manually inserted into TiddlyWiki. Some examples of this technique are http://twmath.tiddlyspot.com/ and http://twequation.tiddlyspot.com/

Examples

Sat, 05 Nov 2011 14:55:07 GMT

See Dave Gifford's incredibly detailed catalogue of TiddlyWiki being used in the wild in his TiddlyWikiShowcase.

Other notable or interesting examples:

Getting Things Done - MonkeyPirateTiddlyWiki, mGSD,D-Cubed, TeamTasks, TiddlyPackingList, tbGTD
Open Notebook Science - Garrett Lisi's Deferential Geometry, (video)
Novels and creative writing - TiddlyWikiWrite, Gimcrack'd, Singularity!, Liberty Hall Writers Wiki, Bibliotheca Caelestis. Tiddlywikiroman from Hartmut Abendschein, Die, Vampire! Die! from David Van Wert, Rose from Alex Schroeder
Education - South Australia, maths in Massachusetts, The NoteStorm Christian database
Factbooks - Web campaigning in the US, Bolivian politics, Prince2 project management, Python Grimoire, Marc Bolan and T-Rex
Teaching - An Introduction to Chain Indexing, Reasoning Well
Role Playing Games - Making kickass campaign sites with TiddlyWiki
Medicine - TiddlyManuals, AMBIT
Law - TiddLegal, Courtrules
Activism - Climate Change 2.0, TiddlyWiki for Left Wing Journalists and Researchers
Homepage/Portfolio - Digimask, American Cryptogram Association, Nykyri.net
Blog - UdiGrudi, LumpyMilk, Veminra
Mobile - iTW optimised for the iPhone, iPhone, Android
Tools - TiddlyFolio (an electronic wallet), TiddlySlidy (presentations using TiddlyWiki), TiddlyPocketBooks (printable pocket books), TiddlyTweets (a tweet archiver), Project Cecily (a zooming user interface for TiddlyWiki)
As a component of other products:
- Dido - a tiddlywikified database application
- KNote - a notetakingprogram (desktopapplikation)
- Twine - a program for creating interactive stories
- CkEditor + TW - wysiwyg and TW on local disk (with an updated version from Måns Mårtensson)

Also, see TiddlyWikiAdaptations

StyleSheet

Thu, 03 Nov 2011 18:25:25 GMT

This fixes a problem with the tabs slider

#sidebarTabs .button {
margin:0em 0.2em;
padding:0.2em 0.3em;
display:block;
}

This is a sample style definition to demonstrate CustomCssClass formatting

.wrappingClass {color: #666; background: #bbb;}

Prettyify

body {
	font-size: 0.92em;
	margin-bottom: 4em;
}

.tiddler .viewer {
	font-size: 1.1em;
}

#contentWrapper .chunkyButton {
	width: auto;
}

#contentWrapper span.chunkyButton {
	border: none;
}

#contentWrapper span.chunkyButton a.button, #contentWrapper span.chunkyButton a:active.button {
	font-weight: bold;
	font-size: 1.3em;
	color: [[ColorPalette::Background]];
	background-color: [[ColorPalette::QuaternaryMid]];
	text-align: center;
	padding: 0.5em 1em;
	border-radius: 1ex;
	border-style: none !important;
}

#contentWrapper span.chunkyButton a.button:hover {
	background-color: [[ColorPalette::QuaternaryDark]];
	color: [[ColorPalette::Background]];
	border-style: none !important;
}

SaveChanges

Thu, 03 Nov 2011 18:25:15 GMT

If you've followed the appropriate Downloading guidelines, then you can save your changes as you go along. (AutoSave makes this easy).

It's important to save changes using TiddlyWiki's built in saving functionality (rather than the browser's 'Save As' function - here's why). Your local version of TiddlyWiki will have a button on the right hand side that says 'save changes' - that's the button you'll need to use.

It's worthwhile configuring your backup settings. You can edit the AdvancedOptions to decide when backups are made and where they're saved.

If you're still experiencing problems, the following links will help:

General guidance on FireFox, InternetExplorer, Opera, Camino or Safari
if you're using InternetExplorer on Windows you might run into XP ServicePack2Problems or VistaIssues

Plugins

Thu, 03 Nov 2011 18:25:07 GMT

TiddlyWiki can be extended by installing plugins that implement a wide variety of features (including Macros, themes or tweaks).

Community member Dave Gifford oversees an extensive catalogue of available plugins at TiddlyVault, and Eric Shulman maintains his own impressive collection of plugins at TiddlyTools. More recently, Saq Imtiaz has built a service which lists plugins from all around the web in a single place, at plugins.tiddlywiki.org

When you've chosen the plugin you'd like to import, follow the directions in ImportTiddlers (just make sure to tag the plugin systemConfig).

See http://tiddlywikidev.tiddlyspace.com/ for information on writing plugins for TiddlyWiki.

Editing

Thu, 03 Nov 2011 18:24:24 GMT

TiddlyWiki is made up of chunks of information called tiddlers. You're reading a tiddler called 'Editing' right now.

When you open an empty TiddlyWiki file for the first time, you'll be presented with a tiddler called "GettingStarted". This contains links to tiddlers to help you define the main attributes of your TiddlyWiki; the Title, SubTitle and MainMenu navigation (see Configuration).

You will notice that each tiddler has a command menu in it's top right corner (close, edit, and so on). You can use this to switch the tiddler into edit mode, or if you prefer you can simply double click the tiddler when it is in view mode. When you are finished, click on done, or cancel to discard your changes.

You can sign your edits with your username, which is currently set to . You can change it here, or in the right hand sidebar, where it can be found under options ».

There are two ways to make links between tiddlers. If you are linking to a tiddler which already exists, put the tiddler name in double square brackets (Double click here, and you'll see double square brackets around the word example). You can use this technique to point to (and create) a new tiddler, or alternatively just write the tiddler name by joining words starting with capital letters, LikeThis. When you save the tiddler and click on the link, you can then add content to your new tiddler.

Download

Thu, 03 Nov 2011 18:24:16 GMT

download