mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-27 12:07:19 +00:00
Docs updates
This commit is contained in:
parent
4c06bd72de
commit
d800deaf4b
@ -2,8 +2,6 @@ title: TiddlyWikiArchitecture
|
|||||||
modifier: JeremyRuston
|
modifier: JeremyRuston
|
||||||
tags: docs internals
|
tags: docs internals
|
||||||
|
|
||||||
! Overview
|
|
||||||
|
|
||||||
The heart of TiddlyWiki can be seen as an extensible representation transformation engine for text and images. Given the text of a tiddler and its associated ContentType, the engine can produce a rendering of the tiddler in a new ContentType. Furthermore, it can efficiently selectively update the rendering to track any changes in the tiddler or its dependents.
|
The heart of TiddlyWiki can be seen as an extensible representation transformation engine for text and images. Given the text of a tiddler and its associated ContentType, the engine can produce a rendering of the tiddler in a new ContentType. Furthermore, it can efficiently selectively update the rendering to track any changes in the tiddler or its dependents.
|
||||||
|
|
||||||
The primary use of the engine is to convert raw `text/vnd.tiddlywiki` WikiText into a `text/html` or `text/plain` representation for display. The transclusion and templating features of WikiText allow the engine to also be used to generate TiddlyWiki HTML files from raw tiddlers.
|
The primary use of the engine is to convert raw `text/vnd.tiddlywiki` WikiText into a `text/html` or `text/plain` representation for display. The transclusion and templating features of WikiText allow the engine to also be used to generate TiddlyWiki HTML files from raw tiddlers.
|
||||||
|
@ -7,7 +7,7 @@ TiddlyWiki5 is based on a 1,000 line boot kernel that runs on node.js or in the
|
|||||||
|
|
||||||
The kernel boots just enough of the TiddlyWiki environment to allow it to load tiddlers and execute JavaScript modules. Plugin modules are written like `node.js` modules.
|
The kernel boots just enough of the TiddlyWiki environment to allow it to load tiddlers and execute JavaScript modules. Plugin modules are written like `node.js` modules.
|
||||||
|
|
||||||
There are many [[different types of module|ModuleType]]: parsers, serializers, deserializers, macros etc. It goes much further than you might expect. For example, individual tiddler fields are modules, too: there's a module that knows how to handle the `tags` field, and another that knows how to handle the special behaviour of the `modified` and `created` fields.
|
There are many [[different types of module|ModuleType]]: parsers, deserializers, widgets etc. It goes much further than you might expect. For example, individual tiddler fields are modules, too: there's a module that knows how to handle the `tags` field, and another that knows how to handle the special behaviour of the `modified` and `created` fields.
|
||||||
|
|
||||||
Some plugin modules have further sub-plugins: the wikitext parser, for instance, accepts rules as individual plugin modules.
|
Some plugin modules have further sub-plugins: the wikitext parser, for instance, accepts rules as individual plugin modules.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user