Help:Transclusion

Transclusion is generally the inclusion of the content of a document into another document by reference. In a wiki context, it is the use of the templatemsg>w:Wikipedia:Template messages|template functionality of MediaWiki to include the same content in multiple documents without having to edit those documents separately.

How transclusion works


  Syntax 

If the source is in the Template namespace (e.g. "templname>Template:Welcome"), just use the name itself, alone:

If the source is in the Main article namespace (e.g. "catname>VisualEditor"), a colon must be added in front of the name:

If the source is in any other namespace (e.g. "userexample>User:Example"), you must use the full name, including the namespace:

If the source is a subpage of the target page, (e.g. "subpageexample>Transclusion/ja"), you can simply specify the name of the subpage regardless of namespace:



To transclude any source page (within a single MediaWiki project, such as Wikipedia) within another target page, include the following code:

Whenever the target page A is rendered, the entire content of the source page B (in this case, SOMEPAGE), will be rendered at the location where the transclusion tag was placed.

For example, you might decide to place a welcome message on every newcomer's talk page. Transclusion creates a "live" link between the template-page and the target-page(s) upon which the message should appear. When the template is edited, all the target-pages are edited too.

You might also decide to create a (template) page with your mailing address and include that template on not only your page, but all your friends' pages as well. When you move your television and couch to another apartment, you can change your address template, and that new information will automatically update on all your friends' pages.

Etymology
Ted Nelson coined the term "transclusion", as well as "hypertext" and "hypermedia", in his 1982 book Literary Machines.

Partial transclusion
By using "noinclude", "onlyinclude" and "includeonly" markup, it is possible to transclude part of a page rather than all of it. Such partial transclusions can also be achieved by transcluding from other pages such as subpages. It is often desirable not to transclude some information, such as template documentation and categories.

Transclusion markup

 * noinclude. The markup <tvar|tagnoincl><noinclude ></noinclude></> means that the text between the tags will not be transcluded onto another page and will appear only on the page itself. This is useful for template documentation and categories.
 * <tvar|inclonly>includeonly</>. The markup <tvar|taginclonly><includeonly ></includeonly></> means that the text between the tags will only be used when the page is transcluded onto another page, and will not appear on the page itself. This can be useful, for example, for adding categories to pages transcluding a template, without adding the template itself to these categories.
 * <tvar|onlyincl>onlyinclude</>. The markup <tvar|tagonlyincl><onlyinclude ></onlyinclude></> indicates that only text surrounded by "<tvar|onlyincl>onlyinclude</>" markup should be transcluded onto another page, but will appear on the page itself if not accompanied by "<tvar|inclonly>includeonly</>" tags as well. This is the most subtle of the partial transclusion tags because it often overrules the others. If there is at least one pair of "<tvar|onlyincl>onlyinclude</>" tags on a page, then whenever this page is transcluded, it is only the material within the "<tvar|onlyincl>onlyinclude</>" tags which gets transcluded. There can be several such sections, and within each such section, some material might be further excluded by "<tvar|noincl>noinclude</>" tags, and might also be surrounded by "<tvar|inclonly>includeonly</>" tags so that it does not appear on the original page itself. But material outside the "<tvar|onlyincl>onlyinclude</>" tags will be ignored when the page is transcluded onto another page. This can be useful, for example, to repeat a small part of one page on a second one: just surround the small part by <tvar|onlyincl>onlyinclude</> tags, and transclude it onto the second page. Note that unlike <tvar|tagnoinclopen></> and <tvar|taginclonlyopen></>, <tvar|tagonlyinclopen></> will take precedence over enclosing <tvar|tagnowikiopen></> tags. In other words, <tvar|tagbegin><nowiki ></nowiki> </>produces only "My content" when transcluded.

Subpages
You can cut and paste the text to be transcluded into a subpage, then use the name of the subpage in the transclusion template. This approach can be used only where subpages are enabled; for example, on the English Wikipedia, subpages can be used only from User, Talk or Wikipedia pages; currently, subpages cannot be created from main article pages.

Example: you want to discuss the deletion and redirecting of Pussycat to Cat. First, create the subpage Talk:Pussycat/Let's delete Pussycat!, write your comment into it, then transclude it in Talk:Pussycat and Talk:Cat using the template  . Comments posted in either talk page will be shown in both.

Special pages

 * See also:w:Wikipedia:Transclusion and manspeincl>Special:MyLanguage/Manual:$wgAllowSpecialInclusion</>|Manual:$wgAllowSpecialInclusion

Some pages on Special:Specialpages can be transcluded, such as Special:AllPages, Special:PrefixIndex, Special:NewFiles, Special:NewPages, Special:RecentChanges and Special:RecentChangesLinked.

Sample: gives 3 new pages.

manparamindex>Special:MyLanguage/Manual:Parameters to index.php</>|URL parameters can be given like template parameters, e. g..

Alternatives to transclusion by template
Occasionally you may want to use a template, but for one reason or another may not want to use transclusion. The automatic one-time copying of a template's code/text to the location of a template tag is called Template substitution or subclusion (substitution + transclusion). To subclude a template's code/text, the template tag is modified from the standard transclusion tag to a substitution tag, simply by adding subst:, creating a tag with the form:.

Labeled Section Transclusion
An extension called extlst>Special:MyLanguage/Extension:Labeled Section Transclusion</>|Labeled Section Transclusion enables marked sections of text to be transcluded. An extension with a somewhat similar function is extpve>Special:MyLanguage/Extension:PageVariableExtension</>|PageVariableExtension.

Semantic MediaWiki
The extsmw>Special:MyLanguage/Extension:Semantic MediaWiki</>|Semantic MediaWiki extension uses inline queries to query and display semantic data. There are currently two ways to perform transclusion or something similar: See inline queries for further information.
 * 1) Transclusion proper. The display format "embedded" ensures that selected pages (mainspace articles, templates, etc.) are transcluded. As with templates, sections placed between noinclude tags will be omitted.
 * 2) Selected passages in a page can be assigned a property of type 'Text'. These selections can be requested by running an inline query for this type of property.

Pages related to MediaWiki transclusion

 * MediaWiki namespace
 * m:Help:MediaWiki namespace
 * m:Help:Variable
 * w:Wikipedia talk:Template namespace

Templates

 * Help:Template
 * w:Wikipedia:Template namespace
 * w:Wikipedia:Template limits