Template:Nutshell/doc

From M3P
Jump to navigation Jump to search

{{#ifeq:doc |doc

    | 

{{#ifeq:show |show

         | {{
 {{#switch:
 {{#if: 
   | 
   | {{#if: 
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     | 
       {{#ifeq:template|template talk
       | talk
       | template 
       }}
     }}
   }}

| main | = ambox | talk = tmbox | user = ombox | wikipedia = ombox | file | image = imbox | mediawiki = ombox | template = ombox | help = ombox | category = cmbox | portal = ombox | book = ombox | other | #default = ombox

}} | type = notice | image = | imageright = | style = margin-bottom:1.0em; | textstyle = | text = This is a documentation subpage for Template:Nutshell.
It contains usage information, categories and other content that is not part of the original {{#if: |{{{text2}}} |{{#if: |{{{text1}}} |{{#ifeq:Template |User |template template page |{{#if:Template |template page|article}}}}}}}}. | small = | smallimage = | smallimageright = | smalltext = }}

        }}{{#if: |
         |   {{#ifexist:Template:Nutshell
                  | [[Category:{{#switch:Template |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]]
                  |
                 }}
        }}
    | 
   }}

This is the {{nutshell}} message box.

This template presents a concise summary at the top of Wikipedia 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 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.
  • Consider the Wikipedia Policy in a nutshell effort when contributing in a nutshell.

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: {{

 {{#switch:
 {{#if: 
   | 
   | {{#if: 
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     | 
       {{#ifeq:template|template talk
       | talk
       | template 
       }}
     }}
   }}

| main | = ambox | talk = tmbox | user = ombox | wikipedia = ombox | file | image = imbox | mediawiki = ombox | template = ombox | help = ombox | category = cmbox | portal = ombox | book = ombox | other | #default = ombox

}} | type = | image = | imageright = {{#if: | Template:Ombox/shortcut }} | style = | textstyle = | text = This page in a nutshell: {{#if:

 | * text 
  • {{{2}}} {{#if:
   | * {{{3}}}
   }}
 | text
 }}

| small = | smallimage = | smallimageright = | smalltext = }}

{{nutshell|First bullet point|Second bullet point|Third bullet point}}

Renders like this: {{

 {{#switch:
 {{#if: 
   | 
   | {{#if: 
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     | 
       {{#ifeq:template|template talk
       | talk
       | template 
       }}
     }}
   }}

| main | = ambox | talk = tmbox | user = ombox | wikipedia = ombox | file | image = imbox | mediawiki = ombox | template = ombox | help = ombox | category = cmbox | portal = ombox | book = ombox | other | #default = ombox

}} | type = | image = | imageright = {{#if: | Template:Ombox/shortcut }} | style = | textstyle = | text = This page in a nutshell: {{#if:Second bullet point

 | * First bullet point 
  • Second bullet point {{#if:Third bullet point
   | * Third bullet point
   }}
 | First bullet point
 }}

| small = | smallimage = | smallimageright = | smalltext = }}

{{Nutshell|title=That's me|concisely summarizes this page}}

Renders like this: {{

 {{#switch:
 {{#if: 
   | 
   | {{#if: 
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     | 
       {{#ifeq:template|template talk
       | talk
       | template 
       }}
     }}
   }}

| main | = ambox | talk = tmbox | user = ombox | wikipedia = ombox | file | image = imbox | mediawiki = ombox | template = ombox | help = ombox | category = cmbox | portal = ombox | book = ombox | other | #default = ombox

}} | type = | image = | imageright = {{#if: | Template:Ombox/shortcut }} | style = | textstyle = | text = That's me in a nutshell: {{#if:

 | * concisely summarizes this page 
  • {{{2}}} {{#if:
   | * {{{3}}}
   }}
 | concisely summarizes this page
 }}

| small = | smallimage = | smallimageright = | smalltext = }}

{{Nutshell|title=That's me|concisely summarizes this page|shortcut=me}}

Renders like this: {{

 {{#switch:
 {{#if: 
   | 
   | {{#if: 
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     | 
       {{#ifeq:template|template talk
       | talk
       | template 
       }}
     }}
   }}

| main | = ambox | talk = tmbox | user = ombox | wikipedia = ombox | file | image = imbox | mediawiki = ombox | template = ombox | help = ombox | category = cmbox | portal = ombox | book = ombox | other | #default = ombox

}} | type = | image = | imageright = {{#if:me | Template:Ombox/shortcut }} | style = | textstyle = | text = That's me in a nutshell: {{#if:

 | * concisely summarizes this page 
  • {{{2}}} {{#if:
   | * {{{3}}}
   }}
 | concisely summarizes this page
 }}

| small = | smallimage = | smallimageright = | smalltext = }}

{{Nutshell|title=That's me|concisely summarizes this page|shortcut=me|shortcut2=you}}

Renders like this: {{

 {{#switch:
 {{#if: 
   | 
   | {{#if: 
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     | 
       {{#ifeq:template|template talk
       | talk
       | template 
       }}
     }}
   }}

| main | = ambox | talk = tmbox | user = ombox | wikipedia = ombox | file | image = imbox | mediawiki = ombox | template = ombox | help = ombox | category = cmbox | portal = ombox | book = ombox | other | #default = ombox

}} | type = | image = | imageright = {{#if:me | Template:Ombox/shortcut }} | style = | textstyle = | text = That's me in a nutshell: {{#if:

 | * concisely summarizes this page 
  • {{{2}}} {{#if:
   | * {{{3}}}
   }}
 | concisely summarizes this page
 }}

| small = | smallimage = | smallimageright = | smalltext = }}

See also