Difference between revisions of "Module:Hatnote/doc"

From blackwiki
Jump to navigation Jump to search
m (44 revisions imported)
 
(56 intermediate revisions by 37 users not shown)
Line 1: Line 1:
{{high-risk|802,000+}}
+
{{Documentation subpage}}
 +
{{High-use| 369726 }}
 +
{{lua|Module:Hatnote}}
  
This is a meta-module that provides various functions for making hatnotes. It implements the {{tl|hatnote}} template, for use in hatnotes at the top of pages, and the {{tl|format link}} template, which is used to format a wikilink for use in hatnotes. It also contains a number of helper functions for use in other Lua hatnote modules.
+
This template produces formatted text, following the guideline for a '''[[WP:HATNOTE|Wikipedia hatnote]]'''.
 +
:<code><nowiki>{{hatnote|Example hatnote text.}}</nowiki></code> &rarr;<br><!-- a construct to show hatnote as expected (using newline) -->
 +
{{hatnote|Example hatnote text.}}
  
== Use from wikitext ==
+
Broadly speaking, a hatnote should answer a reader's question (maybe preemptively): ''Am I on the right page?''
  
The functions in this module cannot be used directly from #invoke, and must be used through templates instead. Please see [[Template:Hatnote]] and [[Template:Format link]] for documentation.
+
{{TOC limit}}
  
== Use from other Lua modules ==
+
== Function ==
 +
This template is primarily used to add a correctly formatted ''hatnote'' to a page. Often, but not always, this is a ''disambiguation link'' at the top of article pages. It places an HTML <code>div-</code> / <code>div</code> block around the text entered as its only argument, which provides standardized formatting (contents are indented and italicized in most displays); it also isolates the contained code to make sure that it is interpreted correctly.
  
To load this module from another Lua module, use the following code.
+
This template is also used as the "meta-template" for additional specialized disambiguation link templates; see [[:Category:Hatnote templates]] for a list.
  
<source lang="lua">
+
The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal [[Wikipedia:Cheatsheet|Wikipedia markup]].
local mHatnote = require('Module:Hatnote')
 
</source>
 
  
You can then use the functions as documented below.
+
== Usage ==
 +
; Basic usage:
 +
&#123;{hatnote|''text''}}
  
=== Hatnote ===
+
; All parameters:
 +
&#123;{hatnote|''text''|extraclasses=''extra classes''|selfref=''yes''|category=''no''}}
  
<source lang="lua">
+
== Parameters ==
mHatnote._hatnote(s, options)
+
This template accepts the following parameters:
</source>
+
* <code>1</code> – the hatnote text (required)
 +
* <code>extraclasses</code> – any extra CSS classes to be added, for example, the {{tl|see also}} template adds the classes "{{para|extraclasses|boilerplate seealso}}".
 +
* <code>selfref</code> – If set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references to Wikipedia. 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 has an effect only if the <!--"first-positional parameter", not "first positional parameter", if you value the readers' time ... but better yet --> leftmost parameter (the hatnote text) is omitted.
  
Formats the string <var>s</var> as a hatnote. This encloses <var>s</var> in the tags {{tag|div|params=class="hatnote"}}. Options are provided in the <var>options</var> table. Options include:
+
== Example ==
* <var>options.extraclasses</var> - a string of extra classes to provide
+
* <code><nowiki>{{hatnote|Example hatnote text}}</nowiki></code> → {{hatnote|Example hatnote text}}
* <var>options.selfref</var> - if this is not nil or false, adds the class "selfref", used to denote self-references to Wikipedia (see [[Template:Selfref]]))
 
The CSS of the hatnote class is defined in [[MediaWiki:Common.css]].
 
  
; Example 1
+
== Errors ==
 +
If no hatnote text is supplied, the template will output the following message:
 +
* {{hatnote|category=no}}
  
<source lang="lua">
+
If you see this error message, it is for one of four reasons:
mHatnote._hatnote('This is a hatnote.')
+
# No parameters were specified (the template code was <code><nowiki>{{hatnote}}</nowiki></code>). Please use <code><nowiki>{{hatnote|</nowiki>''text''<nowiki>}}</nowiki></code> instead.
</source>
+
# Some parameters were specified, but the hatnote text wasn't included. For example, the template text <code><nowiki>{{hatnote|extraclasses=seealso}}</nowiki></code> will produce this error. Please use (for example) <code><nowiki>{{hatnote|</nowiki>''text''<nowiki>|extraclasses=seealso}}</nowiki></code> instead.
 +
# The hatnote text was specified, but that text 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>{{hatnote|2+2=4}}</nowiki></code> will produce this error. To work around this, you can specify the parameter name explicitly by using <code>1=</code> before the hatnote text, like this: <code><nowiki>{{hatnote|1=2+2=4}}</nowiki></code>.
 +
# You tried to access [[Module:Hatnote]] directly by using <code><nowiki>{{#invoke:hatnote|hatnote|</nowiki>''text''<nowiki>}}</nowiki></code>. Use of #invoke in this way has been disabled for performance reasons. Please use <code><nowiki>{{hatnote|</nowiki>''text''<nowiki>}}</nowiki></code> instead.
  
Produces:
+
If you see this error message and are unsure of what to do, please post a message on [[Template talk:Hatnote]], and someone should be able to help you.
{{tag|div|content=This is a hatnote.|params=class="hatnote"}}
 
  
Displays as:
+
Pages that contain this error message are tracked in [[:Category:Hatnote templates with errors]].
{{hatnote|This is a hatnote.}}
 
  
; Example 2
+
== Technical details ==
 +
The HTML code produced by this template looks like this:
  
<source lang="lua">
+
* {{tag|div|attribs=role="note" class="hatnote"|link=yes|content= hatnote text}}
mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true})
 
</source>
 
  
Produces:
+
The code is produced by [[Module:Hatnote]].
{{tag|div|content=This is a hatnote.|params=class="hatnote boilerplate seealso selfref"}}
 
  
Displayed as:
+
==See also==
{{hatnote|This is a hatnote.|extraclasses=boilerplate seealso|selfref=true}}
+
* {{tl|For}}
 
 
=== Format link ===
 
 
 
<source lang="lua">
 
mHatnote._formatLink(link, display)
 
</source>
 
 
 
Formats <var>link</var> as a wikilink for display in hatnote templates, with optional display value <var>display</var>. 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''.
 
 
 
;Examples:
 
: {{code|mHatnote._formatLink('Lion')|lua}} &rarr; <nowiki>[[Lion]]</nowiki> &rarr; {{format hatnote link|Lion}}
 
: {{code|mHatnote._formatLink('Lion#Etymology')|lua}} &rarr; <nowiki>[[Lion#Etymology|Lion § Etymology]]</nowiki> &rarr; {{format hatnote link|Lion#Etymology}}
 
: {{code|mHatnote._formatLink('Category:Lions')|lua}} &rarr; <nowiki>[[:Category:Lions]]</nowiki> &rarr; {{format hatnote link|Category:Lions}}
 
: {{code|mHatnote._formatLink('Lion#Etymology', 'Etymology of lion')|lua}} &rarr; <nowiki>[[Lion#Etymology|Etymology of lion]]</nowiki> &rarr; {{format hatnote link|Lion#Etymology|Etymology of lion}}
 
 
 
=== Format pages ===
 
 
 
<source lang="lua">
 
mHatnote.formatPages(...)
 
</source>
 
 
 
Formats a list of pages using the [[#Format link|_formatLink]] function, and returns the result as an array. For example, the code {{code|mHatnote.formatPages('Lion', 'Category:Lions', 'Lion#Etymology')|lua}} would produce an array like {{code|{'[[Lion]]', '[[:Category:Lions]]', '[[Lion#Etymology|Lion § Etymology]]'}|lua}}.
 
 
 
=== Format page tables ===
 
 
 
<source lang="lua">
 
mHatnote.formatPageTables(...)
 
</source>
 
 
 
Takes a list of page/display tables, formats them with the [[#Format link|_formatLink]] function, and returns the result as an array. Each item in the list must be a table. The first value in the table is the link, and is required. The second value in the table is the display value, and is optional. For example, the code {{code|mHatnote.formatPages({'Lion', 'the Lion article'}, {'Category:Lions'}, {'Lion#Etymology', 'the etymology of lion'})|lua}} would produce an array like {{code|{'[[Lion|the Lion article]]', '[[:Category:Lions]]', '[[Lion#Etymology|the etymology of lion]]'}|lua}}.
 
 
 
=== Find namespace id ===
 
 
 
<source lang="lua">
 
mHatnote.findNamespaceId(link, removeColon)
 
</source>
 
 
 
Finds the [[WP:NS|namespace id]] of the string <var>link</var>, which should be a valid page name, with or without the section name. This function will not work if the page name is enclosed with square brackets. When trying to parse the namespace name, colons are removed from the start of the link by default. This is helpful if users have specified colons when they are not strictly necessary. If you do not need to check for initial colons, set <var>removeColon</var> to false.
 
 
 
;Examples:
 
: {{code|mHatnote.findNamespaceId('Lion')|lua}} &rarr; 0
 
: {{code|mHatnote.findNamespaceId('Category:Lions')|lua}} &rarr; 14
 
: {{code|mHatnote.findNamespaceId(':Category:Lions')|lua}} &rarr; 14
 
: {{code|mHatnote.findNamespaceId(':Category:Lions', false)|lua}} &rarr; 0 (the namespace is detected as ":Category", rather than "Category")
 
 
 
=== Make wikitext error ===
 
 
 
<source lang="lua">
 
mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)
 
</source>
 
 
 
Formats the string <var>msg</var> as a red wikitext error message, with optional link to a help page <var>helpLink</var>. Normally this function also adds [[:Category:Hatnote templates with errors]]; however, if <var>addTrackingCategory</var> is not false after being passed through [[Module:Yesno]], then the category is suppressed. This means that the category can be suppressed with <var>addTrackingCategory</var> values including "no", "n", 0, "false", and {{code|false|lua}}.
 
 
 
Examples:
 
:{{code|mHatnote.makeWikitextError('an error has occurred')|lua}} &rarr; <strong class="error">Error: an error has occurred.</strong>
 
:{{code|mHatnote.makeWikitextError('an error has occurred', 'Template:Example#Errors')|lua}} &rarr; <strong class="error">Error: an error has occurred ([[Template:Example#Errors|help]]).</strong>
 
 
 
== Examples ==
 
 
 
For examples of how this module is used in other Lua modules, see the following (listed in order of complexity):
 
 
 
* [[Module:Details]]
 
* [[Module:Further]]
 
* [[Module:See also]]
 
* [[Module:Main]]
 
 
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 
<!-- Categories go here and interwikis go in Wikidata. -->
 
  
 +
{{Hatnote templates}}
 +
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
 +
{{TemplateData header|noheader=1}}
 +
<templatedata>
 +
{
 +
  "description": "Template for creating a standard Wikipedia hatnote. A hatnote is a short note placed at the top of an article to provide disambiguation of closely related terms or summarise a topic, explaining its boundaries.",
 +
  "params": {
 +
    "1": {
 +
      "label": "Text",
 +
      "description": "This field should contain the text that will be displayed in the hatnote.",
 +
      "type": "string",
 +
      "required": true
 +
    },
 +
    "extraclasses": {
 +
      "type": "string/line",
 +
      "label": "Extra classes",
 +
      "description": "Extra CSS classes to be added to the <div> tags surrounding the hatnote text."
 +
    },
 +
    "selfref": {
 +
      "type": "string/line",
 +
      "label": "Self reference",
 +
      "description": "Set to \"yes\" if the hatnote text is a self-reference to Wikipedia that would not make sense on mirrors or forks of the Wikipedia site. (E.g. \"For the Wikipedia Sandbox, see [[WP:SAND]]\".)"
 +
    },
 +
    "category": {
 +
      "label": "Category",
 +
      "description": "Set to \"no\", \"n\", \"false\", or \"0\" to suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if the hatnote text is omitted."
 +
    }
 +
  }
 +
}
 +
</templatedata>
 +
{{Collapse bottom}}<includeonly>{{Sandbox other||
 +
[[Category:Hatnote templates| ]]
 +
[[Category:Cross-reference templates]]
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 09:51, 21 September 2020

This template produces formatted text, following the guideline for a Wikipedia hatnote.

{{hatnote|Example hatnote text.}}

Broadly speaking, a hatnote should answer a reader's question (maybe preemptively): Am I on the right page?

Function

This template is primarily used to add a correctly formatted hatnote to a page. Often, but not always, this is a disambiguation link at the top of article pages. It places an HTML div- / div block around the text entered as its only argument, which provides standardized formatting (contents are indented and italicized in most displays); it also isolates the contained code to make sure that it is interpreted correctly.

This template is also used as the "meta-template" for additional specialized disambiguation link templates; see Category:Hatnote templates for a list.

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

Usage

Basic usage
{{hatnote|text}}
All parameters
{{hatnote|text|extraclasses=extra classes|selfref=yes|category=no}}

Parameters

This template accepts the following parameters:

  • 1 – the hatnote text (required)
  • extraclasses – any extra CSS classes to be added, for example, the {{see also}} template adds the classes "|extraclasses=boilerplate seealso".
  • selfref – If set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references to Wikipedia. See Template:Selfref for more information.
  • category – If set to "no", "n", "false", or "0", suppresses the error tracking category (Category:Hatnote templates with errors). This has an effect only if the leftmost parameter (the hatnote text) is omitted.

Example

  • {{hatnote|Example hatnote text}}

Errors

If no hatnote text is supplied, the template will output the following message:

  • Error: no text specified (help).

If you see this error message, it is for one of four reasons:

  1. No parameters were specified (the template code was {{hatnote}}). Please use {{hatnote|text}} instead.
  2. Some parameters were specified, but the hatnote text wasn't included. For example, the template text {{hatnote|extraclasses=seealso}} will produce this error. Please use (for example) {{hatnote|text|extraclasses=seealso}} instead.
  3. The hatnote text was specified, but that text 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 {{hatnote|2+2=4}} will produce this error. To work around this, you can specify the parameter name explicitly by using 1= before the hatnote text, like this: {{hatnote|1=2+2=4}}.
  4. You tried to access Module:Hatnote directly by using {{#invoke:hatnote|hatnote|text}}. Use of #invoke in this way has been disabled for performance reasons. Please use {{hatnote|text}} instead.

If you see this error message and are unsure of what to do, please post a message on Template talk:Hatnote, and someone should be able to help you.

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

Technical details

The HTML code produced by this template looks like this:

  • <div role="note" class="hatnote">hatnote text</div>

The code is produced by Module:Hatnote.

See also

TemplateData documentation used by VisualEditor and other tools
See the monthly parameter usage report for this template.

TemplateData for Hatnote

Template for creating a standard Wikipedia hatnote. A hatnote is a short note placed at the top of an article to provide disambiguation of closely related terms or summarise a topic, explaining its boundaries.

Template parameters

ParameterDescriptionTypeStatus
Text1

This field should contain the text that will be displayed in the hatnote.

Stringrequired
Extra classesextraclasses

Extra CSS classes to be added to the <div> tags surrounding the hatnote text.

Lineoptional
Self referenceselfref

Set to "yes" if the hatnote text is a self-reference to Wikipedia that would not make sense on mirrors or forks of the Wikipedia site. (E.g. "For the Wikipedia Sandbox, see [[WP:SAND]]".)

Lineoptional
Categorycategory

Set to "no", "n", "false", or "0" to suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if the hatnote text is omitted.

Unknownoptional