Template:Contains special characters

Template documentation follows
Note: the template above may sometimes be partially or fully invisible.
Visit "Template:Contains special characters/doc" to edit its documentation if it is available. (How does this work?)

This template flags potential font/encoding issues for users when an article contains text which may not be rendered correctly on out-of-the-box installations of current operating systems.

Use this only in articles in which the presence of special characters is likely to confuse readers of affected articles; it is not needed on articles where special characters are ordinarily expected (mathematics articles, for instance).

Usage

Place at the top of affected articles, below any infobox. Specific languages have pre-programmed values installed in "Contains special characters" that hard-code the following (as appropriate for that language, see list below).

Code	Renders as
Typical implementations, with generally useful values:
{{Contains special characters | special = uncommon [[Unicode]] characters | fix = Help:Multilingual support | error = [[Specials (Unicode block)#Replacement character|question marks, boxes, or other symbols]] | characters = the intended characters | image = Replacement character.svg | link = Specials (Unicode block)#Replacement character | alt = <?> | compact = }}
{{Contains special characters | special = uncommon [[Unicode]] characters | fix = Help:Multilingual support | image = Replacement character.svg | link = Specials (Unicode block)#Replacement character | alt = <?> | compact = yes }}
Language-specific simplification
{{Contains special characters|Armenian}}
{{Contains special characters|Runic|section}}
{{Contains special characters|Baybayin|compact=yes}}

Parameters

|special=

The languages or special content the page includes. This is the text immediately after "This page contains". Free-form, so you can specify as many as you like. Remember to link to the articles for the characters / languages.

|fix=

The "rendering support" link to a page with the solution (installing fonts, etc.). This should just be the title of the fix page, unlinked. This should usually be Help:Multilingual support unless you have something more specific to point to for a particular language or use case (e.g. Help:IPA#Rendering issues, used in the {{Contains special characters|IPA}} variant of this template).

|error=

(optional; must be given a value or omitted entirely) The type of rendering error that will observed without the required support. Free-form wikicode, and will appear between "you may see" and "instead of". Defaults to: [[Specials (Unicode block)#Replacement character|question marks, boxes, or other symbols]], though ''[[mojibake]]'' may be good for East Asian languages.

|characters=

The specific type of characters that might be missing (i.e. kanji, kana). This is the final wording of the template, after "instead of". Free-form, remember to use links, if not already linked in |special=. The entire "instead of" clause will not appear if this is blank (i.e., the template will end with the wording of |error= or its default value).

|section=

(optional) By default, this display "article" in an article and "page" on all other pages. You can manually specify a replacement for that word, usually |section=section, but other values might be list or table. Note: The "|section=y" syntax does not work; it will output the letter "y". Support for that option can be added if it is desired.

|image=

(optional) Just the title (no File: or Image: prefix) of an image of the characters, ideally legible at 65x50px and either square or slightly wider than tall. The template defaults to blank, but a reasonable suggestion for many circumstances is Replacement character.svg: File:Replacement character.svg, which can be given an | description. (This is the default replacement character on Windows systems.)

|alt=

(optional) The alt text for the image, for visually-impaired readers. See WP:ALT. If the image is merely some text, the alt text should simply repeat that text.

|link=

(optional) Name of the article that the image should link to. This should just be the title of the page, unlinked, usually Specials (Unicode block)#Replacement character, but perhaps Mojibake for East Asian languages. By default, the image is considered to be purely decorative and does not link to any article. If this parameter is specified, the alt parameter should also be specified.

|width=

(unusually unused) The default width of the image is 22em. This can be made larger with this parameters, for a very small character, or considerably smaller for a short word.

|compact=y

(optional) If set to any value, it will display a shorter form of the standard text, to save space. It suppresses display of the values of |characters= and |error= (so having an image |link= that goes to the same page as |error= is particularly useful, in case someone later turns on the |compact=y feature.

Languages

The following languages have hard-coded values, removing the necessity of the above § Parameters. Note that |section= and |compact= are available for use even if the language is specified.

"Simplified" languages available for direct input

Language parameter	Template rendering	Examples of characters in question
{{Contains special characters|AA}}		＿＿＿_∧∧ ～'　＿＿__(,,ﾟДﾟ) 　 ＵU 　 　Ｕ U
{{Contains special characters|APL}}		⍟⍋⌹⋆⍕⍀←⌽⍳⍝
{{Contains special characters|Armenian}}		Ծծ
{{Contains special characters|Balinese}}		ᬅᬓ᭄ᬱᬭᬩᬮᬶ
{{Contains special characters|Baluchi}}		بلوچی
{{Contains special characters|Baybayin}}		ᜊᜌ᜔ᜊᜌᜒᜈ᜔ᜊᜇ᜔ᜎᜒᜆ᜔
{{Contains special characters|Braille}}		⠞⠑⠭⠞
{{Contains special characters|Burmese}}		မြန်မာအက္ခရာ
{{Contains special characters|Canadian}}		ᐇᑹᑹᓓᓔᔔᕧᗶᙥᙶᙽ
{{Contains special characters|Cherokee}}		Ꮂ
{{Contains special characters|Coptic}}		Ϣϣ
{{Contains special characters|cuneiform}} Other valid inputs are Anatolian cuneiform Neo-Assyrian cuneiform Neo-Babylonian cuneiform Old Babylonian cuneiform		𒅇𒀉𒆤𒈿𒅅𒄠𒅈𒅕𒄑𒌦
{{Contains special characters|Deseret}}		𐐔𐐯𐑅𐐨𐑉𐐯𐐻 𐐔𐐯𐑆𐐲𐑉𐐯𐐻
{{Contains special characters|Egyptian}}
{{Contains special characters|emoticon}}		⏰❤️🍉😂😩🛶☃✌❽🥇🏝️👧🏾
{{Contains special characters|Ethiopic}}		ሀለበተኀነ𐩠𐩡ዘየደገጠ𐩴𐩮𐩰
{{Contains special characters|Georgian}}		ქართული
{{Contains special characters|Glagolitic}}		Ⰳⰾⰰⰳⱁⰾⰻⱌⰰ
{{Contains special characters|Gothic}}		𐌺
{{Contains special characters|Hebrew}}		ק
{{Contains special characters|Hindko}}		بثجچشظعقگلمھے
{{Contains special characters|Hokkien}}		Pe̍h-ōe-jī
{{Contains special characters|Indic}}		ग्रा
{{Contains special characters|Javanese}}		ꦲꦏ꧀ꦱꦫꦗꦮ
{{Contains special characters|Karen}}		ကညီလံာ်ခီၣ်ထံး
{{Contains special characters|Khmer}}		ភាសាខ្មែរ
{{Contains special characters|Khoekhoe}}		ǃne
{{Contains special characters|Lao}}		ພາສາລາວ
{{Contains special characters|Lanna}} {{Contains special characters|Northern Thai}}		ᨣᩴᩤᨾᩮᩬᩥᨦ
{{Contains special characters|Lontara}}		ᨒᨚᨈᨑ
{{Contains special characters|Manchu}}		ᠮᠠᠨᠵᡠ ᡤᡳᠰᡠᠨ
{{Contains special characters|Meitei}}		ꯃꯩꯇꯩ ꯃꯌꯦꯛ
{{Contains special characters|Mongolian}}		ᠮᠣᠩᠭᠣᠯ ᠪᠢᠴᠢᠭ
{{Contains special characters|Nom}}		𡨸喃
{{Contains special characters|Ogham}}		ᚁᚂᚃᚄᚅᚆᚇᚈᚉᚊᚋᚌᚍᚎᚏᚐᚑᚒᚓᚔᚕᚖᚗᚘᚙᚚ᚛᚜
{{Contains special characters|Old Hungarian}}		𐲀𐲄𐲅𐲆𐲇𐲍𐲎𐲜𐲝𐲞𐲟𐲠𐳄𐳅𐳥𐳦𐳧𐳨𐳱𐳲𐳺𐳾𐳿
{{Contains special characters|Old Persian}}		𐎠𐎣𐎤𐎫𐎬𐎭𐎮𐎳𐎴𐎵𐏊𐏋𐏏𐏐𐏑𐏕
{{Contains special characters|Ottoman Turkish}}		ا‎ـا‎ء‎بـ‎ـ‎پـ‎ت‎ـت‎ـضـ‎ظ‎ـظ‎ـغـ‎ف‎ـقـ‎قـ‎ـ‎گـ‎ل‎ـم‎ـمـنـ‎نـ‎ـه‎ـهـ‎ـی‎ـیـ‎
{{Contains special characters|Pashto}}		ﺍپﺕﺙﺝچﺩﺭﺱښﻁﻕکﻡﻥيئ
{{Contains special characters|Perso-Arabic}}		چ
{{Contains special characters|PIE}}		l̥
{{Contains special characters|Runic}}		ᚱᚢᚾᛟᚠᚥᛊᛋᛌᛍᛓᛔᛤᛥᛨᛩᛪ᛫᛭ᛮᛯᛰᛴᛵᛸ
{{Contains special characters|Saraiki}}		ابٹخدڊڈزژسصضعغقکمنھے
{{Contains special characters|Shavian}}		𐑮𐑰𐑮𐑲𐑑𐑦𐑙
{{Contains special characters|SignWriting}}		𝠀𝠁𝠂𝠥𝠧𝡩𝡪𝡫𝣶𝪛𝣷𝣸𝣺𝦙𝦚𝦛𝩆𝩈𝩉
{{Contains special characters|Sindhi}}		सिन्धी ਸਿੰਧੀ سنڌي
{{Contains special characters|Sundanese}}		ᮃᮊ᮪ᮞᮞᮥᮔ᮪ᮓ°ᮂ᮸᳅
{{Contains special characters|Syriac}}		ܐܠܦ ܒܝܬ ܣܘܪܝܝܐ
{{Contains special characters|Tamil}}		தமிழ் அரிச்சடி
{{Contains special characters|Tangut}}		𗃰𗁼𗀪𘄠𘢓𘫖
{{Contains special characters|Thai}}		อักษรไทย
{{Contains special characters|Tibetan}}		༁༂༖༗ཆཇླྀཹྪྫ࿂࿃࿘࿙
{{Contains special characters|Tifinagh}}		ⴰⴲⴸⴹⴺⴻⴼⴽⵃⵈⵏⵐⵞⵟⵥⵯ⵰
{{Contains special characters|Tirhuta}}
{{Contains special characters|Ugaritic}}
{{Contains special characters|Urdu}}		اردو تہجی
{{Contains special characters|Uyghur}}		ئۇيغۇر يېزىقى
{{Contains special characters|Vietnamese}}		ự ; 𡨸喃
{{Contains special characters|Warang Citi}}
{{Contains special characters|IPA}}		ʈʰul
{{Contains special characters|Uncommon Unicode}}		—N/a

See also

Template:Contains special characters 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.