Šablony článků (Templates)

Tato stránka slouží jako návod a knihovna struktur pro tvorbu nových příspěvků v naší encyklopedii. Jednotná struktura zajišťuje, že čtenáři vždy najdou klíčové informace na stejném místě a wiki si zachová vysokou úroveň kvality.

1. Proč používat šablony?

Používání šablon přináší několik výhod:

Konzistence: Všechny články vypadají profesionálně a stejně.

Rychlost: Nemusíte vymýšlet strukturu od nuly, stačí vyplnit připravené sekce.

Úplnost: Šablona vám připomene nezbytné součásti, jako jsou tagy nebo související články.

2. Doporučená struktura IT článku

Každý nový technický článek by měl v ideálním případě obsahovat tyto sekce:

Úvodní definice: Stručný popis (2-3 věty), co daný pojem znamená.

Vizuální prvek: Diagram, schéma nebo ilustrační obrázek.

Hlavní tělo: Podrobné vysvětlení rozdělené do logických celků (úrovně H2 a H3).

Porovnání/Tabulka: Pokud existují alternativy (např. ACL vs. RBAC), použijte tabulku.

Praktické příklady: Ukázky kódu nebo scénáře použití.

Závěrečná sekce: Odkazy na další články a tagování.

—

3. Zdrojový kód univerzální šablony

Níže uvedený kód můžete zkopírovat a použít jako základ pro nový článek:

====== Název pojmu (Zkratka) ====== **Pojem** je [definice]. Slouží k [hlavní účel]. ===== 1. Podnadpis (H2) ===== Text... ===== 2. Podnadpis (H2) ===== ==== Detailní pohled (H3) ==== ^ Vlastnost ^ Hodnota ^ | Příklad | Popis | ===== 3. Příklad kódu / Implementace ===== <code language> // Zde vložte kód

Související články:

Název odkazu

Tagy: tag>kategorie klicove_slovo doplnek </code>

—

4. Správa šablon v DokuWiki

Existuje několik způsobů, jak šablony v našem systému efektivně využívat:

Manuální kopírování

Nejjednodušší metoda. Otevřete si tuto stránku k úpravám, zkopírujete sekci č. 3 a vložíte ji do nově vytvořeného prázdného článku.

Plugin Template Page (Doporučeno)

Pokud je nainstalován plugin Template Page, systém automaticky nabídne předdefinovaný text při vytvoření stránky v určitém jmenném prostoru (např. vše ve složce it:dev: dostane šablonu pro programování).

—

5. Seznam dostupných specifických šablon

Šablona pro hardware (zaměření na parametry a architekturu)

Šablona pro vývoj (zaměření na syntaxi a algoritmy)

Šablona pro bezpečnost (zaměření na rizika a mitigaci)

Související články:

Oficiální syntaxe DokuWiki

Stylistická příručka encyklopedie

Tagy: tag>meta documentation templates workflow wiki-admin