SockyPaws: Create template documentation page

2024-11-25T19:46:49Z

Create template documentation page

New page

{{Documentation subpage}}
{{Lua|icononly=on|Module:Labelled list hatnote}}
{{Hatnote|This template is for linking to main content. For the mainspace detection template, see [[:Template:Main other]].}}
When a Zoophilia Wiki article is large, it is often written in [[wikipedia:Wikipedia:Summary style|summary style]]. This template is used after the heading of the summary, to link to the subtopic article that has been summarized. Use of this template is '''not''' to be used as a substitute for inline links or the {{Template link general|plaincode=on|Further}} template. The latter is used when the section expounds a specific aspect of the topic instead of summarizing its article. This template should also not be used in lead sections.

{{TOC limit}}

== Usage ==
* '''Basic usage:''' {{Code|{{{{BASEPAGENAME}}|{{Var|page}}}}}}
* '''All parameters:''' {{Code|{{{{BASEPAGENAME}}|{{Var|page1}}|{{Var|page2}}|{{Var|page3}}| … |l1={{Var|label1}}|l2={{Var|label2}}|l3={{Var|label3}}| … |selfref={{Var|yes}}}}}}
The module which provides the functions for this template can be called directly using {{Code|#invoke}}).

=== Parameters ===
* {{Code|1}}, {{Code|2}}, {{Code|3}}, … – the pages to link to. If no page names are specified, the current page name is used instead (without the [[wikipedia:Wikipedia:Namespace|namespace]] prefix). Categories and files are automatically escaped with the [[wikipedia:Help:Colon trick|colon trick]], and links to sections are automatically formatted as {{Kbd|{{Var|Page § Section}}}}, rather than the MediaWiki default of {{Kbd|{{Var|Page#Section}}}}.
* {{Code|l1}}, {{Code|l2}}, {{Code|l3}}, … ''or'' {{Code|label 1}}, {{Code|label 2}}, {{Code|label 3}}, … – optional labels for each of the pages to link to (providing the same functionality as a piped link). Note that the extra parameters use a lower case {{Code|L}}, for example, {{Code|l1}}, <span style="text-decoration: underline #000 solid 2px;">not</span> {{Code|L1}}.
* {{Code|selfref}} – if set to {{Code|yes}}, {{Code|y}}, {{Code|true}} or {{Code|1}}, adds the CSS class {{Code|selfref}} to the links. This is used to denote self-references to Zoophilia Wiki. See [[wikipedia:Template:Selfref|Template:Selfref]] for more information. This is only necessary in articles and other content (e.g. templates) that will appear in articles, and need not be added for uses of this template on {{Code|Zoophilia Wiki:}} namespace pages.

== Examples ==
{{Hatnote|Underscores ({{Code|_}}) between words are not necessary.}}
* {{Code|<nowiki>{{Main|Main Page}}</nowiki>}} → {{Main|Main Page}}
* {{Code|<nowiki>{{Main|Main Page#Selected article}}</nowiki>}} → {{Main|Main Page#Selected article}}
* {{Code|<nowiki>{{Main|Main Page#Selected article|l1=Featured page}}</nowiki>}} → {{Main|Main Page#Selected article|l1=Featured page}}
* {{Code|<nowiki>{{Main|Zoophilia|Zoosexuality|Hani Miletski}}</nowiki>}} → {{Main|Zoophilia|Zoosexuality|Hani Miletski}}
* {{Code|<nowiki>{{Main|Main Page|l1=Home|Baneki|l2=VPN service}}</nowiki>}} → {{Main|Main Page|l1=Home|Baneki|l2=VPN service}}

== Template data ==
{{TemplateData header}}
<templatedata>{
"description": "Displays links in italics to a sub-article(s) that are entirely about the topic of the section, following the heading 'Main article:'",
"format": "inline",
"paramOrder": [
"1",
"l1",
"2",
"l2",
"3",
"l3",
"4",
"l4",
"5",
"l5",
"selfref"
],
"params": {
"1": {
"label": "Page 1",
"description": "The name of the first page to link to; if not specified, the current page name (with no namespace prefix) is used. ",
"type": "wiki-page-name",
"required": true,
"example": "Hani Miletski"
},
"2": {
"label": "Page 2",
"description": "The name of the second page to link to",
"type": "wiki-page-name",
"required": false
},
"3": {
"label": "Page 3",
"description": "The name of the third page to link to",
"type": "wiki-page-name",
"required": false
},
"4": {
"label": "Page 4",
"description": "The name of the fourth page to link to",
"type": "wiki-page-name"
},
"5": {
"label": "Page 5",
"description": "The name of the fifth page to link to",
"type": "wiki-page-name"
},
"l1": {
"type": "line",
"label": "Label 1",
"description": "The link text for the first linked page",
"aliases": [
"label 1"
],
"example": "Dr. Hani Miletski"
},
"l2": {
"label": "Label 2",
"description": "The link text for the second linked page",
"type": "line",
"aliases": [
"label 2"
]
},
"l3": {
"label": "Label 3",
"description": "The link text for the third linked page",
"type": "line",
"aliases": [
"label 3"
]
},
"selfref": {
"type": "boolean",
"label": "Self reference",
"description": "Set to \"yes\" if the template is a self-reference to Zoophilis Wiki that would not make sense on mirrors or forks of the site"
},
"l4": {
"aliases": [
"label 4"
],
"label": "Label 4",
"description": "The link text for the fourth linked page",
"type": "line"
},
"l5": {
"aliases": [
"label 5"
],
"label": "Label 5",
"description": "The link text for the fifth linked page",
"type": "line"
}
}
}</templatedata>

== See also ==
* {{Template link general|Main list}} → For a more comprehensive list, see {{Color|blue|Article}}.
* {{Template link general|Broader}} → For broader coverage of this topic, see {{Color|blue|Article}}.
* {{Template link general|Excerpt}} (allows transclusion of text, such as an intro section, from one article into another
* {{Template link general|Further}} → Further information: {{Color|blue|Article}}.
* {{Template link general|Official website}}
{{Hatnote templates}}
<includeonly>{{Sandbox other||
[[Category:Hatnote templates]]
[[Category:Page section templates]]
}}</includeonly>

Template:Main/doc - Revision history

SockyPaws: Create template documentation page