Template:Unichar2/doc

This is a documentation subpage for Template:Unichar2.
It may contain usage information, categories and other content that is not part of the original template page.

__EXPECTED_UNCONNECTED_PAGE__

This template uses Lua:

Redirect

{{Unicode character 2}}

Like {{Unichar}}, this template produces a formatted description of a Unicode character, to be used inline or otherwise with regular text.

Usage

This template takes a Unicode character as input.

The character {{unichar2|©}} is about intellectual property. →
The character U+00A9 © <reserved-00A9> is about intellectual property.

It otherwise behaves the same as {{unichar}} (where the primary input is a Unicode codepoint).

Parameters

The blank template, with all parameters, is as follows:

{{unichar2
| ulink  =
| image  =
| cwith  =
| suffix =
| size   =
| use    =
| use2   =
| nlink  =
| html   =
| note   =
| name   =
| alias  =
}}

Inline version:

{{unichar2| <!--character-->|ulink= |image= |cwith= |suffix= |size= |use= |use2= |nlink= |html= |note= }}

First unnamed parameter or |1= (Required) The character to be displayed.
- {{unichar2|u}} → U+0075 u <reserved-0075>
Note: Only the first code point is read; any subsequent characters—even combining characters—are ignored
- {{unichar2|uͤ}} → U+0075 u <reserved-0075>
|nlink=name Optional hyperlink to the target article. Name of the Wikipedia page that will be linked to. If used, the Unicode name has a wikilink to the article.
{{unichar|00A9|nlink=}} → U+00A9 © <reserved-00A9>

{{unichar|00A9|nlink=Copyright symbol}} → U+00A9 © <reserved-00A9>
Notes:
- The form nlink= (without any detail) is the most common way to use this option, to link to the article about the symbol using its canonical name.
- When used without a name (i.e., |nlink=, blank with no value), the link points to the article about the character itself except when that causes a problem with technical restrictions on naming, in which case the name of the character is used or an error is produced if no such name exists (see § Presentation effects).
- The name of the page is case-sensitive as with all Wikipedia pages.
- It is possible to give a Wiktionary page here, using the syntax nlink=wikt:<target article>, which may be appropriate if there is no suitable Wikipedia article. For example:
  - {{unichar|204A|nlink=wikt:⁊}} → U+204A ⁊ <reserved-204A>
- Use of this parameter to link to any article other than the one at the canonical name (even if that is a redirect) is potentially an intuitive linking violation, so such use is exceptional and must have a clear justification. ['Copyright sign' and 'copyright symbol' are used here for illustration only and nlink would not normally be used in this case.]
|cwith= Optional. The only valid content is ◌ or (or its HTML code, ◌). It may also be used without any content (i.e., |cwith=, blank with no value). This parameter is useful when the Unicode character is combining (such as a combining diacritic). Using |cwith=◌, the character will be combined with the placeholder symbol, U+25CC ◌ <reserved-25CC>.
without a |cwith=:
{{unichar|0485}} → U+0485 ҅ <reserved-0485>

|cwith= with dotted circle:
{{unichar|0485|cwith=◌}} → U+0485 ◌҅ <reserved-0485> or

{{unichar|0485|cwith=◌}} → U+0485 ◌҅ <reserved-0485>

|cwith= without an argument:
{{unichar|0485|cwith=}} → U+0485 ◌҅ <reserved-0485>
- Note that cwith=◌◌ alone does not provide the desired result if the intention is to display a diacritic that spans two characters (such as those in the range U+035C to U+0362): the diacritic will be offset. In such cases, editors must use cwith=◌ together with suffix=◌ to place two dotted circles – one on either side of the codepoint for the combining diacritic.
  {{unichar|035F|cwith=◌|suffix=◌}} → U+035F ◌͟◌ <reserved-035F>
- Use of any other character except dotted circle as input to |cwith= is deprecated; this restriction is not currently enforced but if any other character is used, the output (grapheme and description) is at best misleading.
- For scripts other than Latin, use of the parameters use=lang and use2= may additionally be needed for better rendering.
|suffix= Optional. Its contents directly follow the character. The only supported uses of this parameter are for diacritics that span two characters (see |cwith= above) and for appending variation selectors to certain characters.
For example, using U+FE0E ︎ VARIATION SELECTOR-15 which forces emoji to display as text, one can have:

{{unichar|01F604|suffix=︎|note=with {{unichar|FE0E}}}} → U+1F604 😄︎ <reserved-1F604> (with U+FE0E ︎ VARIATION SELECTOR-15)
Since variation selectors change the appearance of the character, their presence should always be mentioned in a |note= or in prose.

The Unicode Consortium has decided that it was a mistake to unify traditional and emoji forms, so the 'variation selector' method should be regarded as at best time-limited. It is already not fully functional on some plaforms such as Google Android, always preferring the emoji form. See Variation Selectors (Unicode block).
|html= Optional. If a named character reference exists, like " ", it is displayed after the character name. Otherwise nothing happens. In particular, numeric character references like   are never displayed. Only the existence of an |html= parameter is checked, everything after the equal sign is ignored so you can leave it blank.
- {{unichar|160|html=}} → U+0160 Š <reserved-0160> (&Scaron;)
|note= Optional. Adds a comment such as a clarification or explanatory note. For example, as the canonical names of ideographs are not generally helpful, the note= option permits an added comment such as U+4E95 井 CJK UNIFIED IDEOGRAPH-4E95 (jǐng)
|ulink= Optional. Creates a wikilink from the U+ prefix. When used without a name (i.e., |ulink=, blank with no value), the article Unicode is used as the default value in the output: [[Unicode|U+]] producing U+. This only needs to change if you have a reason to link elsewhere than Unicode, e.g. to an article on a subset of Unicode characters.
|use= Optional. Sets the font-hinting template to get the glyph, since the character may not be present in a regular browser font. By default no template is used; the available options are {{IPA}}, {{lang}} and {{script}}.
|use2= Optional. When setting |use=lang or |use=script, |use2= should be used to set the language (e.g. |use2=fr) or the script (e.g. |use2=Cyrs). A glyph may still not show as expected due to browser effects. For a detailed description, see each template's documentation.
{{unichar|0485|cwith=◌|use=script|use2=Cyrs}} → U+0485 ◌҅ <reserved-0485>

{{unichar|3099|cwith=◌|use=lang|use2=ja}} → U+3099 ◌゙ <reserved-3099> (If use+use2 are not used, the Japanese diacritic dakuten is not shown properly by some browsers.)
|image= Optional. Allows for a graphic image file to represent the glyph; overrides the font completely. The filename should include the extension (like .svg or .png), but not the prefix File:.
- Depending on the image used, class=skin-invert might be needed so the image displays correctly in dark mode. Compare:
  {{unichar|20B9|image=Indian Rupee symbol.svg{{!}}class=skin-invert}} → U+20B9 <reserved-20B9> <reserved-20B9>
  
  {{unichar|20B9|image=Indian Rupee symbol.svg}} → U+20B9 <reserved-20B9> <reserved-20B9>
- This option is rarely needed: it is intended for use with characters that have been given a codepoint but have yet to be included in mainstream system fonts. It is good practice to add a (hidden) comment to explain why its use has been needed, as in time that will cease to be the case. It is no longer appropriate to use it with the Indian Rupee sign, for example.
|size= Optional. Can be used to set the size of the glyph. The default value is 125%. For the font, all CSS font-size style inputs are accepted: 7px, 150%, 2em, larger.
- For example, {{unichar|0041|size=2em}} → U+0041 A <reserved-0041>
- When using an image (file) instead of a font, this size can only accept sizes in px like 12px. Default for images is 10px.
|name=. Optional; if used, the only permitted content is none. This parameter is provided for the rare cases where only the code-point and the corresponding character are wanted.
- For example, {{unichar|a9|name=none}} produces U+00A9 © .
|alias=. Optional; if used, the only permitted content is yes. The purpose of this parameter is to handle the very rare cases where the Unicode Consortium has identified that a name is seriously defective and misleading, or has a serious typographical error, and has defined a formal alias that applications are encouraged to use in place of the official character name. (See Unicode#Alias for details.)
- For example, U+A015 YI SYLLABLE WU has the formal alias YI SYLLABLE ITERATION MARK. Thus, rather than {{unichar|A015}} → U+A015 ꀕ <reserved-A015>, the style {{unichar|A015|alias=yes}} → U+A015 ꀕ YI SYLLABLE ITERATION MARK is preferred in most contexts.

Limitations

MediaWiki applies Normalization Form C to every edit. This means that some characters cannot be displayed using this template because they will be converted to the corresponding normalized character(s). For example, putting the character U+2126 Ω <reserved-2126> into this template and saving the edit will result in U+03A9 Ω <reserved-03A9>. The workaround for this is to simply use {{unichar}} instead.

Tracking

Category:Pages using Unichar2 with unknown parameters (0)

TemplateData

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

TemplateData for Unichar2

Formats a Unicode character description inline.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Character	`1`	A single Unicode character Example ∑	String	required
ulink	`ulink`	Add link to the Unicode HEX code point Example Phonetic symbols in Unicode	Line	optional
nlink	`nlink`	Add link to the Unicode character name	String	optional
cwith	`cwith`	(for combing characters only) add the following character before this combining character: Suggested values `◌` Example ◌	String	optional
size	`size`	Relative size of rendered character Example 200%	String	optional
image	`image`	no description	Unknown	optional
use	`use`	no description	String	optional
use2	`use2`	no description	String	optional
HTML code	`html`	When present, shows HTML named entity Example html= shows "©"	String	optional
note	`note`	no description	Line	optional
alias	`alias`	no description Suggested values `yes`	Unknown	optional
name	`name`	Hide the name of the character Suggested values `none`	Unknown	optional
suffix	`suffix`	no description	Unknown	optional

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

v • d • e Unicode templates
General
Inline
Character properties
Code points
Scripts
CJK-specific
Wikipedia related