Template:Shortdesc here/doc

When substituted, this template inserts a filled-in {{Short description}} template wrapped in <noinclude> tags. This adds a short description to the page where it is placed, but not to any pages which transclude that page.

By default an explanatory HTML note is also inserted. This can be reworded or omitted if desired.

Usage

For convenience, the alternative name {{Sdhere}} can be used. This documentation assumes you are doing that.

Basic syntax

{{subst:sdhere|The description}}

inserts a short description for the current page only, followed by an HTML note with the default wording. The inserted wikitext is

<noinclude>{{Short description|The description}}</noinclude><!-- For this page only -->

If no description is supplied, or the one supplied is empty, the template inserts nothing.

Optional second parameter

Add |noreplace or |nr after the description text to prevent the inserted description from overriding earlier ones on its page. Any other value has no effect. The value is not case sensitive.

HTML note

By default, the template inserts <!-- For this page only --> after the short description.

• To use a different wording, add |note= followed by the desired text.
• To omit the note altogether, use |note=none.

An empty value for |note= is treated the same as |note=none.

Example

{{subst:sdhere|Documentation for several templates|note=Short descriptions for the actual templates are on their individual pages.}}

adds the short description Documentation for several templates to a documentation page where it is placed, but not to any of the templates that transclude the documentation. The code it inserts is:

<noinclude>{{Short description|Documentation for several templates}}</noinclude><!-- Short descriptions for the actual templates are on their individual pages. -->

See also

• {{Shortdesc there}} or {{sdthere}}: has identical syntax, but adds a short description for transclusion only.