2012-07-15 16:34:34 +00:00
|
|
|
tags: docs introduction dev
|
2013-04-25 16:55:59 +00:00
|
|
|
title: DeveloperDocs
|
|
|
|
|
modified: 201304251644
|
2012-07-15 16:34:34 +00:00
|
|
|
|
|
|
|
|
This is the developer documentation hub for TiddlyWiki.
|
|
|
|
|
|
|
|
|
|
! Developer Cookbooks
|
|
|
|
|
|
|
|
|
|
* [[Using TiddlyWiki for GitHub Pages project documentation]]
|
|
|
|
|
* [[Using TiddlyWiki as a component in node.js applications]]
|
|
|
|
|
* [[Constructing TiddlyWiki documents in other applications]]
|
|
|
|
|
|
|
|
|
|
! 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
|
2013-01-31 10:20:13 +00:00
|
|
|
* EncryptionMechanism
|
2013-04-25 16:55:59 +00:00
|
|
|
* TestingMechanism
|
2012-07-15 16:34:34 +00:00
|
|
|
|
|
|
|
|
! 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
|
|
|
|
|
* SaverModules
|
|
|
|
|
* StartupModules
|
|
|
|
|
* StoryViewModules
|
|
|
|
|
* SyncerModules
|
|
|
|
|
* TiddlerDeserializerModules
|
|
|
|
|
* TiddlerFieldModules
|
|
|
|
|
* TiddlerMethodModules
|
|
|
|
|
* TreeNodeModules
|
|
|
|
|
* TreeUtilsModules
|
|
|
|
|
* UtilsModules
|
|
|
|
|
* WikiMethodModules
|
|
|
|
|
* WikiTextRuleModules
|
|
|
|
|
|
2013-01-16 13:44:09 +00:00
|
|
|
! Parsers
|
2012-07-15 16:34:34 +00:00
|
|
|
|
2013-01-16 13:44:09 +00:00
|
|
|
TiddlyWiki processes [[ContentTypes|ContentType]] such as WikiText using these parsers:
|
2012-07-15 16:34:34 +00:00
|
|
|
|
2013-01-16 13:44:09 +00:00
|
|
|
* WikiTextParser
|
2012-07-15 16:34:34 +00:00
|
|
|
* JsonParser
|
|
|
|
|
* ImageParser
|
|
|
|
|
* PlainTextParser
|
|
|
|
|
* JavaScriptParser
|
|
|
|
|
|
|
|
|
|
! Deserializers
|
|
|
|
|
|
|
|
|
|
Deserializers are modules that read tiddlers from different text formats:
|
|
|
|
|
|
|
|
|
|
* RecipeFiles
|
|
|
|
|
* TiddlerFiles
|
|
|
|
|
* TiddlyWikiFiles
|
