TiddlyWiki

from Wikipedia, the free encyclopedia
TiddlyWiki

Motovun Jack.svg
Screenshot TiddlyWiki 5.1.19
Screenshot TiddlyWiki 5.1.19
Basic data

developer Community (formerly Jeremy Ruston)
Publishing year September 30, 2004
Current  version 5.1.22
( April 15, 2020 )
operating system all ( JavaScript )
programming language JavaScript
category Wiki software
License BSD license
German speaking Yes
www.tiddlywiki.com

TiddlyWiki is a free web application that realizes a wiki within a single HTML document.

Characteristic

An empty TiddlyWiki, including the integrated JavaScript and CSS code, has a size of around 2.1 megabytes (version 5.1.19). It is controlled by JavaScript and in its simplest version - save by saving as - web browser function - no server application . All data is saved within the document. This makes it suitable as a portable collection of information that can be opened, edited and saved in all browsers and on all operating systems. However, there are also many alternative storage methods available, for example using a Node.js -based web server or a browser plug-in .

Tiddler

The individual "pages" of the wiki are managed within the document in div blocks that can be displayed and hidden using DHTML . These blocks of information are called tiddlers. By default, they consist of a title, date, day line and text area. By means of tags (in addition to normal wiki links), content-related Tiddlers can be linked. Tag hierarchies are also possible.

import and export

The exchange of Tiddlers between wikis using drag & drop or synchronization between different TiddlyWiki files is natively supported. The wiki or selected Tiddlers can be imported and exported from and into various formats, by default CSV , JSON , or the TID format optimized for TiddlyWiki . The latter are human-readable text files with the ending '.tid' (abbreviation for Tiddler ).

Wiki syntax

Screenshot of a tiddler in draft mode

Like most wikis, TiddlyWiki uses its own wiki syntax , which is remotely comparable to that of classic MediaWikis . Using the Markdown parser plug-in , you can also create Tiddlers in Markdown .

By default, 26 different formats, text snippets and macros that can be added by button or manually are supported. a. Paragraphs of text, various inline formatting, links, images, lists, tables, quotations and preformatted text . Furthermore, HTML constructs, SVGs , CSS styles, JavaScripts and macros can be used. You can create and save your own text snippets. Other tiddlers, represented by user-defined templates, can also be transcluded . The entered text can be viewed using a live preview. By default, preview and diff are supported. Using the Tools for exploring the internals of TiddlyWiki plug-in , the generated HTML and JSON-like parse trees can also be viewed.

Search syntax

TiddlyWiki has its own search syntax which returns lists of Tiddlers. For example, [all[]!is[system]sort[created]]all Tiddlers created by the user can be found sorted by creation date. The search syntax can be used by the user to search for Tiddlers, but it is also an integral part of the core functionality of the wiki. It is also used in macros, e.g. B. for creating link lists, TOCs or tab groups . This search syntax can also be used to access so-called Tiddler attributes , which are user - definable and modifiable key-value fields that are assigned to Tiddler.

Adaptability

TiddlyWiki has a modular structure: Most of the functions of the wiki are defined in Tiddlers themselves. The exception are core functions that are required to start the wiki. These core functionalities are called the kernel in TiddlyWiki lingua . Additional functions can be added in the form of your own tiddlers.

In this way it is e.g. B. possible to add language files that translate the English language controls into another language. In the same way the design can be customized, e.g. B. by changing the HTML of an underlying template tiddler or by adding CSS or JavaScript tiddlers. The so-called system tiddlers or shadow tiddlers can also be modified. These are not overwritten, but a copy is created with the same name, which is then edited. If you delete the copy, the underlying original system tiddler is restored.

Extensions

Plug-ins work in the same way . These are groups of tiddlers who duplicate and modify existing system tiddlers or add their own new tiddlers. In addition to executable JavaScript code, they usually also contain the documentation of the plug-in and often configuration options. These tiddlers, like all others, can also be modified by the user. So TiddlyWiki is highly 'hackable'.

Based on this plug-in mechanism, many extensions for TiddlyWiki have been released, e.g. B. a task planner by Simon Baird called mGSD, which is based on the model Getting Things Done by David Allen . The TiddlySpot hosting service is also implemented via the plug-in interface, which makes the wiki generally available after changes (initially only made locally) by re- uploading it to the hosting server.

Special runtime environments for TiddlyWiki enable use on smartphones or tablets under iOS , webOS or Android .

Advantages and disadvantages

TiddlyWiki is very compact and, including the information provided in the wiki, can easily be stored on a USB memory stick. Since TiddlyWiki stores program code and text content in a single file, complete presentations can be passed on in this one file and displayed in any JavaScript-enabled browser.

Since all Tiddlers are displayed within one HTML page, it is possible to look up further information within the wiki while editing a Tiddler without having to change the browser window. By deliberately clicking away or collapsing unwanted tiddlers and sorting the tiddlers by drag & drop, several tiddlers can be viewed one below the other and thus temporary context views can be generated on a topic. Permalinks can be created for these views at the push of a button .

The compact structure is also the main drawback: for the display, not only the currently requested information is transmitted to the browser, but in principle always the entirety of the content stored in the wiki. Therefore, data that may not even be queried by the user strain transmission capacities and main memory. There is the possibility of lazy loading if Node.js is used as the backend . Tiddlers are then only loaded into the document when they are actually opened. However, there are limitations to this, as TOCs based on tags, for example, cannot be rendered. In addition, when it is made available in the network, the server is only concerned with delivering the file; Computing time for the entire program logic has to be provided by the client , which is no longer a problem today, even for less powerful smartphones. The entire file must also be transferred to the server for making changes available via the Internet . Thus, TiddlyWiki is only suitable for small to medium amounts of data. A workaround for this problem is to split the wiki into several wikis according to core topics as the volume increases (several thousand Tiddlers).

TiddlyWiki doesn't have a traditional edit history. When a change is made, a copy of the entire file is saved with a timestamp. However, plug-ins can be used to display a timeline for the Tiddlers. This option can also be switched off.

TiddlyWiki5

On September 20, 2014, a completely re-programmed successor version based on HTML5 was released that uses node.js. The original version TiddlyWiki Classic is still used by numerous users.

literature

  • Nikolaus Schüler: The file for everything. Note management with TiddlyWiki . In: c't . No. 20 , 2018, p. 170–172 ( heise.de [accessed February 19, 2020]).

Web links

Commons : TiddlyWiki  - collection of images, videos and audio files

Individual evidence

  1. Release 5.1.22 . April 15, 2020 (accessed April 16, 2020).
  2. a b TiddlyWikiDeutsch - German translation project
  3. Getting Started. In: tiddlywiki.com. Retrieved April 6, 2019 .
  4. WikiText. In: tiddlywiki.com. Retrieved June 7, 2016 .
  5. " The TiddlyWiki powered GTD® system formerly known as MonkeyGTD " formerly "MonkeyGTD" Renaming due unclaimed rechtl. Claims the David Allen Company
  6. Free hosting service for TiddlyWiki