View source for Template:Onlyinclude/doc

{{Documentation subpage}}
<!-- Categories and interwikis go at the bottom of this page. -->
{{subst only}}

This is a convenience template for inserting a selective transclusion clause, as described at [[WP:Transclusion#Selective transclusion|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|Usage]] below), the following will be inserted:
{{Pre|&lt;onlyinclude&gt;{{((}}#ifeq:{{((}}{1|''keyword''}{{))}}|''keyword''|''text to be included''{{))}}&lt;/onlyinclude&gt;}}

When the source document is viewed, the ''text to be included'' will be displayed regardless of the <code>&lt;onlyinclude&gt;</code> 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 ==

=== Source document ===

At the source document, use the following:
{{Pre|{{((}}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'''! (<code>subst:</code>)

=== Target document ===

To transclude the ''text to be included'' from the source document into the target document, use the following:
{{Pre|{{((}}:PAGENAME|''keyword''{{))}}}}
where
*<code>PAGENAME</code> is the name of the source document (in [[Wikipedia:Main namespace|article namespace]]);
*''keyword'' is the unique keyword as used in the source document.

== Example ==

=== Source document ===

Let's assume the name of the source document is "Some City".

The following is inserted when this document is being edited:
:<code>{{((}}subst:onlyinclude|id{{=}}population|151,853{{))}}</code>

Which will be substituted in the document's source by:
:<code>&lt;onlyinclude&gt;{{((}}#ifeq:{{((}}{1|population}{{))}}|population|151,853{{))}}&lt;/onlyinclude&gt;</code>

When viewing the source document, it will display:
:151,853

=== Target document ===

The following is inserted in a target document:
:<code>{{((}}:Some City|population{{))}}</code>

When viewing the target document, it will display:
:151,853

== See also ==

*{{tl|noinclude}}
*{{tl|includeonly}}
*{{slink|Help:Template#Noinclude, includeonly, and onlyinclude}}
*{{slink|WP:Transclusion#Selective transclusion}}
{{User:Zenexer/Templates/Metatemplate doc|links}}

<includeonly>
<!-- Categories and interwikis go here: -->
[[Category:Wikipedia metatemplates]]
</includeonly>