SockyPaws: Create template documentation page

2024-11-25T21:07:13Z

Create template documentation page

New page

{{Documentation subpage}}
This template presents a concise summary at the top of [[wikipedia:Wikipedia:Administration#Data structure and development|administration pages]]. It is placed below the title and other infoboxes and above the first paragraph of the main body.
* Use the nutshell summary to make Zoophilia Wiki more inviting to new readers and editors.
* Nutshell entries must be brief overviews, with a very high meaning-to-number-of-words ratio.
* Make sure each word in the nutshell carries significant weight, "[[wikipedia:The Elements of Style|make every word tell]]".
* Wikilink to other pages to create a "nut trail" of pages with nutshells.

This template can also be used on other pages, for instance on how-to guides, but it should not be used in articles.

== Usage ==
:: {{Template link general|code=on|italic=on|Nutshell|text}} ⮯
{{Nutshell|text}}

:: {{Template link general|code=on|italic=on|Nutshell|First bullet point.|Second bullet point.|Third bullet point.}} ⮯
{{Nutshell|First bullet point.|Second bullet point.|Third bullet point.}}

:: {{Template link general|code=on|Nutshell|2=title=That's me|3=Concise summary of this page.}} ⮯
{{Nutshell|title=That's me|Concise summary of this page.}}

:: {{Template link general|code=on|Nutshell|2=title=That's me|3=Concise summary of this page.|4=shortcut=Me}} ⮯
{{Nutshell|title=That's me|Concise summary of this page.|shortcut=Me}}

:: {{Template link general|code=on|Nutshell|2=title=That's me|3=Concise summary of this page.|4=shortcut=Me|5=shortcut2=You|6=shortcut3=Them|7=shortcut4=Us|8=shortcut5=Everyone}} ⮯
{{Nutshell|title=That's me|Concise summary of this page.|shortcut=Me|shortcut2=You|shortcut3=Them|shortcut4=Us|shortcut5=Everyone}}

== TemplateData ==
{{TemplateData header}}
<templatedata>{
"description": "Presents a concise summary at the top of administration pages",
"format": "inline",
"paramOrder": [
"1",
"2",
"3",
"4",
"title",
"shortcut",
"shortcut2",
"shortcut3",
"shortcut4",
"shortcut5"
],
"params": {
"1": {
"label": "Nutshell text",
"description": "Brief summary that make page more inviting to new users or first of multiple bullet points",
"type": "string",
"required": true
},
"2": {
"label": "Bullet point 2",
"description": "The second of multiple bullet points",
"type": "string"
},
"3": {
"label": "Bullet point 3",
"description": "The third of multiple bullet points",
"type": "string"
},
"4": {
"label": "Bullet point 4",
"description": "The fourth and final bullet point",
"type": "string"
},
"title": {
"label": "Title",
"description": "Text that replaces \"This page\" at the start of the template's output",
"example": "That's me",
"type": "line",
"default": "{{PAGENAME}}"
},
"shortcut": {
"aliases": [
"shortcut1"
],
"label": "Shortcut link",
"description": "The name of a redirect page that leads to the transcluding page",
"type": "wiki-page-name"
},
"shortcut2": {
"label": "Shortcut link 2",
"description": "The name of another redirect page that leads to the transcluding page",
"type": "wiki-page-name"
},
"shortcut3": {
"label": "Shortcut link 3",
"description": "The name of a third redirect page that leads to the transcluding page",
"type": "wiki-page-name"
},
"shortcut4": {
"label": "Shortcut link 4",
"description": "The name of a fouth redirect page that leads to the transcluding page",
"type": "wiki-page-name"
},
"shortcut5": {
"label": "Shortcut link 5",
"description": "The name of a fifth and final redirect page that leads to the transcluding page",
"type": "wiki-page-name"
}
}
}</templatedata>

== See also ==
* [[wikipedia:Wikipedia:Too long; didn't read|Wikipedia:Too long; didn't read]]
* [[wikipedia:Wikipedia:Essays in a nutshell|Wikipedia:Essays in a nutshell]] (editable lists of essays)

<includeonly>{{Sandbox other||
[[Category:Header templates]]
}}</includeonly>

Template:Nutshell/doc - Revision history

SockyPaws: Create template documentation page