add WidgetVariable documentation

This commit is contained in:
Eucaly
2014-10-02 23:02:48 +08:00
parent 459133cc57
commit d9ccac21d0
6 changed files with 107 additions and 1 deletions

View File

@@ -0,0 +1,20 @@
caption: currentTiddler
created: 20141001232824187
modified: 20141002133837818
tags: Variables
title: WidgetVariable: currentTiddler
type: text/vnd.tiddlywiki
<<<
The ''currentTiddler'' variable containes the title of the current tiddler.
The ListWidget assigns the list result to the ''currentTiddler'' variable, unless the `variable` attribute is specified.
A couple of [[Widgets]] and [[Macros]] by default apply to the tiddler according to the ''currentTiddler'' variable.
The TranscludeWidget (or WikiText `{{||TemplateTitle}}`) transcludes a tiddler without changing the ''currentTiddler'' variable.
<<<
These mechanisms together allow you to write references like `<$view field="title" format="link"/>` in TemplateTiddlers or inside the ListWidget hierarchy without explicitly specifying the tiddler that it applies to.
See also [[WidgetVariable: storyTiddler]]