4,595
edits
Help:Transclusion: Difference between revisions
Jump to navigation
Jump to search
no edit summary
(Created page with "<noinclude> {{pp-vandalism|small=yes}} {{Pp-move-indef}} </noinclude> {{redirect|WP:TRANS|text=You may be looking for Stiles.casa Wiki:Transwiki log, Help:Transwiki, Stiles.casa Wiki:Translation, Stiles.casa Wiki:WikiProject Transwiki or Stiles.casa Wiki:Transgender}} {{Broader|Transclusion}} {{Information page|H:TRANS|WP:TRANS}} '''Transclusion''' means the inclusion of the content of one document within another document by Reference (computer scie...") |
No edit summary |
||
| Line 3: | Line 3: | ||
{{Pp-move-indef}} | {{Pp-move-indef}} | ||
</noinclude> | </noinclude> | ||
{{redirect| | {{redirect|SW:TRANS|text=You may be looking for [[Stiles.casa Wiki:Transwiki log]], [[Help:Transwiki]], [[Stiles.casa Wiki:Translation]], [[Stiles.casa Wiki:WikiProject Transwiki]] or [[Stiles.casa Wiki:Transgender]]}} | ||
{{Broader|Transclusion}} | {{Broader|Transclusion}} | ||
{{Information page|H:TRANS| | {{Information page|H:TRANS|SW:TRANS}} | ||
'''Transclusion''' means the inclusion of the content of one document within another document by [[Reference (computer science)|reference]]. In Stiles.casa Wiki transclusion, the [[MediaWiki]] software will refer to the content of one page, the [[ | '''Transclusion''' means the inclusion of the content of one document within another document by [[Reference (computer science)|reference]]. In Stiles.casa Wiki transclusion, the [[MediaWiki]] software will refer to the content of one page, the [[SW:template|template]], for inclusion into the content of any other page, the target page. Similar to the way any [[wp:page name|page name]] can become a link by placing its name in double square brackets, any page name can become a template by placing it in double curly braces, '''<code><nowiki>{{</nowiki>''Namespace'':''[[SW:Page name|Pagename]]''}}</code>'''. Changes made to the template are then automatically reflected on all pages into which that page has been transcluded (though a [[Stiles.casa Wiki:Purge|purge]] may sometimes be necessary). | ||
If the template's [[ | If the template's [[SW:page name|page name]] does not begin with a namespace, it is assumed to be in the Template namespace. To refer to a page in the "Main" (article) namespace, it is necessary to prefix it with a colon (''':'''). Examples: | ||
* '''<code><nowiki>{{Stochastic processes}}</nowiki></code>''' will transclude from the page [[:Template:Stochastic processes]] | * '''<code><nowiki>{{Stochastic processes}}</nowiki></code>''' will transclude from the page [[:Template:Stochastic processes]] | ||
* '''<code><nowiki>{{:Stochastic processes}}</nowiki></code>''' will transclude from the page [[Stochastic processes]] (an article, in the Main namespace) | * '''<code><nowiki>{{:Stochastic processes}}</nowiki></code>''' will transclude from the page [[Stochastic processes]] (an article, in the Main namespace) | ||
* '''<code><nowiki>{{ | * '''<code><nowiki>{{SW:Assume good faith}}</nowiki></code>''' will transclude from the page [[Stiles.casa Wiki:Assume good faith]] | ||
What will transclude from a page can be controlled with the tags <nowiki><noinclude>, <onlyinclude> and <includeonly></nowiki> placed in the source page wikitext. (See [[#Markup|markup]], below.) The use of tags enables the template to transclude partially, otherwise the double curly braces will always transclude all content. For ''selective'' transclusion the <nowiki><includeonly></nowiki> parts of the template are named (with the help of [[wp:parser functions|parser functions]]) and that template is then called with the [[Help:Template#Parameters|parameter]] <code>transcludesection=''name''</code>. | What will transclude from a page can be controlled with the tags <nowiki><noinclude>, <onlyinclude> and <includeonly></nowiki> placed in the source page wikitext. (See [[#Markup|markup]], below.) The use of tags enables the template to transclude partially, otherwise the double curly braces will always transclude all content. For ''selective'' transclusion the <nowiki><includeonly></nowiki> parts of the template are named (with the help of [[wp:parser functions|parser functions]]) and that template is then called with the [[Help:Template#Parameters|parameter]] <code>transcludesection=''name''</code>. | ||
Transclusion events occur every time the page is ''loaded'', when the template is rendered. Another use of the same mechanism is a one-shot ''[[Help:substitution|substitution]]'' of the template call itself by its transcluded source page. A template call <code><nowiki>{{</nowiki>''[[ | Transclusion events occur every time the page is ''loaded'', when the template is rendered. Another use of the same mechanism is a one-shot ''[[Help:substitution|substitution]]'' of the template call itself by its transcluded source page. A template call <code><nowiki>{{</nowiki>''[[SW:page name#Namespace, pagename, and fullpagename|fullpagename]]''}}</code> with the "subst:" prefix <code><nowiki>{{</nowiki>subst:''fullpagename''}}</code> is transcluded once but never again, because the wikitext of that call is replaced (substituted) when its page is ''saved''. What was a one-time template call becomes the actual wikitext of the template at the time of its call. | ||
==How transclusion works== | ==How transclusion works== | ||
| Line 23: | Line 23: | ||
==Transclusion syntax== | ==Transclusion syntax== | ||
The general [[Syntax (programming languages)|syntax]] for [[Transclusion|transclusion]] on Stiles.casa Wiki is <code><nowiki>{{</nowiki>[[ | The general [[Syntax (programming languages)|syntax]] for [[Transclusion|transclusion]] on Stiles.casa Wiki is <code><nowiki>{{</nowiki>[[SW:Namespace|Namespace]]:[[SW:Page name|Pagename]]<nowiki>}}</nowiki></code>, where <code>Namespace:Pagename</code> describes the title of a Stiles.casa Wiki page. | ||
Using transclusion syntax requires some knowledge of page titles. On Stiles.casa Wiki, non-article pages have titles with a visible namespace and pagename separated by a colon; for example, the page [[Stiles.casa Wiki:Tips]] has <code>Stiles.casa Wiki</code> as the namespace, and <code>Tips</code> as the pagename. But encyclopedic articles only have a visible pagename in their titles: for example the article [[Potato]] has <code>Potato</code> as the pagename, and the namespace, called [[Stiles.casa Wiki:What is an article?#Namespace|main namespace]], is not visible. | Using transclusion syntax requires some knowledge of page titles. On Stiles.casa Wiki, non-article pages have titles with a visible namespace and pagename separated by a colon; for example, the page [[Stiles.casa Wiki:Tips]] has <code>Stiles.casa Wiki</code> as the namespace, and <code>Tips</code> as the pagename. But encyclopedic articles only have a visible pagename in their titles: for example the article [[Potato]] has <code>Potato</code> as the pagename, and the namespace, called [[Stiles.casa Wiki:What is an article?#Namespace|main namespace]], is not visible. | ||
* The [[Help:Wikitext|wikitext]] <code><nowiki>{{</nowiki>Namespace:Pagename<nowiki>}}</nowiki></code> will transclude the page titled <code><nowiki>Namespace:Pagename</nowiki></code>. For example, if a page has the wikitext <code><nowiki>{{</nowiki>Stiles.casa Wiki:Notability<nowiki>}}</nowiki></code> in it, it will transclude the page [[Stiles.casa Wiki:Notability]] into it. Please note that <code><nowiki>{{</nowiki> | * The [[Help:Wikitext|wikitext]] <code><nowiki>{{</nowiki>Namespace:Pagename<nowiki>}}</nowiki></code> will transclude the page titled <code><nowiki>Namespace:Pagename</nowiki></code>. For example, if a page has the wikitext <code><nowiki>{{</nowiki>Stiles.casa Wiki:Notability<nowiki>}}</nowiki></code> in it, it will transclude the page [[Stiles.casa Wiki:Notability]] into it. Please note that <code><nowiki>{{</nowiki>SW:Notability<nowiki>}}</nowiki></code> would do exactly the same thing, as <code>SW:</code> is a [[Stiles.casa Wiki:Namespace#Aliases|namespace alias]], which is [[Stiles.casa Wiki:Shortcut#Namespace_aliases|automatically translated]] by the Stiles.casa Wiki servers to <code>Stiles.casa Wiki:</code>. | ||
*If the namespace is omitted, but the colon is included, like <code><nowiki>{{</nowiki>:Pagename<nowiki>}}</nowiki></code>, the encyclopedic article <code>Pagename</code> will be transcluded. For example, <code><nowiki>{{</nowiki>:Notability<nowiki>}}</nowiki></code> will transclude the article [[Notability]]. | *If the namespace is omitted, but the colon is included, like <code><nowiki>{{</nowiki>:Pagename<nowiki>}}</nowiki></code>, the encyclopedic article <code>Pagename</code> will be transcluded. For example, <code><nowiki>{{</nowiki>:Notability<nowiki>}}</nowiki></code> will transclude the article [[Notability]]. | ||
*If both namepace and colon are omitted, like <code><nowiki>{{</nowiki>Pagename<nowiki>}}</nowiki></code>, the <code>Template:Pagename</code> will be transcluded. For example <code><nowiki>{{</nowiki>Notability<nowiki>}}</nowiki></code>, and also <code><nowiki>{{</nowiki>Template:Notability<nowiki>}}</nowiki></code>, will both transclude the [[Template:Notability]]. | *If both namepace and colon are omitted, like <code><nowiki>{{</nowiki>Pagename<nowiki>}}</nowiki></code>, the <code>Template:Pagename</code> will be transcluded. For example <code><nowiki>{{</nowiki>Notability<nowiki>}}</nowiki></code>, and also <code><nowiki>{{</nowiki>Template:Notability<nowiki>}}</nowiki></code>, will both transclude the [[Template:Notability]]. | ||
| Line 58: | Line 58: | ||
<code><nowiki>{{Pagename|parameter1|parameter2|parameter3}}</nowiki></code> | <code><nowiki>{{Pagename|parameter1|parameter2|parameter3}}</nowiki></code> | ||
{{shortcut| | {{shortcut|SW:UNNAMED|SW:POSPARAM|SW:POSITIONAL}} | ||
with each parameter being substituted with a <code>value</code>, or a <code>parameter name=value</code>, when used in practice. Notice that each parameter is separated with a [[vertical bar]]. Parameters that take the form <code>value</code> are called ''unnamed'' or ''positional parameters.'' Parameters that take the form <code>parameter name=value</code> are called ''named parameters''. With unnamed parameters, the first, second, third etc. parameters are equivalent to parameters '1', '2', '3' etc. in [[Stiles.casa Wiki:Template_documentation|template documentation.]] Unnamed parameters must be in the correct order, and best placed before named parameters. An example of the syntax using the [[Template:Collapse top]]: | with each parameter being substituted with a <code>value</code>, or a <code>parameter name=value</code>, when used in practice. Notice that each parameter is separated with a [[vertical bar]]. Parameters that take the form <code>value</code> are called ''unnamed'' or ''positional parameters.'' Parameters that take the form <code>parameter name=value</code> are called ''named parameters''. With unnamed parameters, the first, second, third etc. parameters are equivalent to parameters '1', '2', '3' etc. in [[Stiles.casa Wiki:Template_documentation|template documentation.]] Unnamed parameters must be in the correct order, and best placed before named parameters. An example of the syntax using the [[Template:Collapse top]]: | ||
| Line 106: | Line 106: | ||
When two pages need to discuss the same material in the same way, they can share a section. This involves creating a third page and transcluding that page onto both pages. This third page may be a page in its own right or a subpage of either of the other two, and if the first, it may be placed in the same namespace as the other pages or in template namespace. Common sections like this should be marked with an explanatory header, and/or given a special layout, to inform the reader that this section of the page is in a different location, since transcluding shared article sections can easily confuse novice editors and readers alike if left unmarked. | When two pages need to discuss the same material in the same way, they can share a section. This involves creating a third page and transcluding that page onto both pages. This third page may be a page in its own right or a subpage of either of the other two, and if the first, it may be placed in the same namespace as the other pages or in template namespace. Common sections like this should be marked with an explanatory header, and/or given a special layout, to inform the reader that this section of the page is in a different location, since transcluding shared article sections can easily confuse novice editors and readers alike if left unmarked. | ||
This can be very useful when two [[ | This can be very useful when two [[SW:DAB|disambiguation]] pages share content,{{Disputed inline|talk=Stiles.casa Wiki talk:Manual of Style/Disambiguation pages#Transclusion|date=September 2017}} or a list page and a disambiguation page share content (see third example below). | ||
Examples: | Examples: | ||
| Line 126: | Line 126: | ||
==Partial transclusion== | ==Partial transclusion== | ||
{{shortcut| | {{shortcut|SW:PARTRANS}} | ||
By using {{tag|noinclude|o}}, {{tag|includeonly|o}} and {{tag|onlyinclude|o}} markup, it is possible to transclude ''part'' of a page, rather than all of it. Such partial transclusions can be achieved by transcluding from any pages, including subpages. It is often useful to exclude part of a page in a transclusion, an example being with template documentation. | By using {{tag|noinclude|o}}, {{tag|includeonly|o}} and {{tag|onlyinclude|o}} markup, it is possible to transclude ''part'' of a page, rather than all of it. Such partial transclusions can be achieved by transcluding from any pages, including subpages. It is often useful to exclude part of a page in a transclusion, an example being with template documentation. | ||
| Line 141: | Line 141: | ||
In transclusion, a source page is transcluded into a destination page. But with partial transclusion, only part of that source page will be transcluded into a destination page. But in addition, what is transcluded to a destination page does not have to be visible on the source page. | In transclusion, a source page is transcluded into a destination page. But with partial transclusion, only part of that source page will be transcluded into a destination page. But in addition, what is transcluded to a destination page does not have to be visible on the source page. | ||
''Page rendering'' of a source page can be defined as the rendering of that source page when it is saved, which will be the same as the [[ | ''Page rendering'' of a source page can be defined as the rendering of that source page when it is saved, which will be the same as the [[SW:preview|preview]]. We can call this rendering '''''here'''''. | ||
''Transclusion rendering'' of a source page can be defined as the rendering of a destination page that has a source page transcluded into it; but only that part of the destination page that was transcluded from the source page. The preview of the transclusion rendering will again be identical. We can call this rendering '''''there'''''. | ''Transclusion rendering'' of a source page can be defined as the rendering of a destination page that has a source page transcluded into it; but only that part of the destination page that was transcluded from the source page. The preview of the transclusion rendering will again be identical. We can call this rendering '''''there'''''. | ||
| Line 183: | Line 183: | ||
==Selective transclusion== | ==Selective transclusion== | ||
{{shortcut| | {{shortcut|SW:SELECTIVETRANSCLUSION|SW:SELTRANS}} | ||
{{See also|Template:Excerpt|Template:Transcluded section}} | {{See also|Template:Excerpt|Template:Transcluded section}} | ||
''Selective transclusion'' is the process of [[#Partial transclusion|partially transcluding]] one selected section of a document that has more than one transcludable section. As noted above, if only one section of a document is to be transcluded, this can be done by simply surrounding the section of interest with <code><nowiki><onlyinclude> … </onlyinclude></nowiki></code> tags, and transcluding the whole page. However, to selectively transclude one section from a template or document into one page, and another section from the same template or document into a second page and/or a different section of the same page, requires a way to: | ''Selective transclusion'' is the process of [[#Partial transclusion|partially transcluding]] one selected section of a document that has more than one transcludable section. As noted above, if only one section of a document is to be transcluded, this can be done by simply surrounding the section of interest with <code><nowiki><onlyinclude> … </onlyinclude></nowiki></code> tags, and transcluding the whole page. However, to selectively transclude one section from a template or document into one page, and another section from the same template or document into a second page and/or a different section of the same page, requires a way to: | ||
| Line 208: | Line 208: | ||
===Using the labeled section method=== | ===Using the labeled section method=== | ||
{{main|Help:Labeled section transclusion}} | {{main|Help:Labeled section transclusion}} | ||
Labeled-section selective transclusion uses the [[ | Labeled-section selective transclusion uses the [[SW:PF|parser function]]s listed in [[mw:Extension:Labeled Section Transclusion]], which are enabled on all Wikimedia wikis, to selectively transclude content. See [[Help:Labeled section transclusion]] for how labeled section transclusion works. | ||
===Parametrization method=== | ===Parametrization method=== | ||
| Line 229: | Line 229: | ||
=====Example===== | =====Example===== | ||
If we want to make the "Principal Criteria" and "Common Name" sections of [[ | If we want to make the "Principal Criteria" and "Common Name" sections of [[SW:TITLE]] be independently transcludable, we edit the SW:TITLE page and enclose the "Principal Criteria" section as follows: | ||
<syntaxhighlight lang="xml+smarty"> | <syntaxhighlight lang="xml+smarty"> | ||
<onlyinclude>{{#ifeq:{{{transcludesection|principalcriteria}}}|principalcriteria| | <onlyinclude>{{#ifeq:{{{transcludesection|principalcriteria}}}|principalcriteria| | ||
| Line 246: | Line 246: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Then, to transclude the "Principal Criteria" section into another page, we insert into that page: | Then, to transclude the "Principal Criteria" section into another page, we insert into that page: | ||
:<code><nowiki>{{ | :<code><nowiki>{{SW:TITLE|transcludesection=principalcriteria}}</nowiki></code> | ||
To transclude the "Common Name" section into another page, we insert into that page: | To transclude the "Common Name" section into another page, we insert into that page: | ||
:<code><nowiki>{{ | :<code><nowiki>{{SW:TITLE|transcludesection=commonname}}</nowiki></code> | ||
Of course, the same page can transclude two or more sections this way by including multiple such lines. | Of course, the same page can transclude two or more sections this way by including multiple such lines. | ||
| Line 266: | Line 266: | ||
If there is a wikilink to the parent article in the lead section of the sub-article, replacing the wikilink to the parent article with a {{tlx|no selflink}} template will ensure that it is wikilinked in the sub-article's lead but not in the transclusion to the parent article. In other words: | If there is a wikilink to the parent article in the lead section of the sub-article, replacing the wikilink to the parent article with a {{tlx|no selflink}} template will ensure that it is wikilinked in the sub-article's lead but not in the transclusion to the parent article. In other words: | ||
# If the wikilink to the parent article is not a [[ | # If the wikilink to the parent article is not a [[SW:Piped link]], replace <code>[[{{var|PARENT_ARTICLE}}]]</code> with {{tnull|no selflink|{{var|PARENT_ARTICLE}}}} in the sub-article's lead | ||
# If the [[Stiles.casa Wiki:Piped link|wikilink to the parent article includes a pipe (e.g., this link)]], replace <code>[[{{var|PARENT_ARTICLE}}|{{var|Piped link wikitext}}]]</code> with {{tnull|No selflink|{{var|PARENT_ARTICLE}}|{{var|Piped link wikitext}}}} in the sub-article's lead | # If the [[Stiles.casa Wiki:Piped link|wikilink to the parent article includes a pipe (e.g., this link)]], replace <code>[[{{var|PARENT_ARTICLE}}|{{var|Piped link wikitext}}]]</code> with {{tnull|No selflink|{{var|PARENT_ARTICLE}}|{{var|Piped link wikitext}}}} in the sub-article's lead | ||
| Line 277: | Line 277: | ||
*Excerpts break the link between article code and article output. | *Excerpts break the link between article code and article output. | ||
*Changes made to transcluded content often do not appear in watchlists, resulting in unseen changes on the target page. | *Changes made to transcluded content often do not appear in watchlists, resulting in unseen changes on the target page. | ||
*{{tl|excerpt}} and related templates may require using {{tag|noinclude|o}}, {{tag|includeonly|o}} and {{tag|onlyinclude|o}} markup at the transcluded page to have [[ | *{{tl|excerpt}} and related templates may require using {{tag|noinclude|o}}, {{tag|includeonly|o}} and {{tag|onlyinclude|o}} markup at the transcluded page to have [[SW:SELECTIVETRANSCLUSION|selective content]]; that would require monitoring that the markup is sustained. | ||
*Excerpts cause editors to monitor transcluded pages for "section heading" changes to ensure transclusion continues to work. | *Excerpts cause editors to monitor transcluded pages for "section heading" changes to ensure transclusion continues to work. | ||
*Transcluded text may cause [[MOS:REFLINK|repeated links]] and [[Help:Cite errors/Cite error references no text|no-text cite errors]]. | *Transcluded text may cause [[MOS:REFLINK|repeated links]] and [[Help:Cite errors/Cite error references no text|no-text cite errors]]. | ||
*Transcluded text may have different [[ | *Transcluded text may have different [[SW:CITEVAR|established reference styles]], [[MOS:ENGVAR|varieties of English]] or [[SW:DATERET|date formats]] than the target page. | ||
*Transclusions do not reflect [[Stiles.casa Wiki:Protection policy|protection levels]], resulting in transcluded text perhaps having a different [[ | *Transclusions do not reflect [[Stiles.casa Wiki:Protection policy|protection levels]], resulting in transcluded text perhaps having a different [[SW:PPLIST|level of protection]] than the target page. | ||
*Excerpts can result in content discussions [[ | *Excerpts can result in content discussions [[SW:CROSS-POST|over multiple talk pages]] that may have different considerations or objectives for readers. | ||
==Special pages== | ==Special pages== | ||
| Line 324: | Line 324: | ||
** [[mw:Help:Template]]: a simple introduction at MediaWiki. | ** [[mw:Help:Template]]: a simple introduction at MediaWiki. | ||
* [[Stiles.casa Wiki:Template index]]: a directory of available templates. | * [[Stiles.casa Wiki:Template index]]: a directory of available templates. | ||
* [[Stiles.casa Wiki:Template namespace]]: about the template [[ | * [[Stiles.casa Wiki:Template namespace]]: about the template [[SW:Namespace|namespace]]. | ||
* [[Stiles.casa Wiki:Template limits]]: limitations to complexity of pages. | * [[Stiles.casa Wiki:Template limits]]: limitations to complexity of pages. | ||