Template:Disambiguation/doc: Difference between revisions

Revision as of 17:58, 12 April 2024

This hatnote template is meant to be used at the top of an article to indicate the existence of a disambiguation page.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Disambiguation Page	`1`	A custom disambiguation page name. Example Disambiguation Page	Page name	optional
Link Label	`2`	A label for the custom disambiguation page. Example Alternative Page Name	Line	optional
Custom Topic	`topic`	In case {{PAGENAME}} does not describe the topic, this can be used to display a custom topic Default {{PAGENAME}} Example a custom topic	Unknown	optional

Code	Result
`{{About}}`	Template:About
`{{About\|Disambig Page}}`	Template:About
`{{About\|Disambig Page\|Page Label\|topic=this particular topic}}`	Template:About

This template requires the {{Hatnote}} metatemplate.

@@ Line 1: / Line 1: @@
 == Summary ==
+<templatedata>
+{
+	"params": {
+		"1": {
+			"label": "Disambiguation Page",
+			"description": "A custom disambiguation page name.",
+			"example": "Disambiguation Page",
+			"type": "wiki-page-name"
+		},
+		"2": {
+			"label": "Link Label",
+			"description": "A label for the custom disambiguation page.",
+			"example": "Alternative Page Name",
+			"type": "line"
+		},
+		"topic": {
+			"label": "Custom Topic",
+			"description": "In case {{PAGENAME}} does not describe the topic, this can be used to display a custom topic",
+			"example": "a custom topic",
+			"default": "{{PAGENAME}}"
+		}
+	},
+	"description": "This hatnote template is meant to be used at the top of an article to indicate the existence of a disambiguation page.",
+	"paramOrder": [
+		"1",
+		"2",
+		"topic"
+	],
+	"format": "inline"
+}
+</templatedata>
 == Examples ==
 {| class="wikitable"