Šablona:Param

{{{parametr|default}}}

Dokumentace  

Param může být použit v diskusích k šablonám a na technických stránkách k zobrazení ukázky vnitřního kódu parametru šablony.

Šablona uvedený parametr barevně zvýrazní, aby bylo snadné všimnout si výskytů parametru, všech jeho uvedených příkladů.

Navíc šablona umí předvést i výchozí hodnotu v případě, že parametru není při volání zadána žádná hodnota.

Použití

Název parametru

První parametr slouží pro název parametru, který chceme zobrazit:

{{param|parametr}}

„{{{parametr}}}“

{{param|parametr|}}

Výchozí hodnota

Druhý parametr pak slouží ke zobrazení výchozí hodnoty, která může být jak prázdná, tak zadaná:

„{{{parametr|}}}“

{{param|parametr|default}}

„{{{parametr|default}}}“

Přepínače a nastavení

• |nocode = ano – vypne stylování <code>, zobrazí už bez změny písma a především nezarámované. Nutný u vnořeného volání.

• |barva = #cff – změna hodnoty barvy CSS pro pozadí, pro zvýraznění, a to i přes trojné složené závorky parametru (viz seznam pojmenovaných barev).
  • Výslovně uvedený, ale prázdný |barva = – Vypne barevné zvýrazňování. Pozor: Zobrazený text stále může být obarvený, ovlivněn barvou nadřazených prvků, do kterých byl vložen.
  • Výslovně nastavená barva |barva = ... – Předaná hodnota se použije pro obarvení pozadí.
    • Je-li předána neplatná hodnota, bude tato i tak zpracována: Šablona barvy nijak nekontroluje, jakoukoli hodnotu pro barvu mechanicky vloží do stylopisu. Že se pak taková hodnota neprojeví nebo projeví chybně, je na zodpovědnosti wikipedisty-editora.

• |bold = normal – nastavuje CSS tučnost textu zobrazovaného mezi trojnými složenými závorkami parametru.
  • Výslovně uvedený, ale prázdný |bold = – Vypne ztučnění. Pozor: Zobrazený text stále může být tučný, ovlivněn ztučněním nadřazených prvků, do kterých byl vložen.
  • Výslovně nastaven |bold = normal – Také vypne ztučnění. Takto už však lze vynutit potlačení tučnosti i při vložení do textu, který sám tučný už je.
  • Je-li do parametru zadána jiná hodnota než jedna z předepsaných, bude zpracována jako výslovně prázdný vstup.

• |bold1 = , |bold2 = – volitelné parametry. Jde o přepínače tučnosti s obdobnými vlastnostmi jako |bold = , ovšem pro vytučnění vždy jen jednoho vstupu: |bold1 = pro |parametr, |bold2 = pro |default. Například |bold1 = bold je užitečný pro vytučnění jen parametrů (či obdobně výchozích hodnot), a to bez vytučnění trojných složených závorek, viz příkladovou tabulku vnořování níže.

• |plain = plaintext – vypne na výsledku všechna formátování, vnitřně povypíná najednou všechny tři zde používané vlastnosti: přebije nejen jejich implicitní přednastavené hodnoty, dokonce i jejich výslovně uvedené/zadávané hodnoty. Výsledek šablony se tak zaručeně zobrazí jen jako prostý text.

Příklady

Kód	Výsledek	Popis
{{Param|autor}}	{{{autor}}}	pojmenovaný parametr zadán anonymním vstupem
{{Param|3}}	{{{3}}}	číslovaný parametr zadán anonymně
{{Param|1=3}}	{{{3}}}	číslovaný parametr zadán pojmenovaně
{{Param|parametr=3}}	{{{3}}}	číslovaný parametr zadán číslovaně
{{Param|3|}}	{{{3|}}}	číslovaný parametr s výslovně předvolenou prázdnou hodnotou zadán pojmenovaně
{{Param|parametr=3|anonym}}	{{{3|anonym}}}	číslovaný parametr s předvolenou hodnotou zadán pojmenovaně. Pozor: Hodnota z {{{1}}} použita 'pro default!
{{Param|param=3|anonym|xy}}	{{{3|anonym}}}	číslovaný parametr s předvolenou hodnotou zadán pojmenovaně. Pozor: Hodnota z {{{1}}} použita 'pro default! Hodnota z {{{2}}} je navíc, nevyužita.
{{Param|3|X}}	{{{3|X}}}	číslovaný parametr s předvolbou hodnoty nastavenou na "X"
{{Param|3|2=X}}	{{{3|X}}}	číslovaný parametr s předvolbou hodnoty nastavenou na "X" zadán pojmenovaně
{{Param|3|default=X}}	{{{3|X}}}	číslovaný parametr s předvolbou hodnoty nastavenou na "X" zadán pojmenovaně
{{Param|param=3|default=X|xy}}	{{{3|X}}}	číslovaný parametr s předvolbou hodnoty nastavenou na "X" zadán 2x pojmenovaně; s hodnotou {{{1}}} navíc, nevyužitou
{{Param|3|default=X|xy}}	{{{3|X}}}	číslovaný parametr s předvolbou hodnoty nastavenou pojmenovaně na "X"; s hodnotou {{{2}}} navíc, nevyužitou
{{Param|3|barva=DeepSkyBlue}}	{{{3}}}	číslovaný parametr bez předvolené hodnoty, se změněnou barvou zvýraznění
{{Param|3|X|color=DeepSkyBlue}}	{{{3|X}}}	číslovaný parametr s předvolbou hodnoty nastavenou na "X", se změněnou barvou zvýraznění
{{Param|3||barva=DeepSkyBlue}}	{{{3|}}}	číslovaný parametr s předvolenou výslovně prázdnou hodnotou, se změněnou barvou zvýraznění
{{Param|3||color=}}	{{{3|}}}	číslovaný parametr s předvolenou výslovně prázdnou hodnotou, bez zvýraznění
{{Param|3|barva=}}	{{{3}}}	číslovaný parametr bez předvolené hodnoty, bez zvýraznění
{{Param|autor|nocode=nocode}}	{{{autor}}}	pojmenovaný parametr bez předvolené hodnoty, ke bez tagu <code> jako zvýrazněný rich-text
{{Param|autor|anonym|nocode=nocode|barva=}}	{{{autor|anonym}}}	pojmenovaný parametr s předvolenou hodnotou, ke zobrazení jako běžný rich-text, zvýrazněný vytučněním
{{Param|3|anonym|nocode=nocode|bold=bold}}	{{{3|anonym}}}	číslovaný parametr s předvolenou hodnotou, zadán anonymně, ke zobrazení jako richtext, zvýrazněný, zato normálním fontem
{{Param|3|anonym|nocode=nocode|bold=normal}}	{{{3|anonym}}}	ukázka aktivního potlačení tučnosti, nastavením protihodnoty do stylu
{{Param|3|anonym|nocode=nocode|bold=}}	{{{3|anonym}}}	ukázka aktivního potlačení tučnosti, ovšem pasivním způsobem: pouhým nenastavením stylu
{{Param|3|anonym|nocode=nocode|bold=chybný}}	{{{3|anonym}}}	ověření chování při zadání chybné hodnoty do vlastnosti pro tučnost: nerozpoznanou hodnotu (mimo dvě povolené) šablona ani nastaví
{{Param|3|anonym|bold1=bold}}	{{{3|anonym}}}	tučnost výslovně jen pro název parametru, přebije celkovou implicitní tučnost
{{Param|3|anonym|bold2=bold}}	{{{3|anonym}}}	tučnost výslovně jen pro default, přebije celkovou implicitní tučnost
{{Param|3|anonym|nocode=nocode|bold1=}}	{{{3|anonym}}}	výslovně vypnutá tučnost, byť i jen dílčí, přebíjí celkovou implicitní tučnost. To i obecně: explicitní vypnutí jakékoli tučnosti přebije implicitně přednastavenou.
{{Param|3&#32;|&#32;anonym|plain=plain}}	{{{3 | anonym}}}	vložení mezer: vše se bere jen jako text, tedy jsou možné textové manipulace; zobrazení vynuceno jako jen prostý text: veškeré stylování-formátování je potlačeno (vnitřně vlastnosti povypínány po jedné).
{{Param|3..|..anonym|plain=plain}}	{{{3..|..anonym}}}	podvržení statického textu: vše se bere jen jako text, tedy jsou možné textové manipulace

Validace

Chybný kód	Hláška	Popis
{{Param}}		není zadán vstup pro název popisovaného parametru
{{Param|}}		není zadán vstup pro název popisovaného parametru
{{Param||default=anonym}}		název parametru ani nezadán, zato s pojmenovaně zadanou předvolbou hodnoty
{{Param||anonym|xy}}		název parametru nezadán: výslovně prázdný string; z fronty anonymních nastaven default; hodnota {{{3}}} je navíc, ani nevyužita

Vnořování

Pro účely zdokumentování, jak jsou vstupy zřetězené, jak je jeden použit pro nastavení defaultu v předešlém, jsou uvedeny příklady konstrukcí:

Vnořené kódy	Zobrazení vnořených	Popis
{{Param|v1|{{Param|v2|d|nocode=nocode}}}}	{{{v1|{{{v2|d}}}}}}	vnoření jednoho jako defaultu uvnitř druhého
{{Param|v1|{{Param|v2|d}}}}	{{{v1|{{{v2|d}}}}}}	rozbité zobrazení tagu <code>, protože jsou do sebe vnořené dva takové: Aby se formátovací značky neovlivňovaly, je třeba u vnitřního formátování vypnout, vynutit si |nocode.
{{Param|v1|{{Param|v2||nocode=nocode}}}}	{{{v1|{{{v2|}}}}}}	výslovně prázdný default vnitřního
{{Param|v1|{{Param|v2|nocode=nocode}}}}	{{{v1|{{{v2}}}}}}	nezmíněný default vnitřního
{{Param|nocode=nocode|v1|{{Param|nocode=nocode|v2|d}}}} {{Param|v1|{{Param|v2|d|nocode=nocode}}|nocode=nocode}}	{{{v1|{{{v2|d}}}}}}	vnořené a vše jako rich-text, vynucení |nocode = nocode u obou, ačkoli potřeba jen u vnitřního. Na pořadí parametrů nezáleží.
{{Param|v1|{{Param|v2|d|nocode=nocode}}|nocode=nocode|bold1=bold}}	{{{v1|{{{v2|d}}}}}}	tučně jen parametry, ne trojné složené závorky: protipříklad k předešlému
{{Param|v1|{{Param|v2|d|nocode=nocode|barva=YellowGreen}}|barva=DeepSkyBlue}}	{{{v1|{{{v2|d}}}}}}	vnořené, vynucení |nocode = nocode u zanořeného. Ukázka barvení.
{{Param|v1| {{Param|v2|d|nocode=nocode|barva=yellowGreen|bold=normal}} |nocode=nocode|barva=DeepSkyBlue}}	{{{v1|{{{v2|d}}}}}}	vnořené a vše jako rich-text, vynucení |nocode = nocode u obou. Ukázka barvení, ukázka potlačení tučnosti.
{{Param|v1| {{Param|v2|d|nocode=nocode|barva=YellowGREen|bold2=bold}} |nocode=nocode|barva=|bold=}}	{{{v1|{{{v2|d}}}}}}	Ukázka vynucení prostého textu přes tři vypínače, obdoba |plain = plain. Ukázka potlačení barvení, ukázka vynucení tučnosti jen pro default.
{{Param|3|{{Param|4|{{Param|5|D|plain=plain}}|plain=plain}}|plain=plain}}	{{{3|{{{4|{{{5|D}}}}}}}}}	hrátky se zanořováním, opakovaně vynucovaný prostý text
{{Param|3| X{{Param|4| Y{{Param|5 | S|nocode=nocode|barva=YellowGreen}}T |nocode=nocode|color=magenta}}Z |barva=DeepSkyBlue}}	{{{3|X{{{4|Y{{{5|S}}}T}}}Z}}}	koplexní hrátky se zanořováním a barvením
{{Param|v1|{{Param|v2|{{Param|v3|d|nocode=nocode}}|nocode=nocode|bold1=bold|barva=#beb}}|bold1=bold}}	{{{v1|{{{v2|{{{v3|d}}}}}}}}}	do dokumentací, vícenásobně alternativní vstup (anebo prostý výpis možností {{Param|v1}}={{Param|v2}}={{Param|v3|d}}: {{{v1}}}={{{v2}}}={{{v3|d}}})

Pro zamezení potíží se zobrazením šablon {{param}} vnořených do sebe, je potřeba u vnitřních vypnout rámečkování <code>: K tomu poslouží vypínač |nocode = ano, který rámečkování vypíná.

Související šablony

• {{šablona}} – uvádí zápis šablony při konkrétním použití
• {{tag}} – předvádí HTML (resp. XML) značku
• {{zvýrazňovač}}
• {{para}} - předvádí praktické přiřazení hodnoty do parametru