Template:Tone/doc

__EXPECTED_UNCONNECTED_PAGE__

If an article is not written in an encyclopedia-like style, add the {{tone}} template at the top. This template creates a banner stating the problem at the top of the article's page, and also adds its tagged articles to one of this wiki's administrative categories: Category:Wikipedia articles with style issues (shortcut to that category: CAT:STYLE).

For more about the way an encyclopedia's article is written, see this wiki's Manual of Style or Template index/Cleanup § Style of writing.

Note: This template is a self-reference, and should not be substituted.

Note 2: {{Magazine}} redirects here. You may be looking for {{Cite magazine}} or {{Infobox magazine}}

Usage

{{Tone}} or {{Tone|{{subst:DATE}}}}

Specific area

To make the banner apply to a more specific area, add |section, or |article:

{{Tone|section}}, or to include the date (recommended), {{Tone|section|{{subst:DATE}}}}

{{Tone|article}}, or to include the date (recommended), {{Tone|article|{{subst:DATE}}}}

Linking to a section on the talk page

To link to a relevant discussion on the article's Talk page, add the |talk= parameter. The argument (the part after the equals sign) can be either a section title on the article's own talk page, or the name of another page where discussion appears (with or without a specific section):

{{Tone|talk=Discussion of tone issues}}

{{Tone|talk=Talk:Another Article#Relevant discussion section}}

Notes

This template will add tagged articles to dated subcategories of Category:Wikipedia articles with style issues by month and to Category:All articles with style issues.

Redirects

The following templates are redirects to this template and will display the same message:

• {{Cleanup tone}}
• {{Cleanup-tone}}
• {{Formal}}
• {{Formal tone}}
• {{Inappropriate tone}}
• {{Inappropriatetone}}
• {{Unencyclopædic tone}}
• {{Unencyclopedic tone}}

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Tone in articles based on its TemplateData.

TemplateData for Tone

Use this template to indicate that an article is not written in an encyclopedia-like style.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Month and year	date	Month and year of tagging; e.g., 'January 2013', but not 'jan13' Example January 2013 Auto value {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}	String	suggested
Affected area	1	Text to replace the word "article", usually "section" Example section Auto value section	String	optional
Section name on talk page	talk	Section name on talk page where further information or discussion can be found	String	optional

See also

• Responsible tagging
• Tagging pages for problems
• Twinkle

Lists of related article templates

• Template index/Cleanup
• Template index/Sources of articles

Lists of other types of article templates

There are also messaging and tagging templates available for:

• merging articles;
• moving articles;
• splitting articles; and
• translating articles.

Templates that might be a better fit than this one

• Template:Promotional for articles on notable topics that sound too much 'like an advertisement'
• Template:Cleanup list
• Template:Cleanup rewrite
• Template:Confusing
• Template:Context for articles that need to provide more context and general information in the lead
• Template:Copy edit for multiple problems with grammar, style, cohesion, tone or spelling; least specific template, and so least helpful in identifying problem
• Template:Fiction for articles that confuse fact and fiction
• Template:Inappropriate person for articles using "I", "we", or "you"
• Template:Notability for articles that are probably not notable. ({{Importance}} is now repurposed and should not be used in this context.)
• Template:Self-contradictory
• Template:Technical for articles or sections with excessive jargon or not enough explanation for the readers outside that article's specialty
• Template:Tone inline to tag specific statements within an article
• Template:Unreferenced for articles with zero references (use {{More citations needed}} for articles with insufficient or weak references)

Template:Tone 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.

this wiki's tagged articles: backlog by template's category

Backlog lists tasks that should be done to improve Wikipedia (assuming the cleanup templates were placed correctly). Helping reduce backlogs is an important issue, so please feel free to help out.

Click any linked number for that category's articles prioritized by their number of incoming links.

Backlog categories

• General
• Administrative
• Assessment
• Stub sorting
• Template parameter

Lacking references

Fix one!

Accuracy

Content

• Popular low quality articles (top 5000 by pageviews with low ORES class predictions)

Links

Layout

Style

File description

File quality

Non-free file use

File licensing

Meta

Quality content

Other

New articles

()