Šablona:Navbox/Dokumentace

Tato dokumentace je editovatelná zde: Šablona:Navbox/Dokumentace. Je potřeba ji aktualizovat po přesunu z Wikipedie a převést do zdejších reálií.

Navbox může být použit jako kostra k vytvoření horizontální navigační šablony. Měla by stačit pro naprostou většinu navigačních šablon. Uživatelé si mohou změnit vzhled pomocí svého stylového předpisu. Používání této šablony je velmi doporučováno, navigační šablony tak získají jednotný vzhled a kód.

Navbox slouží ke vzájemnému prolinkování přesně definované skupiny článků s příbuznými tématy. Jako navigační šablona se umísťuje do zápatí článku za závěrečné sekce (vzor).

Užívejte tuto šablonu střídmě. Jejím použitím se prodlužuje kód stránky, který je nutno vždy načíst. To, že je část stránky na počátku skryta neznamená, že lze takto přidávat libovolné množství textu, ale naopak, že takový text není zas tak důležitý. Mohl by být vložen například na jiné stránce, na kterou by mohl vést jen odkaz. Rozmýšlejte třikrát, než zavedete novou navigační šablonu!

Šablony s použitou třídou class = navbox se neozobrazují na verzi webu pro mobilní zařízení.

Použití

Navigační šablonu můžete vytvořit jen pomocí několika parametrů. Prosím, odstraňte parametry, které nechcete použít. Pro zjednodušení implementace této šablony byly použity anglické názvy parametrů a některých jejich možných hodnot. Jejich významy jsou vysvětleny v této dokumentaci.

{{Navbox
|název = {{subst:PAGENAME}}
|titulek =
|obrázek =
|záhlaví =

|group1 =
|list1 =

|group2 =
|list2 =
 …
|group25 =
|list25 =

|zápatí =
}}

Seznam parametrů

Všechny parametry této šablony obsahují jen malá písmena. Povinné parametry jsou název a titulek (nadpis). Pokud jsou vynechány další parametry, vytvoří se jednořádková navigační šablona.

Všimněte si, že parametry group1 (skupina1) a další jsou nepovinné. Stejně tak nepovinné jsou parametry záhlaví (nad) a zápatí (pod).

Základní a nejpoužívanější parametry jsou následující (úplný seznam je níže):

název - název navigační šablony.

titulek - nadpis, text v záhlaví navigační šablony. Například: [[Kraje v Česku]].

obrázek - Obrázek na pravé straně navigační šablony, například [[Soubor:XX.jpg|90px|Popisek obrázku]]. Nezapomeňte na výstižný popisek obrázku.

obrázek vlevo - Obrázek na levé straně navigační šablony.

záhlaví - Text, který se objeví nad částí se skupinami a výčty, například seznam nějakých obecných wikilinků.

listn - Výčet s číslem n. Obvykle obsahuje seznam pojmů oddělených puntíkem (•).

například [[hlavní město Praha]] • [[Středočeský kraj]] ([[Praha]]) • [[Jihočeský kraj]] ([[České Budějovice]]) • [[Plzeňský kraj]] ([[Plzeň]]) • [[Karlovarský kraj]] ([[Karlovy Vary]]) • [[Ústecký kraj]] ([[Ústí nad Labem]]) • [[Liberecký kraj]] ([[Liberec]]) • [[Královéhradecký kraj]] ([[Hradec Králové]]) • [[Pardubický kraj]] ([[Pardubice]]) • [[kraj Vysočina]] ([[Jihlava]]) • [[Jihomoravský kraj]] ([[Brno]]) • [[Olomoucký kraj]] ([[Olomouc]]) • [[Moravskoslezský kraj]] ([[Ostrava]]) • [[Zlínský kraj]] ([[Zlín]])

groupn - Text na levé straně před výčtem s číslem n. Pokud je vynechán, výčet začíná zcela vlevo.

zápatí - Text, který se objeví pod částí se skupinami a výčty.

Další detaily a omezení jsou vysvětleny v oddílu Popis parametrů. Další možná rozložení naleznete v oddílu Rozložení.

Popis parametrů

V tomto oddíle naleznete úplný seznam parametrů šablony {{Navbox}}. Ve většině případů je nutné vyplnit pouze parametry název, titulek a list1. Vnořené navboxy nemusí mít nastaveny ani ty.

Běžné nastavení

název (název)

Název šablony, který je potřeba pro správnou funkci v odkazech „z • d • e“ („zobraz • diskutuj • edituj“ na všech stránkách, kde je šablona použita. Jako hodnotu tohoto parametru uvádějte Šablona:zvýrazňovač. Parametr je povinný, pokud je vyplněn i parametr titulek (nadpis) a není nastaven parametr border (to znamená, že je povinný, pokud má existovat rámeček nebo záhlaví šablony).

border (rámeček)

Pokud je tento parametr nastaven na hodnotu vnořený (původně child, tedy potomek), navbox může být použit jako vnořená část jiné navigační šablony. Krásně do ní zapadne, pokud je použita jako hodnota parametru list_n nadřazené navigační šablony. Její okraje jsou totiž skryty a není také obalena výplní (padding).

Pokud je tento parametr nastaven na hodnotu none (nic), navigační šablona může být použita uvnitř nějakého jiného kontejneru (například obecné tabulky). Nepoužívejte tuto hodnotu, pokud chcete vytvořit vnořené navboxy!

Pokud je tento parametr nastaven na jakoukoli jinou hodnotu, výsledkem bude výchozí chování, tedy navigační šablona bude mít okraj s mezerou.

První nepojmenovaný parametr této šablony se chová stejně jako tento parametr. Pro vytvoření vnořeného navboxu tedy stačí kód:

{{Navbox|vnořený

...

}}

O vnořených navboxech se dočtete více v oddílu Vnořené navboxy.

listclass (třída seznamu)

Pomocí tohoto parametru je možné zadat třídu pro formátování seznamů. Např. hodnota hlist umožňuje, aby se jednotlivé položky seznamů zadávaly formou klasického odrážkového seznamu, který bude zformátován do podoby řádkového seznamu položek oddělených tečkou (hlist = horizontal list, horizontální seznam)

Jednotlivé části

titulek (nadpis)

Nadpis je text, který se objeví v záhlaví celé šablony. Obvykle je dostatečným popisem obsahu šablony. Nadpis je obyčejně jednořádkový, ale pokud by byly potřeba řádky dva, můžete k zalomení použít šablonu {{-}}.

Po technické stránce není tento parametr povinný, ale bez něj nemá navigační šablona smysl. Neuvádí se pouze pokud se pomocí této šablony vytváří vnořený navbox.

list_n (výčet_n)

Popis se týká řady parametrů, jejichž název se liší jen číslem, t. j. list1, list2, atd…; n může být nejvýše 25.

Hodnoty těchto parametrů jsou samotným tělem šablony, obvykle tedy výčtem nějakých položek, většinou odkazů. Je nutno uvést alespoň jeden parametr list, aby šablona měla nějaký obsah. Každý další list je dalším řádkem tabulky. Ke každému list_n může existovat parametr group_n, viz níže.

group_n (skupina_n)

Popis se týká řady parametrů, jejichž název se liší jen číslem, t. j. group1, group2, atd…; n může být nejvýše 25.

Pokud je některý z těchto parametrů vyplněn, zobrazí nalevo od výčtu buňka, která popisuje daný výčet. Pokud je pro daný výčet tento parametr vynechán, zobrazí se výčet přes celou šířku navigační šablony.

Příklad použití naleznete v šabloně {{Evropa}}.

obrázek

Hodnota parametru je odkaz na obrázek, který se zobrazí napravo od výčtů. Aby se obrázek správně zobrazil, musí být definován parametr list1.

Parametr může obsahovat běžný wikikód, například

obrázek = [[Image:Example.jpg|100px|Popis obrázku]]

Nezapomínejte na popis obrázku, je důležitou součástí obrázku.

Příklad použití naleznete v šabloně {{Olympijské hry}}.

obrázek vlevo

Hodnota parametru je odkaz na obrázek, který se zobrazí nalevo od výčtů a skupin. Aby se obrázek správně zobrazil, musí být definován parametr list1.

Parametr může obsahovat běžný wikikód, například

obrázek vlevo = [[Image:Example.jpg|100px|Popis obrázku]]

Nezapomínejte na popis obrázku, je důležitou součástí obrázku.

záhlaví (nad)

Pomocí tohoto parametru se dá vytvořit úvodní položka navigační šablony nad všemi skupinami, výčty a obrázky. Může se hodit pro podnadpis nebo uvození obsahu samotné šablony. Její text se zobrazí přes celou šířku navigační šablony.

Příklad použití naleznete v šabloně {{Rusko}}.

zápatí (pod)

Pomocí tohoto parametru se dá vytvořit koncová položka (zápatí) navigační šablony pod všemi skupinami, výčty a obrázky. Může se hodit pro vysvětlivky nebo poznámky k obsahu samotné šablony. Její text se zobrazí přes celou šířku navigační šablony.

Příklad použití naleznete v šabloně {{Olympijské hry}}.

Pokročilé parametry

evenodd [swap, even, odd] (sudý lichý [prohoď, sudý, lichý])

Pokud je hodnota tohoto parametru swap (prohoď), prohodí se styly sudých a lichých výčtů. Obvykle sudé jsou trochu tmavší, tato hodnota je udělá světlejšími.

Pokud je hodnota tohoto parametru even (sudý) nebo odd (lichý), všechny výčty budou mít pozadí jako sudé, resp. jako liché výčty.

Rozložení

V tomto oddíle jsou příklady základních možností, která má uživatel této šablony při výběru jejích prvků.

Navbox bez parametrů obrázek, záhlaví a zápatí:

Navbox s parametry obrázek, záhlaví a zápatí:

Navbox s parametry obrázek, obrázek vlevo, lists a bez groups, záhlaví, zápatí:

Příklady

Bez obrázku

{{Navbox
|název = Navbox/doc
|titulek = [[Ústecký kraj]]
|group1 = Okresy
|list1 = [[Okres Děčín|Děčín]] • [[Okres Chomutov|Chomutov]] • [[Okres Litoměřice|Litoměřice]] • [[Okres Louny|Louny]] • [[Okres Most|Most]] • [[Okres Teplice|Teplice]] • [[Okres Ústí nad Labem|Ústí nad Labem]]
|group2 = Největší města
|list2 = [[Ústí nad Labem]] • [[Most (město)|Most]] • [[Děčín]] • [[Teplice]] • [[Chomutov]] • [[Litvínov]] • [[Litoměřice]] • [[Jirkov]] • [[Žatec]] • [[Louny]]
}}

S obrázkem, bez skupin

{{Navbox
|název = Navbox/doc
|titulek = [[Ústecký kraj]]
|obrázek = [[Soubor:Flag of Usti nad Labem Region.svg|60px|Vlajka Ústeckého kraje]]
|list1 = [[Okres Děčín|Děčín]] • [[Okres Chomutov|Chomutov]] • [[Okres Litoměřice|Litoměřice]] • [[Okres Louny|Louny]] • [[Okres Most|Most]] • [[Okres Teplice|Teplice]] • [[Okres Ústí nad Labem|Ústí nad Labem]]
}}

S dvěma obrázky, bez skupin, s dvěma výčty

{{Navbox
|název = Navbox/doc
|titulek = [[Ústecký kraj]]
|obrázek = [[Soubor:Flag of Usti nad Labem Region.svg|60px|Vlajka Ústeckého kraje]]
|obrázek vlevo = [[Soubor:Flag of Usti nad Labem Region.svg|60px|Vlajka Ústeckého kraje]]
|list1 = [[Okres Děčín|Děčín]] • [[Okres Chomutov|Chomutov]] • [[Okres Litoměřice|Litoměřice]] • [[Okres Louny|Louny]] • [[Okres Most|Most]] • [[Okres Teplice|Teplice]] • [[Okres Ústí nad Labem|Ústí nad Labem]]
|list2 = [[Ústí nad Labem]] • [[Most (město)|Most]] • [[Děčín]] • [[Teplice]] • [[Chomutov]] • [[Litvínov]] • [[Litoměřice]] • [[Jirkov]] • [[Žatec]] • [[Louny]]
}}

S obrázkem, skupinami, nad a pod

{{Navbox
|název = Navbox/doc
|titulek = [[Ústecký kraj]]
|záhlaví = Nejúžasnější kraj Česka
|obrázek = [[Soubor:Flag of Usti nad Labem Region.svg|60px|Vlajka Ústeckého kraje]]
|group1 = Okresy
|list1 = [[Okres Děčín|Děčín]] • [[Okres Chomutov|Chomutov]] • [[Okres Litoměřice|Litoměřice]] • [[Okres Louny|Louny]] • [[Okres Most|Most]] • [[Okres Teplice|Teplice]] • [[Okres Ústí nad Labem|Ústí nad Labem]]
|group2 = Největší města
|list2 = [[Ústí nad Labem]] • [[Most (město)|Most]] • [[Děčín]] • [[Teplice]] • [[Chomutov]] • [[Litvínov]] • [[Litoměřice]] • [[Jirkov]] • [[Žatec]] • [[Louny]]
|zápatí = [http://www.kr-ustecky.cz/ Oficiální stránky Ústeckého kraje]
}}

Vnořené navboxy

Navigační šablona může obsahovat vnořené navboxy. U vnořeného navboxu je potřeba definovat první nepojmenovaný parametr jako vnořený. Jednoduchý kód pak může vypadat následovně:

{{Navbox
|název = {{subst:PAGENAME}}
|titulek = Nadpis
...parametry vnějšího navboxu...
|list1 = {{Navbox|vnořený
   ...parametry vnořeného navboxu...
 }}
...zde pokračují parametry vnějšího navboxu
}}

Příklad vnořeného navboxu

V tomto oddíle naleznete příklady s vnořenými navboxy. Všimněte si, že parametr evenodd (sudý lichý) je použit pro prohození pruhů v některých vnořených navboxech.

{{Navbox
|název = Navbox/doc
|obrázek = [[Soubor:Flag of the Czech Republic.svg|100px|Vlajka Česka]]
|titulek = Příklad s několika vnořenými navboxy
|záhlaví = záhlaví
|zápatí = zápatí

|group1 = group1
|list1 = list1
|group2 = group2
|list2 =
 {{Navbox|vnořený
  |evenodd = swap
  |group1 = group1 vnořeného
  |list1 = list1 vnořeného
  |group2 = group2 vnořeného
  |list2 = list2 vnořeného
  |group3 = group3 vnořeného
  |list3 = list3 vnořeného
 }}

|group3 = group3
|list3 = list3

|group4 = group4
|list4 =
 {{Navbox|vnořený
  |evenodd = swap
  |group1 = group1 druhého vnořeného
  |list1 = list1 druhého vnořeného
  |group2 = group2 druhého vnořeného
  |list2 = list2 druhého vnořeného
  |group3 = group3 druhého vnořeného
  |list3 = list3 druhého vnořeného
 }}
}}

Několik ukaž/skryj v jednom kontejneru

Tento příklad demonstruje použití běžného navboxu pro vnější kontejner a jeho parametry pro další vnořené navboxy.

{{Navbox
|název = Navbox/doc
|titulek = Nejúžasnější [[Kraje v Česku|kraje Česka]] 
|list1 = {{Navbox|vnořený
 |název = Ústecký kraj
 |titulek = [[Ústecký kraj]]
 |obrázek = [[Soubor:Flag of Usti nad Labem Region.svg|60px|Vlajka Ústeckého kraje]]
 |group1 = Okresy
 |list1 = [[Okres Děčín|Děčín]] • [[Okres Chomutov|Chomutov]] • [[Okres Litoměřice|Litoměřice]] • [[Okres Louny|Louny]] • [[Okres Most|Most]] • [[Okres Teplice|Teplice]] • [[Okres Ústí nad Labem|Ústí nad Labem]]
 |group2 = Největší města
 |list2 = [[Ústí nad Labem]] •  [[Most (město)|Most]] • [[Děčín]] • [[Teplice]] • [[Chomutov]] • [[Litvínov]] • [[Litoměřice]] • [[Jirkov]] • [[Žatec]] • [[Louny]]
}}
|list2 = {{Navbox|vnořený
 |název = Královéhradecký kraj
 |titulek = [[Královéhradecký kraj]]
 |obrázek = [[Soubor:Flag of Hradec Kralove Region.svg|60px|Vlajka Královéhradeckého kraje]]
 |group1 = Okresy
 |list1 = [[Okres Hradec Králové|Hradec Králové]] • [[Okres Jičín|Jičín]] • [[Okres Náchod|Náchod]] • [[Okres Rychnov nad Kněžnou|Rychnov nad Kněžnou]] • [[Okres Trutnov|Trutnov]]
 |group2 = Největší města
 |list2 = [[Hradec Králové]] • [[Trutnov]] • [[Náchod]] • [[Jičín]] • [[Dvůr Králové nad Labem]] • [[Vrchlabí]] • [[Jaroměř]] • [[Rychnov nad Kněžnou]] • [[Nové Město nad Metují]] • [[Nová Paka]]
}}
|list3 = {{Navbox|vnořený
 |název = Jihočeský kraj
 |titulek = [[Jihočeský kraj]]
 |obrázek = [[Soubor:Flag of South Bohemian Region.svg|60px|Vlajka Jihočeského kraje]]
 |group1 = Okresy
 |list1 = [[Okres České Budějovice|České Budějovice]] • [[Okres Český Krumlov|Český Krumlov]] • [[Okres Jindřichův Hradec|Jindřichův Hradec]] • [[Okres Písek|Písek]] • [[Okres Prachatice|Prachatice]] • [[Okres Strakonice|Strakonice]] • [[Okres Tábor|Tábor]]
 |group2 = Největší města
 |list2 = [[České Budějovice]] • [[Tábor]] • [[Písek (město)|Písek]] • [[Strakonice]] • [[Jindřichův Hradec]] • [[Český Krumlov]] • [[Prachatice]] • [[Milevsko]] • [[Třeboň]] • [[Týn nad Vltavou]]
}}
}}

Technické detaily

• Tato šablona byla včetně většiny dokumentace převzata z anglické Wikipedie 27. 6. 2009, 21:05 (UTC), vizte en:Template:Navbox. Její parametry jsou sice počeštěné, ale šablona akceptuje i anglické názvy.
• Tato šablona používá třídy CSS pro většinu z jejího vzhledu, takže si může každý snadno vytvořit vlastní výchozí vzhled.
• Šablona uvnitř používá HTML, což má ve složitějších metašablonách několik výhod. Lze snadněji používat funkce parseru a speciální znaky v parametrech.
• Technické detaily můžete diskutovat na diskusní stránce šablony, třídy CSS si můžete prohlédnout na MediaWiki:common.css a skripty zajišťující rozvinování a svinování na MediaWiki:common.js.

Specialitky

• Rámeček (border) široký 2px mezi skupinami (groups) a výčty (lists) se kreslí pomocí vlastnosti border-left buňky výčtů. Pokud tedy chcete změnit pozadí navigační šablony (například bodystyle = background:purple;), musíte také nastavit border-left-color výčtů (tedy liststyle = border-left-color:purple;).
• Sousední navboxy mají mezi sebou jen 1pixelový okraj.

Odkazování

Z navboxů jsou standardně odkazovány články. Ve výjimečných případech lze odkázat i na kategorie, a to způsobem, z něhož bude zjevné, že je odkazována kategorie. Vhodným místem pro takové případy je zápatí (např. stylem „k:Časopisy“, „kategorie:Časopisy“).