Jump to content

Module:Message box/doc/cs

From mediawiki.org
This page is a translated version of the page Module:Message box/doc and the translation is 100% complete.

Toto je metamodul, který implementuje šablony zpráv {{mbox}}, {{ambox}}, {{cmbox}}, {{fmbox}}, {{imbox}}, {{ombox}} a {{tmbox}}. Je určen k použití z modulů Lua a neměl by být používán přímo ze stránek wiki. Pokud chcete používat funkce tohoto modulu ze stránky wiki, použijte místo toho jednotlivé šablony zpráv.

Použití

Chcete-li použít tento modul z jiného modulu Lua, musíte jej nejprve načíst.

local messageBox = require('Module:Message box')

Chcete-li vytvořit schránku zpráv, použijte funkci main. Chce to dva parametry:

  • první je typ pole (jako řetězec).
  • druhá je tabulka obsahující parametry zpráv.
local box = messageBox.main( boxType, {
	param1 = param1,
	param2 = param2,
	-- Více parametrů...
})

K dispozici je sedm typů schránek:

Typ schránky Šablona Účel
mbox {{mbox}} Pro schránky zpráv, které mají být použity ve více jmenných prostorech
ambox {{ambox}} Pro pole zpráv článku
cmbox {{cmbox}} Pro pole zpráv kategorií
fmbox {{fmbox}} Pro schránky zpráv rozhraní
imbox {{imbox}} Pro pole zpráv oboru názvů souborů
tmbox {{tmbox}} Pro schránky zpráv diskusních stránek
ombox {{ombox}} Pro schránky zpráv v jiných jmenných prostorech

Dostupné parametry naleznete na stránce šablony pro každý typ schránky.

<span id="Usage_from_#invoke">

Použití pro #invoke

Kromě funkce main má tento modul samostatné funkce pro každý typ schránky. Jsou přístupné pomocí kódu {{#invoke:Message box|mbox|...}}, {{#invoke:Message box|ambox|...}} atd. Ty budou fungovat při volání z jiných modulů, ale přistupují ke kódu používanému ke zpracování argumentů předávaných z {{#invoke:...}}, takže jejich volání bude méně efektivní než volání main

Technické podrobnosti

Modul používá stejný základní kód pro každou z výše uvedených šablon. Rozdíly mezi každým z nich jsou nakonfigurovány pomocí dat na stránce Module:Message box/configuration.