View source for Template:Unichar2/doc

{{Documentation subpage}}
{{lua|Module:Numcr2namecr|Module:Unicode alias|Module:Unicode data|Module:BaseConvert|Module:ustring|Module:Check for unknown parameters|noprotcat=yes}}
{{Template redirect|Unicode character 2}}
Like {{tl|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.
* <syntaxhighlight lang="wikitext" inline>The character {{unichar2|©}} is about intellectual property.</syntaxhighlight> →
*: The character {{unichar2|©}} is about intellectual property.
It otherwise behaves the same as {{tl|unichar}} (where the primary input is a Unicode [[codepoint]]).

===Parameters===
{{hatnote|Parts of this section are transcluded from [[Template:Unichar/doc]], which is why some examples use that template. Both Unichar and Unichar2 support the same named parameters}}
The blank template, with all parameters, is as follows:
<syntaxhighlight lang="wikitext">
{{unichar2
| ulink  =
| image  =
| cwith  =
| suffix =
| size   =
| use    =
| use2   =
| nlink  =
| html   =
| note   =
| name   =
| alias  =
}}
</syntaxhighlight>

Inline version:
<syntaxhighlight lang="wikitext">
{{unichar2| <!--character-->|ulink= |image= |cwith= |suffix= |size= |use= |use2= |nlink= |html= |note= }}
</syntaxhighlight>
* '''First unnamed parameter''' or {{para|1}} {{smallcaps2|(Required)}} The character to be displayed.
**<syntaxhighlight lang="wikitext" inline>{{unichar2|u}}</syntaxhighlight> &rarr; {{unichar2|u}}
*:''Note'': Only the first code point is read; any subsequent characters—even combining characters—are ignored
*:*<syntaxhighlight lang="wikitext" inline>{{unichar2|uͤ}}</syntaxhighlight> &rarr; {{unichar2|uͤ}}
{{#section-h:Template:unichar/doc|Parameters}}

===Limitations===
[[mw:Unicode normalization considerations|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 {{unichar|2126}} into this template and saving the edit will result in {{unichar2|Ω}}. The workaround for this is to simply use {{tl|unichar}} instead.

==Tracking==
* {{clc|Category:Pages using Unichar2 with unknown parameters}}

==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Character",
			"description": "A single Unicode character",
			"example": "∑",
			"type": "string",
			"required": true
		},
		"ulink": {
			"example": "Phonetic symbols in Unicode",
			"type": "line",
			"description": "Add link to the Unicode HEX code point"
		},
		"image": {},
		"cwith": {
			"type": "string",
			"description": "(for combing characters only) add the following character before this combining character:",
			"example": "◌",
			"suggestedvalues": [
				"◌"
			]
		},
		"size": {
			"description": "Relative size of rendered character",
			"example": "200%",
			"type": "string"
		},
		"use": {
			"type": "string"
		},
		"use2": {
			"type": "string"
		},
		"nlink": {
			"type": "string",
			"description": "Add link to the Unicode character name"
		},
		"note": {
			"type": "line"
		},
		"html": {
			"label": "HTML code",
			"description": "When present, shows HTML named entity",
			"example": "html= shows \"&copy;\"",
			"type": "string"
		},
		"alias": {
			"suggestedvalues": [
				"yes"
			]
		},
		"name": {
			"suggestedvalues": [
				"none"
			],
			"description": "Hide the name of the character"
		},
		"suffix": {}
	},
	"description": "Formats a Unicode character description inline.",
	"format": "inline",
	"paramOrder": [
		"1",
		"ulink",
		"nlink",
		"cwith",
		"size",
		"image",
		"use",
		"use2",
		"html",
		"note",
		"alias",
		"name",
		"suffix"
	]
}
</templatedata>

<includeonly>{{Sandbox other||
<!-- Categories below this line -->
[[Category:Unicode character templates]]
}}</includeonly>
{{Unicode templates}}