模组:Scripts/doc

这是Module:Scripts的文档页面

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

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

getByCode

getByCode(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.

findBestScript

findBestScript(text, lang)

Given some text and a language object, this function iterates through the scripts of the given language and tries to find the script that best matches the text. It returns a Script object representing the script. If no match is found at all, it returns the None script object.

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.getByCode("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:getParent

:getParent()

Returns the parent of the script. Example: "Latn" for "Latinx" and "Arab" for "fa-Arab". It returns "top" for scripts without a parent, like "Latn", "Grek", etc.

Script:getWikipediaArticle

:getWikipediaArticle()

Returns the wikipedia_article item in the language's data file, or else calls Script:getCategoryName().

Script:countCharacters

:countCharacters(text)

Returns the number of characters in the text that are part of this script.

Note: You should never rely on text consisting entirely of the same script. Strings may contain spaces, punctuation and even wiki markup or HTML tags. HTML tags will skew the counts, as they contain Latin-script characters. So it's best to avoid them.

Script:getCharacters

:getCharacters()

Returns the regex defining the script's characters from the language's data file.

This can be used to search for words consisting only of this script, but see the warning above.

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.

Script:getDirection

:getDirection()

Returns the text direction, if any. Currently, left-to-right scripts are unmarked, while most right-to-left scripts have direction specified as "rtl" and Mongolian as "down".