Module:scripts/doc

This is the documentation page for Module:scripts

	This module is not ready for use.
	This module may not work properly, because it has not been completed and is being kept for tests and improvement. Its arguments, functions and results may change without warning. It is advisable not to use this module as of yet. You may edit this page or discuss possible changes.

This module is used to retrieve and manage Wiktionary's various writing systems and the information associated with them. See Wiktionary:Scripts for more information.

The information itself is stored in Module:scripts/data. This module should not be used directly by any other module, the data should only be accessed through the functions provided by Module:scripts.

Finding and retrieving scripts

The module exports a number of functions that are used to find scripts.

getScriptByCode

getScriptByCode(code)

Finds the script whose code matches the one provided. If it exists, it returns a Script object representing the script. Otherwise, it returns nil.

Script objects

A Script object is returned from one of the functions above. It is a Lua representation of a script and the data associated with it. It has a number of methods that can be called on it, using the : syntax. For example:

local m_scripts = require("Module:scripts")
local sc = m_scripts.getScriptByCode("Latn")
local name = sc:getCanonicalName()
-- "name" will now be "Latin"

Script:getCode

:getCode()

Returns the script code of the language. Example: "Cyrl" for Cyrillic.

Script:getCanonicalName

:getCanonicalName()

Returns the canonical name of the script. This is the name used to represent that script on Wiktionary. Example: "Cyrillic" for Cyrillic.

Script:getAllNames

:getAllNames()

Returns a table of all names that the script is known by, including the canonical name. The names are not guaranteed to be unique, sometimes more than one script is known by the same name. Example: {"Latin", "Roman"} for the Latin script.

Script:isTextIn

:isTextIn(text)

Checks whether the given text contains one or more characters of this script. Returns true if so, false if not.

Script:getCategoryName

:getCategoryName()

Returns the name of the main category of that script. Example: "Cyrillic script" for Cyrillic, whose category is at Category:Cyrillic script.