diff --git a/readme.md b/readme.md
index e666fae92..18e8aa61f 100644
--- a/readme.md
+++ b/readme.md
@@ -14,10 +14,12 @@
Overview
The heart of
TiddlyWiki can be seen as an extensible representation transformation engine. Given the text of a tiddler and its associated MIME type, the engine can produce a rendering of the tiddler in a new MIME type. Furthermore, it can efficiently selectively update the rendering to track any changes in the tiddler or its dependents.
The most important transformations are from
text/x-tiddlywiki
wikitext into
text/html
or
text/plain
but the engine is used throughout the system for other transformations, such as converting images for display in HTML, sanitising fragments of
JavaScript, and processing CSS.
The key feature of wikitext is the ability to include one tiddler within another (usually referred to as
transclusion). For example, one could have a tiddler called
Disclaimer that contains the boilerplate of a legal disclaimer, and then include it within lots of different tiddlers with the macro call
<<tiddler Disclaimer>>
. This simple feature brings great power in terms of encapsulating and reusing content, and evolving a clean, usable implementation architecture to support it efficiently is a key objective of the
TiddlyWiki5 design.
It turns out that the transclusion capability combined with the selective refreshing mechanism provides a good foundation for building
TiddlyWiki's user interface itself. Consider, for example, the
StoryMacro in its simplest form:
<<story story:MyStoryTiddler>>
The story macro looks for a list of tiddler titles in the tiddler
MyStoryTiddler
, and displays them in sequence. The subtle part is that subsequently, if
MyStoryTiddler
changes, the
<<story>>
macro is selectively re-rendered. So, to navigate to a new tiddler, code merely needs to add the name of the tiddler and a line break to the top of
MyStoryTiddler
:
var storyTiddler = store.getTiddler("MyStoryTiddler");
store.addTiddler(new Tiddler(storyTiddler,{text: navigateTo + "\n" + storyTiddler.text}));
-
The mechanisms that allow all of this to work are fairly intricate. The sections below progressively build the key architectural concepts of
TiddlyWiki5 in a way that should provide a good basis for exploring the code directly.
Tiddlers
Tiddlers are an immutable dictionary of name:value pairs called fields.
The only field that is required is the
title
field, but useful tiddlers also have a
text
field, and some or all of the standard fields
modified
,
modifier
,
created
,
creator
,
tags
and
type
.
Hardcoded in the system is the knowledge that the
tags
field is a string array, and that the
modified
and
created
fields are
JavaScript Date
objects. All other fields are strings.
The
type
field identifies the representation of the tiddler text with a MIME type.
WikiStore
Groups of uniquely titled tiddlers are contained in
WikiStore objects.
The
WikiStore also manages the plugin modules used for macros, and operations like serializing, deserializing, parsing and rendering tiddlers.
Each
WikiStore is connected to another shadow store that is used to provide default content. Under usual circumstances, when an attempt is made to retrieve a tiddler that doesn't exist in the store, the search continues into its shadow store (and so on, if the shadow store itself has a shadow store).
WikiStore Events
Clients can register event handlers with the
WikiStore object. Event handlers can be registered to be triggered for modifications to any tiddler in the store, or with a filter to only be invoked when a particular tiddler or set of tiddlers changes.
Whenever a change is made to a tiddler, the wikistore registers a
nexttick
handler (if it hasn't already done so). The
nexttick
handler looks back at all the tiddler changes, and dispatches any matching event handlers.
Parsing and Rendering
TiddlyWiki parses the content of tiddlers to build an internal tree representation that is used for several purposes:
- Rendering a tiddler to other formats (e.g. converting wikitext to HTML)
- Detecting outgoing links from a tiddler, and from them...
- ...computing incoming links to a tiddler
- Detecting tiddlers that are orphans with no incoming links
- Detecting tiddlers that are referred to but missing
The parse tree is built when needed, and then cached by the
WikiStore until the tiddler changes.
TiddlyWiki5 uses multiple parsers:
- Wikitext (
text/x-tiddlywiki
) in js/WikiTextParser.js
- JavaScript (
text/javascript
) in js/JavaScriptParser.js
- Images (
image/png
and image/jpg
) in js/ImageParser.js
- JSON (
application/json
) in js/JSONParser.js
Additional parsers are planned:
- CSS (
text/css
) - Recipe (
text/x-tiddlywiki-recipe
)
One global instance of each parser is instantiated in
js/App.js
and registered with the main
WikiStore object.
The parsers are all used the same way:
var parseTree = parser.parse(type,text)
The mechanisms that allow all of this to work are fairly intricate. The sections below progressively build the key architectural concepts of
TiddlyWiki5 in a way that should provide a good basis for exploring the code directly.
Tiddlers
Tiddlers are an immutable dictionary of name:value pairs called fields.
The only field that is required is the
title
field, but useful tiddlers also have a
text
field, and some or all of the standard fields
modified
,
modifier
,
created
,
creator
,
tags
and
type
.
Hardcoded in the system is the knowledge that the
tags
field is a string array, and that the
modified
and
created
fields are
JavaScript Date
objects. All other fields are strings.
The
type
field identifies the representation of the tiddler text with a MIME type.
WikiStore
Groups of uniquely titled tiddlers are contained in
WikiStore objects.
The
WikiStore also manages the plugin modules used for macros, and operations like serializing, deserializing, parsing and rendering tiddlers.
Each
WikiStore is connected to another shadow store that is used to provide default content. Under usual circumstances, when an attempt is made to retrieve a tiddler that doesn't exist in the store, the search continues into its shadow store (and so on, if the shadow store itself has a shadow store).
WikiStore Events
Clients can register event handlers with the
WikiStore object. Event handlers can be registered to be triggered for modifications to any tiddler in the store, or with a filter to only be invoked when a particular tiddler or set of tiddlers changes.
Whenever a change is made to a tiddler, the wikistore registers a
nexttick
handler (if it hasn't already done so). The
nexttick
handler looks back at all the tiddler changes, and dispatches any matching event handlers.
Parsing and Rendering
TiddlyWiki parses the content of tiddlers to build an internal tree representation that is used for several purposes:
- Rendering a tiddler to other formats (e.g. converting wikitext to HTML)
- Detecting outgoing links from a tiddler, and from them...
- ...computing incoming links to a tiddler
- Detecting tiddlers that are orphans with no incoming links
- Detecting tiddlers that are referred to but missing
The parse tree is built when needed, and then cached by the
WikiStore until the tiddler changes.
TiddlyWiki5 uses multiple parsers:
- Wikitext (
text/x-tiddlywiki
) in js/WikiTextParser.js
- JavaScript (
text/javascript
) in js/JavaScriptParser.js
- Images (
image/png
and image/jpg
) in js/ImageParser.js
- JSON (
application/json
) in js/JSONParser.js
Additional parsers are planned:
- CSS (
text/css
) - Recipe (
text/x-tiddlywiki-recipe
)
One global instance of each parser is instantiated in
js/App.js
and registered with the main
WikiStore object.
The parsers are all used the same way:
var parseTree = parser.parse(type,text)
The parse tree object exposes the following fields:
var renderer = parseTree.compile(type); console.log(parseTree.toString(type)); var dependencies = parseTree.dependencies; var dependencies = parseTree.dependencies;
The dependencies are returned as an object like this:
{
tiddlers: {"tiddlertitle1": true, "tiddlertitle2": false},
dependentAll: false