Template:Hatnote/doc - Revision history

Ookami: 158 revisions imported

2020-09-03T04:31:37Z

158 revisions imported

← Older revision	Revision as of 04:31, 3 September 2020
(No difference)

meta>Hildeoc at 10:48, 26 August 2020

2020-08-26T10:48:22Z

← Older revision		Revision as of 10:48, 26 August 2020
Line 19:		Line 19:

	== Usage ==		== Usage ==

	; Basic usage:		; Basic usage:
	{{hatnote\|''text''}}		{{hatnote\|''text''}}
Line 27:		Line 26:

	== Parameters ==		== Parameters ==

	This template accepts the following parameters:		This template accepts the following parameters:
	* <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.

	== Example ==		== Example ==

	* <code><nowiki>{{hatnote\|Example hatnote text}}</nowiki></code> → {{hatnote\|Example hatnote text}}		* <code><nowiki>{{hatnote\|Example hatnote text}}</nowiki></code> → {{hatnote\|Example hatnote text}}

	== Errors ==		== Errors ==

	If no hatnote text is supplied, the template will output the following message:		If no hatnote text is supplied, the template will output the following message:
	* {{hatnote\|category=no}}		* {{hatnote\|category=no}}
Line 54:		Line 50:

	== Technical details ==		== Technical details ==

	The HTML code produced by this template looks like this:		The HTML code produced by this template looks like this:

meta>Skierpage: punctuation

2020-06-29T09:19:17Z

punctuation

← Older revision		Revision as of 09:19, 29 June 2020
Line 7:		Line 7:
	{{hatnote\|Example hatnote text.}}		{{hatnote\|Example hatnote text.}}

	Broadly speaking, a hatnote should answer a ~~readers~~' 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}}		{{TOC limit}}

meta>BoldLuis: /* Technical details */

2020-05-03T12:36:47Z

Technical details

← Older revision		Revision as of 12:36, 3 May 2020
Line 57:		Line 57:
	The HTML code produced by this template looks like this:		The HTML code produced by this template looks like this:

	* ~~<code><nowiki><~~div role="note" class="hatnote"~~></nowiki>''~~hatnote text~~''<nowiki></div></nowiki></code>~~		* {{tag\|div\|attribs=role="note" class="hatnote"\|link=yes\|content= hatnote text}}

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

meta>BoldLuis at 12:28, 3 May 2020

2020-05-03T12:28:17Z

← Older revision		Revision as of 12:28, 3 May 2020
Line 60:		Line 60:

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

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

	{{Hatnote templates}}		{{Hatnote templates}}

meta>Bkonrad: Reverted edits by 99.203.17.87 (talk) to last version by Vanisaac

2020-04-30T19:31:54Z

Reverted edits by 99.203.17.87 (talk) to last version by Vanisaac

← Older revision	Revision as of 19:31, 30 April 2020
Line 1:	Line 1:
		{{Documentation subpage}}
		{{High-use\| 369726 }}
		{{lua\|Module:Hatnote}}

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

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

		{{TOC limit}}

		== 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.

		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:Cheatsheet\|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:
		* <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.

		== Example ==

		* <code><nowiki>{{hatnote\|Example hatnote text}}</nowiki></code> → {{hatnote\|Example hatnote text}}

		== Errors ==

		If no hatnote text is supplied, the template will output the following message:
		* {{hatnote\|category=no}}

		If you see this error message, it is for one of four reasons:
		# No parameters were specified (the template code was <code><nowiki>{{hatnote}}</nowiki></code>). Please use <code><nowiki>{{hatnote\|</nowiki>''text''<nowiki>}}</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>.
		# 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.

		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:

		* <code><nowiki><div role="note" class="hatnote"></nowiki>''hatnote text''<nowiki></div></nowiki></code>

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

		{{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>

99.203.17.87: Fraud

2020-04-30T19:29:19Z

Fraud

← Older revision		Revision as of 19:29, 30 April 2020
Line 1:		Line 1:
	~~{{Documentation subpage}}~~
	~~{{High-use\| 369726 }}~~
	~~{{lua\|Module:Hatnote}}~~

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

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

	~~{{TOC limit}}~~

	~~== 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.

	~~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:Cheatsheet\|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:~~
	* <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.

	~~== Example ==~~

	* <code><nowiki>{{hatnote\|Example hatnote text}}</nowiki></code> → {{hatnote\|Example hatnote text}}

	~~== Errors ==~~

	~~If no hatnote text is supplied, the template will output the following message:~~
	* {{hatnote\|category=no}}

	~~If you see this error message, it is for one of four reasons:~~
	~~# No parameters were specified (the template code was <code><nowiki>{{hatnote}}</nowiki></code>). Please use <code><nowiki>{{hatnote\|</nowiki>''text''<nowiki>}}</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>.
	# 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.~~

	~~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:~~

	* <code><nowiki><div role="note" class="hatnote"></nowiki>''hatnote text''<nowiki></div></nowiki></code>

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

	~~{{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>~~

meta>Vanisaac: /* Technical details */clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other

2020-04-25T16:40:31Z

Technical details: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other

← Older revision		Revision as of 16:40, 25 April 2020
Line 91:		Line 91:
	}		}
	</templatedata>		</templatedata>
	{{Collapse bottom}}<includeonly>{{~~#ifeq:{{SUBPAGENAME}}\|sandbox~~\|\|		{{Collapse bottom}}<includeonly>{{Sandbox other\|\|
	[[Category:Hatnote templates\| ]]		[[Category:Hatnote templates\| ]]
	[[Category:Cross-reference templates]]		[[Category:Cross-reference templates]]
	}}</includeonly>		}}</includeonly>

meta>Uanfala: /* top */ ugh T:HAT isn't any sort of shortcut to speak of

2020-04-16T00:09:45Z

top: ugh T:HAT isn't any sort of shortcut to speak of

← Older revision		Revision as of 00:09, 16 April 2020
Line 1:		Line 1:
	{{Documentation subpage}}		{{Documentation subpage}}
	{{High-use\| 369726 }}		{{High-use\| 369726 }}
	~~{{shortcut\|T:HAT}}~~
	{{lua\|Module:Hatnote}}		{{lua\|Module:Hatnote}}

meta>Ravenpuff: Reverted 1 edit by Desirable.peach (talk) (TW)

2019-07-01T10:30:12Z

Reverted 1 edit by Desirable.peach (talk) (TW)

← Older revision		Revision as of 10:30, 1 July 2019
Line 1:		Line 1:
	~~{{hatnote\|text}}1,~~
	{{Documentation subpage}}		{{Documentation subpage}}
	{{High-use\| 369726 }}		{{High-use\| 369726 }}