Module:Unicode data/doc

From MOASSpedia
Jump to navigation Jump to search

This is the documentation page for Module:Unicode data

Usage

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

code point

The code point is to be entered as hexadecimal value. For example, U+00A9 © COPYRIGHT SIGN:

|A9hex
|0xA9hex
|0x00A9hex
|0x00a9hex
{{#invoke:Unicode data|lookup|name|0x00A9}} → COPYRIGHT SIGN

Incorrect or unintended results:

169dec: {{#invoke:Unicode data|lookup|name|169}} → LATIN SMALL LETTER U WITH TILDE Red XN, is read as 169hex => 361hex
U+00A9 {{#invoke:Unicode data|lookup|name|U+00A9}} Red XN
غ {{#invoke:Unicode data|lookup|name|غ}} Red XN, cannot enter a character as codepoint.

lookup_ and is_ functions

lookup, is
Template-invokable functions that allow access to the functions starting with lookup and is. Replace the first underscore in the function name with a pipe. For most of the functions, add the code point in hexadecimal base as the next parameter, but for is_Latin, is_rtl, and is_valid_pagename, add text. HTML character references in the text are decoded by the module into code points.
For example, {{#invoke:Unicode data|is|Latin|àzàhàr̃iyyā̀}} → true.
name, lookup_name|code point
Receives a code point (hex number) and returns its name or label.
For &A9; ©: {{#invoke:Unicode data|lookup|name|A9}} → COPYRIGHT SIGN

List of functions

Incomplete (as of 24 March 2022)
  • Code points: enter hexadecimal value, for example |0x61 or |61.
Topic Function Parameter type Example-in Returns Character
Unicode character name |lookup_name code point
  • {{#invoke:Unicode data|lookup|name|0xA9}}
  • {{#invoke:Unicode data|lookup|name|0x0007}}
  • COPYRIGHT SIGN
  • <control-0007>
  • ©
  • &#x0007;
Scripts |lookup_script code point {{#invoke:Unicode data|lookup|script|A061}} Yiii
  • ꁡ
Blocks |lookup_block code point {{#invoke:Unicode data|lookup|block|A061}} Yi Syllables
  • ꁡ
Planes |lookup_plane code point
  • {{#invoke:Unicode data|lookup|plane|0xA9}}
  • {{#invoke:Unicode data|lookup|plane|0x1F608}}
  • Basic Multilingual Plane
  • Supplementary Multilingual Plane
  • ©
  • 😈


General Category |lookup_category code point
  • {{#invoke:Unicode data|lookup|category|0xA9}}
  • {{#invoke:Unicode data|lookup|category|0x002B}}
  • So
  • Sm
  • ©
  • +
Controls |is_control code point
  • {{#invoke:Unicode data|lookup|control|A9}}
  • {{#invoke:Unicode data|lookup|control|FFFF}}
  • assigned
  • unassigned
  • ©
  • &#xFFFF;
Latin script |is_Latin string
  • {{#invoke:Unicode data|is|Latin|abcŁíā̀}}
  • {{#invoke:Unicode data|is|Latin|abc文xyz}}
  • true
  • false
WP:Article title (WP:NCTR) |is_valid_pagename string
  • {{#invoke:Unicode data|is|valid_pagename|Main_page}}
  • {{#invoke:Unicode data|is|valid_pagename|# (disambiguation)}}
  • true
  • false
Bidirectionality, right-to-left scripts |is_rtl string
  • {{#invoke:Unicode data|is|rtl|ش}}
  • {{#invoke:Unicode data|is|rtl|34}}
  • true
  • false
  • ش
  • 4
Combining character |is_combining code point
  • {{#invoke:Unicode data|is|combining|0300}}
  • {{#invoke:Unicode data|is|combining|A0}}
  • true
  • false
  • ̀
  •  
Character assignation |is_assigned code point
  • {{#invoke:Unicode data|is|assigned|A061}}
  • {{#invoke:Unicode data|is|assigned|A061}}
  • true
  • true
  • ꁡ
  • ;
Printable |is_printable code point
  • {{#invoke:Unicode data|is|printable|A061}}
  • {{#invoke:Unicode data|is|printable|A061}}
  • true
  • true
  • ꁡ
Whitespace character § Unicode |is_whitespace code point
  • {{#invoke:Unicode data|is|whitespace|0x20}}
  • {{#invoke:Unicode data|is|whitespace|0xA0}}
  • true
  • true
  •  
Hangul |Hangul [application unknown]
  • &#x;
  • &#x;
Alias names |aliases [application unknown]
  • &#x;
  • &#x;



get_best_script |get_best_script [application unknown]

Data modules

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.

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. Lua error in mw.title.lua at line 209: too many expensive function calls.

Copyright

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

  • U+0634 ش ARABIC LETTER SHEEN]: false - true, rtl expected

See also

  • Named entities for U+22C1 ⋁ N-ARY LOGICAL OR: {{#invoke:LoadData|Numcr2namecr|0x22C1}} → &bigvee;, &Vee;, &xvee;
Retrieved from "https://moasspedia.org/w/index.php?title=Module:Unicode_data/doc&oldid=3650"