Editace stránky Šablona:Zastaralý parametr/doc

{{Podstránka s dokumentací}}<!-- KATEGORIE, prosíme, přidávejte až na spodek této stránky. Děkujeme! -->
Šablona je k použití při inovaci šablon, kdy je potřeba přechodná doba pro odstranění zastaralých parametrů, které nelze odebrat okamžitě, protože se ještě stále někde používají.

== Motivace ==
Existuje například šablona, u které je díky přestavbě potřeba nahradit parametry novými. V nové verzi šablony se zahrnou obě možnosti parametru, aby se zachovaly všechny stávající funkce. Aby však šablona nebyla takto „nafouknutá“ velkým množstvím synonymních parametrů, přebytečné z parametrů se touto šablonou označí jako zastaralé. Až jsou pak na všech stránkách, kde je infobox vložen, použita jen nová jména parametrů (mravenčí práce nadšených wikipedistů), může se konečně zastaralý parametr z kódu šablony odstranit.

== Syntax ==
Zadáním parametru šablony určíme, který parametr je zastaralý.

Pojmenovaný parametr "šablona" předává informaci o prvotní šabloně a je klíčový k informační funkci této pomocné debugovací šablony při dohledávání chyby v článku.

Další pojmenovaný parametr "parametr" (nepojmenovaný "1") je také povinný, zpřesňuje podávanou informaci o název konkrétního parametru: Jak v hlášení na stránce šablony, tak i u označení v článku, kde se použil.
:<pre>{{Zastaralý parametr|šablona=sídlo světa|param=gps|gps}}</pre>
{{Zastaralý parametr|šablona=sídlo světa|param=gps|gps}}

== Účinky ==
Šablona se projeví dvojím způsobem, na dvou různých místech:
:1) Na stránce šablony se zobrazí cedule hlášení. Ne však ve stránkách-článcích, kde je šablona-se-zastarlým-parametrem použita: Nezúčastněný čtenář není takto velkým hlášením obtěžován.
:<pre>{{Zastaralý parametr|šablona=sídlo světa|param=gps|gps|doc=doc}}</pre>
{{Zastaralý parametr|šablona=sídlo světa|param=gps|gps|doc=doc}}

:2) Na stránce, kde je zastaralý parametr použit:
::a) Výsledek z šablony, a snad přímo z toho parametru, není graficky označen: Text je skrytý [[Kaskádové styly|CSS]] vlastností "hidden", ovšem je v [[HyperText Markup Language|HTML]] kódu stránky přítomen a tedy dohledatelný.
::b) Stránka, kde se zastaralý parametr použil, je automaticky zakategorizována do [[:kategorie:Použití zastaralých parametrů šablon]].

== Související šablony ==
* {{šablona|Zastaralý parametr infoboxu}}
* {{šablona|Zastaralá šablona}}
* {{šablona|Zastaralá šablona k ponechání}}

<includeonly><!--  KATEGORIE PŘIDÁVEJTE SEM, DĚKUJEME  -->
[[Kategorie:Šablony:Dokumentační]]
[[Kategorie:Šablony pro údržbu šablon]]
</includeonly>