Tipy a rady

Zde je pár tipů jak psát dobře stránky za použití wiki syntaxe.

Struktura stránky

  • Začněte psát stránku nadpisem první úrovně (H1) a definujte tak obsah stránky. :!:
  • Dodržujte hierarchii nadpisů – tedy po nadpisu první úrovně 1) přijde nadpis úrovně druhé atd. Sekce druhé úrovně by měla být označena také nadpisem druhé úrovně.
  • Oddělujte dlouhé odstavce mezerami tak, že vynecháte jednu prázdnou řádku. Průměrný odstavec by neměl přesáhnout 10-20 řádků.
  • Pokud je Váš text delší než pár (3-5) odstavců, zvažte rozdělení do sekcí pomocí nadpisů.
  • Přesahuje-li text přes více než 2 stránky obrazovky, vložte krátké shrnutí obsahu stránky po první nadpisu.
  • Nepište příliš dlouhé stránky (přes 3 stránky obrazovky). Raději zkuste rozdělit text do samostatných stránek.
  • Pokud máte mnoho odkazů na jiné stránky či externí zdroje, přidejte speciální sekci s dalšími referencemi (více níže)

Formátování textu

  • Zvýrazňujte jednotlivá slova či krátké pasáže tučně anebo kurzívou.
  • Používejte seznamy pro odlišení od okolního textu a pro zvýraznění jistých frází, které lépe působí na každém řádku zvlášť.
  • Nevyhýbejte se používání poznámek pro krátké doplnění textu.
  • Tabulky mohou výrazně zlepšit čitelnost strukturovaných dat. Pokud vkládáte tabulku, ujistěte se, že má smysluplnou hlavičku s nadpisem, který jednoznačně popisuje obsah tabulky (např. “Tabulka 1.2: Průměrné vzdálenosti mezi planetami”).
  • Rozsáhlé tabulky může být velice pracné upravovat. Zkuste místo toho zvážit např. použití seznamů.

Jazyková úprava

  • I když tento web není zcela veřejný, i tak bychom měli používat hlavně spisovnou češtinu a dodržovat zásady českého jazyka.
  • Větu začínejte velkým písmenem, ukončete tečkou nebo jiným vhodným znaménkem.
  • Pokud je to možné, nepoužívejte příliš dlouhá souvětí. Raději jej rozdělte na několik samostatných vět. Lépe tak udržíte smysl textu.
  • Kontrola textu (gramatiky, překlepů, atd.) ještě před uložením zabrání určitým nedorozuměním.

Reference

  • Narazíte-li na pojem, který by čtenář neměl přejít jen tak bez povšimnutí, vytvořte novou stránku a odkazujte na něj.
  • Při kontrole před uložením článku ještě projeďte zběžně text, zda jsou uvedeny veškeré odkazy – ať již na existující stránky či na ty, které by měly být vytvořeny.
  • Nepřidávejte odkaz na každý výskyt pojmu v textu. Bohatě stačí odkaz jen na prvním výskytu pojmu.
  • Odkazujte na zdroje. Přidejte sekci s názvem „Reference“ nebo „Další informace“ a vložte seznam odkazů.

Obrázky a jiná média

  • Pokud můžete, vložte k textu i tematický obrázek.
  • Krátký textový popisek je lepší než nic.
  • Tak jako u tabulek, i u obrázků by se objevovat nadpisy (dle uvážení).
  • Bylo by dobré uvádět i zdroj obrázku – nejlépe pomocí odkazu.
  • Je-li obrázek větších rozměrů, použijte zmenšenou verzi popsanou v syntaxu
  • Můžete vkládat i videa z různých serverů, tak proč toho nevyužít?
1)
Ten by měl být ve stránce jen jeden – ten hlavní