Template:Ghat/doc

Usage

This template is used in template-structured glossaries with the {{defn}} template to provide an explanatory hatnote for a {{term}}. It can also be used in manually coded HTML description lists.

Important:

• It must be used at the top of, i.e. inside, a {{defn}} (or manual <dd>...</dd> markup) that pertains to the {{term}}, usually at the top of the first one unless it only pertains to a specific definition.
• It cannot be used between the {{term}} and {{defn}} (i.e., between </dt> and <dd>), or inside {{term|content=...}} (<dt>...</dt>), or it will break the glossary (description list) markup.

Inline (e.g. {{Crossreference}}) or after-content (e.g. {{More}}) note templates can be used inside definitions normally. The purpose of this template is prevent the excessive indentation of hatnotes at the top of the definition.

This template is not for inline crossreferences to other pages, or other forms of Wikipedia self-reference. For those, use {{crossreference}}. (This template does not use the CSS class selfref.)

When used with a multi-definition term, the definition in which the {{ghat}} appears must be manually numbered (usually 1  ..., as shown in the example below).

Example

{{glossary}}
{{term| colour ball |colour ball {{anchor|coloured ball|coloured balls|colour|colours|color ball}}}}
{{defn|1=
{{ghat|Also '''coloured ball(s)''', '''colour(s)'''; American spelling '''color''' sometimes also used.}}
1.  In [[snooker]], any of the {{cuegloss|object ball|object balls}} that are not {{cuegloss|red ball|reds}}.
}}
{{defn |no=2 |1=
In [[Blackball (pool)|blackball]], a generic, collective term for the red and yellow {{cuegloss|group|groups}} of object balls.
{{glossary end}}

Results in:

colour ball

Also coloured ball(s), colour(s); American spelling color sometimes also used.

1.  In snooker, any of the object balls that are not reds.

2.  In blackball, a generic, collective term for the red and yellow groups of object balls.

See also

• {{glossary}} a.k.a. {{glossary start}} or {{glossary begin}} – Half of a template pair; uses <dl> with a class to open the structured glossary definition list that {{glossary end}} closes.
• {{glossary end}} – The other half of this template pair; uses </dl> to close the definition list that {{glossary}} opens.
• {{term}} – The glossary term to which the {{defn}} definition applies; a customized <dt> with a class and an embedded <dfn>.
• {{defn}} – The definition that applies to the {{term}}; uses <dd> with a class
• {{ghat}} – a hatnote template properly formatted for the top of a {{defn}} definition
• {{glossary link}} – meta-template for creating shortcut templates for linking to definitions in specific glossaries
• Wikipedia:Manual of Style/Glossaries