Module:scripts/documentation

From Wiktionary, the free dictionary
Jump to navigation Jump to search
Documentation for Module:scripts. [edit]
This page contains usage information, categories, interwiki links and other content describing the module.

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. The data module should not be used directly by any other module, the data should only be accessed through the functions provided by Module:scripts.

For functions that allow templates to use this module, see Module:scripts/templates.

Finding and retrieving scripts

[edit]

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

(The generated documentation is located at the module page.)

Script objects

[edit]

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.getByCode("Latn")
local name = sc:getCanonicalName()
-- "name" will now be "Latin"

(The generated documentation is located at the module page.)

Subpages

[edit]

See also

[edit]