User:Epok/Sandbox/en

Transclusion is generally the inclusion of the content of a document into another document by reference. In a Wikipedia context, it is the use of the template functionality of MediaWiki to include the same content in multiple documents without having to edit those documents separately. Template transclusion is the common way to use template messages, and is implemented by using a template tag, with the form:

{{template name}}

How transclusion works[edit]

Template syntax

If the source is in the Main article namespace (e.g., "Cat"), you must put a colon (:) in front of the name, thus: {{:Cat}}

If the source is in the Template namespace (e.g., "Template:Villagepumppages"), just use the name itself, alone, thus: {{Villagepumppages}}

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

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

{{SOMEPAGE}}

Whenever the target page A with this code is rendered, the engine will include in that place not the code itself, but the entire content of the source page B, SOMEPAGE.

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.

For example, you might decide to create a (template) page with your mailing address and include that template on not only your page, but all your friends' pages, too. When you move your television and couch to another apartment, you will change your address template, and automatically, that new information will appear on all your friends' pages.

Etymology[edit]

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

Partial transclusion[edit]

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.

For an example of how this technique can be applied to simplify the creation of summary articles, see how w:en:History of pathology [1] was transcluded into w:en:Pathology, [2] which consisted of a collection of transcluded lead paragraphs from several main articles.

Transclusion markup[edit]

noinclude. The markup ‎<noinclude>...‎</noinclude> means that the text between the tags will not be transcluded onto another page, but will only appear on the page itself. This is useful for documentation.
includeonly. The markup ‎<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.
onlyinclude. The markup ‎<onlyinclude>...‎</onlyinclude> indicates that only text surrounded by "onlyinclude" markup should be transcluded onto another page. This is the most subtle of the partial transclusion tags because it often overrules the others. If there is at least one pair of "onlyinclude" tags on a page, then whenever this page is transcluded, it is only the material within the "onlyinclude" tags which gets transcluded. There can be several such sections, and within each such section, some material might be further excluded by "noinclude" tags, and might also be surrounded by "includeonly" tags so that it does not appear on the original page itself. But material outside the "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 onlyinclude tags, and transclude it onto the second page. Note that unlike ‎<noinclude> and ‎<includeonly>, ‎<onlyinclude> will take precedence over enclosing ‎<nowiki> tags. In other words, ‎<nowiki>‎<onlyinclude>My content‎</onlyinclude>‎</nowiki> produces only "My content" when transcluded.

Example of how to transclude the lead of an article[edit]

[ Edit Source to see how this works ]

The lead section (also known as the lead, introduction or intro) of a Wikipedia article is the section before the table of contents and the first heading. The lead serves as an introduction to the article and a summary of its most important contents. It is not a news-style lead or lede paragraph.

My content

Subpages[edit]

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 only be used where subpages are enabled; for example, on the English Wikipedia, subpages can only be used 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 {{Talk:Pussycat/Let's delete Pussycat!}}. Comments posted in either talk page will be shown in both.

Special pages[edit]

See also:w:Wikipedia:Transclusion#Special pages and 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: {{Special:Newpages/3}} gives 3 new pages.

URL parameters can be given like template parameters, e. g. {{Special:RecentChanges|namespace=10|limit=5}}.

Alternatives to transclusion by template[edit]

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: {{subst:template name}}.

The content of a page can also be transcluded from a namespace other than "Template". See http://meta.wikimedia.org/wiki/Help:Embed_page.

Labeled Section Transclusion[edit]

An extension called Labeled Section Transclusion enables marked sections of text to be transcluded. An extension with a somewhat similar function is PageVariableExtension.

Semantic MediaWiki[edit]

The Semantic MediaWiki extension uses inline queries to query and display semantic data. There are currently two ways to perform transclusion or something similar:

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.
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.

See http://semantic-mediawiki.org/wiki/Help:Inline_queries for further information.