Module:Unicode data/doc
This is the documentation page for Module:Unicode data
 | This Lua module is used on approximately 953,000 pages, or roughly 16889% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
Usage
[jhyuk a̱tyin ka]This module provides functions that access information on Unicode code points. The information is retrieved from data modules generated from the Unicode Character Database, or derived by rules given in the Unicode Specification. It and its submodules were copied from English Wiktionary and then modified; see there for more information.
Parameters and functions
[jhyuk a̱tyin ka]code point
[jhyuk a̱tyin ka]The code point is to be entered as hexadecimal value. For example, Ta̱mpi̱let:Unichar:
- |A9hex
- |0xA9hex
- |0x00A9hex
- |0x00a9hex
{{#invoke:Unicode data|lookup|name|0x00A9}}→ <reserved-00A9>
Incorrect or unintended results:
- 169dec:
{{#invoke:Unicode data|lookup|name|169}}→ <reserved-0169> Ta̱mpi̱let:Nay —"U+00A9"©expected; but is read as 00A9hex (that is, Ta̱mpi̱let:Hex2decdec - U+00A9
{{#invoke:Unicode data|lookup|name|U+00A9}}Ta̱mpi̱let:Nay —do not use "U+" prefix - غ
{{#invoke:Unicode data|lookup|name|غ}}Ta̱mpi̱let:Nay —cannot enter a character as codepoint
"lookup" and "is" functions
[jhyuk a̱tyin ka]lookup, is- Template-invokable functions that allow access to the functions starting with
lookupandis.For most of the functions, add the code point in hexadecimal base as the next parameter. Foris"|Latin,is|rtl, andis|valid_pagename, add character string. HTML character references in the text are decoded by the module into code points. - For example, Ta̱mpi̱let:Tnull → true.
- Internally, in modules, these functions are named using underscore:
lookup_name|code point←lookup_name - For
&A9;©: Ta̱mpi̱let:Tnull → <reserved-00A9>
Functions overview
[jhyuk a̱tyin ka]- Incomplete (as of March 2022)
- Code points: enter hexadecimal value, for example Ta̱mpi̱let:Mxt or Ta̱mpi̱let:Mxt; not Ta̱mpi̱let:!mxt.
| Topic | Function | Parameter type (string=by character(s); c.p. by 0xHex value) |
Example-in | Returns | Character |
|---|---|---|---|---|---|
| Unicode character name | |lookup|name
|
code point | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl |
| Scripts | |lookup|script
|
code point | Ta̱mpi̱let:Tnull | Yiii | Ta̱mpi̱let:Ubl |
| Blocks | |lookup|block
|
code point | Ta̱mpi̱let:Tnull | Lua error in Module:Unicode_data at line 15: attempt to index local 'ranges' (a boolean value). | Ta̱mpi̱let:Ubl |
| Planes | |lookup|plane
|
code point | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl
|
| General Category | |lookup|category
|
code point | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl |
| Controls | |is|control
|
code point | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl |
| Latin script | |is|Latin
|
string | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl | |
| WP:Article title (WP:NCTR) | |is|valid_pagename
|
string | Ta̱mpi̱let:Ubli | Ta̱mpi̱let:Ubl | |
| Bidirectionality, right-to-left scripts | |is|rtl
|
string | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubli | Ta̱mpi̱let:Ubl |
| Combining character | |is|combining
|
code point | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl |
| Character assignation | |is|assigned
|
code point | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl |
| Printable | |is|printable
|
code point | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl |
| Whitespace character § Unicode | |is|whitespace
|
code point | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl | Ta̱mpi̱let:Ubl |
| Hangul | |Hangul
|
[application unknown] | Ta̱mpi̱let:Ubl | ||
| Alias names | |aliases
|
[application unknown] | Ta̱mpi̱let:Ubl | ||
| Combining class | |
|
[application unknown] | Ta̱mpi̱let:Ubl | ||
| Age | |
|
[application unknown] | Ta̱mpi̱let:Ubl | ||
| get_best_script | |get_best_script
|
[application unknown] | Ta̱mpi̱let:Ubl |
Data modules
[jhyuk a̱tyin ka]The data used by functions in this module is found in submodules. Some are generated by AWK scripts shown at User:Kephir/Unicode on English Wiktionary, others by Lua scripts on the /make subpages of the submodules.
- Module:Unicode data/age: 'Age' of a character, that is: version introduction number.
- Module:Unicode data/aliases: the formal name aliases for characters (from NameAliases.txt)
- Module:Unicode data/blocks: the list of Unicode blocks (from Blocks.txt)
- Module:Unicode data/category: data mapping characters to their General Category (from DerivedGeneralCategory.txt)
- Module:Unicode data/control: data for identifying characters that belong to the General Categories of Separator and Other (from DerivedGeneralCategory.txt)
- Module:Unicode data/combining: data mapping characters to their Combining Classes (from DerivedCombiningClass.txt)
- Module:Unicode data/Hangul: data used to generate the names of Hangul syllables (from Jamo.txt)
- Module:Unicode data/names/* (000hh, .., 0E0hh; eg ../names/000): names
- Module:Unicode data/scripts: data mapping characters to their Unicode script properties (from Scripts.txt).
- Module:Unicode data/derived core properties:
The name data modules (Module:Unicode data/names/xxx) were compiled from UnicodeData.txt. Each one contains, at maximum, code points U+xxx000 to U+xxxFFF. Script error: No such module "Unicode data/documentation functions".
Copyright
[jhyuk a̱tyin ka]The Unicode database is released by Unicode Inc. under the following terms:
Copyright © 1991-2018 Unicode, Inc. All rights reserved. Distributed under the Terms of Use in https://www.unicode.org/copyright.html.
Permission is hereby granted, free of charge, to any person obtaining a copy of the Unicode data files and any associated documentation (the "Data Files") or Unicode software and any associated documentation (the "Software") to deal in the Data Files or Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, and/or sell copies of the Data Files or Software, and to permit persons to whom the Data Files or Software are furnished to do so, provided that either (a) this copyright and permission notice appear with all copies of the Data Files or Software, or (b) this copyright and permission notice appear in associated Documentation.
THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THE DATA FILES OR SOFTWARE.
Except as contained in this notice, the name of a copyright holder shall not be used in advertising or otherwise to promote the sale, use or other dealings in these Data Files or Software without prior written authorization of the copyright holder.
Known issues
[jhyuk a̱tyin ka]- Reading data like
Module:Unicode data/aliasesnot provided nor documented - Test fail:
lookup_categoryU+FFFF (<noncharacter-FFFF>) expected: Cn.
{{#invoke:Unicode data|lookup|category|0xFFFF}}→ [Nil]
See also
[jhyuk a̱tyin ka]- Named entities: for example, Ta̱mpi̱let:Unichar:
{{#invoke:LoadData|Numcr2namecr|0x22C1}}→ Script error: No such module "LoadData".