Šablona:FAQ/doc

Popis

Šablona FAQ slouží k vytváření rozbalovacích otázek a odpovědí ve formě accordionu.

Otázka se zobrazuje jako kliknutelný řádek. Po kliknutí na řádek se zobrazí nebo skryje odpověď.

Šablona je určena zejména pro stránky s častými dotazy. Volitelně lze otázku zařadit také do automaticky generovaného obsahu stránky, aniž by se tím změnil její vzhled.

Použití

Základní použití:

{{FAQ
 |nadpis=Jak dlouho trvá výroba nové karty?
 |text=
Po obdržení správně vyplněné žádosti trvá výroba karty obvykle do 2 pracovních dnů.
}}

Výsledek tvoří jeden rozbalovací FAQ box.

Parametry

Parametr	Povinný	Popis	Příklad
nadpis	ano	Text otázky, který se zobrazí v hlavičce rozbalovacího boxu.	Jak dlouho trvá výroba nové karty?
text	ano	Obsah odpovědi. Lze použít běžné MediaWiki formátování, odkazy, seznamy, tabulky i další šablony.	Výroba trvá obvykle do 2 pracovních dnů.
obsah	ne	Zařadí otázku do automatického obsahu stránky na zvolené úrovni. Podporované hodnoty jsou 2, 3, 4 a 5.	2

Zařazení otázky do obsahu stránky

Pokud má být otázka zobrazena také v automatickém obsahu stránky, použijte parametr obsah.

Například:

{{FAQ
 |nadpis=Jak dlouho trvá výroba nové karty?
 |obsah=2
 |text=
Po obdržení správně vyplněné žádosti trvá výroba karty obvykle do 2 pracovních dnů.
}}

Hodnota parametru určuje úroveň otázky v automatickém obsahu stránky:

Hodnota	Úroveň v obsahu	Interně vytvořený MediaWiki nadpis
2	druhá úroveň	=== Nadpis ===
3	třetí úroveň	==== Nadpis ====
4	čtvrtá úroveň	===== Nadpis =====
5	pátá úroveň	====== Nadpis ======

První úroveň obsahu není šablonou FAQ používána.

Pomocný nadpis sloužící pro vytvoření položky v obsahu stránky je na samotné stránce vizuálně skrytý. Vzhled FAQ boxu se proto při použití parametru obsah nezmění.

Pokud parametr obsah není uveden, otázka se do automatického obsahu stránky nezařadí.

Příklady

Jednoduchá otázka

{{FAQ
 |nadpis=Jak se dozvím, že je karta vyrobena?
 |text=
Jakmile bude nová karta vyrobena, obdržíte notifikační e-mail.
}}

Otázka zařazená do obsahu

{{FAQ
 |nadpis=Jak si mohu prodloužit licenci ISIC?
 |obsah=2
 |text=
Licenci ISIC si můžete prodloužit na [https://isic.jcu.cz isic.jcu.cz].
}}

Odpověď se seznamem

{{FAQ
 |nadpis=Jak mohu dobít svůj účet v IPS?
 |text=
Účet IPS lze dobít několika způsoby:

* pomocí dobíjecího automatu;
* platbou bankovní kartou;
* bankovním převodem;
* vkladem hotovosti na pokladně.
}}

Odpověď s interním odkazem

{{FAQ
 |nadpis=Kde si mohu vyzvednout kartu?
 |text=
Studenti si mohou kartu vyzvednout na [[Kartové centrum|Kartovém centru]].
}}

Odpověď s upozorněním

{{FAQ
 |nadpis=Kde se nacházejí dobíjecí automaty?
 |text=
* REK – [[HelpDesk CIT]] {{Note|type=warn|inline=1|text=dočasně mimo provoz}}
* AK – přízemí
* TF – knihovna
}}

Více FAQ za sebou

Jednotlivé šablony mohou být ve zdrojovém kódu odděleny prázdnými řádky:

{{FAQ
 |nadpis=První otázka
 |text=
První odpověď.
}}

{{FAQ
 |nadpis=Druhá otázka
 |text=
Druhá odpověď.
}}

{{FAQ
 |nadpis=Třetí otázka
 |text=
Třetí odpověď.
}}

Prázdné řádky mezi jednotlivými šablonami jsou při zobrazení stránky automaticky potlačeny, aby mezi FAQ boxy zůstaly jednotné rozestupy.

Doporučení

• Do parametru nadpis zapisujte pokud možno skutečnou otázku.
• Jedna šablona by měla obsahovat jednu otázku a jednu odpověď.
• Dlouhé odpovědi členěte pomocí odstavců, seznamů nebo tabulek.
• Parametr obsah používejte pouze tam, kde má smysl zobrazovat jednotlivé FAQ otázky také v automatickém obsahu stránky.
• Pro FAQ stejné hierarchické úrovně používejte stejnou hodnotu parametru obsah.
• První podporovaná úroveň FAQ v automatickém obsahu je obsah=2.
• Do parametru nadpis nevkládejte značky ==, === apod. Úroveň případného nadpisu v obsahu určuje parametr obsah.
• Mezi jednotlivými voláními

mohou být ve zdrojovém kódu ponechány prázdné řádky.

Technické informace

Šablona používá standardní MediaWiki mechanismus mw-collapsible a vlastní CSS/JavaScript navázaný na třídu:

faq-accordion

Kliknutí na celou hlavičku FAQ je řešeno pomocí JavaScriptu v MediaWiki:Common.js.

Vzhled šablony je definován v MediaWiki:Common.css.

JavaScript a CSS zajišťují zejména:

• rozbalení a sbalení FAQ kliknutím na celou hlavičku;
• ovládání pomocí klávesnice;
• jednotné rozestupy mezi jednotlivými FAQ boxy;
• potlačení prázdných řádků mezi jednotlivými voláními šablony;
• vizuální skrytí pomocných nadpisů používaných pro automatický obsah stránky.

Úpravy jsou navázány pouze na prvky šablony FAQ a neměly by ovlivňovat ostatní rozbalovací prvky na wiki.