မဝ်ဂျူ:aii-translit

This module contains definitions and metadata for language codes. See Wiktionary:Languages for more information.

This module must not be used directly in other modules or templates. The data should be accessed through Module:languages. For the corresponding extra data, see မဝ်ဂျူ:aii-translit/extra.

Errors

The following errors were detected by Module:data consistency check:

Required values

Every entry in the table must contain the following indexed fields:

1

The "canonical" name of the language. This is the name that is used in Wiktionary entries and category names.

2

The Wikidata item id (Q number) for the language. Can be specified as a number (a positive integer) or a string that starts with Q and ends with decimal digits. Set to nil if not known/present. This replaces the older wikipedia_article property, which can still be used to link to specific sections or language editions.

Optional values

3

The code for the family that the language belongs to. See Wiktionary:Families.

4

A list of script codes. See Wiktionary:Scripts. These represent all the scripts (writing systems) that this language uses in the real world, as well as the ones that Wiktionary uses. The scripts that are used most often on Wiktionary should be first in the list, as this will speed up script detection.

Many templates and modules detect the script of text in a particular language using the findBestScript function in Module:scripts. This function goes down the list of scripts and counts how many characters in the text belong to each script. If all the characters belong to one script, that script will be returned; otherwise, the script with the most characters will be returned. Thus, script detection will be faster if the most frequently used scripts are first in the list. If none of the characters match any of the listed scripts, then the None script is returned (even if the characters would match a script not listed). Translingual (mul) and Undetermined (und) have the special value "All", which means they are treated as having every script. This value should not be set for any other language codes.

Due to the ongoing problems with Lua memory limits, this should be given as a comma-separated list in a string (and not a table). This is then converted into a table when returned. For example: "Latn, Brai, Shaw, Dsrt".

type

The type of language (which affects how it is handled on Wiktionary). Possible values are:

• regular - This value is the default, so it doesn't need to be specified. It indicates that the is attested according to WT:CFI and therefore permitted in the main namespace. There may also be reconstructed terms for the language, which are placed in the Reconstruction namespace and must be prefixed with * to indicate a reconstruction.
• reconstructed - This language is not attested according to CFI, and therefore is allowed only in the Reconstruction namespace. All terms in this language are reconstructed, and must be prefixed with *.
• appendix-constructed - This language is attested but does not meet the additional requirements set out for constructed languages (WT:CFI#Constructed languages). Its entries must therefore be in the Appendix namespace, but they are not reconstructed and therefore should not have * prefixed in links.

ancestors

A list of the language codes of the direct ancestors of this language. For example, the ancestor of English is listed as enm (Middle English); ang (Old English, the ancestor of Middle English), gem-pro (Proto-Germanic, the ancestor of Old English), and ine-pro (Proto-Indo-European, the ancestor of Proto-Germanic) are not listed.

For most languages, only one ancestor code should be given, but multiple ancestors can be listed for pidgins, creoles and mixed languages.

The ancestor language list should not be included if the language's direct ancestor is the proto-language of the family to which the language belongs. In such a case, if the family code has been provided, Module:languages will automatically add the proto-language as the language's ancestor. For example, Proto-Germanic (gem-pro) belongs to the Indo-European (ine) family, and its direct ancestor is Proto-Indo-European (ine-pro). Because Proto-Indo-European is the proto-language of the Indo-European languages, Proto-Germanic does not need an ancestors table; Proto-Indo-European will be automatically returned as its ancestor by the getAncestors function.

Due to the ongoing problems with Lua memory limits, this should be given as a comma-separated list in a string (and not a table). This is then converted into a table when returned. For example: "cr, fr".

wikimedia_codes

A list of the Wikimedia language codes that this language maps to. This is used to translate Wiktionary codes to Wikimedia codes, which are usually the same but there are a few languages where it is different. The language codes must be valid Wikimedia codes (as determined by the wiki software), and if they are not defined in one of the language data modules, they must be defined in Module:wikimedia languages/data.

Due to the ongoing problems with Lua memory limits, this should be given as a comma-separated list in a string (and not a table). This is then converted into a table when returned. For example: "en, simple".

wikipedia_article

The name of the Wikipedia article for the language. Should normally only be supplied if the Wikidata id cannot be used.

translit

See the Substitutions section for instructions on syntax.

Defines how a language should be transliterated, which will be automatically applied to any terms in scripts that do not have their isTransliterated value set to false in Module:scripts/data. This is used by transliterate in Module:languages.

link_tr

Set this to true to link the language's transliteration. For instance, Gothic has entries in Gothic script and entries for transliterations: 𐌷𐌻𐌰𐌹𐌱𐍃 (hlaibs).

display_text

See the Substitutions section for instructions on syntax.

Defines replacements to create the display form of the text, which is the form actually displayed on the page. This is occasionally necessary if there is a recurring issue of editors adding the wrong character, which is sometimes an issue when two or more characters are easy to confuse. For example, the palochka ӏ, used in Cyrillic in many Caucasian languages, is frequently entered as I, or even Latin l or I. As this is an ongoing issue (even among native speakers), the easiest way to solve the problem is to automatically correct the display form for those languages. This is used by makeDisplayText in Module:languages.

entry_name

See the Substitutions section for instructions on syntax.

Defines replacements to create the entry name from the displayed form of a term. This can be used to remove certain diacritical marks according to the customs or standard practice of the language. For example, it is used to remove accent marks from Russian words (ру́сский → русский), or macrons from Latin or Old English words (ōs → os), as these are not used in the normal written form of these languages. This is used by makeEntryName in Module:languages.

sort_key

See the Substitutions section for instructions on syntax.

Defines replacements to create a category sort key from the page name. The purpose is to:

1. Remove any characters that should be ignored in sorting.
2. Replace characters with other characters, if the sorting rules for that language do not distinguish them. For example, in German, the characters "ä" and "a" are considered equivalent for sorting, and are both treated as "a".
3. Replace characters that should be sorted in different places with special characters that mimic that behaviour, (which is necessary due to MediaWiki software using the Unicode codepoint to determine sort order, which is often arbitrary). For instance, in Mongolian, the letter "ү" should be sorted after "у", but due to its codepoint it is sorted after the final letter "я" by default. As such, we can replace "ү" with "у" plus a character with a very high codepoint, which ensures that it is always sorted straight after. The data modules contain an in-built way to do this for the sake of convenience: with the above example, this would be done by using "у" .. p[1]. Another character could be inserted straight after by using "у" .. p[2] (and so on).

Note: the term is converted to lowercase before applying any substitutions, so you should not try to process capital letters (as it will not work). This is used by makeSortKey in Module:languages.

dotted_dotless_i

Set this to true for languages that distinguish between the dotted and dotless I (such as some Turkic languages).

Substitutions

translit, display_text, entry_name and sort_key all use the same syntax, which is designed to be as flexible as possible:

• If they are a string, then this is treated as the name of a dedicated module which will be used to generate the output. For example, "sa-translit" refers to Module:sa-translit.
• If they are a table, then it can contain two kinds of keys:
  1. The keys from, to, remove_diacritics and remove_exceptions relate to text substitution (see below).
  2. Script code keys are used to specify script-specific behaviour. These, in turn, can be strings (for dedicated modules) or tables (for text substitution). In addition, a value with the key 1 can be used as a fallback, which will be used if no specific behaviour is defined for that script.

Note: if script keys and text substitution keys are given in the same table, then the text substitution will be applied after the script-specific behaviour has completed. Ensure any fallback text substitutions are given as a subtable with key 1 if you want to avoid this. It is not possible to process the output of a script-specific module with another module, however: this should be done (for example) with a tail call in the first module.

Dedicated modules must take the arguments text, lang, sc, where text is the input text (usually the page name or input by the user), lang is the language code (not the language object), and sc is the script code (not the script object). For performance reasons, they should only be used when it is not possible to achieve the desired result via text substitution.

Text substitution replaces or removes certain characters (or sets of characters) for particular contexts. There are three ways to do this:

1. Using the from and to keys.
2. remove_diacritics (and optionally remove_exceptions).
3. Both of the above (in that order).

from is paired with to, and both of them must be tables that are organised pairwise: each element in from is a pattern to identify which characters in the term to replace, while the corresponding element in to defines what to replace them with (as arguments to mw.ustring.gsub).

If the replacement is not present (or if it is false or nil), then any matching characters are removed altogether. This means that the from list can be longer than the to list, and an empty replacement will be assumed for any elements in from that have no counterpart in to.

The tables can contain literal characters, or the patterns (a simplified form regular expressions) that are used by the standard Scribunto mw.ustring.gsub function. See the Scribunto reference manual for more information. Note that patterns make double substitutions a viable way to achieve more complex results. See the Latin sortkey for Mandarin (cmn) as an example of this.

remove_diacritics is a string which contains characters that will be removed after the text is decomposed. For instance, if remove_diacritics is a combining acute accent, all acute accents will be stripped, even if they are part of precomposed characters (such as á or ά). Despite the name, the characters to be stripped need not be diacritics: for instance, including an apostrophe would remove all apostrophes (though be careful with hyphens, which must be be escaped as %-).

Furthermore, if remove_diacritics is given, then it is possible to specify a remove_exceptions table, which prevents specific characters from having their diacritics stripped. For instance, if remove_diacritics is a combining diaeresis, but remove_exceptions contains "ё", then any instances of ё will remain unchanged. On the other hand, an instance of ӱ would still become у (unless "ӱ" is also added to remove_exceptions).

Formerly supported values

aliases, varieties, otherNames

This data is now located in the extra data modules; see Module:languages and Template:language extradata documentation.

family

Now 3.

scripts

Now 4.

---

local export = {}

local U = mw.ustring.char
local rsub = mw.ustring.gsub
local rmatch = mw.ustring.match

local hbasa = U(0x73C)
local rwaha = U(0x73F)
local zlama_angular = U(0x739)
local zlama_horizontal = U(0x738)
local pthaha = U(0x732)
local zqapha = U(0x735)

local diacritic_vowels = hbasa .. rwaha .. zlama_angular .. zlama_horizontal .. pthaha .. zqapha
local diacritic_vowels_capture = "([" .. diacritic_vowels .. "])"

local talqana_above = U(0x747)
local combining_diaeresis = U(0x308)

-- we declare consonants representing vowels (matres lectionis) as constants to mitigate differences in how mixing
-- right-to-left and left-to-right characters in the same line appears in an IDE vs wiktionary.  Since matres is used in
-- concatenation via the .. operator,  "ܘ" .. "ܐ" on wiktionary would render as "ܐ" .. "ܘ" in an IDE
local alaph = U(0x710)
local waw = U(0x718)
local yudh = U(0x71D)

local combining_tilde_below = U(0x330)
local combining_tilde_above = U(0x303)
local combining_macron_below = U(0x331)
local combining_macron = U(0x304)
local qushshaya = U(0x741)
local rukkakha = U(0x742)
local combining_breve_below = U(0x32E)

local combining_dot_below = U(0x323)
local combining_dot_above = U(0x307)


-- constants for transliterated snippets which are used in later substitutions
local TR_THIRD_PERSON_FEM_SUFFIX = 'ōh'
local TR_WAW_PLUS_RVASA = 'ū'

local tt_transpose_punc = {
	-- left/right single/double quotes
	["“"] = "”",
	["”"] = "“",
	["‘"] = "’",
	["’"] = "‘",
	["؟"] = "?", -- question mark
	["«"] = '“', -- quotation mark
	["»"] = '”', -- quotation mark
	["،"] = ",", -- comma
	["؛"] = ";", -- semicolon
}

local tt_transpose_punc_keys = ''
for key, _ in pairs(tt_transpose_punc) do tt_transpose_punc_keys = tt_transpose_punc_keys .. key end

local fix = {
	{ diacritic_vowels_capture .. qushshaya, qushshaya .. "%1"},

	-- under the hood mw uses uses NFC which preempts the following two substitutions...
	-- feel free to uncomment if there's a test case which can be added that requires them to be uncommented
	-- https://www.mediawiki.org/wiki/Unicode_normalization_considerations
	-- { diacritic_vowels_capture .. rukkakha, rukkakha .. "%1"},
	-- { diacritic_vowels_capture .. combining_tilde_below, combining_tilde_below .. "%1" },

	-- partition punctuation marks so "starts with" and "ends with" substitutions work
	{"([".. tt_transpose_punc_keys .. "()!.:\"'])", "#%1#"},
}

local tt = {
	["ܦ"] = "p",
	["ܒ"] = "b",
	["ܬ"] = "t",
	["ܛ"] = "ṭ",
	["ܕ"] = "d",
	["ܟ"] = "k",
	["ܓ"] = "g",
	["ܩ"] = "q",
	["ܣ"] = "s",
	["ܨ"] = "ṣ",
	["ܙ"] = "z",
	["ܫ"] = "š",
	["ܚ"] = "ḥ",
	["ܥ"] = "ˁ",
	["ܗ"] = "h",
	["ܡ"] = "m",
	["ܢ"] = "n",
	["ܪ"] = "r",
	["ܠ"] = "l",
}

-- local tt_keys = ''
-- for key, _ in pairs(tt) do tt_keys = tt_keys .. key end

local tt_values = ''
for _, value in pairs(tt) do tt_values = tt_values .. value end

local mhagjana_capture =  "([" .. rsub('ܗܠܡܢܥܪ', ".", tt) .. alaph .. yudh .. waw  .. "])"
local marhetana_capture =  "([" .. rsub('ܦܒܬܛܕܟܓܩܣܨܙܫܚ', ".", tt) .. "])"

-- https://r12a.github.io/scripts/syrc/aii.html#single_letter_words
local bdul = 'ܒܕܘܠ'
local bdul_capture = '([' .. bdul .. '])'
local bdul_capture2 = '([' .. bdul .. '])([' .. bdul .. '])'

-- local alphabet = ''
-- for letter, _ in pairs(tt) do alphabet = alphabet .. letter end
-- alphabet = alphabet .. yudh .. waw .. alaph
-- local alphabet_capture = '([' .. alphabet .. '])'

local tt_next = {
	[waw] = "w",
	[yudh] = "y",

	[zlama_angular] = "ē",
	[zlama_horizontal] = "i",
	[pthaha] = "a",
	[zqapha] = "ā"
}

local glides = alaph .. yudh .. waw -- unvoweled, original values of matres lectionis (consonants representing vowels)
local consonants_minus_glides = tt_values .. "cžfḇṯḏḵḡ"

local consonants_capture = "([" .. glides .. consonants_minus_glides .. "])"
-- local consonants_capture_minus_alaph = "([" .. yudh .. waw .. consonants_minus_glides .. "])"

local vowels_w = TR_WAW_PLUS_RVASA .. "ō"
local vowels_y = "eiēī"
local vowels = vowels_y .. vowels_w .. "aā"

local consonants_and_vowels_capture = "([" .. glides .. consonants_minus_glides .. vowels .. "])"

local genitive_endings = {"ܵܐ", "ܝܼ", "ܘܼܟ݂", "ܵܟ݂ܝ", "ܹܗ", "ܵܗ̇", "ܘܼܗܝ" , "ܘܿܗ̇" , "ܘܼܗ̇" , "ܲܢ", "ܵܘܟ݂ܘܿܢ", "ܗܘܿܢ", "ܵܝܗܝ" , "ܹ̈ܐ" , "ܹܐ" , "ܲܝ" , "ܲܝ̈" , "ܲܬ݂" , "ܵܬ݂̈" , "ܵܬ݂" , "ܝܼ̈", "ܘܼ̈ܟ݂", "ܵܟ݂ܝ̈", "ܘܼ̈ܗܝ", "̈ܘܿܗ̇", "ܘܼ̈ܗ̇" , "ܲܢ̈", "ܵܘ̈ܟ݂ܘܿܢ", "ܗ̈ܘܿܢ" , "ܵܝ̈ܗܝ"}
-- per "No alternation (the | operator)" https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Patterns
-- lua doesn't provide support to check if a word contains this, or that, or other via (this|that|other)
-- this means we can't simply check if the word ends in any of the possible masculine genitive endings with a capture group like
-- local genitive_endings_capture = "(" .. table.concat(genitive_endings,"|") .. ")"
local genitive_endings_special_cases = {
	["ܒܵܬ"] = "bātt",
	["ܚܘܼܒ"] = "ḥubb",
	["ܓܘܼܕ"] = "gudd",	["ܓܘܼܕܵܢ"] = "guddān",
	["ܦܘܼܡ"] = "pumm",
	["ܐܸܛܪܘܼܓ"] = "iṭrugg",	["ܐܸܛܪ̈ܘܼܓ"] = "iṭrugg",
}

-- due to runtime performance concerns, we should strive to limit special cases to only the most common terms for which the transliterator is way off
local special_cases = {
	-- { aii_text, aii_translit_output }
	--
	-- the # symbol pads the start and end of a word, consider the follow examples
	-- #float#    only float matches
	-- #float     words starting with float like float or floats match
	-- float#     words ending with float like float or afloat match
	-- float      words containing float like float, floats, afloat and refloats match
	{"#ܒܗ" .. combining_dot_above .. "ܝ#", "#b-ay#"},
	{"ܗ" .. combining_dot_above .. "ܝ#", "aya#"},
	{"ܗ" .. combining_dot_above .. "ܘ#", "awa#"},
	{"ܡ" .. combining_dot_above .. "ܢ#", "man#"},
	{"ܡ" .. combining_dot_below .. "ܢ#", "min#"},
	-- commenting this out for now until test cases can be added for it
	-- {waw .. hbasa .. "ܟ݂#", "ōḵ#"}, {waw .. hbasa .. combining_diaeresis ..  "ܟ݂#", "ōḵ#"},
	{"ܟ̰ܵܐܝ", "čāy"},
	{"ܒܵܐܝ", "bāy"},
	{"ܐܲܦ̮ܘܿܟܵܕ", "avōkād"},
	{"ܝܼܫܘܿܥ#", "īšōˁ#"}, -- starts with vowel but not silent alaph
	-- "to be" without inital khwasa, ì
	{"#ܝܘܸܢ#", "#ìwen#"}, {"#ܝܘܵܢ#", "#ìwān#"},
	{"#ܝܘܲܚ#", "#ìwaḥ#"}, {"#ܝܘܸܬ#", "#ìwet#"},
	{"#ܝܘܵܬܝ#", "#ìwāt#"}, {"#ܝܬܘܿܢ#", "#ìtōn#"},
	{"#ܝܠܹܗ#", "#ìlēh#"}, {"#ܝܠܵܗ̇#", "#ìlāh#"},
	{"#ܝܢܵܐ#", "#ìnā#"}, {"#ܝܗ݇ܘܵܐ#", "#ìwā#"},
	{"#ܝܗ݇ܘܵܬ݇#", "#ìwā#"}, {"#ܝܗ݇ܘܵܘ#", "#ìwā#"},
	-- "to be" with inital khwasa, ī
	-- https://en.wiktionary.org/wiki/Template:aii-conj-verb/hawe
	{"ܝܼܘܸܢ#", "īwen#"}, {"ܝܼܘܵܢ", "īwān"},
	{"ܝܼܘܸܬ#", "īwet#"}, {"ܝܼܘܵܬܝ#", "īwāt#"},
	{"ܝܼܠܹܗ#", "īlēh#"}, {"ܝܼܠܵܗ̇#", "īlāh#"},
	{"ܝܼܘܲܚ#", "īwaḥ#"}, {"ܝܼܬܘܿܢ#", "ītōn#"}, {"ܝܼܢܵܐ#", "īnā#"},
	-- "to be" blends
	{"ܝܼܗ݇ܘܵܐ#", "īwā#"}, {"ܝܼܗ݇ܘܵܘ#", "īwā#"},
	-- "to be" imperative forms
	-- following substitutions starting with '#w' are to pre-empt 'w-' prefixing rule
	{"#ܗ݇ܘܝܼ", "#wī"}, {"#ܗ݇ܘܹܝܡܘܼܢ#", "#wēmūn#"},
	-- "to be" past particles
	{"#ܗ݇ܘܵܐ#", "#wā#"}, {"#ܗ݇ܘܵܘ#", "#wā#"}, {"#ܗ݇ܘܹܐ#", "#wē#"},
	-- "of" (fixed expressions)
	{"#ܕܝܵܡܵܐ#", "#d-yāmā#"}, {"#ܕܠܵܐ#", "#d-lā#"},
	{"#ܕܲܕܡܵܐ#", "#da-dmā#"},
	-- "to" (fixed expressions)
	{"ܠܒܲܕܲܪ#" , "l-baddar#"}, {"ܠܓܵܘܵܐ#", "l-gāwā#"},
	{"ܠܡܵܐ#" , "lemā#"},
	-- "per" (fixed expressions with time)
	{"ܒܕܲܩܝܼܩܵܐ#", "b-daqqīqā#"}, {"ܒܪܦܵܦܵܐ#", "b-rpāpā#"},
	{"ܒܝܵܘܡܵܐ#", "b-yāwmā#"}, {"ܒܫܵܥܬ݂ܵܐ#", "b-šāˁṯā#"},
	{"ܒܝܲܪܚܵܐ#", "b-yarḥā#"}, {"ܒܫܵܒ݂ܘܿܥܵܐ#", "b-šāḇōˁā#"},
	{"ܒܕܵܘܪܵܐ#", "b-dāwrā#"}, {"ܒܫܹܢ݇ܬܵܐ#", "b-šētā#"},
	{"ܒܨܲܦܪܵܐ#", "b-ṣaprā#"}, {"ܒܪܲܡܫܵܐ#", "b-ramšā#"},
	-- adverbs with clitics (fixed expressions)
	{"ܠܩܘܼܪܒܵܐ", "l-qurbā"}, {"ܠܩܘܼܪܒܵܐ ܕ", "l-qurbā d-"},
	{"ܒܡܸܬܚܵܐ", "b-mitḥā"},
	{"ܒܟܠ#", "b-kul#"}, {"ܕܗܵܘܝܵܐ#", "d-hāwyā#"},
	-- "all", "each", "every"
	{"ܟܠ#", "kul#"}, {"ܟܠܵܢ#", "kullān#"},
	{"ܟܠܘܼܟ݂#", "kullōḵ#"}, {"ܟܠܵܟ݂ܝ#", "kullāḵ#"},
	{"ܟܠܹܗ#", "kullēh#"}, {"ܟܠܵܗ̇#", "kullāh#"},
	{"ܟܠܘܼܗܝ#", "kullūh#"}, {"ܟܠܘܿܗ̇#", "kullōh#"},
	{"ܟܠܲܢ#", "kullan#"}, {"ܟܠܵܘܟ݂ܘܿܢ#", "kullāwḵōn#"},
	{"ܟܠܵܝܗܝ#", "kullāyh#"}, {"ܟܠܗܘܿܢ#", "kullhōn#"},
	{"ܟܠܵܢܵܐܝܼܬ#", "kullānāˀīt#"}, {"ܟܠܵܢܵܐܝܼܬ݂#", "kullānāˀīṯ#"},
	{"ܟܠܵܢܵܝ", "kullānāy"}, {"ܟܘܿܠܵܝ", "kollāy"},
	{"ܟܠܚܲܕ݇#", "kulḥa#"}, {"ܟܠܚܕ݂ܵܐ#", "kulḥḏā#"},
	{"ܟܠܫܲܢ݇ܬ#", "kulšat#"},
	-- "classical because"
	{"ܡܸܛܠ#", "miṭṭul#"}, {"ܡܸܛܠܬ", "miṭṭult"},
	{"ܡܸܛܠܵܐܝܼܬ݂#", "miṭṭullāˀīṯ#"},
	-- "houses"
	{"ܒܵܬܹ̈ܐ#", "bāttē#"},
	{"ܒܵܬܲܝ̈#", "bāttay#"},
	{"ܒܵܬܲܢ̈#", "bāttān#"},
	{"ܒܵܬܘܼ̈ܟ݂#", "bāttōḵ#"},
	{"ܒܵܬ̈ܗܘܿܢ#", "bātthōn#"},
	-- masc sing construct state rvasa
	{"ܓܘܼܕ#", "gud#"},	{"ܦܘܼܡ#", "pum#"},
	{"ܐܸܛܪܘܼܓ#", "iṭrug#"},
	-- countries and nationalities
	{"ܒܸܠܓܝܵܐ#" , "belgyā#"}, {"ܒܸܠܓܝܼܩܵܝ", "belgīqāy"},
	{"ܣܹܝܫܸܠܝܼܣ#" , "sēšellīs#"}, {"ܣܹܝܫܸܠ#", "sēšel#"}, {"ܣܹܝܫܸܠܵܝ", "sēšellāy"},
	-- popular slang terms
	{"ܝܲܐܠܵܗ#", "yallāh#"}, {"ܘܲܐܠܵܗ#", "wallāh#"},
	-- feminine imperative forms
	{"ܙܹܠ݇ܝ#", "zē#"}, {"ܬܵܐܝ#", "tā#"},
}

function export.tr(text, lang, sc)

	text = rsub(text, " | ", "# | #")
	text = "##" .. rsub(text, " ", "# #") .. "##"
	text = rsub(text, "ـ", "")
	for _, sub in ipairs(fix) do text = rsub(text, unpack(sub)) end

	-- Special cases
	-- print(text)
	for _, sub in ipairs(special_cases) do text = rsub(text, unpack(sub)) end
	-- print(text)

	-- for every special case, apply substitutions for every masc genitive ending
	for aii_prefix, aii_prefix_corrected_tr in pairs(genitive_endings_special_cases) do
		for _, masc_genitive_ending in ipairs(genitive_endings) do
			text = rsub(text, aii_prefix .. '(' .. masc_genitive_ending .. ')' .. '#',  aii_prefix_corrected_tr .. '%1#' )
		end
	end

	-- Ignore siyameh
	text = rsub(text, combining_diaeresis, "")

	text = rsub(text, "ܟ" .. combining_tilde_below, "č")
	text = rsub(text, "ܓ" .. combining_tilde_below, "j")
	text = rsub(text, "ܫ" .. combining_tilde_below, "ž")

	text = rsub(text, "ܙ" .. combining_tilde_above, "ž")
	text = rsub(text, "ܟ" .. combining_tilde_above, "č")
	text = rsub(text, "ܫ" .. combining_tilde_above, "ž")

	text = rsub(text, "ܦ" .. combining_breve_below, "f")

	text = rsub(text, "ܦ" .. qushshaya, "p") -- needs a test case
	text = rsub(text, "ܒ" .. qushshaya, "b")
	text = rsub(text, "ܬ" .. qushshaya, "t")
	text = rsub(text, "ܕ" .. qushshaya, "d")
	text = rsub(text, "ܟ" .. qushshaya, "k")
	text = rsub(text, "ܓ" .. qushshaya, "g")

	text = rsub(text, "ܒ" .. rukkakha, "ḇ")
	text = rsub(text, "ܬ" .. rukkakha, "ṯ")
	text = rsub(text, "ܕ" .. rukkakha, "ḏ")
	text = rsub(text, "ܟ" .. rukkakha, "ḵ")
	text = rsub(text, "ܓ" .. rukkakha, "ḡ")

	-- this covers b-, d-, w-, l- prefixing for words starting with an alaph
	-- https://r12a.github.io/scripts/syrc/aii.html#standalone
	-- and ALL special_cases starting with initial_translit_char
	local initial_translit_char = 'aī' -- accounts for substituted special cases starting with vowel sound
	local initial_char_capture = "([" .. alaph .. initial_translit_char .. "])"
	text = rsub(text, "#" .. bdul_capture2 ..  initial_char_capture, "#%1-%2-%3")
	text = rsub(text, "#" .. bdul_capture ..  initial_char_capture, "#%1-%2")

	text = rsub(text, waw .. hbasa .. "ܗ" .. combining_dot_above .. "#", TR_THIRD_PERSON_FEM_SUFFIX .. "#")

	text = rsub(text, yudh .. hbasa, "ī")
	text = rsub(text, waw .. rwaha, "ō")
	text = rsub(text, waw .. hbasa, TR_WAW_PLUS_RVASA)

	text = rsub(text, ".", tt_transpose_punc)
	text = rsub(text, ".", tt)
	text = rsub(text, "#" .. alaph .. "#", "#ˀ#") -- needs a test case

	text = rsub(text, consonants_capture .. mhagjana_capture .. combining_macron_below .. consonants_capture, "%1e%2%3")
	text = rsub(text, consonants_capture .. marhetana_capture .. combining_macron .. consonants_capture, "%1%2e%3")

	text = rsub(text, consonants_capture .. talqana_above, "")

	-- doubling consonants
	text = rsub(text, "([" .. zlama_horizontal .. pthaha .. "])" .. consonants_capture .. diacritic_vowels_capture, "%1%2%2%3")
	text = rsub(text, "([" .. zlama_horizontal .. pthaha .. "])" .. consonants_capture .. TR_WAW_PLUS_RVASA .. consonants_capture .. diacritic_vowels_capture, "%1%2%2".. TR_WAW_PLUS_RVASA .. "%3%4")
	text = rsub(text, "([" .. zlama_horizontal .. pthaha .. "])" .. consonants_capture .. TR_THIRD_PERSON_FEM_SUFFIX , "%1%2%2" .. TR_THIRD_PERSON_FEM_SUFFIX)
	--

	text = rsub(text, combining_dot_above, "")

	text = rsub(text, consonants_capture .. zlama_angular .. yudh .. consonants_capture, "%1ē%2")
	text = rsub(text, consonants_capture .. yudh .. consonants_capture, "%1i%2")

	text = rsub(text, "([" .. consonants_minus_glides .. "])" .. yudh .. "#", "%1#")

	text = rsub(text, alaph .. pthaha .. waw .. "#", "aw#") -- needs a test case (impossible combination of characters?)
	text = rsub(text, alaph .. pthaha .. yudh .. "#", "ay#") -- needs a test case

	text = rsub(text, "#" .. alaph .. zlama_angular .. yudh, "#ē")  -- needs a test case
	text = rsub(text, "#" .. alaph .. yudh, "#ī") -- needs a test case

	text = rsub(text, "#" .. yudh .. consonants_capture, "#%1")

	text = rsub(text, pthaha .. alaph .. "#", "a#") -- needs a test case
	text = rsub(text, zlama_angular .. alaph .. "#", "ē#")
	text = rsub(text, zqapha .. alaph .. "#", "ā#") -- needs a test case
	text = rsub(text, alaph .. "#", "ā#") -- needs a test case
	text = rsub(text, "#" .. alaph, "#")
	text = rsub(text, alaph, "ˀ")

	text = rsub(text, "#" .. waw .. consonants_and_vowels_capture, "#w-%1")

	text = rsub(text, ".", tt_next)

	text = rsub(text, "([ēīā])" .. "ˀ" .. consonants_capture, "%1%2")

	text = rsub(text, "([" .. vowels_w .. "])([" .. vowels .. "])", "%1w%2") -- needs a test case
	text = rsub(text, "([" .. vowels_y .. "])([" .. vowels .. "])", "%1y%2")

	text = rsub(text, "ˁˁ", "ˁ") -- needs a test case
	text = rsub(text, "ˀˀ", "ˀ") -- needs a test case
	text = rsub(text, "-ˀ", "-")

	text = rsub(text, "ḇḇ", "ḇ")
	text = rsub(text, "ḡḡ", "ḡ")
	text = rsub(text, "ḏḏ", "ḏ")
	text = rsub(text, "ḵḵ", "ḵ")
	text = rsub(text, "p̄p̄", "p̄")
	text = rsub(text, "ṯṯ", "ṯ")

	-- local bdul_capture = '([bdwl])'
	-- text = rsub(text, "#" .. bdul_capture .. "([" .. vowels .. "])", "#%1-%2")

	text = rsub(text, "#", "")

	if not rmatch(text, "([-" .. vowels .. " ])") then
		require("Module:debug").track("aii-translit/lacking diacritics")
		return nil
	end

	return text
end

return export