Template:Thank you/doc
| icon | This is a documentation subpage for Template:Thank you. It may contain usage information, categories and other content that is not part of the original template page. |
__EXPECTED_UNCONNECTED_PAGE__
 | This template is used on approximately 5,500 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
- Not to be confused with Template:Thanks.
Usage
This template is often used on talk pages to show clearly that a section of discussion has been resolved, so that each editor does not have to re-read the section. Its counterpart is {{You're welcome}}.
Example
|
Neutrality
I think the article is biased in favour of the school. --User:John
|
Template data
This template is often used on talk pages to show clearly that a section of discussion has been resolved, so that each editor does not have to re-read the section. Its counterpart is {{You're welcome}}.
| Parameter | Description | Type | Status | |||
|---|---|---|---|---|---|---|
| No parameters specified | ||||||
See also
- {{Thank you very much}} –
Thank you very much! - {{Thank You TA}} – File:WikiThanks.png A special thank you for your help in our battle against vandalism. Thank you so much for your efforts to improve this encyclopedia, and welcome to Wikipedia!
- Please consider creating an account for yourself!
- {{WikiThanks}} – File:Tournesol.png Thank you
- {{Thank}} – File:Face-wink.svg Thanks
- {{Because you thanked me}}
- {{No problem}}
This list:
Inline icon templates by shape and color
Any of the following inline, comment-level templates can be converted into {{Resolved}}-style hatnotes by using {{Resbox}} to put a box around the icon and text.
| Black check marks | |
 Already done | {{Already done}} |
| Resolved | {{Resolved1}} |
 | {{Check mark-n}} |
| Checked | {{Checked}} |
 | {{Checked box}} |
| Yellow check marks | |
| File:Yellow check.svg Half done | {{Half done}} |
| File:Yellow check.svg Partly done | {{Partly done}} |
| Blue check marks | |
 Semi-done | {{Semi-done}} |
| Go ahead | {{Go ahead}} |
| File:Pictogram voting keep.svg Fixed | {{Fixed}} |
| File:Artículo bueno-blue.svg Fixed by reporter | {{Fixed by reporter}} |
| File:Time2wait.svg Pending | {{Bug pending}} |
| File:Artículo bueno-blue.svg Resolved | {{Bug resolved}} |
| File:Artículo bueno-blue.svg Blocked and tagged | {{Blockedandtagged}} |
| File:Candidato-Artículo bueno-blue.svg Blocked without tags | {{Blockedwithouttags}} |
| File:Artículo bueno-blue.svg Tagged | {{Socks tagged}} |
| File:Candidato-Artículo bueno-blue.svg No tags | {{No tags}} |
| File:Artículo bueno-blue.svg IP block exemption granted | {{Ipbedone}} |
| File:Artículo bueno-blue.svg IP blocked | {{IPblock}} |
| File:Artículo bueno-blue.svg Proxy blocked | {{Pblock}} |
| File:Artículo bueno-blue.svg Proxies blocked | {{Psblock}} |
| File:Artículo bueno-blue.svg Range blocked | {{Rblock}} |
| File:Artículo bueno-blue.svg Requested actions completed, closing | {{Action and close}} |
| File:Artículo bueno-blue.svg Blocked and tagged. Closing. | {{Blockedtaggedclosing}} |
| Minus sign | |
| File:Symbol declined.svg Closed | {{Close}} |
| File:Symbol declined.svg Denied | {{Denied}} |
| no Disagree | {{Disagree}} |
| no Not approved | {{Unapproved}} |
| no Not bug | {{NotBug}} |
| no Duplicate bug | {{Duplicate bug}} |
| no Invalid | {{Invalid}} |
| no Declined | {{Declined}} |
| no No action | {{No action}} |
| no No comment | {{Nocomment}} |
| no Unnecessary | {{Unnecessary}} |
| no No comment with respect to the unregistered user(s) | {{Nc}} |
| no No comment with respect to temporary account(s) | {{Nc-ta}} |
| File:Crystal Clear action edit remove.png Removed | {{Removed}} |
| File:Crystal Clear action edit remove.png Pulled | {{Pulled}} |
| File:Symbol declined.svg Closing without action | {{Closing without action}} |
| File:Symbol declined.svg Failed | {{Failed-ga}} |
| Plus sign | |
| File:Crystal Clear action edit add.png Added | {{Added}} |
| File:Symbol support vote.svg Posted | {{Posted}} |
| File:Symbol support vote.svg Works for me | {{Works for me}} |
| File:Symbol support vote.svg Passed | {{Passed}} |
| File:Symbol support vote.svg Likely | {{Likely}} |
| File:Symbol support vote.svg Highly likely | {{Highly likely}} |
| File:Symbol support2 vote.svg Endorsed | {{Endorsed+}} |
| File:Symbol support2 vote.svg Clerk endorsed | {{Endorse}} |
| File:Symbol unsupport2 vote.svg Clerk declined | {{Decline}} |
| File:Symbol unsupport2 vote.svg Check declined – Checkusers will not link accounts to IPs, per the privacy policy. | {{Decline-IP}} |
| File:Symbol support2 vote.svg Endorsed by a checkuser | {{Cu-endorsed}} |
| File:Symbol unsupport2 vote.svg Check declined by a checkuser | {{Cudecline}} |
| File:Symbol unsupport vote.svg Delisted | {{Delisted}} |
| File:Symbol unsupport vote.svg Inconclusive | {{Inconclusive}} |
| File:Symbol unsupport vote.svg Not Applicable | {{N/A icon}} |
| +1 | {{+1}} |
| Neutral sign | |
| File:Symbol neutral vote.svg Closed | {{Bug closed}} |
| File:Symbol neutral vote.svg New: | {{Bug new}} |
| File:Symbol neutral vote.svg Second opinion requested | {{GA2ndopinion}} |
| Gray equals sign | {{equc}} |
| Purple turn-right | |
| File:Symbol deferred.svg Deferred | {{Deferred}} |
| File:Symbol deferred.svg Defer to edit filter | {{Deferabusefilter}} |
| File:Symbol deferred.svg Defer to Local blacklist | {{Deferblack}} |
| File:Symbol deferred.svg Defer to Global blacklist | {{Defermetablack}} |
| File:Symbol deferred.svg Defer to WPSPAM | {{Deferspam}} |
| File:Symbol deferred.svg Defer to XLinkBot | {{Deferspambot}} |
| File:Symbol deferred.svg Defer to Whitelist | {{Deferwhite}} |
| Simple clock | |
| File:Symbol wait.svg Pending approval | {{PendingRequest}} |
| File:Symbol wait.svg GA on hold | {{GAOnHold}} |
| File:Symbol wait.svg On hold | {{On hold}} |
| File:Symbol wait.svg On hold until | {{OnHoldUntil}} |
| Magenta clock | {{cloc}} |
| Clock | |
| Orange clock Proposal on hold | {{ProposalOnHold}} |
| File:Pictogram voting wait blue.svg Reviewing request. | {{Reviewing request}} |
| Pink clock Awaiting administrative action | {{Awaitingadmin}} |
| Clock | {{Await}} |
| File:Pictogram voting wait.svg Later | {{Later}} |
| File:Pictogram voting wait.svg Pending | {{Tobedone}} |
| File:Pictogram voting wait.svg Discussion ongoing... | {{Discussing}} |
| File:Pictogram voting wait.svg Doing... | {{Doing}} |
| File:Pictogram voting wait.svg [[User:|]] is doing... | {{Isdoing}} |
| File:Pictogram voting wait orange.svg Started | {{Started}} |
| File:Pictogram voting wait orange.svg In progress | {{In progress}} |
| File:Pictogram voting wait blue.svg Checking... | {{Checking}} |
| File:Pictogram voting wait green.svg Reviewing... | {{Reviewing}} |
| Information mark | |
| information Needs discussion | {{NeedsDiscussion}} |
| Information Note: | {{A note}} |
| information Administrator note | {{Administrator note}} |
| File:Symbol information vote.svg Assigned | {{Bug assigned}} |
| File:Symbol information vote.svg RM created | {{RM created}} |
_-_The_Noun_Project.svg){kind=link}
| Question mark | |
| File:Blue question mark icon.svg Suggestion | {{Suggestion}} |
| ? Maybe | {{Maybe-t}} |
| File:Orange question mark.svg Maybe | {{Maybe-i}} |
 | {{Qmark}} |
| Question | {{Question mark}} |
 | {{InfoNeeded}} |
| Not done for now | {{Not done for now}} |
| File:Purple question mark.svg Not sure | {{Not sure}} |
| File:Symbol question.svg Not sure. | {{Not sure2}} |
| File:Symbol question.svg Question: | {{Question}} |
| File:Symbol question.svg foo: | {{Question|label=foo}} |
| File:Symbol question.svg Additional information needed | {{MoreInfo}} |
| File:Pictogram voting question.svg Feedback required | {{Bug feedback}} |
| Blue question mark | {{Idkc}} |
| Bulb | |
 | {{Bulb}} |
 | {{Bulb2}} |
| Idea: | {{Idea}} |
 New proposal | {{NewProposal}} |
| Smile | |
| Thank you | {{Thank you}} |
| Thank you very much! | {{Thank you very much}} |
| You're welcome! | {{You're welcome}} |
| Sorry! | {{Sorry}} |
| File:Face-wink.svg Thanks | {{Thank}} |
| File:Tournesol.png Thank you | {{WikiThanks}} |
| No problem! | {{No problem}} |
| Thumb sign | |
| Thumbs down icon | {{Thumbs down}}{{(n)}} |
| Thumbs up icon | {{Thumbs up}}{{(y)}} |
| File:Thumbs-up-icon.svg Great! | {{Great}} |
| 👍 Like | {{Like}} |
| File:Not facebook not like thumbs down.png Dislike | {{Dislike}} |
Others
| ω Awaiting | {{Awaiting}} |
| (orange butt icon Buttinsky) | {{Buttinsky}} |
| File:Symbol dot dot dot.svg Comment. | {{Commentvote}} |
| File:Symbol redirect vote2.svg Dupe | {{Bug dupe}} |
| File:Mergefrom.svg Merged | {{Clerk-Note-merged}} |
 New bug | {{NewBug}} |
 Bug fixed | {{BugFixed}} |
 Duplicate proposal | {{DuplicateProposal}} |
| confused face icon Just curious... | {{Justcurious}} |
 Proposal out of scope | {{ProposalOutOfScope}} |
| File:Symbol redirect vote.svg Moved to Commons | {{Moved to commons}} |
| File:Symbol 囧 vote.svg Orz... | {{Orz}} |
| (File:Peanuts icon.svg peanut gallery comment) | {{Peanut}} |
| File:Symbol possible vote.svg Possibly | {{Possibly}} |
 I have read the above message. I will reply when I have a moment. | {{Read}} |
| Yes Received | {{Received}} |
| flag Redflag | {{Redflag}} |
 Redundant | {{Redundant symbol}} |
| recycle Reopened | {{Reopened}} |
| @Example: | {{Reply to}} |
| arrow Reverted | {{Reverted}} |
| File:Twemoji2 1f941.svg Audio file "Kevin MacLeod assorted rimshots - Kdum-keesh.wav" not found | {{Rimshot}} |
| lens Review | {{Twomanrule}} |
| lens Review – This section is under review or has been partially reviewed by | {{UnderReview}} |
 Facepalm | {{Facepalm}} |
| scissors Running with scissors is too dangerous for Wikipedia! | {{Scissors}} |
| trout Self-trout | {{Self-trout}} |
| whale Self-whale... for when a trout just isn't enough | {{Self-whale}} |
 Sent | {{Sent}} |
| per snowball clause icon | {{Snow}} |
| File:Symbol Translate.svg SUL Check | {{SULcheck}} |
 | {{Doge}} |
| File:OOjs UI icon robot.svg Looks AI-generated to me. | {{Looks AI-generated}} |
| File:OOjs UI icon robot.svg | {{Looks AI-generated2}} |
File:OOjs UI icon robot.svg  Sounds like a clanker beeping into a megaphone to me | {{MegaphoneAI}} |
| File:OOjs UI icon robot.svg 1.75x amplified ultimate beep of ultimate destiny | {{MegaphoneAI|ultimate}} |
| icon ToDo | {{ToDo}} |
| eraser Undone | {{Undone}} |
| icon Uploaded | {{Uploaded}} |
| icon Request withdrawn | {{Withdrawn}} |
| icon Working | {{Working}} |
 Wikipedia is not a crystal ball. | {{WPcrystalball}} |
| File:Symbol redirect vote.svg Completed | {{Completed}} |
| File:Symbol version newer.svg Blocked but awaiting tags | {{Sblock}} |
| File:Symbol possible vote.svg Possible | {{Possible}} |
| File:Symbol no support vote.svg Not possible | {{Not possible}} |
| File:Symbol version generic.svg Possilikely (a mix between possible and likely) | {{Possilikely}} |
| File:Symbol unlikely.svg Unlikely | {{Unlikely}} |
| minus Replaced | {{Replaced}} |
 Looks like a duck to me | {{Duck}} |
| | {{Duck2}} |
 Sounds like a duck quacking into a megaphone to me | {{Megaphoneduck}} |
| 1.75x amplified ultimate quack of ultimate destiny | {{Megaphoneduck|ultimate}} |
| File:Symbol merge vote.svg Clerk assistance requested: | {{Clerk Request}} |
| File:Symbol move vote.svg Relisted | {{Relisted}} |
| icon No sleepers immediately visible | {{Nosleepers}} |
| File:Symbol rename vote.svg Behavioural evidence needs evaluation | {{Behaviour}} |
| Redirect arrow Global lock(s) requested | {{GlobalLocksRequested}} |
| File:Time2wait.svg Stale | {{StaleIP}} |
 The CheckUser Magic 8-Ball says: | {{8ball}} |
| CheckUser is not a crystal ball | {{Crystalball}} |
 CheckUser is not for fishing | {{Fishing}} |
| File:Pixie dust.png CheckUser is not magic pixie dust | {{Pixiedust}} |
| ¯\_(ツ)_/¯ | {{Shrug}} |
| ( ͡° ͜ʖ ͡°) | {{Lenny}} |
| (╯°□°)╯︵ ┻━┻ | {{Table flip}} |
| File:Symbol version newer.svg Almost | {{Almost}} |
Multi-sign templates
The following templates implement several icons:
- {{AIV}} – used by Wikipedia:Administrator intervention against vandalism
- {{AN3}} - used by Wikipedia:Administrators' noticeboard and its subpages
- {{BOTREQ}} - used by Wikipedia:Bot requests
- {{CPC}} - used by Wikipedia:Copyright problems
- {{CUI}} - used by CheckUsers
- {{EFFP}} – used by Wikipedia:Edit filter/False positives
- {{EFR}} – used by Wikipedia:Edit filter/Requested
- {{EP}} – used for servicing requests in edit-protected areas
- {{RFPP}} – used by Wikipedia:Requests for page protection
- {{RFPC}}, {{RFPNPR}}, {{RFPPM}}, {{RFPR}} – used by subpages of Wikipedia:Requests for permissions
- {{UAA}} – used by Wikipedia:Usernames for administrator attention
- {{UND}} – used by Wikipedia:Requests for undeletion
- {{Smiley}} – used for informal communication purposes
- {{Sym}} – Various commonly used symbols and icons
- {{Article history}}
Others
- Template:Check mark templates, for templates like these but without text
- Template:Icon, a template that creates an inline icon/image that is used in metapages
- Wikipedia:List of discussion templates, a more linear table of essentially the same set of templates
- Template:Resolved/See also, the smaller family of thread-level hatnote templates, similar to the above but with a box around them; any template above can be converted to one of those with {{Resbox}}
- Template:Table cell templates/doc, the family of table-specific templates that work only in tables
- Category:Image with comment templates
- Category:Resolution templates
| General community topics | |
| Contents and grading | |
| WikiProjects and collaborations | |
| Awards and feedback | |
| Maintenance tasks | |
| Administrators and noticeboards | |
| Content dispute resolution | |
| Other noticeboards and assistance | |
| Deletion discussions | |
| Elections and voting | |
| Directories, indexes, and summaries |
- Template:Thank you invokes Module:Navbox using Lua.
Usage
This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.
The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.
Syntax
{{navbox
|state = uncollapsed, collapsed, plain, autocollapse (default)
|name = mandatory - name of the template
|style = optional - style for the whole table
|title = mandatory - navbox header
|gtitleN = optional - title of N-th group of items
|styleN = optional - style for groupN; i.e. text-align
|groupN = mandatory - list of groups of items
|fstyle = optional - style for footer ; i.e. text-align
|footer = optional - navbox footer
}}
- Groups: Currently there is no technical limit to the maximum number of groups.
- Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
- Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
- Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
- Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
- Line breaks: Line-breaks (
<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN. - Bullets: Create unordered lists with lines beginning with *.
- Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! (
{{!}}).
States
- Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
- Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
- Uncollapsed: Forces the navbox to be displayed.
- All of the navboxes in this documentation are in the uncollapsed state.
- Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
- Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
- Plain: Removes the "show/hide" link.
Sub-groups
- For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
- To create sub-groups within
{{navbox}}, certain parameters are to be included:- The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
- The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|gtitle2 =
|gtype2 = Subgroup (mandatory)
|group2 =
{{navbox
|subgroup = yes (mandatory)
|gtitle1 =
|group1 =
|gtitle2 =
|group2 =
}}
}}
Collapsible sub-groups
- For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
- To create collapsible sub-groups within
{{navbox}}, these parameters need to be included:- The parent navbox is almost always uncollapsed (state=uncollapsed).
- The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
- The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
- The nested collapsible navbox is forcefully collapsed (state=collapsed).
{{navbox
|state = uncollapsed
|name =
|gtype1 = Subgroup
|group1 =
{{navbox
|collapsible = yes
|state = collapsed
|title =
|gtitle1 =
|group1 =
|gtitle2 =
|group2 =
}}
}}
Use of images
- The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
- Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.
Link and file share the same name
{{plink|Item}}
File name differs from the link
{{plink|Item|File}}
Link and file share the same name, but different text is desired to display
{{plink|Item|alt=Text}}
File name differs from the link and different text is desired to display
{{plink|Item|File|alt=Text}}
Categorising
Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.
There are 2 methods of categorising pages with navboxes:
The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.
Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.
Examples
To see the following navboxes in action, see Template:Navbox.
Single line navbox with centered list
{{navbox
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Navbox with standard footer
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|footer = Centered footer
}}
Navbox with styled footer
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|fstyle = text-align:right
|footer = Right-aligned footer
}}
Multiple line navbox
{{navbox
|name =
|title =
|gtitle1 = Group title 1
|group1 =
|gtitle2 = Group title 2
|group2 =
|gtitle3 = Group title 3
|group3 =
}}
Collapsed navbox
{{navbox
|state = collapsed
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Plain navbox with Tnavbar
{{navbox
|state = plain
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Plain navbox without Tnavbar
{{navbox
|state = plain
|title =
|style1 = text-align:center
|group1 =
}}
Complicated navbox
{{navbox
|state = uncollapsed
|name =
|title =
|gtitle1 = Level 1 Title 1
|group1 =
|gtitle2 = Level 1 Title 2
|group2 =
|gtitle3 = Level 1 Title 3
|group3 =
|gtitle4 = Level 1 Title 4
|group4 =
|gtitle5 = Level 1 Title 5
|gtype5 = Subgroup
|group5 =
{{navbox
|subgroup = Yes
|gtitle1 = Level 2 Title 1
|group1 =
|gtitle2 = Level 2 Title 2
|group2 =
|gtitle3 = Level 2 Title 3
|gtype3 = Subgroup
|group3 =
{{navbox
|subgroup = Yes
|gtitle1 = Level 3 Title 1
|group1 =
|gtitle2 = Level 3 Title 2
|group2 =
}}
|gtitle4 = Level 2 Title 4
|group4 =
}}
|gtitle6 = Level 1 Title 6
|group6 =
|gtitle7 = Level 1 Title 7
|group7 =
|fstyle =
|footer =
}}
Preventing unwanted documentation
The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).
Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.
| Help page navboxes | |
| Community navboxes | |
| Other navboxes | |
| All-in-one navboxes | |
| Rule sidebars | |
| Other help sidebars | |
| Community sidebars | |
| Bar-style headers |
- Template:Thank you invokes Module:Navbox using Lua.
Usage
This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.
The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.
Syntax
{{navbox
|state = uncollapsed, collapsed, plain, autocollapse (default)
|name = mandatory - name of the template
|style = optional - style for the whole table
|title = mandatory - navbox header
|gtitleN = optional - title of N-th group of items
|styleN = optional - style for groupN; i.e. text-align
|groupN = mandatory - list of groups of items
|fstyle = optional - style for footer ; i.e. text-align
|footer = optional - navbox footer
}}
- Groups: Currently there is no technical limit to the maximum number of groups.
- Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
- Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
- Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
- Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
- Line breaks: Line-breaks (
<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN. - Bullets: Create unordered lists with lines beginning with *.
- Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! (
{{!}}).
States
- Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
- Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
- Uncollapsed: Forces the navbox to be displayed.
- All of the navboxes in this documentation are in the uncollapsed state.
- Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
- Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
- Plain: Removes the "show/hide" link.
Sub-groups
- For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
- To create sub-groups within
{{navbox}}, certain parameters are to be included:- The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
- The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|gtitle2 =
|gtype2 = Subgroup (mandatory)
|group2 =
{{navbox
|subgroup = yes (mandatory)
|gtitle1 =
|group1 =
|gtitle2 =
|group2 =
}}
}}
Collapsible sub-groups
- For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
- To create collapsible sub-groups within
{{navbox}}, these parameters need to be included:- The parent navbox is almost always uncollapsed (state=uncollapsed).
- The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
- The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
- The nested collapsible navbox is forcefully collapsed (state=collapsed).
{{navbox
|state = uncollapsed
|name =
|gtype1 = Subgroup
|group1 =
{{navbox
|collapsible = yes
|state = collapsed
|title =
|gtitle1 =
|group1 =
|gtitle2 =
|group2 =
}}
}}
Use of images
- The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
- Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.
Link and file share the same name
{{plink|Item}}
File name differs from the link
{{plink|Item|File}}
Link and file share the same name, but different text is desired to display
{{plink|Item|alt=Text}}
File name differs from the link and different text is desired to display
{{plink|Item|File|alt=Text}}
Categorising
Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.
There are 2 methods of categorising pages with navboxes:
The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.
Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.
Examples
To see the following navboxes in action, see Template:Navbox.
Single line navbox with centered list
{{navbox
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Navbox with standard footer
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|footer = Centered footer
}}
Navbox with styled footer
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|fstyle = text-align:right
|footer = Right-aligned footer
}}
Multiple line navbox
{{navbox
|name =
|title =
|gtitle1 = Group title 1
|group1 =
|gtitle2 = Group title 2
|group2 =
|gtitle3 = Group title 3
|group3 =
}}
Collapsed navbox
{{navbox
|state = collapsed
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Plain navbox with Tnavbar
{{navbox
|state = plain
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Plain navbox without Tnavbar
{{navbox
|state = plain
|title =
|style1 = text-align:center
|group1 =
}}
Complicated navbox
{{navbox
|state = uncollapsed
|name =
|title =
|gtitle1 = Level 1 Title 1
|group1 =
|gtitle2 = Level 1 Title 2
|group2 =
|gtitle3 = Level 1 Title 3
|group3 =
|gtitle4 = Level 1 Title 4
|group4 =
|gtitle5 = Level 1 Title 5
|gtype5 = Subgroup
|group5 =
{{navbox
|subgroup = Yes
|gtitle1 = Level 2 Title 1
|group1 =
|gtitle2 = Level 2 Title 2
|group2 =
|gtitle3 = Level 2 Title 3
|gtype3 = Subgroup
|group3 =
{{navbox
|subgroup = Yes
|gtitle1 = Level 3 Title 1
|group1 =
|gtitle2 = Level 3 Title 2
|group2 =
}}
|gtitle4 = Level 2 Title 4
|group4 =
}}
|gtitle6 = Level 1 Title 6
|group6 =
|gtitle7 = Level 1 Title 7
|group7 =
|fstyle =
|footer =
}}
Preventing unwanted documentation
The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).
Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.