3,699
edits
Changes
Template:NavigationBox/doc (view source)
Revision as of 16:55, 14 December 2006
, 16:55, 14 December 2006no edit summary
<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
==Purpose==
This is a [[Centiare: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.
==Use==
To apply this template you can start by copy-and-pasting the following code and then provide adequate arguments:
<pre>{{NavigationBox
| Title =
| Color =
| Image =
| List =
| Category =
| Summary =
}}</pre>
===Mandatory arguments===
*Title: A title for the navigation box; may include links
*List: List of links to related articles; links maybe separated, for instance, by commas, bullets, or pipe symbols.
===Recommended arguments===
*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>.
===Default values===
The Color parameter defaults to the color showed in the {{{Title}}} row above.<!-- note: do not add the color code explicitly here; someone could modify it in the template code only, making this docs outdated-->
===Examples===
;Example 1
The following code:
<div style="margin-left: 3%">
<nowiki>{{</nowiki>NavigationBox <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}}
{{Commonstmp|NavigationBox}}
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Navigational templates| {{PAGENAME}}]]
[[Category:Templates using ParserFunctions|{{PAGENAME}}]]
</includeonly>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
==Purpose==
This is a [[Centiare: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.
==Use==
To apply this template you can start by copy-and-pasting the following code and then provide adequate arguments:
<pre>{{NavigationBox
| Title =
| Color =
| Image =
| List =
| Category =
| Summary =
}}</pre>
===Mandatory arguments===
*Title: A title for the navigation box; may include links
*List: List of links to related articles; links maybe separated, for instance, by commas, bullets, or pipe symbols.
===Recommended arguments===
*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>.
===Default values===
The Color parameter defaults to the color showed in the {{{Title}}} row above.<!-- note: do not add the color code explicitly here; someone could modify it in the template code only, making this docs outdated-->
===Examples===
;Example 1
The following code:
<div style="margin-left: 3%">
<nowiki>{{</nowiki>NavigationBox <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}}
{{Commonstmp|NavigationBox}}
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Navigational templates| {{PAGENAME}}]]
[[Category:Templates using ParserFunctions|{{PAGENAME}}]]
</includeonly>