Šablona:Zastaralý parametr infoboxu/doc

Šablona je k použití při inovaci šablon, zejména při sjednocování podobných infoboxů, kdy je potřeba přechodná doba pro odstranění zastaralých částí, které nelze odebrat okamžitě, protože se ještě stále někde používají.

Motivace

Existují například dva podobné infoboxy, které je potřeba spojit do jednoho. Každý infobox však používá pro stejný údaj (např. "počet obyvatel") jiný název parametru (např: "obyv" a "obyvatelstvo"). Ve spojeném infoboxu se zahrnou obě možnosti parametru, aby se ve článcích zobrazily všechny údaje. 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, zadána správná 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 odkaz na infobox, jehož parametr je zastaralý.

• Pojmenovaný povinný vstup {{{šablona|}}} předává informaci o prvotní šabloně a je klíčový k informační funkci této pomocné debugovací šablony. Je pouze uvažován jako povinný, není tak však validován.
• Pojmenovaný povinný vstup {{{parametr|{{{param|}}}}}} udává název zastaralého parametru: Jak v hlášení na dokumentační stránce infoboxu, tak i u označení v článku (hover tooltip), kde je použit.
• Nepojmenovaný nepovinný vstup {{{3|}}} předává hodnotu požitého zastaralého parametru (dostal přiřazenu hodnotu) anebo i jen zmíněného (hodnotu má prázdnou "", ta však byla výslovně zadána).
• Pojmenovaný nepovinný vstup pro komentář, kam je dobré zmínit, kterým jiným parametrem se ten zastaralý nově nahrazuje, nebo zda se odebírá bez náhrady, souvislosti...
• Pojmenovaný nepovinný vstup pro rozlišení dokumentace popisované šablony: Přepíná zobrazení cedule / ukazovátka.

{{Zastaralý parametr infoboxu|šablona=Infobox - sídlo světa|param=gps|{{{gps|}}}|comment=komentář}}

ukazatel na použití zastaralého parametru, ukázka projevu přímo v infoboxu ve stránce

Účinky

Šablona se projeví dvojím způsobem, na dvou různých místech, má se totiž i vkládat na dvě místa infoboxu, pro ošetření každého jednoho zastaralého parametru:

1) Projeví se na stránce šablony, například infoboxu, na vrcholu její dokumentační stránky ať se zobrazí cedule hlášení: To je zde v dokumentaci předvedeno. Nezobrazí se však ve stránkách-článcích, kde je šablona použita: Nezúčastněný čtenář není takto velkým hlášením obtěžován: I k tomuto slouží výslovné určení názvu editované šablony, která v sobě má zastaralý parametr - šablona-cedule si vnitřně tento název porovnává s aktuální stránkou. Na začátek editovaného infoboxu tedy je potřeba vložit oznámení:

{{Zastaralý parametr infoboxu|šablona=Infobox - sídlo světa|param=gps|{{{gps|}}}|comment=komentář|cedule=ano}}

Infobox je zároveň zařazen do kategorie:Údržba:Infoboxy se zastaralými parametry.

2) Projeví se na stránce, kde je editovaný infobox volán a zastaralý parametr použit:

a) Zobrazí se výsledek z šablony, a snad přímo z toho parametru, tedy v kódu hned vedle volání toho zastaralého parametru, ať je ve výstupu jeho projev graficky označen ikonou "šipka":

b) Stránka, kde je zastaralý parametr použit (i jen zmíněn, hodnotou "" ?), je automaticky zařazen do kategorie:Údržba:Články se zastaralými parametry v infoboxech.

Související šablony

• {{Zastaralý parametr}}
• {{Zastaralá šablona}}
• {{Zastaralá šablona k ponechání}}