Template:Hatnote inline/doc

For the template to make multiple hatnotes appear on the same line, see Template:Hatnote group.

The {{Hatnote inline}} meta-template formats text into a standardized style for an inline (not block-level) variant of a Wikipedia:Hatnote, a short note placed at the point of insertion, to link to more information or otherwise cross-reference another Wikipedia page. like this: Example inline hatnote text.

The most common uses for this meta-template are:

• Inline "(See also ...)"-type parenthetical Wikipedia crossreferences to other Wikipedia pages, provided by the {{crossreference}} template and its progeny. These are unprintworthy Wikipedia self-references.
• Hatnotes inside definitions in template-formatted glossaries, provided by the {{ghat}} template. These are printworthy, as they refer to content on the same page.

Usage

Basic usage

{{hatnote inline|Template:Var}}

All parameters

{{hatnote inline|Template:Var|extraclasses=Template:Var|selfref=yes|category=no}}

The meta-template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal Wikipedia markup.

Parameters

This template accepts the following parameters:

• |1= or |text= or |content= – The inline hatnote's text (required). While the explicit naming of this parameter with |1=, |text=, or |content= is not required, it is always safest to use it this way, since any Template:Kbd character in the input text will break the template if the parameter is unnamed.
• |class= or |extraclasses= – Any extra CSS classes to be added. This should not normally be used.
• |selfref=no – If set to Template:Kbd (or Template:Kbd, Template:Kbd, Template:Kbd, etc.) removes the default CSS class selfref, used to denote unprintworthy self-references to Wikipedia Template:Crossref. This option should not be used to indicate a non-selfref on cross-article links, only links within the same article (and the derived shorthand templates {{See above}} and {{See below}} do this automatically). The parameter alias |printworthy=yes (or with any other value, like Template:Kbd, Template:Kbd, Template:Kbd, etc.) has the same effect as |selfref=no. Note that attempting to manually supply a "this is a selfref" value with |selfref=yes or |printworthy=no will not have the desired effect (which is the default anyway); Template:Em, since most uses are self-references (only those within the same article as the template are not). This could actually be fixed by use of {{YesNo}}, but it's maybe more hassle than it's worth.
• |category= – If set to Template:Kbd (or Template:Kbd, Template:Kbd, Template:Kbd, etc.), suppresses the error-tracking category (Category:Hatnote templates with errors). This only has an effect if the first positional parameter (the hatnote text) is omitted. This should not normally be used.
• |inline= – Defaults to Template:Kbd; you never need to set that. If set to Template:Kbd (or Template:Kbd, Template:Kbd, Template:Kbd, etc.), it is a special-use parameter, which turns off the conversion of the Hatnote module code's <div> into a <span>, so it becomes a <div> again. By default, this will simply produce the same output as {{Hatnote}}. The only use for this is when a template using {{Hatnote inline}} as its meta-template (e.g. {{Crossreference}} has WP:TemplateStyles and a custom class that do something different with it in block mode than would happen if it were a regular hatnote (e.g., by removing the hatnote indentation). So, obviously this is not normally used, and it requires setup to use it to do anything practical.

Technical details

The meta-template places an HTML <span>...</span> container around the text entered as its first, required parameter, upon which it provides standardized formatting (italicized in most displays, and only stylistically, not as semantic emphasis); it also uses CSS classes to isolate the contained code to make sure that it is interpreted correctly and can be acted upon independently of true article content.

The HTML code produced by this template looks like this:

• <span class="hatnote">Template:Var</span>

This is the same class used by the <div>-based {{hatnote}} template, the block display of which is controlled by a separate div.hatnote directive in Mediawiki:Common.css.

The output is produced by Module:Hatnote inline.

See also

• Template:Hatnote templates documentation, for all the block-format hatnotes

Templates based on this meta-template

• {{Crossreference}} (a.k.a. {{Crossref}}, {{Xref}}) – Template for inline crossreferences to (usually) other Wikipedia pages (unprintworthy in most cases)
• {{Ghat}} – Hatnote template for use in template-structured glossaries (printworthy)
• {{See above}} and {{See below}} – some more specific templates than {{Crossreference}} for use on same page only (printworthy)