Template:Onlyinclude/doc
This is a documentation subpage for Template:Onlyinclude. It may contain usage information, categories and other content that is not part of the original template page. |
This template should always be substituted (i.e., use {{subst:Onlyinclude}} ). |
This is a convenience template for inserting a selective transclusion clause, as described at WP:Transclusion. It can be used to include a part of a source document from any other target document by providing a unique keyword.
By substituting this template in the source document (see Usage below), the following will be inserted:
<onlyinclude>{{#ifeq:{{{1|keyword}}}|keyword|text to be included}}</onlyinclude>
When the source document is viewed, the text to be included will be displayed regardless of the <onlyinclude>
tags.
To display the text to be included in a target document, the source document should be transcluded along with the keyword (see below).
Usage
[edit]Source document
[edit]At the source document, use the following:
{{subst:onlyinclude|id=keyword|text to be included}}
where
- keyword is a unique keyword used for referring to the text to be included;
- text to be included is the text that will be included in the target document when the source document is transcluded along with the keyword.
Note that this template must be substituted! (subst:
)
Target document
[edit]To transclude the text to be included from the source document into the target document, use the following:
{{:PAGENAME|keyword}}
where
PAGENAME
is the name of the source document (in article namespace);- keyword is the unique keyword as used in the source document.
Example
[edit]Source document
[edit]Let's assume the name of the source document is "Some City".
The following is inserted when this document is being edited:
{{subst:onlyinclude|id=population|151,853}}
Which will be substituted in the document's source by:
<onlyinclude>{{#ifeq:{{{1|population}}}|population|151,853}}</onlyinclude>
When viewing the source document, it will display:
- 151,853
Target document
[edit]The following is inserted in a target document:
{{:Some City|population}}
When viewing the target document, it will display:
- 151,853
See also
[edit]- {{noinclude}}
- {{includeonly}}
- Help:Template § Noinclude, includeonly, and onlyinclude
- WP:Transclusion § Selective transclusion
- Help:Metatemplating
- Template:dtag
- Template:eval
- Template:includeonly, Template:noinclude, Template:onlyinclude, and Template:nowiki
- Template:sibling
- Template:TEMPLATENAME and Template:TEMPLATENAMEE
- Template:!
- Template:=
- Template:(( and Template:))
- Template:((( and Template:)))