Documentation

Using the library

• Getting started: requirements, building, installing, build options, the model the API follows, results and buffers.
• Validating and converting text: UTF-8, UTF-16 and UTF-32.
• Character properties: per code point lookups.
• Characters, words, sentences and lines: grapheme clusters, word and sentence boundaries, line breaking, complex scripts, text in pieces.
• Bidirectional text: embedding levels and line order.
• Script runs and shaping: runs for a shaper and the HarfBuzz functions.
• Normalization and case: normal forms, case operations, comparing strings.
• Identifiers and security: identifier rules, confusable skeletons, restriction levels.
• API reference, generated from the headers.

How it works

• Overview: the library profile and how the parts fit.
• Glossary.
• Property tables, UTF-8 handling, Segmentation, Bidi, Normalization and case, Security.
• Maul conventions: the rules every Maul library follows.

Maintaining it

• Development: toolchain, running tests, the generator, a new Unicode version, benchmarks, fuzz findings.
• Checks: the local tiers, the CI jobs and their budgets.
• Release.