Help:Transclusion

From Meta, a Wikimedia project coordination wiki
(Redirected from Transclusion)
Jump to: navigation, search
Detailed reference page on this subject: Help:Template.

Transclusion refers to the process by which the entire contents of a page are inserted on to another page for the sake of convenience, speed of editing and/or tidiness of the source wikitext. The process works by applying the title of the page to be transcluded, with two braces {{}} on either side and sometimes a colon.

Templates[edit]

Pages created for the sole purpose of being useful to transclude are known as templates. Templates come in many varieties; some templates constitute generic messages that can be quickly and easily sent, while others contain pieces of text that are used in mass quantities. The use for these quick pieces of text or code are almost limitless, and there are literally hundreds of thousands in current use all over Wikimedia. They have their own namespace, Template:.

The braces assume, and it is implied by default, that the template namespace is to be transcluded; i.e., the syntax assumes that {{FOO}} refers to Template:FOO. However, all kinds of pages can be transcluded in every namespace so long as the namespace is specified: e.g., {{Meta:Help}} would be a viable and workable transclusion. Because of template: vs (main) confusion when transcluding, pages with no namespace prefix, as this one (Transclusion), are transcluded with a colon preceding the page name, like this: {{:Transclusion}}.

Link that is created[edit]

It is important to remember that transclusion creates a very real and direct link between the target page and the transcluded one; when the source page is changed, the transcluded text is changed with it. This especially applies to templates that are in mass use; many pages can be altered very radically by a small change. The volatility of this situation should be considered when making changes.

It is possible to see what pages are transcluded on a page, and where a page is transcluded, by use of the "What links here" link in the toolbox in the left hand panel.

Examples[edit]

The following is an example of transclusion {{Information thread}}:

---


February 2016[edit]

Wikimedia-logo.svg 15: New Wikimedia referrer policy to counteract unwanted effects of using HTTPS
Wikimedia-logo.svg 8–28: 2016 Steward elections' voting is running until 28 February 2016, 13:59 (UTC)
Crystal filetypes.png 1–16: Community discussion on the focus areas and proposed projects for Program Capacity and Learning, newly integrated team at WMF

January 2016[edit]

Wikimedia-logo.svg 18: Community consultation for the 2016 Wikimedia Foundation Strategy
Wikimedia-logo.svg 15–28: Candidate submissions for the 2016 Steward election ran until 28 January 2016, 23:59 (UTC)

December 2015[edit]

Crystal filetypes.png 13: RFC on password requirements for users with advanced permissions

November 2015[edit]

Wikimedia-logo.svg 20: Community Tech Community Wishlist Survey
Crystal filetypes.png 16: WMF Community Consultation on harassment

September 2015[edit]

Wikimedia-logo.svg 25: Request for comment: OAuth handover


---

Viewing that source will show that while that thread is complex, with a fair bit of text and a lot of use of code, all it takes is a simple application of {{Information thread}} here to transclude accurately, how it displays there. This is very handy for managing information on the wiki.

See also[edit]