Šablona:Testy

Dokumentace  

Šablona {{Testy}} na začátek /test podstránky šablon nebo /testcases podstránky modulů přidá upozornění, že jde o testovací podstránku, a to i s odkazem na samu šablonu nebo modul.

Účel

Prosíme, pomozte vylepšit wikipedii tím, že zdokumentujete chování šablon a modulů, aby se tak nejen odstranily jejich případné chyby, ovšem také aby i jejich dokumentace byly názornější.

Vytváření nových šablon či modulů a jejich podstránek

Pokud např. připravujete novou verzi šablony Šablona:Hypotetická, pak závěr její noinclude části bude obsahovat volání {{Dokumentace}} (podrobnosti umístění kódu vizte tam) a první řádek testovací podstránky Šablona:Hypotetická/test bude obsahovat tuto pomocnou šablonu.

Šablona se vzájemně doplňuje se šablonou {{Dokumentace}} a je sesterská k šabloně {{Podstránka s dokumentací}}.

Ověření měněné funkce

Před uložením změny v šabloně (či modulu) je očekáváno, že se nové či změněné funkcionality prakticky vyzkouší, k čemuž jsou určeny podstránky /pískoviště. Takové je vhodné vytvořit a zamýšlenou verzi uložit nejdříve do ní. A správnost této připravené nové verze lze ověřit pomocí již uložené testovací podstránky /test, kterou lze zobrazit z rozeditovaného pískoviště pomocí funkce Náhled stránky s touto šablonou systému Wikipedie.

Ověření dosavadní funkce

I bez použití pískoviště, podstránka /test (/testcases) slouží i samostatně pro předvedení aktuálního chování, tedy jako přehled regresních testů a jejich okamžitých výsledků.

Použití

Na vrcholek testovací podstránky vložte:

{{Testy}}

Testování šablony, zdokumentované testovací případy

Každé testování má pokrývat nějakou sadu testovacích případů:

• Ty je zde tedy potřeba zdokumentovat: uvést vstupy a způsoby použití, připravit ke snadnému okopírování.
• A dále tyto připravené testovací případy nechat rovnou provést, šablonu naplněnou vstupy opravdu použít a nechat předvést aktuální výsledek, jak šablona zrovna funguje.
• Lze také zaznamenávat historický vývoj chování šablony uchováním výsledků z dřívějších verzí, to však nelze požadovat systematicky.

Forma dokumentování testovacích případů

Předpokládanou formou zdokumentování testovacích případů a jejich výsledků jsou například:

• odrážky - wikisyntax *
• tabulky - wikisyntax {| a |- a |}

A tyto předvedeny strukturovaně:

• v kapitolách - wikisyntax ==
• pod nadpisy - wikisyntax ;

Toto vše ideálně včetně vzorové ukázky na úvod a s uvedením probíraného parametru {{para|2|}} na začátku příslušné kapitoly, například |2 = .

Testování šablony, ne však osobní pokusy

K čemu však testovací podstránka šablony neslouží, jsou jednorázové experimenty, které by rozbíjely již připravené testovací případy, nebo by nesplňovaly požadavky na zdokumentování testovacího případu.

Lépe, experimenty se šablonami provádět lze jen na jiných podstránkách:

• na pískovištích, ideálně každý wikipedista na svém osobním,
• či na podstránkách své osobní stránky, stačí si tam nějakou libovolně vytvořit: V uživatelském jmenném prostoru, např.: Wikipedista:_vaše_uživatelské_jméno_/experimenty.

Automatická kategorizace

Další funkcí šablony {{Testy}} je, že

• u šablon sama zařadí testovací podstránky /test do kategorie:Wikipedie:Testy šablon
• nebo u modulů podstránky /testcases zařadí do kategorie:Wikipedie:Testy modulů.

Správný jmenný prostor si šablona rozlišuje sama.

Související šablony

• {{Dokumentace}} – Zpětný odkaz z šablony samotné na dokumentační podstránku, vzájemně se doplňující šablony.
• {{Podstránka s dokumentací}} – Podobná cedule do dokumentační podstránky šablony.

Související stránky

• Šablona:Zvýrazňovač/test – Příklad velmi dobře zdokumentovaných testovacích případů a i výsledků prakticky provedených experimentů, tedy aktuálního chování.