Typografické konvence
Pro odlišení významných prvků v textu používám následující konvence:
- Klávesnicové příkazy
Jsou zobrazovány písmem s pevnou šířkou znaku na šedém podkladu. Například
G
. Pokud se jedná o speciální klávesy, jako třeba[Esc]
, jsou uvedeny v podobě názvu uzavřeného do hranatých závorek.- Řádkové příkazy
Také řádkové příkazy se zobrazují písmem s pevnou šířkou znaku, ovšem na oranžovém pozadí. Například
:help
. Aby se zvýraznilo jejich určení pro příkazový řádek, obsahují i úvodní dvojtečku.- Příklady
Rozsáhlejší příklady, obsahující ukázkové příkazy a popis reakce editoru na ně, jsou zobrazovány s užšími řádky, písmo je zabarveno do zelena a začátek je vždy uvozen slovem „Příklad:“.
Příklad:
Celkově vypadá příklad asi takto.
K barevnému odlišení používám kaskádové definice stylů (CSS). Proto vřele doporučuji při čtení příručky používat klienta, který je podporuje. To by v současnosti již neměl být problém.
© 2016 Pavel Satrapa