Template:Nutshell/doc: Difference between revisions

Jump to navigation Jump to search

Template:Nutshell/doc (view source)

Revision as of 00:16, 17 February 2025

1,114 bytes added ,  17 February
update /doc
VisualWikitext
m (Text replacement - "Powerpedia" to "Saintapedia")
(update /doc)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{High-use}}
{{Nosubst}}


This is the {{tl|nutshell}} message box.
This template presents a [[WP:TRITE|concise]] summary at the top of  [[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.  


This template presents a concise summary at the top of Saintapedia policy and guideline 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 Wikipedia more inviting to [[Wikipedia:Welcoming committee|new users]].
 
* Use the nutshell summary to make Saintapedia more inviting to [[Welcoming committee|new users]].
* Nutshell entries must be brief overviews, with a very high meaning to number of words ratio.
* 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, "{{W|The Elements of Style|make every word tell}}".
* Make sure each word in the nutshell carries significant weight, "[[The Elements of Style|make every word tell]]".
* [[WP:CONTEXT|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.
This template can also be used on other pages, for instance on how-to guides. But it should not be used in articles.
__TOC__


== Usage ==
== Usage ==
<pre>{{nutshell|text}}</pre>
<syntaxhighlight lang="wikitext">{{nutshell|text}}</syntaxhighlight>
Renders like this:
Renders like this:
{{nutshell|text}}
{{nutshell|text}}


<pre>{{nutshell|First bullet point|Second bullet point|Third bullet point}}</pre>
<syntaxhighlight lang="wikitext">{{nutshell|First bullet point.|Second bullet point.|Third bullet point.}}</syntaxhighlight>
Renders like this:
yields:
{{nutshell|First bullet point|Second bullet point|Third bullet point}}
{{nutshell|First bullet point.|Second bullet point.|Third bullet point.}}
 
<syntaxhighlight lang="wikitext">{{Nutshell|title=That's me|Concise summary of this page.}}</syntaxhighlight>
yields:
{{nutshell|title=That's me|Concise summary of this page.}}


<pre>{{Nutshell|title=That's me|concisely summarizes this page}}</pre>
<syntaxhighlight lang="wikitext">{{Nutshell|title=That's me|Concise summary of this page.|shortcut=me}}</syntaxhighlight>
Renders like this:
yields:
{{nutshell|title=That's me|concisely summarizes this page}}
{{nutshell|title=That's me|Concise summary of this page.|shortcut=me}}


<pre>{{Nutshell|title=That's me|concisely summarizes this page|shortcut=me}}</pre>
<syntaxhighlight lang="wikitext">{{Nutshell|title=That's me|Concise summary of this page.|shortcut=me|shortcut2=you|shortcut3=them|shortcut4=us|shortcut5=everyone}}</syntaxhighlight>
Renders like this:
yields:
{{nutshell|title=That's me|concisely summarizes this page|shortcut=me}}
{{Nutshell|title=That's me|Concise summary of this page.|shortcut=me|shortcut2=you|shortcut3=them|shortcut4=us|shortcut5=everyone}}


<pre>{{Nutshell|title=That's me|concisely summarizes this page|shortcut=me|shortcut2=you}}</pre>
== See also ==
Renders like this:
* [[Wikipedia:Too long; didn't read]]
{{Nutshell|title=That's me|concisely summarizes this page|shortcut=me|shortcut2=you}}
* [[Wikipedia:Essays in a nutshell]] (editable lists of essays)
* [[Wikipedia:Template messages/Wikipedia namespace]] for a listing of Wikipedia namespace banners.


<includeonly>
== Template data ==
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Policy and guidelines header templates|Nutshell]]
</includeonly>
<templatedata>
<templatedata>
{
{
"params": {
"params": {
"1": {
"1": {
"label": "Summary/First bullet point",
"label": "Nutshell text",
"suggested": true
"description": "Brief summary that make page more inviting to new users",
"type": "string",
"required": true
},
},
"2": {
"2": {
"label": "Second bullet point"
"label": "Bullet point #2"
},
},
"3": {
"3": {
"label": "Third bullet point"
"label": "Bullet point #3"
},
},
"title": {}
"4": {
"label": "Bullet point #4"
},
"title": {
"label": "Title",
"description": "Text that replace \"This page\" into the text you inserted",
"example": "That's me",
"type": "string"
},
"shortcut": {
"aliases": [
"shortcut1"
]
},
"shortcut2": {},
"shortcut3": {},
"shortcut4": {},
"shortcut5": {}
},
},
"paramOrder": [
"description": "List of parameters for this template",
"title",
"format": "inline"
"1",
"2",
"3"
]
}
}
</templatedata>
</templatedata>
<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Header templates]]
}}</includeonly>
Retrieved from "https://saintapedia.org/wiki/Special:MobileDiff/9920"

Navigation menu