Nápověda:Název šablony nebo modulu

Z Wikipedie, otevřené encyklopedie
Skočit na navigaci Skočit na vyhledávání
Zkratka:
  • WP:NŠ
    WP:NŠM
    WP:NM

Tato nápověda obsahuje soubor rad, jaké názvy šablon, modulů a jejich parametrů jsou na české Wikipedii upřednostňovány.

Obecné zásady[editovat | editovat zdroj]

  • Snažte se v názvu co nejlépe vystihnout účel šablony nebo modulu, např. místo Rozdělení použijte raději Sloupce.
  • Ve většině případů aplikujte standardní způsob pojmenovávání (viz Název článku), zvláště
    • berte ohled na technická omezení, v případě nemožnosti použít zvolený název zvolte prostě název jiný;
    • upřednostňujte očekávaný název;
    • v případě stejných názvů použijte rozlišovač (upřesnění v závorce), např. místo Adresa brány – Mléčná dráha použijte raději Adresa brány (Mléčná dráha).
  • Naopak v určitých případech aplikujte přesně opačné znění oproti standardnímu způsobu, zvláště
    • použijte sloveso, pokud šablona zobrazuje prosbu nebo příkaz k vykonání určité činnosti, např. Upravit;
    • v případě stejných názvů šablon velmi podobného obsahu můžete použít i číslovku na konci bez mezery mezi ní a názvem, např. místo Šablona (druhá) použijte raději Šablona2 (nikoliv Šablona 2);
    • stejně tak lze v názvu používat v rozumné míře i zkratky, např. Doplnit VE, nebo zkracovat čísla číslicemi, např. 1. liga národní házené mužů.
  • Berte ohled na jednoduchost použití, např. namísto typograficky správné pomlčky použijte raději spojovník, který lze najít na většině klávesnic, např. místo Přirozená čísla 0–99 použijte raději Přirozená čísla 0-99.
  • Vámi vytvořená šablona může být v budoucnu mnohokrát použita, proto volte název co nejjednodušší, např. namísto přesného a korektního První česká fotbalová Synot liga mužů použijte raději 1. česká fotbalová liga.

Název šablony[editovat | editovat zdroj]

U šablon upřednostněte český název před cizojazyčným, např. místo Deferred použijte raději Odloženo. V odůvodněných případech může být použit i cizojazyčný název, nejčastěji z historických důvodů, např. Flagicon, nebo jako tzv. dočasná použití, tj. šablony určené k usnadnění překladu článků do češtiny dočasně použité v přeložených článcích, např. Cite web, ty by však měly být výhledově nahrazeny za české ekvivalenty. Doporučujeme však spíše vytvořit přesměrování z cizojazyčného názvu a název šablony ponechat český.

Některé typy šablon vyžadují speciální zacházení:

Infoboxy[editovat | editovat zdroj]

  • Vždy volte název ve tvaru Infobox - název tématu, obsahující spojovník (nikoliv pomlčku), a název tématu zapisujte s malým počátečním písmenem (vyjma případů, kdy je téma zároveň vlastním jménem, např. Infobox - Sims).
  • Použijte přednostně jednotné číslo, např. místo Infobox - lidé použijte raději Infobox - osoba.
  • Název tématu co nejvíce zjednodušte a zkraťte, např. místo Infobox - jednotlivé národní reprezentace v ledním hokeji použijte raději Infobox - hokejová reprezentace. Pokud existuje také obecně známá zkratka, můžete použít i tu, např. místo Infobox - mistrovství světa v ledním hokeji použijte Infobox - MS v hokeji.
Související informace naleznete také na stránce Wikipedie:Žádost o komentář/Pojmenování infoboxů.

Navigační šablony[editovat | editovat zdroj]

  • Je-li téma vymezeno názvem hlavního článku oboru nebo tématu, použijte přednostně název hlavního článku, např. Biologie.
  • Je-li téma vymezeno názvem oboru nebo tématu, použijte přednostně jednotné číslo, např. Věda, Káva nebo Renesance. Je-li vymezeno věcně, použijte množné číslo, např. Barvy, Fotoaparáty nebo Vitamíny. Všimněte si, že v některých případech existují dvě šablony s názvem jak v jednotném čísle (kam se řadí témata vztahující se k danému oboru), tak v množném čísle (seznam různých konkrétních zástupců), např. Borovicovité a Borovice. Při použití v článcích dejte pozor, abyste nepoužili nesprávnou variantu.
  • Je-li název již zabraný významnější šablonou, použijte rozlišovač (navbox), např. Periodická tabulka (navbox).

Název modulu[editovat | editovat zdroj]

U modulů je naopak kladen důraz na univerzálnost kvůli případnému předávání a sdílení modulů mezi různými jazykovými verzemi Wikipedie. Zároveň by se modul neměl přímo vkládat do článků, ale používat převážně jako součást šablon. Z těchto důvodů tedy upřednostněte cizojazyčný název před českým, např. místo Čas použijte raději Time. V odůvodněných případech však lze použít i český název, např. Sraz, zejména je-li modul orientován na české prostředí.

Mezi technická omezení modulů patří nemožnost vytváření jejich přesměrování, proto název volte po důkladném uvážení.

Parametry[editovat | editovat zdroj]

U parametrů šablon platí obdobná pravidla jako pro název šablony, stejně tak je tomu i u modulu. Od zásad pro názvy šablon a modulů jsou zde však různé odchylky a vyskytují se zde specifické „chybné názvy“, které jsou u názvů šablon nebo modulů v pořádku.

Parametry pojmenujte…

  • jednoduše, vyvarujte se speciálních znaků a upřesňujících slovních spojení, např. místo jestli existuje písmeno π použijte raději existence pí, tedy znaky, které lze najít na většině klávesnic;
  • bez rovnítek (=), které slouží k oddělení názvu parametru od jeho hodnoty, a podtržítek (_), např. místo nadmořská_výška použijte nadmořská výška; dále se vyvarujte hlavně svislítka (|) a složených závorek ({}), tyto i další už však patří mezi výše zmíněná technická omezení pro názvy stránek;
  • česky u česky pojmenovaných a cizojazyčně u cizojazyčně pojmenovaných šablon nebo modulů, u šablon s mezerami a diakritikou, u modulů bez mezer a diakritiky, např. u šablony místo full-name použijte raději celý název a u modulu místo číslo revize použijte revisionNumber;
  • krátce a heslovitě, např. místo výška zvířete v kohoutku použijte raději výška, případně pro odlišení od jiných výšek např. výška v kohoutku;
  • přehledně a výstižně, např. místo výškaXšířkaXhloubka použijte raději rozměry a případné použití vysvětlete v dokumentaci;
  • přesně a věcně, např. místo obyvatelé použijte raději počet obyvatel;
  • s malým počátečním písmenem, např. souřadnice nebo nadmořská výška, neplatí žádné omezení velkého počátečního písmene jako u názvů stránek; výjimkou i zde mohou být zkratky nebo vlastní jména, např. IUCN nebo S-rank;
  • v případě stejných názvů použijte rozlišovač, nyní však bez závorky, např. místo spalné teplo (na m3) použijte raději spalné teplo m3. U více parametrů pro více podobných hodnot můžete použít i číslovku na konci bez mezery mezi ní a názvem, např. zástupce ředitele, zástupce ředitele2, zástupce ředitele3;
  • srozumitelně a pochopitelně, např. místo p. tab. použijte raději periodická tabulka.

Některé typy parametrů mají běžné ustálené názvy, na které jsou wikipedisté zvyklí:

  • místo nadpis použijte raději název
  • místo fotka nebo foto použijte raději obrázek
  • místo šířka obrázku nebo obrázek velikost použijte raději velikost obrázku
  • místo popisek obrázku nebo popis použijte raději popisek
  • místo homepage, webová stránka nebo www použijte raději web nebo url
  • místo velikost boxu, šířka šablony nebo velikost navigace použijte raději šířka boxu nebo šířka, resp. výška boxu nebo výška
  • místo doplnění nebo poznámka použijte raději komentář
  • místo obsah nebo předmět použijte raději text
  • u posloupností jsou obecně používány názvy parametrů předchozí a následující, případně doplněny upřesněním (např. ročník)
  • u posloupností výrobků nebo v úřadu se používají parametry předchůdce a nástupce
  • časové údaje je vhodné pojmenovat datum něčeho, například datum narození, datum zániku apod.
  • v infoboxech se vyvarujte použití nepojmenovaných parametrů
  • v navigačních šablonách se vyhněte použití parametrů jako takových


Související informace naleznete také na stránce Nápověda:Vytvoření infoboxu#Parametry.

Související stránky[editovat | editovat zdroj]