doc
Dokumentaci této šablony lze vytvořit na stránce Šablona:FAQ/doc/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í se zobrazí nebo skryje odpověď.
Šablona je určena zejména pro stránky s častými dotazy a umožňuje také volitelně zařadit otázku 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 nadpisu. Podporované hodnoty jsou 2, 3, 4 a 5. | 3
|
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=3
|text=
Po obdržení správně vyplněné žádosti trvá výroba karty obvykle do 2 pracovních dnů.
}}
Hodnota parametru určuje úroveň nadpisu:
| Hodnota | Odpovídající úroveň |
|---|---|
2
|
== Nadpis ==
|
3
|
=== Nadpis ===
|
4
|
==== Nadpis ====
|
5
|
===== Nadpis =====
|
Otázka se díky tomu objeví v obsahu stránky, ale její vzhled na stránce se nezmění.
Pokud parametr obsah není uveden, otázka se do 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=3
|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
}}
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 běžné FAQ stránky je vhodné používat stejnou úroveň parametru obsah u všech otázek stejné hierarchické úrovně.
- Do nadpisu není nutné vkládat značky
==,===apod. Úroveň případného nadpisu v obsahu určuje parametr obsah.
Technické informace
Šablona používá MediaWiki mechanismus mw-collapsible a vlastní CSS/JavaScript definovaný pro 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.
Funkce rozbalování se vztahuje pouze na prvky s třídou faq-accordion a neměla by ovlivňovat ostatní rozbalovací prvky na wiki.
