Module:Message box/doc/cs
< Module:Message box | doc
| File:OOjs UI icon book-ltr.svg | This is a documentation subpage for Module:Message box/doc. It contains usage information, categories and other content that is not part of the original Module page. |
| File:OOjs UI icon notice-warning.svg | This module is used in system messages. Changes to it can cause immediate changes to the MediaWiki user interface. To avoid large-scale disruption, any changes should first be tested in this module's /sandbox or /testcases subpage, or in your own user space.The tested changes can then be added in one single edit to this module. Please discuss any changes on the talk page before implementing them. |
| File:OOjs UI icon check-constructive.svg | <translate> This module is rated as [[<tvar name=1>Special:MyLanguage/Category:Modules for general use</tvar>|ready for general use]].</translate> <translate> It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate.</translate> <translate> It is ready to mention on help pages and other resources as an option for new users to learn.</translate> <translate> To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.</translate> |
| File:Semi-protection-shackle-no-text.svg | <translate> This module is [[<tvar name=1>Special:MyLanguage/Category:Modules subject to page protection</tvar>|subject to {{<tvar name=2>#if:</tvar>|cascading|page}} protection]].</translate> <translate> It is a highly visible module in use by a very large number of pages.</translate> <translate> Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is [[<tvar name=1>Special:MyLanguage/Project:Protected page</tvar>|protected]] from editing.</translate> |
| File:Lua-logo-nolabel.svg | Uses Lua: |
| File:Farm-Fresh css add.svg | This module uses 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.
<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.
