Template:Contains special characters/doc
Jump to navigation
Jump to search
Script error: No such module "Message box". Script error: No such module "High-use". Template:Uses TemplateStyles 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}}
|
Template:Contains special characters |
{{Contains special characters|Runic|section}}
|
Template:Contains special characters |
{{Contains special characters|Baybayin|compact=yes}}
|
Template:Contains special characters |
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 supportunless you have something more specific to point to for a particular language or use case (e.g.Help:IPA#Rendering issues, used in the Template:Tlx variant of this template). |error=- (optional; Template:Em 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 belistortable. 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:orImage: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 perhapsMojibakefor 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=yfeature.
Languages
The following languages have hard-coded values, removing the necessity of the above Template:Slink. Note that |section= and |compact= are available for use even if the language is specified.