TiddlyWiki5/tw5.com/tiddlers/Docs.tid

title: Docs
tags: docs introduction

This is the main documentation hub for TiddlyWiki.

! Guides

How to get things done with TiddlyWiki:

* [[Getting started with TiddlyWiki in the browser]]
* [[Getting started with TiddlyWiki under node.js]]
* [[Getting involved in TiddlyWiki development]]

! Concepts

The core concepts underlying TiddlyWiki are:

* [[Tiddlers]]
* [[Wiki]]
* TiddlyWiki
* WikiText

The machinery tying those concepts together includes:

* TiddlerFilters
* TiddlerFields
* ContentType
* ShadowTiddlers
* TiddlerModules

! Wiki Text Rules

These are the individual rules that make up WikiText:

* ClassBlockWikiText
* CodeBlockWikiText
* CodeRunWikiText
* DashWikiText
* EmphasisWikiText
* EntityWikiText
* ExternalLinkWikiText
* HeadingWikiText
* HtmlWikiText
* ImageWikiText
* ListWikiText
* MacroWikiText
* PrettyLinkWikiText
* RuleWikiText
* StyleBlockWikiText
* TypedBlockWikiText
* WikiLinkWikiText

! Macros

Macros give WikiText dynamic functionality:

* ViewMacro
* EditMacro
* StoryMacro
* TiddlerMacro
* ButtonMacro
* CommentMacro
* DownloadMacro
* EchoMacro
* ImageMacro
* IncludeMacro
* LinkMacro
* ListMacro
* VideoMacro
* SliderMacro
* ZoomerMacro
* ChooserMacro
* TagsMacro
* ColorMacro

! 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
* LoadCommand
* SaveTiddlerCommand
* ServerCommand
* VerboseCommand
* VersionCommand
* WikiTestCommand

! Internal Objects and Mechanisms

Internally, TiddlyWiki is built on a number of key objects and mechanisms:

* TiddlerObject
* WikiObject
* BootMechanism
* PluginMechanism
* ParsingMechanism
* RenderingMechanism
* DependencyMechanism
* RefreshMechanism
* MacroMechanism
* StoryMechanism
* EditingMechanism
* SavingMechanism
* SyncMechanism
* CommandMechanism
* ConfigMechanism

! Plugin Module Types

TiddlyWiki is built on a [[tiny microkernel|BootMechanism]] with all functionality provided as various types of plugin module:

* CommandModules
* ConfigModules
* EditorModules
* GlobalModules
* LibraryModules
* MacroModules
* ModuleModules
* ParserModules
* StartupModules
* StoryViewModules
* TiddlerDeserializerModules
* TiddlerFieldModules
* TiddlerMethodModules
* TiddlerSerializerModules
* TreeNodeModules
* TreeUtilsModules
* UtilsModules
* WikiMethodModules
* WikiTextRuleModules

! 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
* ElementNode
* EntityNode
* MacroNode
* RawNode
* TextNode

! Other Parsers

TiddlyWiki processes other [[ContentTypes|ContentType]] than WikiText using these parsers:

* OldWikiTextParser
* JsonParser
* ImageParser
* PlainTextParser
* TiddlyTextParser
* JavaScriptParser

! Deserializers

Deserializers are modules that read tiddlers from different text formats:

* RecipeFiles
* TiddlerFiles
* TiddlyWikiFiles

! Serializers

Serializers are modules that convert tiddlers to different text formats:

! Developer Cookbooks

* [[Using TiddlyWiki for GitHub Pages project documentation]]
* [[Using TiddlyWiki as a component in node.js applications]]

! Miscellaneous

* ReportingBugs
* JeremyRuston (aka [[Jermolene]])
* FederatialLimited
* [[History]]
* [[Acknowledgements]]
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`title: Docs`
Docs update 2012-06-14 16:14:58 +00:00			`tags: docs introduction`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00
Docs update 2012-06-11 16:35:56 +00:00			`This is the main documentation hub for TiddlyWiki.`

Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`! Guides`

Docs updates 2012-06-10 21:53:51 +00:00			`How to get things done with TiddlyWiki:`

Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`* [[Getting started with TiddlyWiki in the browser]]`
			`* [[Getting started with TiddlyWiki under node.js]]`
			`* [[Getting involved in TiddlyWiki development]]`

			`! Concepts`

Docs updates 2012-06-10 21:53:51 +00:00			`The core concepts underlying TiddlyWiki are:`

Docs update 2012-06-10 16:27:09 +00:00			`* [[Tiddlers]]`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`* [[Wiki]]`
			`* TiddlyWiki`
			`* WikiText`
Docs updates 2012-06-10 21:53:51 +00:00
			`The machinery tying those concepts together includes:`

Docs update 2012-06-10 16:27:09 +00:00			`* TiddlerFilters`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`* TiddlerFields`
Docs updates 2012-06-10 21:01:22 +00:00			`* ContentType`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`* ShadowTiddlers`
			`* TiddlerModules`

			`! Wiki Text Rules`

Docs updates 2012-06-10 21:53:51 +00:00			`These are the individual rules that make up WikiText:`

Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`* ClassBlockWikiText`
			`* CodeBlockWikiText`
			`* CodeRunWikiText`
			`* DashWikiText`
			`* EmphasisWikiText`
			`* EntityWikiText`
			`* ExternalLinkWikiText`
			`* HeadingWikiText`
			`* HtmlWikiText`
			`* ImageWikiText`
			`* ListWikiText`
			`* MacroWikiText`
			`* PrettyLinkWikiText`
			`* RuleWikiText`
Added support for style blocks 2012-06-14 17:18:32 +00:00			`* StyleBlockWikiText`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`* TypedBlockWikiText`
			`* WikiLinkWikiText`

			`! Macros`

Docs updates 2012-06-10 21:53:51 +00:00			`Macros give WikiText dynamic functionality:`

Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`* ViewMacro`
			`* EditMacro`
			`* StoryMacro`
			`* TiddlerMacro`
			`* ButtonMacro`
			`* CommentMacro`
			`* DownloadMacro`
			`* EchoMacro`
			`* ImageMacro`
			`* IncludeMacro`
			`* LinkMacro`
			`* ListMacro`
			`* VideoMacro`
			`* SliderMacro`
			`* ZoomerMacro`
			`* ChooserMacro`
Added tags and color macros Which enables us to do nice colour coded tags. Soon they'll have a drop down on them too 2012-06-10 18:47:24 +00:00			`* TagsMacro`
			`* ColorMacro`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00
			`! Commands`

Docs updates 2012-06-10 21:53:51 +00:00			`When run under node.js, TiddlyWiki supports a [[command line interface\|Getting started with TiddlyWiki under node.js]] with the following built-in commands:`

Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`* DumpCommand`
			`* LoadCommand`
			`* SaveTiddlerCommand`
			`* ServerCommand`
			`* VerboseCommand`
			`* VersionCommand`
			`* WikiTestCommand`

Docs updates 2012-06-10 21:53:51 +00:00			`! Internal Objects and Mechanisms`

			`Internally, TiddlyWiki is built on a number of key objects and mechanisms:`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00
Docs updates 2012-06-10 21:53:51 +00:00			`* TiddlerObject`
			`* WikiObject`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`* BootMechanism`
			`* PluginMechanism`
			`* ParsingMechanism`
			`* RenderingMechanism`
			`* DependencyMechanism`
			`* RefreshMechanism`
			`* MacroMechanism`
			`* StoryMechanism`
			`* EditingMechanism`
			`* SavingMechanism`
			`* SyncMechanism`
			`* CommandMechanism`
			`* ConfigMechanism`

			`! Plugin Module Types`

Docs updates 2012-06-10 21:53:51 +00:00			`TiddlyWiki is built on a [[tiny microkernel\|BootMechanism]] with all functionality provided as various types of plugin module:`

			`* CommandModules`
			`* ConfigModules`
			`* EditorModules`
			`* GlobalModules`
			`* LibraryModules`
			`* MacroModules`
			`* ModuleModules`
			`* ParserModules`
			`* StartupModules`
			`* StoryViewModules`
			`* TiddlerDeserializerModules`
			`* TiddlerFieldModules`
			`* TiddlerMethodModules`
			`* TiddlerSerializerModules`
			`* TreeNodeModules`
			`* TreeUtilsModules`
			`* UtilsModules`
			`* WikiMethodModules`
			`* WikiTextRuleModules`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00
			`! Tree Nodes`

Docs updates 2012-06-10 21:53:51 +00:00			`The ParsingMechanism and the RenderingMechanism use a simple tree structure to represent both parsed WikiText and the HTML DOM structure of rendered content.`

Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`* TreeNode`
			`* ElementNode`
			`* EntityNode`
			`* MacroNode`
			`* RawNode`
			`* TextNode`

			`! Other Parsers`

Docs updates 2012-06-10 21:53:51 +00:00			`TiddlyWiki processes other [[ContentTypes\|ContentType]] than WikiText using these parsers:`

Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`* OldWikiTextParser`
			`* JsonParser`
			`* ImageParser`
			`* PlainTextParser`
			`* TiddlyTextParser`
			`* JavaScriptParser`

			`! Deserializers`

Docs updates 2012-06-10 21:53:51 +00:00			`Deserializers are modules that read tiddlers from different text formats:`

Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`* RecipeFiles`
			`* TiddlerFiles`
Docs updates 2012-06-10 21:53:51 +00:00			`* TiddlyWikiFiles`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00
			`! Serializers`

Docs updates 2012-06-10 21:53:51 +00:00			`Serializers are modules that convert tiddlers to different text formats:`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00
Docs updates 2012-06-21 11:39:04 +00:00			`! Developer Cookbooks`

Docs updates 2012-06-21 14:38:01 +00:00			`* [[Using TiddlyWiki for GitHub Pages project documentation]]`
Docs updates 2012-06-21 11:39:04 +00:00			`* [[Using TiddlyWiki as a component in node.js applications]]`

Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`! Miscellaneous`

Docs update 2012-06-13 12:19:24 +00:00			`* ReportingBugs`
Docs update 2012-06-11 12:08:02 +00:00			`* JeremyRuston (aka [[Jermolene]])`
			`* FederatialLimited`
Docs updates 2012-06-10 21:53:51 +00:00			`* [[History]]`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`* [[Acknowledgements]]`