TiddlyWiki5/editions/tw5.com/tiddlers/wikitext/Transclusion in WikiText.tid

caption: Transclusion
created: 20131205160146648
modified: 20220909111836951
tags: WikiText
title: Transclusion in WikiText
type: text/vnd.tiddlywiki

! Introduction

You can incorporate the content of one tiddler within another using the [[Transclusion]] notation:

* `{{MyTiddler}}` transcludes a single tiddler
* `{{MyTiddler||TemplateTitle}}` displays the tiddler through a specified [[TemplateTiddler|TemplateTiddlers]]
* `{{||TemplateTitle}}` displays the specified template tiddler without altering the [[current tiddler|Current Tiddler]]
* `{{MyTiddler|Parameter}}` transcludes a single tiddler with a single parameter
* `{{MyTiddler||TemplateTitle|Parameter|SecondParameter}}` transcludes a single tiddler through a specified [[TemplateTiddler|TemplateTiddlers]] with two parameters

!! Transcluding Text References

You can also use a TextReference instead of a tiddler title:

* `{{MyTiddler!!field}}` transcludes a specified field of a tiddler
* `{{!!field}}` transcludes a specified field of the current tiddler
* `{{MyTiddler##index}}` transcludes a specified indexed property of a [[DataTiddler|DataTiddlers]]
* `{{##index}}` transcludes a specified indexed property of the current [[DataTiddler|DataTiddlers]]

!! Filtered Transclusion

A similar syntax can be used to transclude a list of tiddlers matching a specified [[filter|Filters]]:

```
{{{ [tag[mechanism]] }}}
{{{ [tag[mechanism]] ||TemplateTitle}}}
```

! Generated Widgets

The WikiText transclusion syntax generates a TiddlerWidget wrapped around a TranscludeWidget. For example, `{{MyTiddler||MyTemplate!!myField}}` generates the following pair of widgets:

```
<$tiddler tiddler="MyTiddler">
<$transclude $tiddler="MyTemplate" $field="myField"/>
</$tiddler>
```

See also:

* [[Transclusion Basic Usage]]
* [[Transclusion with Templates]]
* TemplateTiddlers
* TranscludeWidget
* [[Transclusion and Substitution]]
* [[WikiText parser mode: transclusion examples]]
Docs: Clarify widgets generated by wikitext transclusion 2014-12-30 09:09:40 +00:00			`caption: Transclusion`
Big docs update Finally sorting out the wikitext documentation 2013-12-05 16:21:10 +00:00			`created: 20131205160146648`
Huge Documentation Update Not quite finished, but definitely on the home stretch 2022-09-21 09:41:03 +00:00			`modified: 20220909111836951`
Update wikitext documentation 2014-09-11 08:15:58 +00:00			`tags: WikiText`
Big docs update Finally sorting out the wikitext documentation 2013-12-05 16:21:10 +00:00			`title: Transclusion in WikiText`
			`type: text/vnd.tiddlywiki`
Docs: Clarify widgets generated by wikitext transclusion 2014-12-30 09:09:40 +00:00
			`! Introduction`
Big docs update Finally sorting out the wikitext documentation 2013-12-05 16:21:10 +00:00
Documentation tweaks @erwanm I ended up making some fairly extensive tweaks. One issue is that the (excellent) material you’ve provided on transclusion with templates covers very much the same ground as the existing TemplateTiddlers tiddler. The existing text was focused on transclusion with widgets; I think your material using transclusion notation is much easier to understand. I’ve also removed the exercises section. We don’t have exercises elsewhere in the documentation, so I think we need to make a conscious decision about whether we’re going to try to add them, and then do so consistently across the material. I also made some changes to bring the text into house style for consistency (which I’ve also tried to start documenting). 2014-12-10 17:08:59 +00:00			`You can incorporate the content of one tiddler within another using the [[Transclusion]] notation:`
Big docs update Finally sorting out the wikitext documentation 2013-12-05 16:21:10 +00:00
			* `{{MyTiddler}}` transcludes a single tiddler
Docs updates 2014-01-07 11:57:42 +00:00			* `{{MyTiddler\|\|TemplateTitle}}` displays the tiddler through a specified [[TemplateTiddler\|TemplateTiddlers]]
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			* `{{\|\|TemplateTitle}}` displays the specified template tiddler without altering the [[current tiddler\|Current Tiddler]]
Huge Documentation Update Not quite finished, but definitely on the home stretch 2022-09-21 09:41:03 +00:00			* `{{MyTiddler\|Parameter}}` transcludes a single tiddler with a single parameter
			* `{{MyTiddler\|\|TemplateTitle\|Parameter\|SecondParameter}}` transcludes a single tiddler through a specified [[TemplateTiddler\|TemplateTiddlers]] with two parameters
Update transclusion wikitext syntax to allow a template without a target tiddler This allows us to transclude a tiddler without changing the current tiddler with `{{\|\|MyTiddler}}`. 2014-03-17 21:44:10 +00:00
Docs: Clarify widgets generated by wikitext transclusion 2014-12-30 09:09:40 +00:00			`!! Transcluding Text References`

Update transclusion wikitext syntax to allow a template without a target tiddler This allows us to transclude a tiddler without changing the current tiddler with `{{\|\|MyTiddler}}`. 2014-03-17 21:44:10 +00:00			`You can also use a TextReference instead of a tiddler title:`

			* `{{MyTiddler!!field}}` transcludes a specified field of a tiddler
			* `{{!!field}}` transcludes a specified field of the current tiddler
			* `{{MyTiddler##index}}` transcludes a specified indexed property of a [[DataTiddler\|DataTiddlers]]
			* `{{##index}}` transcludes a specified indexed property of the current [[DataTiddler\|DataTiddlers]]
Big docs update Finally sorting out the wikitext documentation 2013-12-05 16:21:10 +00:00
Docs: Clarify widgets generated by wikitext transclusion 2014-12-30 09:09:40 +00:00			`!! Filtered Transclusion`

Update filter docs 2014-09-10 22:42:13 +00:00			`A similar syntax can be used to transclude a list of tiddlers matching a specified [[filter\|Filters]]:`
Big docs update Finally sorting out the wikitext documentation 2013-12-05 16:21:10 +00:00
			```
			`{{{ [tag[mechanism]] }}}`
			`{{{ [tag[mechanism]] \|\|TemplateTitle}}}`
			```
Docs updates 2014-10-20 15:12:24 +00:00
Docs: Clarify widgets generated by wikitext transclusion 2014-12-30 09:09:40 +00:00			`! Generated Widgets`

			The WikiText transclusion syntax generates a TiddlerWidget wrapped around a TranscludeWidget. For example, `{{MyTiddler\|\|MyTemplate!!myField}}` generates the following pair of widgets:

			```
			`<$tiddler tiddler="MyTiddler">`
Huge Documentation Update Not quite finished, but definitely on the home stretch 2022-09-21 09:41:03 +00:00			`<$transclude $tiddler="MyTemplate" $field="myField"/>`
Docs: Clarify widgets generated by wikitext transclusion 2014-12-30 09:09:40 +00:00			`</$tiddler>`
			```

Docs updates 2014-10-20 15:12:24 +00:00			`See also:`

Documentation tweaks @erwanm I ended up making some fairly extensive tweaks. One issue is that the (excellent) material you’ve provided on transclusion with templates covers very much the same ground as the existing TemplateTiddlers tiddler. The existing text was focused on transclusion with widgets; I think your material using transclusion notation is much easier to understand. I’ve also removed the exercises section. We don’t have exercises elsewhere in the documentation, so I think we need to make a conscious decision about whether we’re going to try to add them, and then do so consistently across the material. I also made some changes to bring the text into house style for consistency (which I’ve also tried to start documenting). 2014-12-10 17:08:59 +00:00			`* [[Transclusion Basic Usage]]`
			`* [[Transclusion with Templates]]`
			`* TemplateTiddlers`
			`* TranscludeWidget`
Transclusion and Substitution - fixed the link The tiddler got renamed a while ago, the link was pointing to non-existent old name. 2015-05-05 20:48:48 +00:00			`* [[Transclusion and Substitution]]`
Add doc related to WikiText parser modes (#6415) * Added macros for displaying wikitext examples in a table * Added documentation for WikiText parsing * Changed recognize to British spelling * Add links to the new wikitext parser tiddlers 2022-01-23 09:44:01 +00:00			`* [[WikiText parser mode: transclusion examples]]`