# Unicode v2.2.0 - Table of Contents

Functions to introspect the Unicode character database and
to provide fast codepoint lookups and guards.

## Pages

- [Unicode](readme.md)
- [License](license.md)
- [Changelog](changelog.md)

- Guides
  - [Introduction](introduction.md)

## Modules

- [Unicode](Unicode.md): Functions to introspect the Unicode character database and
to provide fast codepoint lookups for scripts, blocks,
categories and properties.

- Character properties
  - [Unicode.Age](Unicode.Age.md): Functions to introspect the Unicode `Age` property for binaries (Strings) and codepoints.
  - [Unicode.Block](Unicode.Block.md): Functions to introspect the Unicode block property for binaries (Strings) and codepoints.
  - [Unicode.CanonicalCombiningClass](Unicode.CanonicalCombiningClass.md): Functions to introspect the Unicode canonical combining class property for binaries (Strings) and codepoints.
  - [Unicode.DecompositionType](Unicode.DecompositionType.md): Functions to introspect the Unicode `Decomposition_Type` property for binaries (Strings) and codepoints.
  - [Unicode.EastAsianWidth](Unicode.EastAsianWidth.md): Functions to introspect the Unicode east asian width property for binaries (Strings) and codepoints.
  - [Unicode.GeneralCategory](Unicode.GeneralCategory.md): Functions to introspect the Unicode general category property for binaries (Strings) and codepoints.
  - [Unicode.HangulSyllableType](Unicode.HangulSyllableType.md): Functions to introspect the Unicode `Hangul_Syllable_Type` property for binaries (Strings) and codepoints.
  - [Unicode.NumericType](Unicode.NumericType.md): Functions to introspect the Unicode `Numeric_Type` property for binaries (Strings) and codepoints.
  - [Unicode.NumericValue](Unicode.NumericValue.md): Functions to introspect the Unicode `Numeric_Value` property for binaries (Strings) and codepoints.
  - [Unicode.Property](Unicode.Property.md): Functions to introspect Unicode properties for binaries
(Strings) and codepoints.
  - [Unicode.Script](Unicode.Script.md): Functions to introspect the Unicode script property for binaries (Strings) and codepoints.
  - [Unicode.ScriptExtensions](Unicode.ScriptExtensions.md): Functions to introspect the Unicode `Script_Extensions` property for binaries (Strings) and codepoints.
  - [Unicode.VerticalOrientation](Unicode.VerticalOrientation.md): Functions to introspect the Unicode `Vertical_Orientation` property for binaries (Strings) and codepoints.

- Bidirectional and shaping
  - [Unicode.BidiClass](Unicode.BidiClass.md): Functions to introspect the Unicode bidirectional (bidi) class property for binaries (Strings) and codepoints.
  - [Unicode.BidiPairedBracketType](Unicode.BidiPairedBracketType.md): Functions to introspect the Unicode `Bidi_Paired_Bracket_Type` property for binaries (Strings) and codepoints.
  - [Unicode.JoiningGroup](Unicode.JoiningGroup.md): Functions to introspect the Unicode `Joining_Group` property for binaries (Strings) and codepoints.
  - [Unicode.JoiningType](Unicode.JoiningType.md): Functions to introspect the Unicode joining type property for binaries (Strings) and codepoints.

- Segmentation
  - [Unicode.GraphemeClusterBreak](Unicode.GraphemeClusterBreak.md): Functions to introspect the Unicode grapheme cluster break property for binaries (Strings) and codepoints.
  - [Unicode.LineBreak](Unicode.LineBreak.md): Functions to introspect the Unicode line break property for binaries (Strings) and codepoints.
  - [Unicode.SentenceBreak](Unicode.SentenceBreak.md): Functions to introspect the Unicode sentence break property for binaries (Strings) and codepoints.
  - [Unicode.WordBreak](Unicode.WordBreak.md): Functions to introspect the Unicode word break property for binaries (Strings) and codepoints.

- Indic properties
  - [Unicode.IndicConjunctBreak](Unicode.IndicConjunctBreak.md): Functions to introspect the Unicode Indic conjunct break property for binaries (Strings) and codepoints.
  - [Unicode.IndicPositionalCategory](Unicode.IndicPositionalCategory.md): Functions to introspect the Unicode `Indic_Positional_Category` property for binaries (Strings) and codepoints.
  - [Unicode.IndicSyllabicCategory](Unicode.IndicSyllabicCategory.md): Functions to introspect the Unicode Indic syllabic category property for binaries (Strings) and codepoints.

- Normalization
  - [Unicode.NfcQuickCheck](Unicode.NfcQuickCheck.md): Functions to introspect the Unicode `NFC_Quick_Check` property for binaries (Strings) and codepoints.
  - [Unicode.NfdQuickCheck](Unicode.NfdQuickCheck.md): Functions to introspect the Unicode `NFD_Quick_Check` property for binaries (Strings) and codepoints.
  - [Unicode.NfkcQuickCheck](Unicode.NfkcQuickCheck.md): Functions to introspect the Unicode `NFKC_Quick_Check` property for binaries (Strings) and codepoints.
  - [Unicode.NfkdQuickCheck](Unicode.NfkdQuickCheck.md): Functions to introspect the Unicode `NFKD_Quick_Check` property for binaries (Strings) and codepoints.

- Character names
  - [Unicode.CharacterName](Unicode.CharacterName.md): Resolves Unicode character names to their codepoint, and back again.

- Link detection
  - [Unicode.LinkBracket](Unicode.LinkBracket.md): Functions to introspect the `Link_Bracket` property.
  - [Unicode.LinkEmail](Unicode.LinkEmail.md): Functions to introspect the `Link_Email` property for binaries (Strings) and codepoints.
  - [Unicode.LinkTerm](Unicode.LinkTerm.md): Functions to introspect the `Link_Term` property for binaries (Strings) and codepoints.

- Guards
  - [Unicode.Guards](Unicode.Guards.md): Defines a set of guards that can be used with
Elixir functions to test whether a codepoint is
a member of a Unicode set.

- Internals
  - [Unicode.Category.QuoteMarks](Unicode.Category.QuoteMarks.md): Functions to return codepoints that form quotation marks. These
marks are taken from the [Wikipedia definition](https://en.wikipedia.org/wiki/Quotation_mark)
which is more expansive than the Unicode categories [Pi](https://www.compart.com/en/unicode/category/Pi)
and [Pf](https://www.compart.com/en/unicode/category/Pf).
  - [Unicode.GeneralCategory.Derived](Unicode.GeneralCategory.Derived.md): For certain operations and transformations
(especially in [Unicode Sets](http://unicode.org/reports/tr35/#Unicode_Sets))
there is an expectation that certain derived
general categories exist even though they are not
defined in the unicode character database.
  - [Unicode.Property.Behaviour](Unicode.Property.Behaviour.md): Defines the behaviour required of modules that
serve a Unicode property.
  - [Unicode.RangeSearch](Unicode.RangeSearch.md): Builds compact search tables from codepoint ranges and performs binary search over them.