Template:See also/doc: Difference between revisions

Latest revision as of 00:42, 2 August 2024

This template is used to point to a small number of other related titles at the top of article sections.

TemplateData

This template creates a hatnote to point to a small number of related pages. It is placed at the top of a section, directly underneath the section heading.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Page 1	`1`	The name of the first page that you want to link to. Example Article name	Page name	required
Page 2	`2`	The name of the second page that you want to link to.	Page name	optional
Page 3	`3`	The name of the third page that you want to link to. More pages can be added using the parameters "4", "5", "6", etc.	Page name	optional
Label 1	`label 1` `l1`	What the first linked article is to be displayed as.	String	optional
Label 2	`label 2` `l2`	What the second linked article is to be displayed as.	String	optional
Self reference	`selfref`	Set to "yes" if the template is a self-reference to Wikipedia that would not make sense on mirrors or forks of the Wikipedia site. Default no Example yes	Boolean	optional
Category	`category`	Set to "no", "n", "false", or "0" to suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if no page names are specified. Default yes Example no	Boolean	optional
Label 3	`label 3` `l3`	What the third linked article is to be displayed as. Other labels can be added by using increasing numbers (starting with "label 4" or "l4" for page 4) as parameter names.	String	optional

@@ Line 1: / Line 1: @@
-=== Usage ===
+{{Documentation|fromWikipedia=true}}
-<nowiki>{{see also|Dinosaur}}</nowiki>
-Shows up as a "see also" link to article [[Dinosaur]], thus:
+This template is used to point to a small number of other related titles at the top of article sections.
-{{see also|Dinosaur}}
+==TemplateData==
+<templatedata>
+{
+	"description": "This template creates a hatnote to point to a small number of related pages. It is placed at the top of a section, directly underneath the section heading.",
+	"params": {
+		"1": {
+			"label": "Page 1",
+			"description": "The name of the first page that you want to link to.",
+			"type": "wiki-page-name",
+			"required": true,
+			"example": "Article name"
+		},
+		"2": {
+			"label": "Page 2",
+			"description": "The name of the second page that you want to link to.",
+			"type": "wiki-page-name",
+			"required": false
+		},
+		"3": {
+			"label": "Page 3",
+			"description": "The name of the third page that you want to link to. More pages can be added using the parameters \"4\", \"5\", \"6\", etc.",
+			"type": "wiki-page-name",
+			"required": false
+		},
+		"label 1": {
+			"label": "Label 1",
+			"type": "string",
+			"description": "What the first linked article is to be displayed as. ",
+			"aliases": [
+				"l1"
+			]
+		},
+		"label 2": {
+			"label": "Label 2",
+			"type": "string",
+			"description": "What the second linked article is to be displayed as.",
+			"aliases": [
+				"l2"
+			]
+		},
+		"selfref": {
+			"type": "boolean",
+			"label": "Self reference",
+			"description": "Set to \"yes\" if the template is a self-reference to Wikipedia that would not make sense on mirrors or forks of the Wikipedia site.",
+			"example": "yes",
+			"default": "no"
+		},
+		"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 no page names are specified.",
+			"type": "boolean",
+			"default": "yes",
+			"example": "no"
+		},
+		"label 3": {
+			"aliases": [
+				"l3"
+			],
+			"type": "string",
+			"label": "Label 3",
+			"description": "What the third linked article is to be displayed as. Other labels can be added by using increasing numbers (starting with \"label 4\" or \"l4\" for page 4) as parameter names."
+		}
+	},
+	"format": "inline"
+}
+</templatedata>
-<nowiki>{{see also|Dinosaur|Scary lizardy things}}</nowiki>
+<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude></noinclude>
-Shows up as a "see also" link to article [[Dinosaur]] with text "Scary lizardy things":
-{{see also|Dinosaur|Scary lizardy things}}
-<!-- === See also === -->
-<includeonly>
-<!-- ADD CATEGORIES HERE -->
-</includeonly>

Template:See also/doc: Difference between revisions

Latest revision as of 00:42, 2 August 2024

TemplateData

Navigation menu

Search