Template:Hatnote/doc - Revision history

Matt at 22:11, 9 April 2025

2025-04-09T22:11:01Z

← Older revision		Revision as of 18:11, 9 April 2025
Line 1:		Line 1:
	{{wikipedia\|page name}}		{{wikipedia\|page name}}
	{{Documentation subpage}}		{{Documentation subpage}}
	~~{{used in system}}~~
	{{Lua\|Module:Hatnote}}		{{Lua\|Module:Hatnote}}

Matt at 13:44, 9 April 2025

2025-04-09T13:44:36Z

← Older revision		Revision as of 09:44, 9 April 2025
Line 10:		Line 10:
	Broadly speaking, a hatnote should answer a reader's question (maybe preemptively): ''Am I on the right page?''		Broadly speaking, a hatnote should answer a reader's question (maybe preemptively): ''Am I on the right page?''

	~~{{TOC limit}}~~

	== Function ==		== Function ==

Matt at 13:26, 9 April 2025

2025-04-09T13:26:53Z

← Older revision		Revision as of 09:26, 9 April 2025
Line 2:		Line 2:
	{{Documentation subpage}}		{{Documentation subpage}}
	{{used in system}}		{{used in system}}
	~~{{Never substitute}}~~
	{{Lua\|Module:Hatnote}}		{{Lua\|Module:Hatnote}}

Matt at 13:22, 9 April 2025

2025-04-09T13:22:01Z

← Older revision		Revision as of 09:22, 9 April 2025
Line 16:		Line 16:
	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.		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.

	This template is also used as the "meta-template" for additional specialized disambiguation link templates; see ~~[[:Category:Hatnote templates]]~~ for a list.		This template is also used as the "meta-template" for additional specialized disambiguation link templates; see 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:Cheatsheet\|~~Wikipedia markup]].		The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal Wikipedia markup.

	== Usage ==		== Usage ==
Line 32:		Line 32:
	* <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>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>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.		* <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.

	== Example ==		== Example ==
Line 49:		Line 49:
	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.		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]].		Pages that contain this error message are tracked in :Category:Hatnote templates with errors.

	== Technical details ==		== Technical details ==
Line 58:		Line 58:
	The code is produced by Module:Hatnote.		The code is produced by Module:Hatnote.

	~~==See also==~~
	* {{tl\|For}}

	~~{{Hatnote templates}}~~
	{{Collapse top\|[[Wikipedia:TemplateData\|TemplateData]] documentation used by [[Wikipedia:VisualEditor\|VisualEditor]] and other tools}}		{{Collapse top\|[[Wikipedia:TemplateData\|TemplateData]] documentation used by [[Wikipedia:VisualEditor\|VisualEditor]] and other tools}}
	{{TemplateData header\|noheader=1}}		{{TemplateData header\|noheader=1}}

Matt at 10:54, 9 April 2025

2025-04-09T10:54:08Z

← Older revision		Revision as of 06:54, 9 April 2025
Line 3:		Line 3:
	{{used in system}}		{{used in system}}
	{{Never substitute}}		{{Never substitute}}
	~~{{Template redirect\|Dablink}}~~
	{{Lua\|Module:Hatnote}}		{{Lua\|Module:Hatnote}}

Matt at 10:51, 9 April 2025

2025-04-09T10:51:57Z

← Older revision		Revision as of 06:51, 9 April 2025
Line 1:		Line 1:
	{{wikipedia\|page name}}		{{wikipedia\|page name}}
	{{Documentation subpage}}		{{Documentation subpage}}
	~~{{Redirect\|Template:Dablink\|the maintenance template\|Template:Dablinks}}~~
	{{used in system}}		{{used in system}}
	{{Never substitute}}		{{Never substitute}}

Matt at 07:56, 9 April 2025

2025-04-09T07:56:48Z

← Older revision		Revision as of 03:56, 9 April 2025
Line 8:		Line 8:

	This template produces formatted text, following the guideline for a '''[[Wikipedia:Hatnote\|Wikipedia hatnote]]''':		This template produces formatted text, following the guideline for a '''[[Wikipedia:Hatnote\|Wikipedia hatnote]]''':
	:~~{{tji\|Hatnote\|Example hatnote text.}}~~ →<br><!-- a construct to show hatnote as expected (using newline) -->		: →<br><!-- a construct to show hatnote as expected (using newline) -->
	{{Hatnote\|Example hatnote text.}}		{{Hatnote\|Example hatnote text.}}

Line 24:		Line 24:
	== Usage ==		== Usage ==
	; Basic usage:		; Basic usage:
	: ~~{{tji\|hatnote\|text}}~~		:

	; All parameters:		; All parameters:
	: ~~{{tji\|hatnote\|text\|extraclasses:extra classes\|selfref:yes\|category:no}}~~		:

	== Parameters ==		== Parameters ==
Line 37:		Line 37:

	== Example ==		== Example ==
	* ~~{{tji\|hatnote\|Example hatnote text}}~~ → {{hatnote\|Example hatnote text}}		* → {{hatnote\|Example hatnote text}}

	== Errors ==		== Errors ==

Matt at 20:36, 6 April 2025

2025-04-06T20:36:13Z

Matt at 21:10, 5 March 2025

2025-03-05T21:10:50Z

← Older revision		Revision as of 17:10, 5 March 2025
Line 1:		Line 1:
			{{wikipedia\|page name}}
	{{Documentation subpage}}		{{Documentation subpage}}
	{{Redirect\|Template:Dablink\|the maintenance template\|Template:Dablinks}}		{{Redirect\|Template:Dablink\|the maintenance template\|Template:Dablinks}}

Matt: Protected "Template:Hatnote/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2025-03-05T19:57:30Z

Protected "Template:Hatnote/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision	Revision as of 15:57, 5 March 2025
(No difference)

← Older revision		Revision as of 16:36, 6 April 2025
Line 33:		Line 33:
	* <code>1</code> – the hatnote text (required)		* <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>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>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.		* <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.

Line 47:		Line 47:
	# 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.		# 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>.		# 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.		# 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.

	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.		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]].		Pages that contain this error message are tracked in [[:Category:Hatnote templates with errors]].
Line 58:		Line 58:
	* {{tag\|div\|attribs=role="note" class="hatnote navigation-not-searchable"\|link=yes\|content= hatnote text}}		* {{tag\|div\|attribs=role="note" class="hatnote navigation-not-searchable"\|link=yes\|content= hatnote text}}

	The code is produced by [[Module:Hatnote]].		The code is produced by Module:Hatnote.

	==See also==		==See also==