Editing Module:Multilingual/doc (section)

== Functions for Lua modules (API) ==

All functions described above can be used by other modules:
<syntaxhighlight lang="lua">
local lucky, Multilingual = pcall( require, "Module:Multilingual" )
if type( Multilingual ) == "table" then
    Multilingual = Multilingual.Multilingual()
else
    -- failure; Multilingual is the error message
    return "<span class='error'>" .. Multilingual .. "</span>"
end
</syntaxhighlight>
Subsequently there are available:
; Multilingual.fair( ask )
:* ''ask'' – string, or table according to getLang()
; Multilingual.findCode( ask )
; Multilingual.format( apply, alien, alter, active, alert, frame, assembly, adjacent )
:* ''apply'' – string with language list or single item
:* ''alien'' – language of the answer
:** <code>nil false "*"</code> – native
:** <code>"!"</code> – current project
:** any valid code
:* ''alter'' – capitalization
:** <code>"c"</code> – capitalize
:** <code>"d"</code> – downcase everything
:** <code>"f"</code> – capitalize first item only, downcase anything else
:* ''active'' – link items, if <code>true</code>
:* ''alert'' – string with category title in case of error
:* ''frame'' – if available
:* ''assembly'' – string with split pattern, if list expected
:* ''adjacent'' – string with list separator, else ''assembly''
:* ''ahead'' – string for optional prepending first element, if any
; Multilingual.getBase( ask )
; Multilingual.getLang( ask )
: Split language code into components
: Returns: ''table''
:: <code>.base</code> – Basic language (2–3 lowercase letters)
:: <code>.region</code> – Country (2 uppercase letters)
:: <code>.script</code> – Scripting (4 letters, capitalized)
:: <code>.year</code> – year (4 digits)
:: <code>.extension</code> – Extension (1 lowercase letter)
:: <code>.other</code> – More
:: <code>.legal</code> – ''true'' if valid
:: <code>.n</code> – Number of components
; Multilingual.getName( ask, alien )
:* ''alien'' – language of the answer
:** <code>nil false "*"</code> – native
:** <code>"!"</code> – current project
:** Any ISO code.
; Multilingual.isLang( ask )
; Multilingual.isLangWiki( ask )
; Multilingual.kannDeutsch( ask )
; Multilingual.userLang( accept, frame )
:* ''accept'' – string with space separated list of available ISO 639 codes
:* ''frame'' – if available
; Multilingual.failsafe( atleast )
:* atleast<br />''optional''<br />''nil'' or required version
:* Returns: ''string'' or ''false''
If succeeding, the ''Multilingual.get*()'' return a string, the ''Multilingual.is*()'' <code>true</code>; on failure <code>false</code>.