215
editací
Změny
Založena nová stránka s textem „{{Zkratka názvu stránky|šablona:tl}} {{Podstránka s dokumentací}} <!-- KATEGORIE prosím přidejte až na spodek této stránky --> {{Tisíckrát}…“
{{Zkratka názvu stránky|šablona:tl}}
{{Podstránka s dokumentací}}
<!--
KATEGORIE prosím přidejte až na spodek této stránky
-->
{{Tisíckrát}}
Vkládání přímého [[Nápověda:Odkazy|odkazu]] na [[Nápověda:Šablony|šablony]], navíc v podobě jako v kódu: {{Šablona|Š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: <code><nowiki>{{Šablona|Rozcestník}}</nowiki></code>. Výsledkem je přímý odkaz ve tvaru {{Šablona|Rozcestník}}.
Šablona testuje, zda cílová šablona skutečně existuje, a nevytváří červené odkazy: <code><nowiki>{{šablona|zaručeně neeexistující}}</nowiki></code> dá {{šablona|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ě {{šablona|tl}}, z anglického ''[[:en:template:tl|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): <code><nowiki>{{šablona|vítejte|subst}}</nowiki></code> dá {{šablona|vítejte|subst}}.
Následně se zjistí přítomnost třetího parametru a ten se případně použije k zobrazení parametrů substované šablony: <code><nowiki>{{Šablona|Vítejte|subst|a}}</nowiki></code> dá {{Šablona|Vítejte|subst|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í: <code><nowiki>{{šablona|smazat|blábol}}</nowiki></code> dá {{šablona|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 {{šablona|!}} do textu předávané šablony:
{| class="wikitable"
! příklad wiki-výsledku v článku
| {{Podrobně | článek_1 | článek_2 | článek_3}}
|-
! požadovaný výsledek do [[Šablona:dokumentace|dokumentace]] nebo diskuse<br />pro copy&paste z psaného textu, jako usnadnění ostatním
| {{Šablona |Podrobně | článek_1 {{!}} článek_2 {{!}} článek_3}}
|-
! kód předváděný dokumentací nebo v diskusi,<br />nutné [[escapování]]
|
* {{šablona |Šablona |Podrobně {{!}} článek_1 {{šablona|!}} článek_2 {{šablona|!}} článek_3 }}
použitím nahrazovací šablony {{Šablona|!}} (znak |)
* {{šablona |Šablona |Podrobně | článek_1 &#124; článek_2 &#124; článek_3}}
použitím [[HTML entita|SGML entit]] &#124; (znak |)
|-
! ještě zdrojovější vrstva kódu<br />pro vytvoření kódu k vložení do dokumentace,<br />složitější, protože zde dokonce [[autoreference|selfreference]]
|
* {{šablona|tl |Šablona {{!}}Podrobně {{tl|!}} článek_1 {{šablona|tl|!}} článek_2 {{šablona|tl|!}} článek_3 }}
použitím nahrazovacích šablon {{Šablona|!}} (znak |), {{Šablona|Šablona}} a pomocí jejího přesměrování {{Šablona|tl}}
* {{šablona|tl |Šablona |Podrobně &#124; článek_1 &amp;#124; článek_2 &amp;#124; článek_3 }}
použitím [[HTML entita|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'': <code>článek_1 {{šablona|!}} článek_2 {{šablona|!}} článek_3</code>
==== Předvádění číslovaných parametrů jako pojmenovaných ====
{{redirect|Wikipedie:číslované parametry}}
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ů!
{| class="wikitable"
! výsledek v textu článku či dokumentace,<br />uživatelský cíl: po všech wiki-strojových interpretacích
| {{Podrobně|2=druhý=článek_2|1=první=článek_1}}
|-
! požadovaný výsledek<br />do [[Šablona:dokumentace|dokumentace]] nebo diskuse<br />pro copy&paste z psaného textu,<br />jako usnadnění ostatním
|
* {{Šablona|Podrobně|2=2=druhý=článek_2{{!}}1=první=článek_1}}
použitím dvojitého číslování a nahrazovací šablony {{Šablona|!}} (znak |)
* {{Šablona|Podrobně|2=druhý=článek_2{{!}}1=první=článek_1}}
použitím [[HTML entita|SGML entit]] &#124; (znak |)
|-<!-- doc a zdrojaky jeho prikladu jsou zapsane spravne, ale WP interpret wiki inerpretuje znacky "code" nespravne!
Spatne zpracovani:
* <nowiki><code>x<code>y</code>z</code></nowiki>
interpretuje jako
* <nowiki><code>x (code-ignorovan) y</code>z (/code-ignorovan)</nowiki>
Takze je neinterpretuje jako vnorene XML tagy, ale spis jako "HTML komentare" (podle prvniho vyskytu). Pritom to ale ''jsou'' XML tagy!
Reseni A, uplne:
Opravit wiki-interpret
Reseni B, docasne:
upravit sablonu {Sablona}, aby neobklopovala tagem "code", ale radeji "span" s nastavenym attr style (jako ma tag code, CSS class code?).
...to uz nez se interpret opravi a klidne i pak: Stejne jde jen o stylovani, tak se s tim wiki-stroj nemusi zatezovat
-->
! kód předváděný<br />dokumentací nebo v diskusi,<br />nutné [[escapování]]
|
* {{tl|Šablona|2=Podrobně{{!}}2=2=druhý=článek_2{{Šablona|!}}1=první=článek_1}}
použitím dvojitého číslování, {{Šablona|!}} a pomocí popisné nahrazovací šablony {{Šablona|Šablona}}
* {{tl|Š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<br />pro vytvoření kódu k vložení do dokumentace,<br />složitější, protože zde dokonce [[autoreference|selfreference]]
|
* {{šablona|tl|2=Šablona{{!}}2=Podrobně{{tl|!}}2=2=druhý=článek_2{{šablona|Šablona|!}}1=první=článek_1}}
dvojitým číslováním a šablonami
* {{šablona|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ě <code><nowiki>"2=2=druhý=článek_2{{šablona|Šablona|!}}1=první=článek_1"</nowiki></code> se první levé rovnítko interpretuje jako přiřazení, ve [[wiki-syntax]]i, 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: <code>2=</code>. Původní textový "vstup do parametru" se tedy zkrátil a dokonce rozpadl na dva ještě menší vstupy, do dvou jiných parametrů: <code>2=druhý=článek_2</code> + {{šablona|Šablona|!}} + <code>1=první=článek_1</code>. 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.
{{viz též|1=šablona:=|2=šablona:para}}
== Potlačení formátování ==
* Výchozí formátování <code><code></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 <code><nowiki>{{šablona|vítejte|nocode=nocode}}</nowiki></code> dá {{šablona|vítejte|nocode=nocode}}, místo {{šablona|vítejte}} bez potlačení formátování.
== Související šablony ==
* [[Šablona:Výstup šablony|Výstup šablony]] – uvádí přímý výstup šablony
* [[Šablona:Tag|Tag]] – předvádí HTML (resp. XML) značku
* [[Šablona:Para|Para]] – předvádí zápis parametru šablony s případnou hodnotou při konkrétním použití
* [[Šablona:Param|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><code></code>, pro použití v příkladech šablon, kde je již takto obalováno,<br />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>
<includeonly><!-- KATEGORIE zde, děkujeme -->
[[Kategorie:Šablony:Dokumentační]]
</includeonly>
{{Podstránka s dokumentací}}
<!--
KATEGORIE prosím přidejte až na spodek této stránky
-->
{{Tisíckrát}}
Vkládání přímého [[Nápověda:Odkazy|odkazu]] na [[Nápověda:Šablony|šablony]], navíc v podobě jako v kódu: {{Šablona|Š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: <code><nowiki>{{Šablona|Rozcestník}}</nowiki></code>. Výsledkem je přímý odkaz ve tvaru {{Šablona|Rozcestník}}.
Šablona testuje, zda cílová šablona skutečně existuje, a nevytváří červené odkazy: <code><nowiki>{{šablona|zaručeně neeexistující}}</nowiki></code> dá {{šablona|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ě {{šablona|tl}}, z anglického ''[[:en:template:tl|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): <code><nowiki>{{šablona|vítejte|subst}}</nowiki></code> dá {{šablona|vítejte|subst}}.
Následně se zjistí přítomnost třetího parametru a ten se případně použije k zobrazení parametrů substované šablony: <code><nowiki>{{Šablona|Vítejte|subst|a}}</nowiki></code> dá {{Šablona|Vítejte|subst|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í: <code><nowiki>{{šablona|smazat|blábol}}</nowiki></code> dá {{šablona|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 {{šablona|!}} do textu předávané šablony:
{| class="wikitable"
! příklad wiki-výsledku v článku
| {{Podrobně | článek_1 | článek_2 | článek_3}}
|-
! požadovaný výsledek do [[Šablona:dokumentace|dokumentace]] nebo diskuse<br />pro copy&paste z psaného textu, jako usnadnění ostatním
| {{Šablona |Podrobně | článek_1 {{!}} článek_2 {{!}} článek_3}}
|-
! kód předváděný dokumentací nebo v diskusi,<br />nutné [[escapování]]
|
* {{šablona |Šablona |Podrobně {{!}} článek_1 {{šablona|!}} článek_2 {{šablona|!}} článek_3 }}
použitím nahrazovací šablony {{Šablona|!}} (znak |)
* {{šablona |Šablona |Podrobně | článek_1 &#124; článek_2 &#124; článek_3}}
použitím [[HTML entita|SGML entit]] &#124; (znak |)
|-
! ještě zdrojovější vrstva kódu<br />pro vytvoření kódu k vložení do dokumentace,<br />složitější, protože zde dokonce [[autoreference|selfreference]]
|
* {{šablona|tl |Šablona {{!}}Podrobně {{tl|!}} článek_1 {{šablona|tl|!}} článek_2 {{šablona|tl|!}} článek_3 }}
použitím nahrazovacích šablon {{Šablona|!}} (znak |), {{Šablona|Šablona}} a pomocí jejího přesměrování {{Šablona|tl}}
* {{šablona|tl |Šablona |Podrobně &#124; článek_1 &amp;#124; článek_2 &amp;#124; článek_3 }}
použitím [[HTML entita|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'': <code>článek_1 {{šablona|!}} článek_2 {{šablona|!}} článek_3</code>
==== Předvádění číslovaných parametrů jako pojmenovaných ====
{{redirect|Wikipedie:číslované parametry}}
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ů!
{| class="wikitable"
! výsledek v textu článku či dokumentace,<br />uživatelský cíl: po všech wiki-strojových interpretacích
| {{Podrobně|2=druhý=článek_2|1=první=článek_1}}
|-
! požadovaný výsledek<br />do [[Šablona:dokumentace|dokumentace]] nebo diskuse<br />pro copy&paste z psaného textu,<br />jako usnadnění ostatním
|
* {{Šablona|Podrobně|2=2=druhý=článek_2{{!}}1=první=článek_1}}
použitím dvojitého číslování a nahrazovací šablony {{Šablona|!}} (znak |)
* {{Šablona|Podrobně|2=druhý=článek_2{{!}}1=první=článek_1}}
použitím [[HTML entita|SGML entit]] &#124; (znak |)
|-<!-- doc a zdrojaky jeho prikladu jsou zapsane spravne, ale WP interpret wiki inerpretuje znacky "code" nespravne!
Spatne zpracovani:
* <nowiki><code>x<code>y</code>z</code></nowiki>
interpretuje jako
* <nowiki><code>x (code-ignorovan) y</code>z (/code-ignorovan)</nowiki>
Takze je neinterpretuje jako vnorene XML tagy, ale spis jako "HTML komentare" (podle prvniho vyskytu). Pritom to ale ''jsou'' XML tagy!
Reseni A, uplne:
Opravit wiki-interpret
Reseni B, docasne:
upravit sablonu {Sablona}, aby neobklopovala tagem "code", ale radeji "span" s nastavenym attr style (jako ma tag code, CSS class code?).
...to uz nez se interpret opravi a klidne i pak: Stejne jde jen o stylovani, tak se s tim wiki-stroj nemusi zatezovat
-->
! kód předváděný<br />dokumentací nebo v diskusi,<br />nutné [[escapování]]
|
* {{tl|Šablona|2=Podrobně{{!}}2=2=druhý=článek_2{{Šablona|!}}1=první=článek_1}}
použitím dvojitého číslování, {{Šablona|!}} a pomocí popisné nahrazovací šablony {{Šablona|Šablona}}
* {{tl|Š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<br />pro vytvoření kódu k vložení do dokumentace,<br />složitější, protože zde dokonce [[autoreference|selfreference]]
|
* {{šablona|tl|2=Šablona{{!}}2=Podrobně{{tl|!}}2=2=druhý=článek_2{{šablona|Šablona|!}}1=první=článek_1}}
dvojitým číslováním a šablonami
* {{šablona|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ě <code><nowiki>"2=2=druhý=článek_2{{šablona|Šablona|!}}1=první=článek_1"</nowiki></code> se první levé rovnítko interpretuje jako přiřazení, ve [[wiki-syntax]]i, 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: <code>2=</code>. Původní textový "vstup do parametru" se tedy zkrátil a dokonce rozpadl na dva ještě menší vstupy, do dvou jiných parametrů: <code>2=druhý=článek_2</code> + {{šablona|Šablona|!}} + <code>1=první=článek_1</code>. 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.
{{viz též|1=šablona:=|2=šablona:para}}
== Potlačení formátování ==
* Výchozí formátování <code><code></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 <code><nowiki>{{šablona|vítejte|nocode=nocode}}</nowiki></code> dá {{šablona|vítejte|nocode=nocode}}, místo {{šablona|vítejte}} bez potlačení formátování.
== Související šablony ==
* [[Šablona:Výstup šablony|Výstup šablony]] – uvádí přímý výstup šablony
* [[Šablona:Tag|Tag]] – předvádí HTML (resp. XML) značku
* [[Šablona:Para|Para]] – předvádí zápis parametru šablony s případnou hodnotou při konkrétním použití
* [[Šablona:Param|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><code></code>, pro použití v příkladech šablon, kde je již takto obalováno,<br />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>
<includeonly><!-- KATEGORIE zde, děkujeme -->
[[Kategorie:Šablony:Dokumentační]]
</includeonly>
