Template:Globalize/doc

__EXPECTED_UNCONNECTED_PAGE__

Usage

Paste this at the top of the affected article or section:

{{Globalize|date=October 2026}}

This code provides the correct date, assumes that your concerns affect the entire article, and assumes that you will promptly explain your concerns on that article's talk page in a new section titled "Globalize."

For instructions on modifying this simplest version of the template code, see the following:

Article or section?

The default word article is replaceable so you can specify whether the whole article or just a section doesn't represent a worldwide view. One or the other must be given if you also wish to specify any countries to which the article currently leans without using a named parameter (which are: 2name=, 3name=, 4name=) to specify the country. Specifying the whole article or just one section is accomplished simply by adding those words as parameters: {{Globalize|article|date=October 2026}} or {{Globalize|section|date=October 2026}}.

Date

The maintenance date tagging parameter 'date=' should be given with a properly formatted ISO date as is common to most maintenance tags. This parameter is used in time-keyed autocategories, if you do not supply the current date, then a bot will add it later.

Link to the correct section of the talk page

As a means of maximizing the likelihood that your concerns will be addressed, you should consider to initiate a talk section detailing your concerns when hanging any maintenance tag. Without such explanations, it may be difficult for editors to understand what concerned you and to figure out whether subsequent changes have addressed your concerns.

Specify the full link prefix through section title. (Capture this off the url after saving your newly inaugurated complaint section works best—you literally can't go wrong and introduce a typo since it's cut and paste.)

This is achieved by adding |discuss=Talk:Article_Name#This_is_section_title.

If you do not explain your concerns on the article's talk page, you may expect this tag to be promptly and justifiably removed as "unexplained" by the first editor who happens to not understand why you added this tag.

Which regions are over-represented?

Country or region names given as a positional parameter are assumed to be links as can be seen in the code snippet: {{{2name|[[{{{2}}}]]}}} The 2name, 3name parameters also affect categorizations, so can be used to display one name and link those to a variant.

Up to three geographical areas covered can also be selected, {{Globalize|article or section|area 1|area 2|area 3}}. For each region, the template will automatically add the page to an appropriate cleanup category, named category:{{{country}}}-centric. If the name of the country differs from the category (for instance, the United Kingdom, but UK-centric) then you can use the 2name, 3name and 4name attributes to modify the displayed name.

Categorization

This template will also categorize tagged articles into Category:Articles with limited geographic scope. To disable all auto-categorisation (such as when used multiple times on the same page tagging various sections), define either inhibit= or nocat= to any value (e.g., |nocat=my cat or |inhibit=1.

Technical note

The first, second, third... positional parameters are equivalent in wikimarkup language to the named parameters 1=, 2=, 3=, ... so far as article links are concerned. However, the two parameters differ in their effects in selecting named autocategories as is covered below. (The best trick ... try either, or both, for many country related names have slight name differences from their category names and therefore you must test (check) for both redlinked article and category names)

simple form

{{Globalize
|{{subst:DATE}}
|discuss=Talk:Article_Name#"This_is_section_title"
| 1= article or section <!-- (defaults to article) -->
| 2= <!-- 1st country or region or  --> 
  | 2name=
}}

---

full commented form

{{Globalize
|date=
|discuss=|discussion=|talk= <!-- (just one of) Defines link paths to article's talk page SECTION link by title.
-- Define as "Talk:Article_Name#This_is_section_title" ) -->
| 1= article or section <!-- (defaults to article) -->
 <!-- 
  (just one of each pair in: {{{2}}}, {{{3}}}, {{{4}}} or 2name, 3name, 4name)
  These are the countries or regions on which the article is currently overly focused,
  in other words, 'those places the article is biased toward in the complaint
 -->
|  <!-- ({{{2}}}) --> 2= <!-- 1st country or region --> or | 2name=
|  <!-- ({{{3}}}) --> 3= <!-- 2nd country or region --> or | 3name
|  <!-- ({{{4}}}) --> 4= <!-- 3rd country or region --> or | 4name
 <!-- 
(optional category control parameters) -->
| nocat= true or inhibit=true  <!-- define either or both to inhibit auto-categorization into cleanup categories. -->
}}

Location

As with all maintenance templates, this template should be placed below any disambiguation links and above infoboxes, images, and the text of the lead to increase accessibility for users of screen readers.

TemplateData

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

TemplateData for Globalize

Use this cleanup template to indicate that an article is written primarily from the perspective of a particular region of the world.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Month and year	date	The month and year that the template was placed (in full). "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}" inserts the current month and year automatically. Example January 2013 Auto value {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}	Line	suggested
Region	2	Country or region that the article primarily deals with Example US, the Western world	Line	suggested
Second region	3	Second country or region that the article primarily deals with Example UK, Anglophone	Line	optional
Third region	4	Third country or region that the article primarily deals with Example Europe, Canada	Line	optional
First region name override	2name	Enter text here to override the automatic conversion of some region names (US, UK) with the text entered. Example the US, the UK	Line	optional
Second region name override	3name	Enter text here to override the automatic conversion of some region names (US, UK) with the text entered. Example Britain, the West	Line	optional
Third region name override	4name	Enter text here to override the automatic conversion of some region names (US, UK) with the text entered. Example the EU, the Anglosphere	Line	optional
Talk page section	talk discuss discussion	Section name on the talk page for further discussion	Line	suggested
Make template small	small	Enter "left" here to make the template box small and aligned to the left. Example left Auto value left	Line	optional
Scope	1	Custom text to describe the area of the article needing attention. Defaults to "article" if blank, and is usually customized to "section". Consider using the {{Globalize section}} template for identical function. Suggested values section Default article Example section Auto value section	Line	optional
Reason	reason	no description	Unknown	optional

See also

• {{Globalize-inline}} inline version of this template
• {{Geographical imbalance}} for coverage within a specific region
• {{Where}} for unclear geographical scope
• Template messages/Cleanup

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