TiddlyWiki Manual/Printable version

TiddlyWiki Manual

The current, editable version of this book is available in Wikibooks, the open-content textbooks collection, at
https://en.wikibooks.org/wiki/TiddlyWiki_Manual

Permission is granted to copy, distribute, and/or modify this document under the terms of the Creative Commons Attribution-ShareAlike 3.0 License.

Saving Methods

This is an incomplete list of methods the community has used to saved TiddlyWiki files in a normal user workflow.

Saver mechanism

These methods use the saver mechanism, which saves the entire TiddlyWiki as one file.

TiddlyFox on FireFox up to version 56

• Simple to install and use.

Installation instructions are in the link.

http://tiddlywiki.com/#TiddlyFox

TiddlyChrome on Google Chrome as long as it supports apps

• Simple to install and use.

Chrome is slated to remove Apps support in early 2018. Until then, this app should work fine. The instructions are in the link.

https://github.com/Arlen22/tiddly-chrome-app

TiddlyServer

https://github.com/Arlen22/TiddlyServer

TiddlyDesktop

http://tiddlywiki.com/#TiddlyDesktop

Electron Wrapper

https://github.com/Arlen22/TiddlyWiki-Electron

Using the default download saver with a powershell script and a batch file

Put the powershell script in the directory that your browser saves downloads to.

param([string]$stem="foo", [string]$dir="")
$copyme = ls $stem*.html | sort LastWriteTime | select -last 1
$copyme = $copyme.FullName
Copy-Item $copyme -Destination $dir\$stem.html
Invoke-Item $dir\$stem.html

For each TiddlyWiki that you use, create a batch file in the download directory.

powershell -executionpolicy bypass -File .\launch_tw.ps1 -stem "bible" -dir d:\data\apps\TW_Ant

Every time you want to open a TiddlyWiki, you click on the corresponding batch file. The script grabs the newest file that starts with the name you specified for stem (in this case "bible"), and copies it into the specified directory as $stem$.html (in this case, "bible.html"). Once you are done editing you click save to download a new copy of the file. Then you can run the batch file again to copy the latest version back into your directory.

Getting started

What is TiddlyWiki?

TiddlyWiki (TW) is a single file that consists of many small chunks of data called tiddlers. The file is the application and also holds the content you add.

Every aspect of TW's functional code is a tiddler, and any content you add will become a tiddler. Everything is customisable. The basic setup is ready to use, vanilla flavoured.

As its name implies, TiddlyWiki was designed to create wikis with the aim of being easy to use in its most basic form, where a wiki can be hosted and/or published remotely, or used offline. As a single file it's extremely portable, it can be saved to and accessed from a USB-thumb-drive.

TiddlyWiki has been in use for almost 20 years. The first version of TiddlyWiki was released by Jeremy Ruston in September 2004. The current version, TW5, was released in 2013. See Wikipedia entry TiddlyWiki

Choosing an edition

There are four methods available to create, edit and view TiddlyWiki content.

1. Use an existing TW5 environment, online hosted. Eg. TiddlyHost
2. Download a stand-alone desktop application. Eg. TiddlyDesktop
3. Add a TW5 extension to your web-browser. This enables you to use your browser (ie. Chrome, Safari, etc.) as an editor. All TW5 content remains offline. Installation and basic configuration.
4. Subscribe to a TW5 multi-user environment, intended for organisations. Eg. Xememex]