mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-17 15:24:50 +00:00
Code Issues Releases Wiki Activity

New architecture diagram and docs updates

Browse Source
This commit is contained in:
Jermolene 2014-03-18 21:18:00 +00:00
parent b52299872a
commit a19432541e
5 changed files with 28 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
editions/tw5.com/tiddlers/dev/TiddlyWiki Architecture.tid Normal file
View File

@ -0,0 +1,19 @@
created: 20130825162100000
modified: 20140318211655525
tags: dev
title: TiddlyWiki Architecture
type: text/vnd.tiddlywiki
The heart of TiddlyWiki is 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.
! Overview
The following diagram shows the internals of TiddlyWiki as a stack of tiddlers above a processing pipeline that converts WikiText into HTML.
{{TiddlyWiki Architecture.svg}}
The processing pipeline shows how WikiText is parsed by a stack of parse rules into a parse tree. The parse tree is rendered as a tree of widgets, which is synchronised into the DOM via the RefreshMechanism.
DOM events trigger actions on widgets which update the tiddler store. The updates trigger a change event which in turn triggers the refresh mechanism to update the DOM.

6
editions/tw5.com/tiddlers/dev/TiddlyWiki for Developers.tid
View File

@ -1,14 +1,14 @@
created: 20131203074550710
modified: 20140226083600000
modified: 20140318210720798
tags: introduction dev
title: TiddlyWiki for Developers
type: text/vnd.tiddlywiki
TiddlyWiki is published as OpenSource which means that anyone can read the code and contribute to its development. It's a big, complex piece of software and can be overwhelming to newcomers.
TiddlyWiki is published as OpenSource which means that anyone can read the code and contribute to its development.
! Resources
If you're interested in understanding more about the internal operation of TiddlyWiki, start by reviewing [[TiddlyWiki for Developers]] and then read the code -- start with the boot kernel [[$:/boot/boot.js]].
If you're interested in understanding more about the internal operation of TiddlyWiki, [[TiddlyWiki Architecture]] gives an overview of how TiddlyWiki is structured. Then read the code -- start with the boot kernel [[$:/boot/boot.js]].
! The one thing you need to know

9
editions/tw5.com/tiddlers/dev/TiddlyWikiArchitecture.tid
View File

@ -1,9 +0,0 @@
created: 20130825162100000
modified: 20131212093605368
tags: dev
title: TiddlyWikiArchitecture
type: text/vnd.tiddlywiki
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.

3
editions/tw5.com/tiddlers/images/TiddlyWiki Architecture.svg Normal file
View File

File diff suppressed because one or more lines are too long
Side by Side

After

Width:  |  Height:  |  Size: 19 KiB

3
editions/tw5.com/tiddlers/images/TiddlyWiki Architecture.svg.meta Normal file
View File

@ -0,0 +1,3 @@
title: TiddlyWiki Architecture.svg
type: image/svg+xml
tags: picture