TiddlyWiki5/editions/tw5.com/tiddlers/Docs.tid

created: 201308241418
creator: JeremyRuston
modified: 201308251303
modifier: JeremyRuston
tags: introduction
title: Docs

This is the main documentation hub for TiddlyWiki. See also the DeveloperDocs.

! Editions

TiddlyWiki5 can be used via these editions:

<$list filter="[tag[edition]sort[title]]" type="ul"/>

! How to use ~TiddlyWiki5

<$list filter="[tag[howto]sort[title]]" type="ul"/>

! Concepts

The core concepts underlying TiddlyWiki are:

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

The machinery tying those concepts together includes:

* TiddlerFilters
* TiddlerFields
* TiddlerTemplates
* DataTiddlers
* ContentType
* SystemTiddlers
* [[Plugins]]
* [[Modules]] and [[ModuleType]]

! Wiki Text Rules

These are the individual rules that make up WikiText:

<$list filter="[tag[wikitextrule]sort[title]]" type="ul"/>

! Widgets

Widgets give WikiText dynamic functionality:

<$list filter="[tag[widget]sort[title]]" type="ul"/>

! Commands

{{command}}

<$list filter="[tag[command]sort[title]]" type="ul"/>

! Tips

{{tips}}

<$list filter="[tag[tips]sort[title]]" type="ul"/>

! Miscellaneous

* ReportingBugs
* JeremyRuston (aka [[Jermolene]])
* FederatialLimited
* [[Acknowledgements]]
Split "transclude" widget into a separate "tiddler" and "transclude" widget Belatedly realised that the design would be clearer without these two separate concepts being conflated into a single widget. As a result of this change, any other widget or template that generates transclude widgets has needed adjustment. 2013-08-24 15:45:45 +00:00			`created: 201308241418`
			`creator: JeremyRuston`
Docs update Tearing up the recent changes tab... 2013-08-25 20:22:11 +00:00			`modified: 201308251303`
Split "transclude" widget into a separate "tiddler" and "transclude" widget Belatedly realised that the design would be clearer without these two separate concepts being conflated into a single widget. As a result of this change, any other widget or template that generates transclude widgets has needed adjustment. 2013-08-24 15:45:45 +00:00			`modifier: JeremyRuston`
Get rid of the 'docs' tag It was unnecessary, since everything here is documentation 2013-08-25 20:41:00 +00:00			`tags: introduction`
Split "transclude" widget into a separate "tiddler" and "transclude" widget Belatedly realised that the design would be clearer without these two separate concepts being conflated into a single widget. As a result of this change, any other widget or template that generates transclude widgets has needed adjustment. 2013-08-24 15:45:45 +00:00			`title: Docs`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00
Docs updates 2013-03-02 13:14:56 +00:00			`This is the main documentation hub for TiddlyWiki. See also the DeveloperDocs.`
Docs update 2012-07-15 16:34:34 +00:00
Docs updates 2013-03-02 13:14:56 +00:00			`! Editions`
Docs update 2012-06-11 16:35:56 +00:00
Docs updates 2013-03-02 13:14:56 +00:00			`TiddlyWiki5 can be used via these editions:`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00
Extend the list widget to allow the generated HTML elements to be controlled This makes it possible to generate UL or OL lists as well as the current divs and spans. This feature is clearly necessary but I'm not very happy with it. It feels as though the syntax should be modifying a UL tag to specify the extra information required to generate the list, rather than turning the list widget to indirectly specify it's elements. 2013-08-19 10:08:00 +00:00			`<$list filter="[tag[edition]sort[title]]" type="ul"/>`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00
Docs updates 2013-03-11 14:49:06 +00:00			`! How to use ~TiddlyWiki5`
Docs updates 2013-03-11 14:43:24 +00:00
Extend the list widget to allow the generated HTML elements to be controlled This makes it possible to generate UL or OL lists as well as the current divs and spans. This feature is clearly necessary but I'm not very happy with it. It feels as though the syntax should be modifying a UL tag to specify the extra information required to generate the list, rather than turning the list widget to indirectly specify it's elements. 2013-08-19 10:08:00 +00:00			`<$list filter="[tag[howto]sort[title]]" type="ul"/>`
Docs updates 2013-03-11 14:43:24 +00:00
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`! 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`
Mo' docs updates 2012-06-22 14:12:42 +00:00			`* TiddlerTemplates`
Docs updates 2013-01-16 13:44:09 +00:00			`* DataTiddlers`
Docs updates 2012-06-10 21:01:22 +00:00			`* ContentType`
Rename "shadow" tiddlers to "system" tiddlers What we have at the moment isn't really the same as TiddlyWiki classic's shadow tiddlers, it's a much simpler system for excluding tiddlers. We'll use the term "shadow" instead to refer to the way that tiddlers in plugins behave, which is exactly like TiddlyWiki classic's shadow tiddlers. 2013-03-15 22:00:19 +00:00			`* SystemTiddlers`
Docs updates Trying to get the plugin documentation into shape 2012-08-30 12:55:28 +00:00			`* [[Plugins]]`
			`* [[Modules]] and [[ModuleType]]`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00
			`! Wiki Text Rules`

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

Split "transclude" widget into a separate "tiddler" and "transclude" widget Belatedly realised that the design would be clearer without these two separate concepts being conflated into a single widget. As a result of this change, any other widget or template that generates transclude widgets has needed adjustment. 2013-08-24 15:45:45 +00:00			`<$list filter="[tag[wikitextrule]sort[title]]" type="ul"/>`
Docs updates 2013-03-02 13:14:56 +00:00
			`! Widgets`

			`Widgets give WikiText dynamic functionality:`

Split "transclude" widget into a separate "tiddler" and "transclude" widget Belatedly realised that the design would be clearer without these two separate concepts being conflated into a single widget. As a result of this change, any other widget or template that generates transclude widgets has needed adjustment. 2013-08-24 15:45:45 +00:00			`<$list filter="[tag[widget]sort[title]]" type="ul"/>`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00
			`! Commands`

Split "transclude" widget into a separate "tiddler" and "transclude" widget Belatedly realised that the design would be clearer without these two separate concepts being conflated into a single widget. As a result of this change, any other widget or template that generates transclude widgets has needed adjustment. 2013-08-24 15:45:45 +00:00			`{{command}}`
Docs updates 2012-06-10 21:53:51 +00:00
Split "transclude" widget into a separate "tiddler" and "transclude" widget Belatedly realised that the design would be clearer without these two separate concepts being conflated into a single widget. As a result of this change, any other widget or template that generates transclude widgets has needed adjustment. 2013-08-24 15:45:45 +00:00			`<$list filter="[tag[command]sort[title]]" type="ul"/>`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00
Docs update Tearing up the recent changes tab... 2013-08-25 20:22:11 +00:00			`! Tips`

			`{{tips}}`

			`<$list filter="[tag[tips]sort[title]]" type="ul"/>`

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`
Lots of documentation updates More to come... 2012-06-10 12:40:53 +00:00			`* [[Acknowledgements]]`