Šablona:Šablona/doc

Tato šablona je velmi často použita (i dalšími šablonami).

Každá změna se tak projeví na mnoha místech. Editujte ji s maximální obezřetností, jen pokud víte jistě, co děláte. Pokud úprava způsobí nečekané následky, urychleně ji vraťte. Veškeré experimenty byste měli raději provádět na pískovišti nebo ve svém uživatelském prostoru.

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í {{š}}, 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	Podrobnější informace naleznete v článcích článek_1 , článek_2 a článek_3.
požadovaný výsledek do dokumentace nebo diskuse pro copy&paste z psaného textu, jako usnadnění ostatním	{{Podrobně | článek_1 | č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ě <code>{{!}} článek_1 {{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í pojmenovaných parametrů

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ů!

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|Podrobně|2=2=druhý=článek_2<code>{{!}}1=první=článek_1}}</code> použitím dvojitého číslování, {{!}} a pomocí popisné nahrazovací šablony {{Šablona}} {{Šablona|Podrobně|2&#61;druhý&#61;článek_2&#124;1&#61;první&#61;článek_1}} použitím entit &#61; (=) a &#124; (|) a jejich konstrukcí pomocí &amp; (&)
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ě<code>{{!}}2=2=druhý=článek_2{{Š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