Module:Message box/doc/cs
 | Toto je dokumentace podstránky Module:Message box/doc. Obsahuje informace o použití, kategorie a další obsah, který není součástí původní stránky Module. |
 | Tento modul se používá v systémových zprávách. Jeho změny mohou způsobit okamžité změny uživatelského rozhraní MediaWiki. Chcete-li se vyhnout rozsáhlému narušení, měly by být všechny změny nejprve otestovány na podstránce /sandbox nebo /testcases tohoto module nebo ve vašem vlastním uživatelském prostoru.Testované změny pak mohou být přidány v jedné jediné úpravě do tohoto modulu. Před implementací prodiskutujte jakékoli změny na diskusní stránce. |
 | Tento modul je hodnocen jako připraven pro všeobecné použití. Dosáhl zralé formy a předpokládá se, že je bez chyb a je připraven k použití, kdekoli je to vhodné. Je připraven zmínit se na stránkách nápovědy a dalších zdrojích jako možnost, kterou se mohou naučit noví uživatelé. Aby se snížilo zatížení serveru a špatný výstup, měl by být vylepšen pomocí testování v izolovaném prostoru spíše než opakovanými úpravami metodou pokus-omyl. |
 | Tento modul podléhá stránkové ochraně. Je to vysoce viditelný modul, který používá velmi velký počet stránek. Protože vandalismus nebo chyby by ovlivnily mnoho stránek a dokonce i triviální úpravy by mohly způsobit značné zatížení serverů, je chráněn před úpravami. |
 | Uses Lua: |
 | Tento modul používá TemplateStyles: |
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.
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.