Wikipedija:Lua/Module/LuaWiki/en

Programowanje předłohi	Diskusije	Lua				Testy	Podstrony
		Modul	Hornjoserbsce	English	Deutsch		Modul:	Dokumentacija

LuaWiki – Module with functions for Lua programming in context of a Wiki project.

Functions for templates

No direct usage by templates.

Functions for Lua modules (API)

The Lua Scribunto Debug Console is a safe, interactive tool for learning Modul:LuaWiki.

1. Click Edit source on the Modul:LuaWiki page.
2. Do not modify the Lua code in the editor and do not click Publish changes.
3. Scroll to the bottom of the page to the Debug console section.
4. Paste the following into the gray input box (above the Clear button).

local LuaWiki = require("Modul:LuaWiki")      -- load the LuaWiki module
print(type(LuaWiki))                          -- A Lua module must return a table
print(LuaWiki.isExisting("Modul:LuaWiki"))    -- Does Modul:LuaWiki exist?
print(LuaWiki.getVariable("PAGENAME", false)) -- Get the title of the current page

5. Press ↵ Enter once to execute all Lua commands.
6. The result will appear below the Lua print command line:

table
true
LuaWiki

7. Press Up arrow (↑) to cycle through previous Lua commands.
8. Optionally, click Clear to clear only the Debug Console; the Lua editor above will remain unmodified.

Thereafter the functions can be accessed.

LuaWiki.getArg(arg, assign)

Retrieve template argument

• arg – string or number; argument identifier
• assign – optional; default value of any type, if not provided in template transclusion
• Returns: string (ensured) or default value orherwise

If not set in template transclusion and no default value, then: {{{<arg>}}}

LuaWiki.getVariable(seek, numeric)

Retrieve item from wikiVariables; populate if not yet present; see de:Hilfe:Variablen

• seek – string; name of variable, like "PAGENAME"
• numeric – boolean, optional; true: seek is numeric (else string)
• Returns: string or number

Previous initialization with initVariables accelerates but ist not mandatory.

LuaWiki.initVariables(request)

Initialization of some required variables for acceleration

• request – table; selection of variables

  every element either:

  • string; name of variable, like "PAGENAME"
  • table; variable is always returned as numerical value
    • [1] string; name of variable
    • [2] true

• Returns: none

LuaWiki.isExisting(seek)

Test page existence; like #ifexist

• seek – string; full page name
• Returns: boolean

LuaWiki.setFrame(frame)

Deprecated: Initialize frame for this utility by current template environment

• frame – frame object
• Returns: none

LuaWiki.transclude(s, args)

Save transclusion of a page, or error message

• s – string; full page name (if namespace not provided Template: will be used)
• args – table, optional; arguments
• Returns: string; transclusion or error message if page missing

LuaWiki.error(msg)

HTML generator of error message

• msg – string; error message
• Returns: string; HTML error message

In Debug console of Modul:LuaWiki:

local LuaWiki = require("Modul:LuaWiki")    -- load the LuaWiki module
print(LuaWiki.getArg("argUnknown"))         -- Get unknown arg
print(LuaWiki.error("LuaWiki.setFrame(frame) is deprecated")) -- setFrame doesn't exist

{{{<argUnknown>}}}
Lua-zmylk:  LuaWiki.setFrame(frame) is deprecated.

Wróćoslědowanje:

[C]: in function "error"
Modul:LuaWiki:32: in function "error"
console input:13: ?
[C]: ?

1. Click Cancel beneath the Lua editor.
2. The Module:LuaWiki remains unmodified.

Usage

General library; no limitations.

Dependencies

None.

Origin

• de:Vorlage:LuaWiki - 2013-05-04