Difference between revisions of "Template:Featured topic box/doc"
Jump to navigation
Jump to search
imported>Wizardman (nm) |
imported>IceWelder m (Formatting, Cleaned up using AutoEd) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{Documentation subpage}} | |
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | ||
| Line 5: | Line 5: | ||
General syntax options for this template are as follows: | General syntax options for this template are as follows: | ||
<nowiki>{{Featured topic box | <nowiki>{{Featured topic box | ||
| − | |title= | + | | title = |
| − | |lead= | + | | lead = |
| − | |discussion= | + | | discussion = |
| − | |bookname= | + | | view = |
| − | |count= | + | | bookname = |
| − | |image= | + | | count = |
| − | |imagesize= | + | | image = |
| − | |column1= | + | | imagesize = |
| + | | column1 = | ||
: | : | ||
: | : | ||
| − | |column2= | + | | column2 = |
: | : | ||
: | : | ||
| − | |column3= | + | | column3 = |
}}</nowiki> | }}</nowiki> | ||
| − | + | * '''title''': name of the featured topic (used for the talk page link) | |
| − | *'''title''': name of the featured topic (used for the talk page link) | + | *: Example: 2003 Atlantic hurricane season for [[Wikipedia talk:Featured topics/2003 Atlantic hurricane season|2003 Atlantic hurricane season]] |
| − | *:Example: 2003 Atlantic hurricane season for [[Wikipedia talk:Featured topics/2003 Atlantic hurricane season|2003 Atlantic hurricane season]] | + | * '''lead''': name of topic to be displayed in header bar, including any formating and links. Must not include any bold text. Should be the same as the topic title - can be piped if needs be. |
| − | *'''lead''': name of topic to be displayed in header bar, including any formating and links. Must not include any bold text. Should be the same as the topic title - can be piped if needs be. | + | *: Example: <nowiki>{{classicon|FA}} [[2003 Atlantic hurricane season]] </nowiki> |
| − | *:Example: <nowiki>{{classicon|FA}} [[2003 Atlantic hurricane season]] </nowiki> | + | * '''discussion''' (optional): Link to the most recent discussion (Wikipedia:Featured topic candidates/Title/{{{discussion}}}). By default, it links to the nomination. |
| − | *'''discussion''' (optional): Link to the most recent discussion (Wikipedia:Featured topic candidates/Title/{{{discussion}}}). By default, it links to the nomination. | + | * '''view''' (optional): Link to the topic's page itself |
| − | *'''bookname''' (''optional''): name of [[Wikipedia:Books|book]] associated with topic, where different from ''title''. If omitted or blank, a book with the same title as the featured topic is linked. | + | * '''bookname''' (''optional''): name of [[Wikipedia:Books|book]] associated with topic, where different from ''title''. If omitted or blank, a book with the same title as the featured topic is linked. |
| − | *:Example: University of Toronto ''(provides link to [[Book:University of Toronto]] and [[Book talk:University of Toronto#Book report|the associated book report]])'' | + | *: Example: University of Toronto ''(provides link to [[Book:University of Toronto]] and [[Book talk:University of Toronto#Book report|the associated book report]])'' |
| − | *'''count''': number of articles in topic | + | * '''count''': number of articles in topic |
| − | *:Example: 17 | + | *: Example: 17 |
| − | *'''image''' (''optional''): name of image to be used, which '''must not be fair use'''. If omitted or blank, no image is used. | + | * '''image''' (''optional''): name of image to be used, which '''must not be fair use'''. If omitted or blank, no image is used. |
*: Example: 2003 Atlantic hurricane season map.png (''see [[:Image:2003 Atlantic hurricane season map.png]]'') | *: Example: 2003 Atlantic hurricane season map.png (''see [[:Image:2003 Atlantic hurricane season map.png]]'') | ||
| − | *'''imagesize''' (''optional'') size of any image in pixels. If omitted or blank, this will take the value 60 (if there is an image) | + | * '''imagesize''' (''optional'') size of any image in pixels. If omitted or blank, this will take the value 60 (if there is an image) |
| − | *: Example: 55 | + | *: Example: 55 |
*: To make the height 60, like in most of the current boxes, divide length by height and multiply by 60. | *: To make the height 60, like in most of the current boxes, divide length by height and multiply by 60. | ||
| − | *'''column1''', '''column2''', '''column3''': use these to list the articles in the topic using bulleted lists, with any formatting, links, and the FA/GA stars. | + | * '''column1''', '''column2''', '''column3''': use these to list the articles in the topic using bulleted lists, with any formatting, links, and the FA/GA stars. |
*: Example: | *: Example: | ||
| − | *:* <nowiki>{{icon|FL}} [[List of storms in the 2003 Atlantic hurricane season|List of storms]]</nowiki> | + | *: * <nowiki>{{icon|FL}} [[List of storms in the 2003 Atlantic hurricane season|List of storms]]</nowiki> |
| − | *:* <nowiki>{{icon|GA}} [[Tropical Storm Ana (2003)|Tropical Storm Ana]]</nowiki> | + | *: * <nowiki>{{icon|GA}} [[Tropical Storm Ana (2003)|Tropical Storm Ana]]</nowiki> |
| − | *:* <nowiki>{{icon|FA}} [[Hurricane Juan]]</nowiki> | + | *: * <nowiki>{{icon|FA}} [[Hurricane Juan]]</nowiki> |
| − | *:* <nowiki>{{icon|PR}} [[Hurricane Bob]]</nowiki> | + | *: * <nowiki>{{icon|PR}} [[Hurricane Bob]]</nowiki> |
| − | *:* | + | *: * — etc. |
''The colour scheme for this template uses the H90 header / accent colours at [[Wikipedia talk:Colours]]'' | ''The colour scheme for this template uses the H90 header / accent colours at [[Wikipedia talk:Colours]]'' | ||
Latest revision as of 11:54, 10 September 2020
| 40px | This is a documentation subpage for Template:Featured topic box. It contains usage information, categories and other content that is not part of the original template page. |
Usage
General syntax options for this template are as follows:
{{Featured topic box
| title =
| lead =
| discussion =
| view =
| bookname =
| count =
| image =
| imagesize =
| column1 =
:
:
| column2 =
:
:
| column3 =
}}
- title: name of the featured topic (used for the talk page link)
- Example: 2003 Atlantic hurricane season for 2003 Atlantic hurricane season
- lead: name of topic to be displayed in header bar, including any formating and links. Must not include any bold text. Should be the same as the topic title - can be piped if needs be.
- Example: {{classicon|FA}} [[2003 Atlantic hurricane season]]
- discussion (optional): Link to the most recent discussion (Wikipedia:Featured topic candidates/Title/{{{discussion}}}). By default, it links to the nomination.
- view (optional): Link to the topic's page itself
- bookname (optional): name of book associated with topic, where different from title. If omitted or blank, a book with the same title as the featured topic is linked.
- Example: University of Toronto (provides link to Book:University of Toronto and the associated book report)
- count: number of articles in topic
- Example: 17
- image (optional): name of image to be used, which must not be fair use. If omitted or blank, no image is used.
- Example: 2003 Atlantic hurricane season map.png (see Image:2003 Atlantic hurricane season map.png)
- imagesize (optional) size of any image in pixels. If omitted or blank, this will take the value 60 (if there is an image)
- Example: 55
- To make the height 60, like in most of the current boxes, divide length by height and multiply by 60.
- column1, column2, column3: use these to list the articles in the topic using bulleted lists, with any formatting, links, and the FA/GA stars.
- Example:
- * {{icon|FL}} [[List of storms in the 2003 Atlantic hurricane season|List of storms]]
- * {{icon|GA}} [[Tropical Storm Ana (2003)|Tropical Storm Ana]]
- * {{icon|FA}} [[Hurricane Juan]]
- * {{icon|PR}} [[Hurricane Bob]]
- * — etc.
The colour scheme for this template uses the H90 header / accent colours at Wikipedia talk:Colours