Template:Nutshell/doc

From MeritBadgeDotOrg

Revision as of 10:41, October 20, 2008 by Milominderbinder2 (Talk | contribs)
(diff) ←Older revision | Current revision (diff) | Newer revision→ (diff)
Jump to: navigation, search
This documentation is transcluded from Template:Nutshell/doc/doc.
This template may have a sandbox (edit) and testcases for editors to experiment.

Function


{{Nutshell|Sample text}} lets you quickly note a key fact at the top of a page.

{{Nutshell|Sample text|width|leftmargin}} is the format for the optional variables 2 and 3. The default values are width = 80% and leftmargin=10%.


Location


This infobox template presents a concise summary at the top of MeritBadgeDotOrg policy and guideline pages. It is placed below the title and other infoboxes and above the first paragraph of the main body.


Examples


If you use {{Nutshell|Sample text}} with just the text parameter
{{Nutshell|Sample text}}

which gives:

This page in a nutshell: Sample text


You can use Nutshell to give a three point outline of the article
  • {{nutshell|<li>item 1<li>item 2<li>item 3}}
becomes:
This page in a nutshell:
  • item 1
  • item 2
  • item 3

  • To automatically set the width to the minimum width needed
    {{Nutshell|Sample text|auto}}
    

    which gives:

    This page in a nutshell: Sample text


    To change the left margin to 5% and use auto width
    {{Nutshell|Sample text|auto|5%}}
    

    which gives:

    This page in a nutshell: Sample text


    One last example of left margin of 30px and width of 60%
    {{Nutshell|Sample text|60%|30px}}
    

    which gives:

    This page in a nutshell: Sample text


    Template notes

    • Use the nutshell summary to make MeritBadgeDotOrg more inviting to new users
    • Nutshell entries must be brief overviews, with a very high signal to noise ratio
    • Make sure each word in the nutshell carries significant weight — "Make every word tell"
    • Wikilink key words to other policy and guideline pages to create a "nut trail"}}


    See also


    Personal tools
    language