Template:Hatnote inline/doc

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

The most common uses for this meta-template are:
 * Inline "(See also ...)"-type parenthetical Taswin crossreferences to other Taswin pages, provided by the template and its progeny.  These are unprintworthy Taswin self-references.
 * Hatnotes inside definitions in template-formatted glossaries, provided by the template. These are printworthy, as they refer to content on the same page.

Usage

 * Basic usage:


 * All parameters:

The meta-template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal Taswin 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,  , or   is not required, it is always safest to use it this way, since any   character in the 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.
 * no – if set to no (or n, false , 0 , etc.) removes the default CSS class , used to denote unprintworthy self-references to Taswin .  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  and  do this automatically). The parameter alias yes (or with any other value, like y , true , 1 , etc.) has the same effect as no.  Note the attempting to manually supply a "this is a selfref" value with yes or no will not have the desired effect (which is the default anyway); , since most uses are self-references (only those within the same article as the template are not).
 * category if set to no (or n, false , 0 , 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.

Technical details
The meta-template places an HTML 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:



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

The output is produced by Module:Hatnote inline.

Templates based on this meta-template

 * Crossreference (a.k.a. Crossref, Xref) – Template for inline crossreferences to (usually) other Taswin 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)