1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-24 02:27:19 +00:00
TiddlyWiki5/tw5.com/tiddlers/Docs.tid
Jeremy Ruston 7e888e051d Docs updates
Trying to get the plugin documentation into shape
2012-08-30 13:55:28 +01:00

102 lines
1.8 KiB
Plaintext

title: Docs
tags: docs introduction
This is the main documentation hub for TiddlyWiki. See also:
* [[Internals]] for developer documentation
! 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
* TiddlerTemplates
* ContentType
* ShadowTiddlers
* [[Plugins]]
* [[Modules]] and [[ModuleType]]
! 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
* TranscludeWikiText
* TypedBlockWikiText
* WikiLinkWikiText
! Macros
Macros give WikiText dynamic functionality:
* ButtonMacro
* ChooserMacro
* ColorMacro
* CommentMacro
* DownloadMacro
* EchoMacro
* EditMacro
* HideMacro
* ImageMacro
* IncludeMacro
* LinkMacro
* LinkCatcherMacro
* ListMacro
* SliderMacro
* StoryMacro
* TiddlerMacro
* TranscludeMacro
* VideoMacro
* ViewMacro
* ZoomerMacro
! 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
! Miscellaneous
* ReportingBugs
* JeremyRuston (aka [[Jermolene]])
* FederatialLimited
* [[History]]
* [[Acknowledgements]]