Skip to content

Commit b39389a

Browse files
VitSimonVitSimon
committed
CZ : Description of processes and structure (partial, unfinished)
1 parent 28865a6 commit b39389a

28 files changed

+716
-5
lines changed

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
# helpTemplate
2-
Help file base template
1+
# helpAuthorsGuide
2+
Help file for authors of new help files

‎cs/README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
# Main chapter
1+
# Dokumentace pro autory
2+
3+
Cílem dokumentace je popsat:
4+
- postupy pro tvorbu vlastní nápovědy,
5+
- vnitřní formát metadat,
6+
- významná specifika HelpViewer a jeho procesů,
7+
- přístupy pro integraci mezi aplikacemi a nápovědou

‎cs/code.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# 🧾Kódový výpis
2+
3+
Pro HTML dokumenty zde v tomto není žádná podpora.
4+
5+
Výpis zdrojového kódu do **md** vložíte tímto způsobem:
6+
7+
````
8+
```
9+
Text Vašeho kódu
10+
```
11+
````
12+
13+
Ukázka:
14+
15+
```
16+
Text Vašeho kódu
17+
```

‎cs/diagram.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# 📊Diagram
2+
3+
Výpis diagramu do **md** vložíte tímto způsobem:
4+
5+
````
6+
```mermaid
7+
graph TD;
8+
A-->B;
9+
A-->C;
10+
B-->D;
11+
C-->D;
12+
```
13+
````
14+
15+
Ukázka:
16+
17+
```mermaid
18+
graph TD;
19+
A-->B;
20+
A-->C;
21+
B-->D;
22+
C-->D;
23+
```
24+
25+
- Pro další příklady a informace si přečtěte dokumentaci knihovny [Mermaid][Mermaid].
26+
- V rámci přípravy balíčku HelpViewer je vždy použita v daný čas sestavení nejnovější verze Mermaid, která je publikována prostřednictvím [jsdelivr distribuce][MermaJsDelivr].
27+
28+
[Mermaid]: https://mermaid.js.org/intro/ "Mermaid - vykresluje grafy a schémata podle speciálních textových definic"
29+
[MermaJsDelivr]: https://cdn.jsdelivr.net/npm/mermaid/dist/ "Mermaid - JsDelivr"

‎cs/features.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# ⚙️Funkce
2+
3+
- 🔄 Jednotná platforma pro zobrazování Markdown a HTML souborů (oba formáty mohou být obsažené v jedné nápovědě)
4+
- 📦 ZIP komprese je podporována (pouze jednodílný archiv), lze také číst nápovědu přímo z adresáře
5+
- 📈 Mermaid knihovna pro vykreslování diagramů (obsažena v základním nasazení aplikace)
6+
- 🧠 Zvýraznění syntaxe u výpisů zdrojových kódů
7+
- 🎨 Aplikace je přístupná úpravám vzhledu, rozložení i funkcionality
8+
- 🌐 Podpora více jazykových verzí nápovědy
9+
- 🤖 Automatizovaná CI/CD příkazová dávka pro rychlé a bezpečné nasazování (výsledkem je 1 zip archiv na jeden jazyk nápovědy)
10+
- 🧩 Kód je snadno rozšiřitelný a open source
11+
- 🔧 Ve spolupráci s infrastrukturou GitHub je proces tvorby nápovědy přehledně strukturovaný a řada kroků probíhá automaticky s minimální potřebou ručního zásahu
12+
13+
## ⚙️Vestavěné funkce
14+
15+
- 💻 Multiplatformní - pracuje na všech operačních systémech přes webový prohlížeč
16+
- 📱 Responzivní web (podporuje desktop i mobilní zařízení)
17+
- 📂 Hierarchický strom témat s možností otevírání a uzavírání složek
18+
- 📇 Propojení pojmů s příslušnými kapitolami a soubory
19+
- 🔎 Slovník pro fulltextové vyhledávání obsahu kapitol
20+
- ⏭ Integrovaná tlačítka pro základní navigaci v nápovědě
21+
- 🔖 Podpora záložek pro podsekce v kapitole
22+
- 🎨 4 vestavěné barevné režimy: barva (výchozí), stupně šedi, bílá a černá, černá a bílá
23+
- ♿ Zohlednění přístupnosti – WCAG 2.1 (accessibilitychecker.org: 89 %, Lighthouse: 96%, [Web Aim][waverep])
24+
- 📄 Verze vhodná pro tisk (upřednostňuje stupně šedi)
25+
- 💬 Bublinová nápověda prostředí v češtině a angličtině (plánují se další jazyky)
26+
27+
[waverep]: https://wave.webaim.org/report#/https://helpviewer.github.io "WAVE WebAim protokol"

‎cs/files.lst‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,22 @@
1-
README.md|Overview
1+
README.md|Dokumentace pro autory
2+
features.md|Seznam funkcí
3+
newHelp.md|Vytvoření nové nápovědy
4+
struct.md|Struktura projektu nápovědy
5+
general.md|Obecná doporučení
6+
newTopic.md|Nová kapitola
7+
links.md|Odkazy v textech
8+
images.md|Obrázky v textech
9+
code.md|Výpis kódu
10+
diagram.md|Diagram
11+
texts.md|Texty
12+
heading.md|Určení nadpisu
13+
indexing.md|Indexace
14+
newLang.md|Nový jazyk
15+
helpCfg.md|Konfigurace nápovědy
16+
tocIcon.md|Ikony stromu témat
17+
innerJS.md|JavaScript bloky
18+
mdata/files.lst.md|Seznam souborů
19+
mdata/keywords.lst.md|Seznam klíčových slov
20+
mdata/keywords-files.lst.md|Klíčová slova - soubor
21+
mdata/tree.lst.md|Strom témat
22+
fulltextIndex.md|Fulltext index

‎cs/fulltextIndex.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# 🔎Fulltextové vyhledávání (fts-keywords.lst)
2+
3+
- Soubor je využíván v případě fulltext vyhledávání (🔎)
4+
- Nachází se v jazykové verzi nápovědy.
5+
- Každý jazyk má svoji kopii.
6+
- Pokud soubor **existuje, je zapnuto** vytvoření fulltext indexu při vydávání nápovědy. Dalšího zásahu ze strany autora zde není potřeba.
7+
- Soubor ponechte prázdný
8+
- Pro vypnutí vytvoření fulltext indexu stačí soubor z jazykové verze smazat.

‎cs/general.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# 💡Obecná doporučení a zdroje informací
2+
3+
V organizaci **[HelpVewer][HV]** naleznete repozitáře začínající na **help\***. Kromě **helpTemplate** a **HelpViewer** jsou všechny ukázkami souborů nápovědy. Můžete si vzít kterýkoli z nich jako příklad, stáhnout si z kteréhokoli **Release** jeho přílohy **Help-*.zip**. Archivy jsou nezaheslované, jejich obsah je přístupný k procházení.
4+
5+
[HV]: https://github.com/orgs/HelpViewer/repositories "Repozitáře"

‎cs/heading.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# 📑Určení nadpisu do oblasti nad obsahem kapitoly
2+
3+
💡 Doporučení:
4+
- Každá kapitola by měla začínat h1 (1x #) nadpisem, který je v textu úplně prvním nadpisem a je úplně na začátku dokumentu.
5+
6+
**HelpViewer** určuje nadpis dokumentu při jeho zobrazování takto (priorita od nejvyšší):
7+
- text **h1** nadpisu z kapitoly, je-li první a hned na začátku textu dokumentu (nepoužijí se další body níže)
8+
- text položky stromu témat (📖) pokud bylo na ni kliknuto
9+
- text položky rejstříků (📇,🔎), pokud bylo na ni kliknuto. Jedná se zde o záložní nadpis ze seznamu souborů (je také upřednostněn, pokud uživatel obnoví stránku)
10+
- relativní cesta a jméno souboru uvnitř nápovědy

‎cs/helpCfg.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# 🛠️Konfigurace nápovědy
2+
3+
Konfiguraci nápovědy změníte v souboru **_config.txt**. Soubor se nachází v podsložce jazykové verze nápovědy. Každý jazyk má svoji vlastní verzi.
4+
5+
Jeho základní stuktura je tato:
6+
7+
```
8+
klíč|hodnota
9+
klíč|hodnota
10+
```
11+
12+
## Pravidla
13+
14+
- 1 řádek = jedna hodnota
15+
- Pokud se klíč bude později opakovat, je použita vždy poslední z přečtených hodnot
16+
17+
## Konfigurační klíče
18+
19+
### Ikony stromu témat
20+
21+
| Jméno klíče | Popis a význam |
22+
|---|---|
23+
| OverrideBookIcon-opened | Znak pro otevřenou knihu |
24+
| OverrideBookIcon-closed | Znak pro zavřenou knihu |
25+
26+
### Přepsání uživatelských nastavení UI
27+
28+
| Jméno klíče | Popis a význam |
29+
|---|---|
30+
| OverrideColorTheme | Přepíše uživatelské schéma barev na konkrétní jiné a uloží hodnotu do jeho konfigurace |
31+
| OverrideSidebarVisible | Přepíše uživatelskou volbu, zda bude levý panel viditelný a uloží hodnotu do jeho konfigurace |
32+
33+
### Klíče, které řídí proces vydávání
34+
| Jméno klíče | Popis a význam |
35+
|---|---|
36+
| _lang | Jazyk tohoto balíku nápovědy |
37+
| _version | Verze vydání (převzata ze souboru CHANGELOG.md) |
38+
| _prjname | (organizace)/(jméno repozitáře) ve kterém se nápověda v době sestavení nacházela. |

0 commit comments

Comments
 (0)