Module:Arguments/doc/cs

{{#switch: {{Languages|Module:Arguments/doc}}

{{Shared Template Warning|Module:Arguments|Module:Arguments}} {{Used in system}} {{Module rating|release}} {{Module rating|protected}}

Tento modul umožňuje snadné zpracování argumentů předávaných z {{Magic word|#invoke|...|ext=Scribunto|code=1|nowrap=1}}. Je to metamodul určený pro použití jinými moduly a neměl by být volán přímo z {{tlc| #invoke:... }}. Mezi jeho vlastnosti patří:


 * Snadné ořezávání argumentů a odstraňování prázdných argumentů.
 * Argumenty mohou být předány současně aktuálním rámcem i nadřazeným rámcem. (Další podrobnosti níže.)
 * Argumenty lze předávat přímo z jiného modulu Lua nebo z ladicí konzole.
 * Argumenty se načítají podle potřeby, což může pomoci vyhnout se (některým) problémům se značkami {{xtag|ref}}.
 * Většinu funkcí lze přizpůsobit.



Základní použití
Nejprve je třeba načíst modul. Obsahuje jednu funkci s názvem.

V nejzákladnějším scénáři můžete v hlavní funkci použít. Proměnná  je tabulka obsahující argumenty z. (Další podrobnosti najdete níže.)

Doporučená praxe je však použít funkci pouze pro zpracování argumentů od. To znamená, že pokud někdo zavolá váš modul z jiného modulu Lua, nemusíte mít k dispozici rámový objekt, což zlepšuje výkon.

Pokud chcete, aby argumenty používalo více funkcí, a také chcete, aby byly přístupné z, můžete použít funkci wrapper.

Možnosti
K dispozici jsou následující možnosti. Jsou vysvětleny v následujících částech.



Ořezávání a odstraňování polotovarů
Prázdné argumenty často podrazí kodéry, které jsou novým převodem šablon MediaWiki na Lua. V syntaxi šablony jsou prázdné řetězce a řetězce obsahující pouze mezery považovány za. V Lua jsou však prázdné řetězce a řetězce obsahující mezery považovány za. To znamená, že pokud těmto argumentům při psaní svých Lua modulů nevěnujete pozornost, můžete s něčím zacházet jako s, s čím by ve skutečnosti mělo být zacházeno jako s. Aby se tomu zabránilo, ve výchozím nastavení tento modul odstraňuje všechny prázdné argumenty.

Podobně mohou bílé znaky způsobit problémy při práci s pozičními argumenty. Přestože jsou mezery oříznuty pro pojmenované argumenty pocházející z, jsou zachovány pro poziční argumenty. Většinu času není tato další mezera žádoucí, takže tento modul je ve výchozím nastavení ořízne.

Někdy však chcete jako vstup použít prázdné argumenty a někdy chcete ponechat další mezery. To může být nezbytné pro převod některých šablon přesně tak, jak byly napsány. Pokud to chcete udělat, můžete nastavit argumenty  a   na.



Vlastní formátování argumentů
Někdy chcete odstranit některé prázdné argumenty, ale ne jiné, nebo možná budete chtít umístit všechny poziční argumenty malými písmeny. Chcete-li dělat věci, jako je tato, můžete použít možnost. Vstupem této možnosti musí být funkce, která přebírá dva parametry,  a , a vrací jedinou hodnotu. Tato hodnota je to, co získáte, když vstoupíte do pole  v tabulce.

Příklad 1: Tato funkce zachová mezery pro první poziční argument, ale ořízne všechny ostatní argumenty a odstraní všechny ostatní prázdné argumenty.

Příklad 2: Tato funkce odstraní prázdné argumenty a převede všechny argumenty na malá písmena, ale neořízne mezery od pozičních parametrů.

Example 1:

Example 2:

Also, please note that the  function is called more or less every time an argument is requested from the   table, so if you care about performance you should make sure you aren't doing anything inefficient with your code.

Frames and parent frames
Arguments in the  table can be passed from the current frame or from its parent frame at the same time. To understand what this means, it is easiest to give an example. Let's say that we have a module called. This module prints the first two positional arguments that it is passed.

is then called by, which contains the code. This produces the result "firstInvokeArg".

Now if we were to call, the following would happen:

There are three options you can set to change this behaviour:,   and. If you set  then only arguments passed from the current frame will be accepted; if you set   then only arguments passed from the parent frame will be accepted; and if you set   then arguments will be passed from both the current and parent frames, but the parent frame will have priority over the current frame. Here are the results in terms of :

    

   

    </dl>

Wrappers
The  option is used to specify a limited number of templates as wrapper templates, that is, templates whose only purpose is to call a module. If the module detects that it is being called from a wrapper template, it will only check for arguments in the parent frame; otherwise it will only check for arguments in the frame passed to. This allows modules to be called by either or through a wrapper template without the loss of performance associated with having to check both the frame and the parent frame for each argument lookup.

For example, the only content of (excluding content in <noinclude ></noinclude> tags) is. There is no point in checking the arguments passed directly to the statement for this template, as no arguments will ever be specified there. We can avoid checking arguments passed to by using the   option, but if we do this then  will not work from other pages either. If this were the case, then in the code  would be ignored completely, no matter what page it was used from. By using the  option to specify Template:Navbox as a wrapper, we can make  work from most pages, while still not requiring that the module check for arguments on the Template:Navbox page itself.

Wrappers can be specified either as a string, or as an array of strings.

Writing to the table
Sometimes it can be useful to write new values to the  table. This is possible with the default settings of this module. (However, bear in mind that it is usually better coding style to create a new table with your new values and copy arguments from the  table as needed.)

It is possible to alter this behaviour with the  and   options. If  is set then it is not possible to write any values to the   table at all. If  is set, then it is possible to add new values to the table, but it is not possible to add a value if it would overwrite any arguments that are passed from.

Ref tags
This module uses metatables to fetch arguments from. This allows access to both the frame arguments and the parent frame arguments without using the  function. This can help if your module might be passed ref tags as input.

As soon as ref tags are accessed from Lua, they are processed by the MediaWiki software and the reference will appear in the reference list at the bottom of the article. If your module proceeds to omit the reference tag from the output, you will end up with a phantom reference - a reference that appears in the reference list, but no number that links to it. This has been a problem with modules that use  to detect whether to use the arguments from the frame or the parent frame, as those modules automatically process every available argument.

This module solves this problem by allowing access to both frame and parent frame arguments, while still only fetching those arguments when it is necessary. The problem will still occur if you use  elsewhere in your module, however.

Known limitations
The use of metatables also has its downsides. Most of the normal Lua table tools won't work properly on the  table, including the   operator, the   function, and the functions in the   library. If using these is important for your module, you should use your own argument processing function instead of this module.

Tests
}}
 * #default=