mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-10-01 16:30:46 +00:00
Code Issues Releases Wiki Activity

Docs updates

Browse Source
This commit is contained in:
Jeremy Ruston 2012-06-10 22:53:51 +01:00
parent ce411ff0f1
commit 85d7bb6d8b
3 changed files with 48 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
tw5.com/tiddlers/Docs.tid
View File

@ -3,16 +3,23 @@ tags: docs
! Guides ! Guides
How to get things done with TiddlyWiki:
* [[Getting started with TiddlyWiki in the browser]] * [[Getting started with TiddlyWiki in the browser]]
* [[Getting started with TiddlyWiki under node.js]] * [[Getting started with TiddlyWiki under node.js]]
* [[Getting involved in TiddlyWiki development]] * [[Getting involved in TiddlyWiki development]]
! Concepts ! Concepts
The core concepts underlying TiddlyWiki are:
* [[Tiddlers]] * [[Tiddlers]]
* [[Wiki]] * [[Wiki]]
* TiddlyWiki * TiddlyWiki
* WikiText * WikiText
The machinery tying those concepts together includes:
* TiddlerFilters * TiddlerFilters
* TiddlerFields * TiddlerFields
* ContentType * ContentType
@ -21,6 +28,8 @@ tags: docs
! Wiki Text Rules ! Wiki Text Rules
These are the individual rules that make up WikiText:
* ClassBlockWikiText * ClassBlockWikiText
* CodeBlockWikiText * CodeBlockWikiText
* CodeRunWikiText * CodeRunWikiText
@ -40,6 +49,8 @@ tags: docs
! Macros ! Macros
Macros give WikiText dynamic functionality:
* ViewMacro * ViewMacro
* EditMacro * EditMacro
* StoryMacro * StoryMacro
@ -61,6 +72,8 @@ tags: docs
! Commands ! Commands
When run under node.js, TiddlyWiki supports a [[command line interface|Getting started with TiddlyWiki under node.js]] with the following built-in commands:
* DumpCommand * DumpCommand
* LoadCommand * LoadCommand
* SaveTiddlerCommand * SaveTiddlerCommand
@ -69,8 +82,12 @@ tags: docs
* VersionCommand * VersionCommand
* WikiTestCommand * WikiTestCommand
! Internal Mechanisms ! Internal Objects and Mechanisms
Internally, TiddlyWiki is built on a number of key objects and mechanisms:
* TiddlerObject
* WikiObject
* BootMechanism * BootMechanism
* PluginMechanism * PluginMechanism
* ParsingMechanism * ParsingMechanism
@ -85,35 +102,34 @@ tags: docs
* CommandMechanism * CommandMechanism
* ConfigMechanism * ConfigMechanism
! Data Model
* TiddlerObject
* WikiObject
! Plugin Module Types ! Plugin Module Types
* CommandPlugins TiddlyWiki is built on a [[tiny microkernel|BootMechanism]] with all functionality provided as various types of plugin module:
* ConfigPlugins
* EditorPlugins * CommandModules
* GlobalPlugins * ConfigModules
* LibraryPlugins * EditorModules
* MacroPlugins * GlobalModules
* ModulePlugins * LibraryModules
* ParserPlugins * MacroModules
* StartupPlugins * ModuleModules
* StoryViewPlugins * ParserModules
* TiddlerDeserializerPlugins * StartupModules
* TiddlerFieldPlugins * StoryViewModules
* TiddlerMethodPlugins * TiddlerDeserializerModules
* TiddlerSerializerPlugins * TiddlerFieldModules
* TreeNodePlugins * TiddlerMethodModules
* TreeUtilsPlugins * TiddlerSerializerModules
* UtilsPlugins * TreeNodeModules
* WikiMethodPlugins * TreeUtilsModules
* WikiTextRulePlugins * UtilsModules
* WikiMethodModules
* WikiTextRuleModules
! Tree Nodes ! Tree Nodes
The ParsingMechanism and the RenderingMechanism use a simple tree structure to represent both parsed WikiText and the HTML DOM structure of rendered content.
* TreeNode * TreeNode
* ElementNode * ElementNode
* EntityNode * EntityNode
@ -123,6 +139,8 @@ tags: docs
! Other Parsers ! Other Parsers
TiddlyWiki processes other [[ContentTypes|ContentType]] than WikiText using these parsers:
* OldWikiTextParser * OldWikiTextParser
* JsonParser * JsonParser
* ImageParser * ImageParser
@ -132,14 +150,18 @@ tags: docs
! Deserializers ! Deserializers
Deserializers are modules that read tiddlers from different text formats:
* RecipeFiles * RecipeFiles
* TiddlerFiles * TiddlerFiles
* TiddlyWikiFiles
! Serializers ! Serializers
* TiddlyWikiFiles Serializers are modules that convert tiddlers to different text formats:
! Miscellaneous ! Miscellaneous
* [[History]]
* [[Acknowledgements]] * [[Acknowledgements]]

2
tw5.com/tiddlers/concepts/Tiddlers.tid
View File

@ -1,8 +1,6 @@
title: Tiddlers title: Tiddlers
tags: docs concepts tags: docs concepts
!! Tiddlers
Tiddlers are an immutable dictionary of name:value pairs called fields. 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}}}. 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}}}.

2
tw5.com/tiddlers/concepts/Wiki.tid
View File

@ -1,8 +1,6 @@
title: Wiki title: Wiki
tags: docs concepts tags: docs concepts
!! ~WikiStore
Groups of uniquely titled tiddlers are contained in WikiStore objects. 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. The WikiStore also manages the plugin modules used for macros, and operations like serializing, deserializing, parsing and rendering tiddlers.