Template:Nutshell/doc
Jump to navigation
Jump to search
![]() | This is a documentation subpage for Template:Nutshell. It contains usage information, categories and other content that is not part of the original template page. |
![]() | This template is used on approximately 3,800 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
![]() | This template should not be substituted. |
This template presents a concise summary at the top of 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 Justapedia more inviting to new users.
- 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, "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
{{nutshell|text}}
Renders like this:
![]() | Summary : text |
{{nutshell|First bullet point.|Second bullet point.|Third bullet point.}}
yields:
![]() | Summary :
|
{{Nutshell|title=That's me|Concise summary of this page.}}
yields:
![]() | That's me : Concise summary of this page. |
{{Nutshell|title=That's me|Concise summary of this page.|shortcut=me}}
yields:
![]() | That's me : Concise summary of this page. |
{{Nutshell|title=That's me|Concise summary of this page.|shortcut=me|shortcut2=you|shortcut3=them|shortcut4=us|shortcut5=everyone}}
yields:
![]() | That's me : Concise summary of this page. |
See also
- Justapedia:Too long; didn't read
- Justapedia:Essays in a nutshell (editable lists of essays)
- Justapedia:Template messages/Justapedia namespace for a listing of Justapedia namespace banners.
List of parameters for this template
Parameter | Description | Type | Status | |
---|---|---|---|---|
Nutshell text | 2 | Brief summary that make page more inviting to new users | String | required |
Bullet point #2 | 3 | no description | Unknown | optional |
Bullet point #3 | 4 | no description | Unknown | optional |
Bullet point #4 | 5 | no description | Unknown | optional |
Title | title 1 | Text that replace "This page" into the text you inserted
| String | optional |
shortcut | shortcut shortcut1 | no description | Unknown | optional |
shortcut2 | shortcut2 | no description | Unknown | optional |
shortcut3 | shortcut3 | no description | Unknown | optional |
shortcut4 | shortcut4 | no description | Unknown | optional |
shortcut5 | shortcut5 | no description | Unknown | optional |