thisTiddler description and examples improved (#7433)

This commit is contained in:
Mohammad Rahmani 2023-05-06 21:27:22 +03:30 committed by GitHub
parent e2fe681b50
commit fe716dd58f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 45 additions and 25 deletions

View File

@ -1,13 +0,0 @@
created: 20230304123606350
modified: 20230304124149055
tags: [[currentTiddler Variable]] [[Variable Examples]]
title: thisTiddler Variable (Examples)
type: text/vnd.tiddlywiki
<$macrocall $name=".example" n="1" eg="""<$text text=<<thisTiddler>>/>"""/>
<$macrocall $name=".example" n="2" eg="""\define example() <$text text=<<thisTiddler>>/>
<<example>>
"""/>

View File

@ -1,12 +0,0 @@
caption: currentTiddler
created: 20230304122810114
modified: 20230304123557862
tags: Variables [[Core Variables]]
title: thisTiddler Variable
type: text/vnd.tiddlywiki
<<.from-version "5.3.0">> The <<.def thisTiddler>> [[variable|Variables]] is set by the <<.wlink TranscludeWidget>> widget to contain the title of the tiddler that was transcluded. This means that within a tiddler <<.def thisTiddler>> will contain the title of that tiddler. It is not affected by macros, which means that within a macro <<.def thisTiddler>> will contain the title of the tiddler from which the macro was invoked. Intermediate, nested macro calls are ignored.
Compare <<.vlink storyTiddler>> and <<.vlink currentTiddler>>.
<<.variable-examples "thisTiddler">>

View File

@ -0,0 +1,10 @@
created: 20230506165016526
description: I'm a demonstration template
modified: 20230506170529579
tags: Demonstrations thisTiddler
title: SampleTemplate
type: text/vnd.tiddlywiki
''thisTiddler'': <$text text=<<thisTiddler>> />
''currentTiddler'': <$text text=<<currentTiddler>> />

View File

@ -0,0 +1,18 @@
created: 20230304123606350
modified: 20230304124149055
tags: [[thisTiddler Variable]] [[Variable Examples]]
title: thisTiddler Variable (Examples)
type: text/vnd.tiddlywiki
The first example shows how <<.def thisTiddler>> works whithin transcluded template. Here the [[SampleTemplate]] is a template for demonstration.
<$macrocall $name=".example" n="1" eg="""{{||SampleTemplate}}"""/>
The second example shows <<.def thisTiddler>> in the body of tiddler and inside a macro.
<$macrocall $name=".example" n="1" eg="""<$text text=<<thisTiddler>>/>"""/>
<$macrocall $name=".example" n="2" eg="""\define example() <$text text=<<thisTiddler>>/>
<<example>>
"""/>

View File

@ -0,0 +1,17 @@
caption: currentTiddler
created: 20230304122810114
modified: 20230505200086200
tags: Variables [[Core Variables]]
title: thisTiddler Variable
type: text/vnd.tiddlywiki
<<.from-version "5.3.0">> The <<.def thisTiddler>> [[variable|Variables]] is set by the <<.wlink TranscludeWidget>> widget to contain the title of the tiddler that was transcluded. This means that within transclusions <<.def thisTiddler>> will contain the title of the transcluded tiddler. It is not affected by macros, which means that within a macro <<.def thisTiddler>> will contain the title of the tiddler from which the macro was invoked. Intermediate, nested macro calls are ignored.
There are two key usages for <<.def thisTiddler>>:
* Within a transcluded template, <<.def thisTiddler>> points to the template itself, making it possible for the template to access data stored in other fields of the template
* Within a macro, <<.def thisTiddler>> points to the template that invoked the macro. If the macro was invoked by another macro, the template that invoked that macro is returned, and so on
Compare <<.vlink storyTiddler>> and <<.vlink currentTiddler>>.
<<.variable-examples "thisTiddler">>