Editace stránky Šablona:Šablona/doc

{{Podstránka s dokumentací}}

<!--

    KATEGORIE a INTERWIKI prosím přidejte až na spodek této stránky

-->

Vkládání přímého [[Nápověda:Odkazy|odkaz]]u 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í {{š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é [[w:cs: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 | článek_2 | článek_3}}

použitím [[HTML entita|SGML entit]] | (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ě | článek_1 | článek_2 | článek_3 }}

použitím [[HTML entita|SGML entit]] | (znak |) a jejich konstrukcí pomocí & (&)

|}

​

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

​

{| class="wikitable"

! 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]] | (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=druhý=článek_2|1=první=článek_1}}

použitím entit = (=) a | (|) a jejich konstrukcí pomocí & (&)

|-

! 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ě|2=druhý=článek_2|1=první=článek_1}}

entitami

|}

​

<includeonly><!-- KATEGORIE a INTERWIKI zde, děkujeme -->

{{DEFAULTSORT:{{PAGENAME}}}}

[[Kategorie:Šablony Wikipedie]]

[[Kategorie:Šablony užívající ParserFunctions]]

​