2012-06-10 12:40:53 +00:00
title: Docs
tags: docs
! Guides
2012-06-10 21:53:51 +00:00
How to get things done with TiddlyWiki:
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
2012-06-10 21:53:51 +00:00
The core concepts underlying TiddlyWiki are:
2012-06-10 16:27:09 +00:00
* [[Tiddlers]]
2012-06-10 12:40:53 +00:00
* [[Wiki]]
* TiddlyWiki
* WikiText
2012-06-10 21:53:51 +00:00
The machinery tying those concepts together includes:
2012-06-10 16:27:09 +00:00
* TiddlerFilters
2012-06-10 12:40:53 +00:00
* TiddlerFields
2012-06-10 21:01:22 +00:00
* ContentType
2012-06-10 12:40:53 +00:00
* ShadowTiddlers
* TiddlerModules
! Wiki Text Rules
2012-06-10 21:53:51 +00:00
These are the individual rules that make up WikiText:
2012-06-10 12:40:53 +00:00
* ClassBlockWikiText
* CodeBlockWikiText
* CodeRunWikiText
* DashWikiText
* EmphasisWikiText
* EntityWikiText
* ExternalLinkWikiText
* HeadingWikiText
* HtmlWikiText
* ImageWikiText
* ListWikiText
* MacroWikiText
* PrettyLinkWikiText
* RuleWikiText
* TypedBlockWikiText
* WikiLinkWikiText
! Macros
2012-06-10 21:53:51 +00:00
Macros give WikiText dynamic functionality:
2012-06-10 12:40:53 +00:00
* ViewMacro
* EditMacro
* StoryMacro
* TiddlerMacro
* ButtonMacro
* CommentMacro
* DownloadMacro
* EchoMacro
* ImageMacro
* IncludeMacro
* LinkMacro
* ListMacro
* VideoMacro
* SliderMacro
* ZoomerMacro
* ChooserMacro
2012-06-10 18:47:24 +00:00
* TagsMacro
* ColorMacro
2012-06-10 12:40:53 +00:00
! Commands
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:
2012-06-10 12:40:53 +00:00
* DumpCommand
* LoadCommand
* SaveTiddlerCommand
* ServerCommand
* VerboseCommand
* VersionCommand
* WikiTestCommand
2012-06-10 21:53:51 +00:00
! Internal Objects and Mechanisms
Internally, TiddlyWiki is built on a number of key objects and mechanisms:
2012-06-10 12:40:53 +00:00
2012-06-10 21:53:51 +00:00
* TiddlerObject
* WikiObject
2012-06-10 12:40:53 +00:00
* BootMechanism
* PluginMechanism
* ParsingMechanism
* RenderingMechanism
* DependencyMechanism
* RefreshMechanism
* MacroMechanism
* StoryMechanism
* EditingMechanism
* SavingMechanism
* SyncMechanism
* CommandMechanism
* ConfigMechanism
! Plugin Module Types
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
2012-06-10 12:40:53 +00:00
! Tree Nodes
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.
2012-06-10 12:40:53 +00:00
* TreeNode
* ElementNode
* EntityNode
* MacroNode
* RawNode
* TextNode
! Other Parsers
2012-06-10 21:53:51 +00:00
TiddlyWiki processes other [[ContentTypes|ContentType]] than WikiText using these parsers:
2012-06-10 12:40:53 +00:00
* OldWikiTextParser
* JsonParser
* ImageParser
* PlainTextParser
* TiddlyTextParser
* JavaScriptParser
! Deserializers
2012-06-10 21:53:51 +00:00
Deserializers are modules that read tiddlers from different text formats:
2012-06-10 12:40:53 +00:00
* RecipeFiles
* TiddlerFiles
2012-06-10 21:53:51 +00:00
* TiddlyWikiFiles
2012-06-10 12:40:53 +00:00
! Serializers
2012-06-10 21:53:51 +00:00
Serializers are modules that convert tiddlers to different text formats:
2012-06-10 12:40:53 +00:00
! Miscellaneous
2012-06-10 21:53:51 +00:00
* [[History]]
2012-06-10 12:40:53 +00:00
* [[Acknowledgements]]
