Template:Broader/doc - Revision history

imported>Fgnievinski: /* See also */

2023-03-05T04:22:17Z

See also

← Older revision		Revision as of 05:22, 5 March 2023
Line 21:		Line 21:
	* <code>2</code> (and greater numbers) - any additional pages to link to. These links are also automatically formatted as with the first parameter.		* <code>2</code> (and greater numbers) - any additional pages to link to. These links are also automatically formatted as with the first parameter.
	* <code>topic</code> - the name of the topic. If this is not specified, the text "this topic" is used.		* <code>topic</code> - the name of the topic. If this is not specified, the text "this topic" is used.
	* <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:Self ref]] 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 only has an effect if the first positional parameter (the page to link to) is omitted.		* <code>category</code> - if set to "no", "n", "false", or "0", suppresses the error tracking category ([[:Category:Hatnote templates with errors]]). This only has an effect if the first positional parameter (the page to link to) is omitted.

Line 45:		Line 45:
	== See also ==		== See also ==
	*{{tl\|Further}}		*{{tl\|Further}}
			*{{tl\|Redirect}}

	{{Hatnote templates}}		{{Hatnote templates}}
Line 51:		Line 52:
	<templatedata>		<templatedata>
	{		{
	"description": "This template is used to show readers where to find broader coverage related to a particular topic. It is usually placed at the top of a section or article.",		"description": "This template is used to show readers where to find broader coverage related to a particular topic. It is usually placed at the top of a section or article.",
	"params": {		"params": {
	"1": {		"1": {
	"label": "Article",		"label": "Article",
	"description": "The name of the article that you want to link to",		"description": "The name of the article that you want to link to",
	"type": "~~string~~",		"type": "wiki-page-name",
	"required": true		"required": true
	},		},
	"2": {		"2": {
	"label": "Article 2",		"label": "Article 2",
	"description": "The name of an additional article that you want to link to",		"description": "The name of an additional article that you want to link to",
	"type": "~~string~~",		"type": "wiki-page-name",
	"required": false		"required": false
	},		},
	"3": {		"3": {
	"label": "Article 3",		"label": "Article 3",
	"description": "The name of an additional article that you want to link to",		"description": "The name of an additional article that you want to link to",
	"type": "~~string~~",		"type": "wiki-page-name",
	"required": false		"required": false
	},		},
	"4": {		"4": {
	"label": "Article 4",		"label": "Article 4",
	"description": "The name of an additional article that you want to link to",		"description": "The name of an additional article that you want to link to",
	"type": "~~string~~",		"type": "wiki-page-name",
	"required": false		"required": false
	},		},
	"topic": {		"topic": {
	"label": "Topic",		"label": "Topic",
	"description": "A brief description of the topic related to which a broader coverage will be provided. If left blank, the template will read 'For broader coverage related to this topic...'",		"description": "A brief description of the topic related to which a broader coverage will be provided. If left blank, the template will read 'For broader coverage related to this topic...'",
	"type": "string",		"type": "string",
	"required": false		"required": false
	},		},
	"selfref": {		"selfref": {
	"type": "string/line",		"type": "string/line",
	"label": "Self reference",		"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]]\".)"		"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": {		"category": {
	"label": "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."		"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>		</templatedata>

Richardpruen: 1 revision imported: Templates and CSS files

2022-12-04T17:19:27Z

1 revision imported: Templates and CSS files

← Older revision		Revision as of 18:19, 4 December 2022
(No difference)

wikipedia>Moxy: /* Usage */ {{see|WP:SUMMARYHATNOTE}}

2022-09-10T13:50:54Z

Usage: {{see|WP:SUMMARYHATNOTE}}

New page

{{Documentation subpage}}
{{Lua|Module:Broader}}

This template is used to make [[Wikipedia:Summary style|summary style]] explicit. It looks like this:

{{Broader|Article}}

It is used in sections for which there is also a separate article on the subject. It should be used when there should be a link to another article that discusses a subject more broadly, but is not a main article (which should use {{tl|Main}}), a narrower topic (which should probably use {{tl|Further}}), or at the same level of focus (which should probably use {{tl|See also}}).

== Usage ==
{{see|WP:SUMMARYHATNOTE}}
; Basic usage: {{tlc|Broader|''article''}}
; With a topic: {{tlc|Broader|''article''|topic{{=}}''topic''}}
; With more than one target page: {{tlc|Broader|''article1''|''article2''|''article3''|topic{{=}}''topic''}}
; All parameters: {{tlc|Broader|''article''|topic{{=}}''topic''|selfref{{=}}''yes''|category{{=}}''no''}}

== Parameters ==

This template accepts the following parameters:
* <code>1</code> - the page to link to (required). 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''.
* <code>2</code> (and greater numbers) - any additional pages to link to. These links are also automatically formatted as with the first parameter.
* <code>topic</code> - the name of the topic. If this is not specified, the text "this topic" is used.
* <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 only has an effect if the first positional parameter (the page to link to) is omitted.

== Examples ==

* {{tlc|Broader|Article}} → {{Broader|Article}}
* {{tlc|Broader|Article|topic{{=}}some topic}} → {{Broader|Article|topic=some topic}}

== Errors ==

If no page name is supplied, the template will output the following message:
* {{Broader|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>{{Broader}}</nowiki></code>). Please use <code><nowiki>{{Broader|</nowiki>''page''<nowiki>}}</nowiki></code> instead.
# Some parameters were specified, but the page name wasn't included. For example, the template text <code><nowiki>{{Broader|selfref=yes}}</nowiki></code> will produce this error. Please use (for example) <code><nowiki>{{Broader|</nowiki>''page''<nowiki>|selfref=yes}}</nowiki></code> instead.
# The page name was specified, but it 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>{{Broader|2+2=4}}</nowiki></code> will produce this error. To work around this, you can specify the parameter name explictly by using <code>1=</code> before the page name (like this: <code><nowiki>{{Broader|1=2+2=4}}</nowiki></code>) or you can disable the equals being interpreted as delimiting a parameter name by [[Template:=|surrounding the equals with double braces]] (like this: <code><nowiki>{{Broader|2+2{{=}}4}}</nowiki></code>).

If you see this error message and are unsure of what to do, please post a message on [[WP:HD|the help desk]], and someone should be able to help you.

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

== See also ==
*{{tl|Further}}

{{Hatnote templates}}
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
"description": "This template is used to show readers where to find broader coverage related to a particular topic. It is usually placed at the top of a section or article.",
"params": {
"1": {
"label": "Article",
"description": "The name of the article that you want to link to",
"type": "string",
"required": true
},
"2": {
"label": "Article 2",
"description": "The name of an additional article that you want to link to",
"type": "string",
"required": false
},
"3": {
"label": "Article 3",
"description": "The name of an additional article that you want to link to",
"type": "string",
"required": false
},
"4": {
"label": "Article 4",
"description": "The name of an additional article that you want to link to",
"type": "string",
"required": false
},
"topic": {
"label": "Topic",
"description": "A brief description of the topic related to which a broader coverage will be provided. If left blank, the template will read 'For broader coverage related to this topic...'",
"type": "string",
"required": false
},
"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:Cross-reference templates|{{PAGENAME}}]]
[[Category:Wikipedia page-section templates|{{PAGENAME}}]]
[[Category:Hatnote templates]]
}}</includeonly>