Template:Onlyinclude/doc

This template should always be substituted, i.e. never directly use {{onlyinclude}}, instead 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

Source document

At the source document, use the following:

<onlyinclude>{{subst:onlyinclude|id=keyword|text to be included}}</onlyinclude>

• id 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

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

See Example section at WP