View source for Template:Broader/doc

{{documentation subpage}}
{{tsh|more}}
{{lua|Module:Broader}}

This template is used to make summary style explicit. It looks like this:

{{broader|Laboratory informatics}}

It is used in sections for which there is also a separate article on the subject.

== Usage ==

; Basic usage:
 &#123;{broader|''article''}}

; With a topic:
 &#123;{broader|''article''|''topic''}}

; All parameters:
 &#123;{broader|''article''|''topic''|selfref=''yes''|category=''no''}}

== Parameters ==

This template accepts the following parameters:
* <code>1</code> - the page to link to (required). Categories and files are automatically escaped with the [[Help:Colon trick|colon trick]], and links to sections are automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''.
* <code>2</code> - the name of the topic. If this is not specified, the text "this topic" is used.
* <code>selfref</code> - if set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references to LIMSwiki. See [[Template:Selfref]] for more information.
* <code>category</code> - if set to "no", "n", "false", or "0", suppresses the error tracking category ([[:Category:Hatnote templates with errors]]). This only has an effect if the first positional parameter (the page to link to) is omitted.

== Examples ==

* <code><nowiki>{{broaderLaboratory informatics}}</nowiki></code> &rarr; {{broader|Laboratory informatics}}
* <code><nowiki>{{broader|Laboratory informatics|the application of technology to labs}}</nowiki></code> &rarr; {{broader|Laboratory informatics|the application of technology to labs}}

== Errors ==

If no page name is supplied, the template will output the following message:
* {{broader|category=no}}

If you see this error message, it is for one of four reasons:
# No parameters were specified (the template code was <code><nowiki>{{broader}}</nowiki></code>). Please use <code><nowiki>{{broader|</nowiki>''page''<nowiki>}}</nowiki></code> instead.
# Some parameters were specified, but the page name wasn't included. For example, the template text <code><nowiki>{{broader|selfref=yes}}</nowiki></code> will produce this error. Please use (for example) <code><nowiki>{{broader|</nowiki>''page''<nowiki>|selfref=yes}}</nowiki></code> instead.
# The page name was specified, but it contains an equals sign ("="). The equals sign has a special meaning in template code, and because of this it cannot be used in template parameters that do not specify a parameter name. For example, the template code <code><nowiki>{{broader|2+2=4}}</nowiki></code> will produce this error. To work around this, you can specify the parameter name explictly by using <code>1=</code> before the page name, like this: <code><nowiki>{{broader|1=2+2=4}}</nowiki></code>.
# You tried to access [[Module:Broader]] directly by using <code><nowiki>{{#invoke:broader|broader|</nowiki>''text''<nowiki>}}</nowiki></code>. Use of #invoke in this way has been disabled for performance reasons. Please use <code><nowiki>{{broader|</nowiki>''text''<nowiki>}}</nowiki></code> instead.

If you see this error message and are unsure of what to do, please post a message on [[WP:HD|the help desk]], and someone should be able to help you.

Pages that contain this error message are tracked in [[:Category:Hatnote templates with errors]].

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories go here and interwikis go in Wikidata. -->
[[Category:Cross-reference templates|{{PAGENAME}}]]
[[Category:LIMSwiki page-section templates|{{PAGENAME}}]]
[[Category:Exclude in print|{{PAGENAME}}]]
[[Category:Hatnote templates]]

}}</includeonly>