Příklady použití stylů

Nadpis první úrovně (<h1>)

Nadpis první úrovně bude vždy a pouze na začátku kapitoly.
Po schválení kapitoly šéfem vloží tvůrce helpu za nadpis fajfku pro označení, že je kapitola hotová a není třeba se jí věnovat (pokud nevzniknou nové věci, např. rozšíření uživatelského rozhraní, funkce, apod., které je potřeba do kapitoly doplnit).

Nadpis druhé úrovně (<h2>)

Nadpis druhé úrovně rozděluje kapitolu na jasně oddělené sekce, v rámci nichž je použité další (podrobnější členění).
Nadpis musí být vždy krátký a výstižný, popisující danou sekci. Např. v Prohlížeč druhu Faktura vydaná jsou použité nadpisy druhé úrovně pro Karty a Činnosti s objektem nebo v kapitole Fulltextový systém jsou použité nadpisy pro Definice, Údržba fulltextového rejstříku a Uživatelské rozhraní.

Nadpis třetí úrovně (<h3>)

Tento nadpis je možné použít tam, kde není vhodné nebo je zbytečné používat pro tuto úroveň členění čtvereček.
Ve většině případů se však tento styl nepoužívá a pokud ano, musí k tomu být opravdu pádné důvody.

• Čtvereček (<h3>)

  Další možné členění v rámci nadřazeného členění (tedy pod nadpisem první nebo druhé úrovně).
  Za čtverečkem bude následovat odstavec nebo další členění (odrážky, podnadpisy, ...).
  V nadpisu tohoto čtverečku se nesmí používat žádné jiné styly. Výjimkou jsou linky na karty, které jsou však vyjmenované vedle sebe a nechceme je "roztahovat" pod sebe s jejich popisem kvůli odkazu, použito např. v kapitole Prohlížeč druhu Faktura vydaná, kde jsou vyjmenované karty Obsah, Souvisí, ...

  Technicky je použitý tag <ul> se třídou class="ctv" dále <li> a v něm <h3> a následně odstavec nebo další členění.

  Příklad kompaktních odrážek

  • První odrážka hustější
  • Druhá odrážka hustější
  • Třetí odrážka hustější

  Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec.

  NEBO

  • První odrážka hustější. Jedná se o delší souvislý text, kde může být použité zalomení textu, ale ne odstavec.
    Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení.
  • Druhá odrážka hustější. Jedná se o delší souvislý text, kde může být použité zalomení textu, ale ne odstavec.
    Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení.
  • Třetí odrážka hustější. Jedná se o delší souvislý text, kde může být použité zalomení textu, ale ne odstavec.
    Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení. Pokračování tohoto bodu po zalomení.

  NEBO

  • První odrážka hustější - jedná se o delší souvislý text, kde může být použité zalomení textu, ale ne odstavec.
  • Druhá odrážka hustější - jedná se o delší souvislý text, kde může být použité zalomení textu, ale ne odstavec.
  • Třetí odrážka hustější - jedná se o delší souvislý text, kde může být použité zalomení textu, ale ne odstavec.

  Hustější odrážky mohou, ale nemusí obsahovat "nadpisy", nikdy však nesmí být nadpis tučný.
  Většinou se jedná o krátké body (jedno či více slov), nebo
  několik vět bez nadpisu, kde může být použité zalomení textu, nikoliv odstavce.
  Tyto odrážky budou použity tam, kde se jedná o kompaktní sekci, kde není dále použito další členění, odstavce, apod. Technicky jde o čisté použití tagu <ul> bez třídy a v něm pak několik <li> a pokud je to potřeba, tak <br />.
  Použito např. v kapitole Prohlížeč druhu Faktura vydaná u činnosti "Úhrada v hotovosti" nebo v kapitole Karta Rekapitulace u popisu "boxu Určení měny".

• Druhý čtvereček (<h3>)

  Zde opět může a nemusí být použitý odstavec.

  Příklady nekompaktních odrážek - s tučným nadpisem.

  • První odrážka (<h4>)

    Tyto odrážky mohou, ale nemusí obsahovat "nadpisy". Tyto nadpisy mohou, ale nemusí být tučné , záleží na celkovém pojetí kapitoly. Pokud nadpisy je potřeba zvýraznit (kvůli lepší čitelnosti nebo důležitosti), pak je možné je vytučnit (technicky použitím tagu <h4>, nikoliv tagem <strong>).

    Tyto odrážky budou použity tam, kde bude následovat další členění nebo odstavce.
    Technicky jde o použití tagu <ul> bez třídy a v něm pak několik <li> a pokud je to potřeba, tak <h4> a pak následuje odstavec<p> podnadpis <h5> nebo další členění (odrážky).
    

  • Druhá odrážka (<h4>)

    Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec.
    Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec.

  • Třetí odrážka (<h4>)

    • Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec.
    • Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec. Zde opět může a
    • nemusí být použitý odstavec.

  • Čtvrtá odrážka (<h4>)

    text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text

    • Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec.
    • Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec. Zde opět může a
    • nemusí být použitý odstavec.

  Příklady nekompaktních odrážek - s netučným nadpisem.

  • První odrážka
    Tyto odrážky mohou, ale nemusí obsahovat "nadpisy". Tyto nadpisy mohou, ale nemusí být tučné , záleží na celkovém pojetí kapitoly. Pokud nadpisy je potřeba zvýraznit (kvůli lepší čitelnosti nebo důležitosti), pak je možné je vytučnit (technicky použitím tagu <h4>, nikoliv tagem <strong>).

    Tyto odrážky budou použity tam, kde bude následovat další členění nebo odstavce.
    Technicky jde o použití tagu <ul> bez třídy a v něm pak několik <li> a pokud je to potřeba, tak <h4> a pak následuje odstavec<p> podnadpis <h5> nebo další členění (odrážky).
    

  • Druhá odrážka
    Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec.
    Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec.

  Další styl nekompaktních odrážek - bez nadpisu

  • Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec.
    Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec.

  • Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec.
    Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec. Zde opět může a nemusí být použitý odstavec.

    Nadpis páté úrovně (<h5>)

    Tento nadpis by měl být použitý až jako poslední možné členění (v rámci nadpisů). Většinou jde o vypíchnutí nějaké části v rámci jedné odrážky.

Tabulky

Tabulky v helpu máme dvojího druhu a to:

• Popis ikon (funkcí)

  	Nadpis funkce (ikony)
  	Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony).
  	Nadpis funkce (ikony)
  	Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony).
  	Nadpis funkce (ikony)
  	Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony).
  	Nadpis funkce (ikony)
  	Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony). Popis funkce (ikony).

• Ostatní (např. popis klávesových zkratek, apod.)

  Příkaz / Akce	Klávesová zkratka	Poznámka	Číslo (zarovnané vpravo)
  Nápověda / Místní nápověda	<F1> / <Shift+F1>		1 200,00 Kč
  Nový	<Ins> nebo <Ctrl+N>	viz Vytváření nových objektů	343-200
  Nový kopií aktuálního	<Ctrl+Alt+N>	viz Vytváření nových objektů volbou předlohy	5 600,00 Kč

Technicky nemá smysl popisovat použití tagů. Je nutné se podívat do kódu a řídit se příkladem.

Další pravidla a styly.

• Použití doplňkových stylů v textu (odstavcích).

  • Label
  • Složka

• PSPad

  • Snippety
    Soubor KaskProjekt/Help/html.def je potřeba nakopírovat do složky PSPadu, do podsložky Context.

Příbuzná témata:

• Šablona "Typické případy použití"