.
Template:NavigationBox/doc: Difference between revisions
Red marquis (talk | contribs) No edit summary |
Red marquis (talk | contribs) No edit summary |
||
Line 1: | Line 1: | ||
<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude> | <includeonly> | ||
{{mergefrom|Navigation no hide}}{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude> | |||
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | ||
{{Commonstmp|NavigationBox}} | |||
This is a [[Wikipedia:Navigational templates|navigational template]]. It helps to construct a standardized box containing a list of links to articles which relates to the one being read, plus an optional image. | |||
==Blank== | |||
<pre>{{ | <pre>{{NavigationBox | ||
| | | Name = {{subst:PAGENAME}} | ||
| | | Title = | ||
| | | Image = | ||
}} | | List = | ||
</ | | Category = | ||
| Summary = | |||
}}</pre> | |||
== Parameters == | |||
===''Mandatory''=== | |||
; Name : Name of the template, include for future use when Tnavbar functionality is added. | |||
; Title : Text that appears centered in the titlebar (the top bar). Usually this is the template's topic, i.e. a succinct description of the body contents. | |||
; List: Contents of the navigation box. Use <nowiki>&#124;</nowiki> to separate links. It is not possible to include a pipe ("|") in the contents as this symbol is used to separate parameters. | |||
===''Optional''=== | |||
; Color : Header color. Default is <span style="background-color: #ccf;">#ccf</span>. Use of this parameter is discouraged. Where it is used, care and consensus are needed as multiple navigational templates on one page with different titlebar colors will probably look unpleasant. | |||
; Image : The image. Must include <code><nowiki>[[Image:...|?px|alt text]]</nowiki></code> | |||
; Summary : this parameter is aimed at vocal and Braille-based user agents and should give a brief textual description of the box contents; ''ordinary quotation marks around or within the provided text are not allowed;'' if quoting is needed you may use curly quotes: <code>“</code> and <code>”</code>. | |||
; | |||
===== | ==Examples== | ||
===Example 1=== | |||
The following code: | |||
=== | <div style="margin-left: 3%"> | ||
<nowiki>{{</nowiki>NavigationBox <br /><nowiki> | |||
| Name = US Presidents </nowiki><br /><nowiki> | |||
| Title = The first 25 Presidents of the United States </nowiki><br /><nowiki> | |||
| Image = [[Image:USPresidentialSeal.jpg|60px|U.S. presidential seal]] </nowiki><br /><nowiki> | |||
| Summary = A list of the first 25 US Presidents </nowiki><br /><nowiki> | |||
| Color = </nowiki><br /><nowiki> | |||
| Category = </nowiki><br /><nowiki> | |||
| List = [[George Washington|Washington]]&nbsp;• [[John Adams|J&nbsp;Adams]]&nbsp;• [[Thomas Jefferson|Jefferson]]&nbsp;• [[James Madison|Madison]]&nbsp;• [[James Monroe|Monroe]]&nbsp;• [[John Quincy Adams|JQ&nbsp;Adams]]&nbsp;• [[Andrew Jackson|Jackson]]&nbsp;• [[Martin Van Buren|Van&nbsp;Buren]]&nbsp;• [[William Henry Harrison|W&nbsp;Harrison]]&nbsp;• [[John Tyler|Tyler]]&nbsp;• [[James K. Polk|Polk]]&nbsp;• [[Zachary Taylor|Taylor]]&nbsp;• [[Millard Fillmore|Fillmore]]&nbsp;• [[Franklin Pierce|Pierce]]&nbsp;• [[James Buchanan|Buchanan]]&nbsp;• [[Abraham Lincoln|Lincoln]]&nbsp;• [[Andrew Johnson|A&nbsp;Johnson]]&nbsp;• [[Ulysses S. Grant|Grant]]&nbsp;• [[Rutherford B. Hayes|Hayes]]&nbsp;• [[James Garfield|Garfield]]&nbsp;• [[Chester A. Arthur|Arthur]]&nbsp;• [[Grover Cleveland|Cleveland]]&nbsp;• [[Benjamin Harrison|B&nbsp;Harrison]]&nbsp;• [[Grover Cleveland|Cleveland]]&nbsp;• [[William McKinley|McKinley]]</nowiki><br /><nowiki> | |||
}}</nowiki> | |||
</div> | |||
yields: | |||
{{NavigationBox | |||
| | | Title = The first 25 Presidents of the United States | ||
| | | Image = [[Image:USPresidentialSeal.jpg|60px|U.S. presidential seal]] | ||
| | | Summary = A list of the first 25 US Presidents | ||
| | | Color = | ||
[[ | | Category = | ||
[[ | | List = [[George Washington|Washington]] • [[John Adams|J Adams]] • [[Thomas Jefferson|Jefferson]] • [[James Madison|Madison]] • [[James Monroe|Monroe]] • [[John Quincy Adams|JQ Adams]] • [[Andrew Jackson|Jackson]] • [[Martin Van Buren|Van Buren]] • [[William Henry Harrison|W Harrison]] • [[John Tyler|Tyler]] • [[James K. Polk|Polk]] • [[Zachary Taylor|Taylor]] • [[Millard Fillmore|Fillmore]] • [[Franklin Pierce|Pierce]] • [[James Buchanan|Buchanan]] • [[Abraham Lincoln|Lincoln]] • [[Andrew Johnson|A Johnson]] • [[Ulysses S. Grant|Grant]] • [[Rutherford B. Hayes|Hayes]] • [[James Garfield|Garfield]] • [[Chester A. Arthur|Arthur]] • [[Grover Cleveland|Cleveland]] • [[Benjamin Harrison|B Harrison]] • [[Grover Cleveland|Cleveland]] • [[William McKinley|McKinley]] | ||
[[ | |||
[[ | |||
[[ | |||
[[ | |||
[[ | |||
[[ | |||
}} | }} | ||
=== | ===Example 2=== | ||
{{ | Removing the <code>Image</code> argument and providing <code>Color= teal</code> the result changes to: | ||
| | {{NavigationBox | ||
| | | Title = The first 25 Presidents of the United States | ||
| | | Image = | ||
[[ | | Summary = A list of the first 25 US Presidents | ||
[[ | | Color = teal | ||
[[ | | Category = | ||
[[ | | List = [[George Washington|Washington]] • [[John Adams|J Adams]] • [[Thomas Jefferson|Jefferson]] • [[James Madison|Madison]] • [[James Monroe|Monroe]] • [[John Quincy Adams|JQ Adams]] • [[Andrew Jackson|Jackson]] • [[Martin Van Buren|Van Buren]] • [[William Henry Harrison|W Harrison]] • [[John Tyler|Tyler]] • [[James K. Polk|Polk]] • [[Zachary Taylor|Taylor]] • [[Millard Fillmore|Fillmore]] • [[Franklin Pierce|Pierce]] • [[James Buchanan|Buchanan]] • [[Abraham Lincoln|Lincoln]] • [[Andrew Johnson|A Johnson]] • [[Ulysses S. Grant|Grant]] • [[Rutherford B. Hayes|Hayes]] • [[James Garfield|Garfield]] • [[Chester A. Arthur|Arthur]] • [[Grover Cleveland|Cleveland]] • [[Benjamin Harrison|B Harrison]] • [[Grover Cleveland|Cleveland]] • [[William McKinley|McKinley]] | ||
[[ | |||
[[ | |||
[[ | |||
[[ | |||
}} | }} | ||
==See also== | |||
{{Navigational templates}} | |||
<includeonly> | <includeonly> | ||
<!-- ADD CATEGORIES BELOW THIS LINE --> | |||
[[Category:Navigational templates| {{PAGENAME}}]] | |||
[[Category:Templates using ParserFunctions|{{PAGENAME}}]] | |||
<!-- ADD INTERWIKIS BELOW THIS LINE --> | |||
</includeonly> | </includeonly> | ||
[[Category:Templates]] | [[Category:Templates]] |
Revision as of 02:27, 12 January 2007
Template:Template doc page viewed directly
{{#ifeq:NavigationBox/doc|Commonstmp1| |}} This is a navigational template. It helps to construct a standardized box containing a list of links to articles which relates to the one being read, plus an optional image.
Blank
{{NavigationBox | Name = {{subst:PAGENAME}} | Title = | Image = | List = | Category = | Summary = }}
Parameters
Mandatory
- Name
- Name of the template, include for future use when Tnavbar functionality is added.
- Title
- Text that appears centered in the titlebar (the top bar). Usually this is the template's topic, i.e. a succinct description of the body contents.
- List
- Contents of the navigation box. Use | to separate links. It is not possible to include a pipe ("|") in the contents as this symbol is used to separate parameters.
Optional
- Color
- Header color. Default is #ccf. Use of this parameter is discouraged. Where it is used, care and consensus are needed as multiple navigational templates on one page with different titlebar colors will probably look unpleasant.
- Image
- The image. Must include
[[Image:...|?px|alt text]]
- Summary
- this parameter is aimed at vocal and Braille-based user agents and should give a brief textual description of the box contents; ordinary quotation marks around or within the provided text are not allowed; if quoting is needed you may use curly quotes:
“
and”
.
Examples
Example 1
The following code:
{{NavigationBox
| Name = US Presidents
| Title = The first 25 Presidents of the United States
| Image = [[Image:USPresidentialSeal.jpg|60px|U.S. presidential seal]]
| Summary = A list of the first 25 US Presidents
| Color =
| Category =
| List = [[George Washington|Washington]] • [[John Adams|J Adams]] • [[Thomas Jefferson|Jefferson]] • [[James Madison|Madison]] • [[James Monroe|Monroe]] • [[John Quincy Adams|JQ Adams]] • [[Andrew Jackson|Jackson]] • [[Martin Van Buren|Van Buren]] • [[William Henry Harrison|W Harrison]] • [[John Tyler|Tyler]] • [[James K. Polk|Polk]] • [[Zachary Taylor|Taylor]] • [[Millard Fillmore|Fillmore]] • [[Franklin Pierce|Pierce]] • [[James Buchanan|Buchanan]] • [[Abraham Lincoln|Lincoln]] • [[Andrew Johnson|A Johnson]] • [[Ulysses S. Grant|Grant]] • [[Rutherford B. Hayes|Hayes]] • [[James Garfield|Garfield]] • [[Chester A. Arthur|Arthur]] • [[Grover Cleveland|Cleveland]] • [[Benjamin Harrison|B Harrison]] • [[Grover Cleveland|Cleveland]] • [[William McKinley|McKinley]]
}}
yields:
The first 25 Presidents of the United States |
---|
Washington • J Adams • Jefferson • Madison • Monroe • JQ Adams • Jackson • Van Buren • W Harrison • Tyler • Polk • Taylor • Fillmore • Pierce • Buchanan • Lincoln • A Johnson • Grant • Hayes • Garfield • Arthur • Cleveland • B Harrison • Cleveland • McKinley |
Example 2
Removing the Image
argument and providing Color= teal
the result changes to:
The first 25 Presidents of the United States |
---|
Washington • J Adams • Jefferson • Madison • Monroe • JQ Adams • Jackson • Van Buren • W Harrison • Tyler • Polk • Taylor • Fillmore • Pierce • Buchanan • Lincoln • A Johnson • Grant • Hayes • Garfield • Arthur • Cleveland • B Harrison • Cleveland • McKinley |