Šablona:Šablona/doc

Vkládání přímého odkazu na šablony, navíc v podobě jako v kódu: {{Šablona}}

Účel

Vhodné používat na začátku dokumentací šablon, aby se výsledný text dal rychle a snadno překopírovat: Usnadní se tím praktické použití té dokumentované šablony do kódu.

Použití

Potřebujete-li v textu diskuse nebo dokumentace zmínit nějakou šablonu zároveň s přímým odkazem na ní, můžete ho zapsat právě pomocí této šablony a jejího prvního parametru: {{Šablona|Rozcestník}}. Výsledkem je přímý odkaz ve tvaru {{Rozcestník}}.

Šablona testuje, zda cílová šablona skutečně existuje, a nevytváří červené odkazy: {{šablona|zaručeně neeexistující}} dá {{zaručeně neexistující}}.

Přesměrování

Protože se šablona nepoužívá v hlavním prostoru wikipedie, v článcích (není proč), běžně se používá její zkrácené volaní Šablona:Š, případně {{tl}}, z anglického template link: odkaz na šablonu.

Druhý parametr

subst

V případě použití druhého parametru „subst“ se na úvod textu vypíše povel „subst:“ (sloužící při skutečném zadání a uložení k náhradě volání šablony ve zdrojovém kódu stránky jejím aktuálním obsahem): {{šablona|vítejte|subst}} dá {{subst:vítejte}}.

Následně se zjistí přítomnost třetího parametru a ten se případně použije k zobrazení parametrů substované šablony: {{Šablona|Vítejte|subst|a}} dá {{subst:Vítejte|a}}.

Vstup do popisované šablony

Je-li druhý parametr jiná hodnota než „subst“, uvažuje se tato jako první parametr popisované šablony a tak se i zobrazí: {{šablona|smazat|blábol}} dá {{smazat|blábol}}.

Ukázka vícera parametrů popisované šablony

Pro předvedení předávání šabloně vícera parametrů, než jen jediného, se tohoto zobrazení dosáhne nepřímo, vložením pomocné šablony {{!}} do textu předávané šablony:

příklad wiki-výsledku v článku	Šablona:Podrobně
požadovaný výsledek do dokumentace nebo diskuse pro copy&paste z psaného textu, jako usnadnění ostatním	článek_2 | článek_3}}
kód předváděný dokumentací nebo v diskusi, nutné escapování	{{Šablona|Podrobně | článek_1 <code>{{!}} článek_2 {{!}} článek_3}}</code> použitím nahrazovací šablony {{!}} (znak |) {{Šablona|Podrobně | článek_1 &#124; článek_2 &#124; článek_3}} použitím SGML entit &#124; (znak |)
ještě zdrojovější vrstva kódu pro vytvoření kódu k vložení do dokumentace, složitější, protože zde dokonce selfreference	{{tl|Šablona |Podrobně Šablona:Tl článek_1 <code>{{tl|!}} článek_2 {{tl|!}} článek_3}}</code> použitím nahrazovacích šablon {{!}} (znak |), {{Šablona}} a pomocí jejího přesměrování {{tl}} {{tl|Šablona |Podrobně &#124; článek_1 &amp;#124; článek_2 &amp;#124; článek_3}} použitím SGML entit &#124; (znak |) a jejich konstrukcí pomocí &amp; (&)

Všechny parametry předávané popisované šabloně se tedy popíší popisnou šablonou Šablona, té se všechny popisované hodnoty předají skrze popisný druhý parametr, jako text, tedy jako jedna hodnota: článek_1 <code>{{!}} článek_2 {{!}} článek_3</code>

Předvádění číslovaných parametrů jako pojmenovaných

Šablona:Redirect Zápis pojmenovaných parametrů podle čísel sice je možný (je-li tak šablona naprogramovaná, aby používala obojí), ale je třeba mít na paměti, že s postupujícím rozkódováváním do příkladů se také mění relativní pozice těchto parametrů!

výsledek v textu článku či dokumentace, uživatelský cíl: po všech wiki-strojových interpretacích	Šablona:Podrobně
požadovaný výsledek do dokumentace nebo diskuse pro copy&paste z psaného textu, jako usnadnění ostatním	{{Podrobně|2=druhý=článek_2|1=první=článek_1}} použitím dvojitého číslování a nahrazovací šablony {{!}} (znak |) {{Podrobně|2=druhý=článek_2|1=první=článek_1}} použitím SGML entit | (znak |)
kód předváděný dokumentací nebo v diskusi, nutné escapování	Šablona:Tl použitím dvojitého číslování, {{!}} a pomocí popisné nahrazovací šablony {{Šablona}} Šablona:Tl použitím entit = (=) a | (|) a jejich konstrukcí pomocí & (&)
ještě zdrojovější vrstva kódu pro vytvoření kódu k vložení do dokumentace, složitější, protože zde dokonce selfreference	{{tl|Šablona|2=PodrobněŠablona:Tl2=2=druhý=článek_2<code>{{Šablona|!}}1=první=článek_1}}</code> dvojitým číslováním a šablonami {{tl|Šablona|Podrobně&#124;2&amp;#61;druhý&amp;#61;článek_2&amp;#124;1&amp;#61;první&amp;#61;článek_1}} entitami

V předávané textové hodnotě "2=2=druhý=článek_2{{šablona|Šablona|!}}1=první=článek_1" se první levé rovnítko interpretuje jako přiřazení, ve wiki-syntaxi, další rovnítka už jsou jen "obyčejné znaky v textu". Tedy v tomto kroku interpretace: V příštím kroku zpracování (text-kód na text, který i nadále bude vystupovat v roli kódu), v dalším kole interpretování příkladu výše, se stane syntakticky významným druhé "první rovnítko zleva". První takové bylo prve požráno při interpretaci: 2=. Původní textový "vstup do parametru" se tedy zkrátil a dokonce rozpadl na dva ještě menší vstupy, do dvou jiných parametrů: 2=druhý=článek_2 + {{Šablona|!}} + 1=první=článek_1. Takový text, potřebuje-li zdokumentovat složitý případ, si wikipedista musí postavit (zkomplikovat) sám, zpětnými úvahami o funkcích wiki interpreterů a šablon.

Potlačení formátování

• Výchozí formátování <code>, zobrazování výsledku neproporcionálním písmem a v rámečku, lze potlačit: Kód s potlačeným formátováním {{šablona|vítejte|nocode=nocode}} dá {{vítejte}}, místo {{vítejte}} bez potlačení formátování.

Související šablony

• Výstup šablony – uvádí přímý výstup šablony
• Tag – předvádí HTML (resp. XML) značku
• Para – předvádí zápis parametru šablony s případnou hodnotou při konkrétním použití
• Param – předvádí samotný kód parametru šablony, případně i jemu přednastavenou defaultní hodnotu

Data šablony

<templatedata> { "params": { "1": { "aliases": [ "šablona" ], "label": "Název šablony", "type": "wiki-template-name", "required": true }, "2": { "aliases": [ "subst" ], "label": "Substuje se?", "description": "Pokud se šablona používá se subst:, vložte subst (viz Nápověda:Substituce).", "example": "subst", "type": "boolean", "autovalue": "subst" }, "3": { "aliases": [ "param" ], "label": "Parametr", "description": "Použitý parametr", "type": "string" }, "nocode": { "aliases": [ ], "label": "nocode", "description": "Vypne vnitřní obalování do <code>, pro použití v příkladech šablon, kde je již takto obalováno,
stačí pouhá přítomnost jakékoli hodnoty", "example": "|nocode=nocode", "type": "string" } }, "description": "Vytvoří zformátovaný odkaz na šablonu.", "format": "inline", "paramOrder": [ "1", "2", "3", "nocode" ] } </templatedata>