mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 10:07:19 +00:00
Code Issues Releases Wiki Activity

Docs updates

Browse Source
This commit is contained in:
Jeremy Ruston 2013-04-22 17:58:44 +01:00
parent 3dc31d6704
commit e57095ba37
2 changed files with 6 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
editions/tw5.com/tiddlers/TiddlyWikiArchitecture.tid
View File

@ -1,45 +1,10 @@
title: TiddlyWikiArchitecture
modifier: JeremyRuston
tags: docs internals
modified: 201304212156
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.
You can explore this mechanism by opening the JavaScript console in your browser. Typing this command will replace the text of the tiddler `HelloThere` with new content:
```
$tw.wiki.addTiddler({title: "HelloThere", text: "This is some new content"});
```
If the tiddler `HelloThere` is visible then you'll see it instantly change to reflect the new content. If you create a tiddler that doesn't currently exist (like IntentionallyMissingTiddler) then you'll see any displayed links to it instantly change from italicised to normal:
```
$tw.wiki.addTiddler({title: "IntentionallyMissingTiddler", text: "This tiddler now exists"});
```
This example deletes a tiddler:
```
$tw.wiki.deleteTiddler("HelloThere")
```
This example retrieves all the outgoing links from a tiddler:
```
$tw.wiki.getTiddlerLinks("HelloThere")
```
This example retrieves all the incoming links to a tiddler:
```
$tw.wiki.getTiddlerLinks("HelloThere")
```
This example retrieves the titles of all the tiddlers matching a TiddlerFilter expression:
```
$tw.wiki.filterTiddlers("[tag[docs]sort[modified]]")`
```
If you're interested in understanding more about the internal operation of TiddlyWiki, it is recommended that you review the DeveloperDocs and read the code -- start with the boot kernel [[$:/core/boot.js]].
If you're interested in understanding more about the internal operation of TiddlyWiki, it is recommended that you review the DeveloperDocs and read the code -- start with the boot kernel [[$:/core/boot.js]].

7
editions/tw5.com/tiddlers/roadmap/RoadMap.tid
View File

@ -1,7 +1,7 @@
modified: 201304181001
title: RoadMap
modifier: JeremyRuston
tags: docs planning
modifier: JeremyRuston
title: RoadMap
modified: 201304212151
TiddlyWiki5 is currently an alpha release, meaning that it is incomplete and subject to change.
@ -39,6 +39,7 @@ Some of the additional features under consideration during the beta include:
* Encrypted tiddlers and ~~encrypted TiddlyWikis~~
* Facebook, Twitter, G+ and LinkedIn macros
* Integration with the browser back and forwards buttons
* Minification of plugins (JS and CSS)
! 1.0 Release