1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-07-02 18:23:28 +00:00
TiddlyWiki5/editions/tw5.com/tiddlers/DeveloperDocs.tid
2013-04-25 17:55:59 +01:00

77 lines
1.6 KiB
Plaintext

tags: docs introduction dev
title: DeveloperDocs
modified: 201304251644
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
* EncryptionMechanism
* TestingMechanism
! 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
! Parsers
TiddlyWiki processes [[ContentTypes|ContentType]] such as WikiText using these parsers:
* WikiTextParser
* JsonParser
* ImageParser
* PlainTextParser
* JavaScriptParser
! Deserializers
Deserializers are modules that read tiddlers from different text formats:
* RecipeFiles
* TiddlerFiles
* TiddlyWikiFiles