Skip to content

Commit be60460

Browse files
committed
CZ : techstack, list chapter overview, typo fixes, update of list of help repositories
1 parent efc8b26 commit be60460

9 files changed

Lines changed: 56 additions & 5 deletions

File tree

cs/files.lst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ js.lst.md|Seznam skriptů
1111
plugins.lst.md|Seznam pluginů
1212
oexplorer.md|Prohlížeč objektů
1313
firstPlugin.md|První plugin
14+
techstack.md|Použité technologie

cs/firstPlugin.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ Pro vývoj nového pluginu je potřeba provést následující:
88
2. Do seznamu [pluginů][plugins] zaveďte plugin definičním řádkem:
99
- **[jméno třídy]** pokud má být plugin pouze načten (je předkem pro jiné pluginy, ale není určen k samostatné práci)
1010
- **[jméno třídy]:[jméno instance]** pokud má být plugin načten a je určen k zajištění funkcionality
11-
3. Do umístění **plugins-config/[jméno třídy]_[jméno instance].cfg** vložte konfigurační definice pro novou instanci.
11+
3. Do umístění **zip/plugins-config/[jméno třídy]_[jméno instance].cfg** vložte konfigurační definice pro novou instanci.
12+
4. Do umístění **zip/plugins/[jméno třídy].js** vložte zdrojový kód pluginu.
1213

1314
## Minimální plugin
1415

cs/helpviewer.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Repozitáře bývají pojmenovány **help\***. Vzhledem k pojmenování projektu
2929
| [helpUser][RhelpUser] | Nápověda pro uživatele prohlížeče. Popisuje základní práci s prohlížečem. |
3030
| [helpAuthorsGuide][RhelpAuthorsGuide] | (Tato) Nápověda pro autory nápověd. Popisuje vyškeré kroky, které jsou potřebné k vytvoření a vydání nápovědy. |
3131
| [helpDevelop][RhelpDevelop] | Nápověda pro vývojáře. Popisuje platformu a možnosti jejího rozšíření včetně psaní vlastních zásuvných modulů. |
32+
| [helpInternalRef][RhelpInternalRef] | Nápověda pro vývojáře. Popisuje objekty systému, a parametry událostí, které se mezi pluginy posílají. |
3233

3334
## Vydávání verzí
3435

@@ -52,3 +53,4 @@ Repozitáře bývají pojmenovány **help\***. Vzhledem k pojmenování projektu
5253
[RhelpAuthorsGuide]: https://github.com/HelpViewer/helpAuthorsGuide
5354
[R.github]: https://github.com/HelpViewer/.github "Repozitář se základními informacemi"
5455
[RPrism]: https://github.com/HelpViewer/prism
56+
[RhelpInternalRef]: https://github.com/HelpViewer/helpInternalRef "HelpViewer dokumentace systémových objektů"

cs/lists.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# 📄 Seznamy
2+
3+
Pro správné fungování aplikace HelpViewer jsou důležité následující seznamy:
4+
5+
- Seznam stylů (css.lst)
6+
- Seznam skriptů (js.lst)
7+
- Seznam pluginů (plugins.lst)
8+
9+
Seznamy řídí především co a v jakém pořadí se má z dat aplikace zavést.
10+
11+
Jejich popis naleznete v dalších podkapitolách.

cs/oexplorer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ HelpViewer obsahuje plugin **puiButtonObjectExplorer**. Tento plugin slouží k
66

77
⚠️ ObjectExplorer zásuvný modul je načten pouze pokud aplikace běží s **DEBUG_MODE = true** v **hvdata/appmain.js**. V opačném případě není k dispozici žádná funkcionalita ani výstup a aplikace vrací odpověď nenalezeno pro kapitoly, které modul obsluhuje.
88

9+
⚠️ Pokud plugin nebyl doposud v rámci relace aktivní, část funkcionality ze seznamu funkcí při použití odkazů nebude ještě k dispozici.
10+
911
## Funkce
1012

1113
Plugin zobrazuje například:
@@ -20,8 +22,6 @@ Plugin zobrazuje například:
2022
- Dokumentaci prvků, pokud je dostupná (zatím především v angličtině)
2123
- Informace o definovaných filtrech a vazbách v řetězci předání události: odesilatel -> obsluha.
2224

23-
⚠️ Pokud plugin nebyl doposud v rámci relace aktivní, část funkcionality ze seznamu výše při použití odkazů nemusí být ještě k dispozici.
24-
2525
Dále podporuje:
2626

2727
- Vyhledání objektu podle jeho klíčového jména s přesností na podřízenou definici pluginu (vyhledávání podle jména javascript funkce zatím není možné)

cs/runseq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ V dokumentaci se budou objevovat obecnější názvy popisů fází. Tyto pojmy
3939
| Zavádění | 0-2 | Základní sekvence zavádění aplikace. Komponenty jsou k dispozici jako nekomprimované soubory. |
4040
| Zavedení dat aplikace | 3 | Soubor **hvdata/data.zip** je načten do paměti knihovnou **JSZIP**. Pokud tato operace selže (CORS omezení), na obrazovce uvidíte zprávu **⚠ Do you see this message only?**. |
4141
| Zavedení dat aplikace 2 | 3.1-3.4 | Další aplikační data - kaskádové styly, layout UI - jsou načtena a připravena pro použití. |
42-
| Načtení dat nápovědy | 3.5-3.9 | Data z nápovědy rozšiřují nebo nahrazují standardní logiku. Obsah je nepovinný, popsaný v samostatné kapitole. |
42+
| Načtení dat nápovědy | 3.5-3.9 | Data z nápovědy rozšiřují nebo nahrazují standardní logiku. Obsah je nepovinný, popsaný v následující kapitole. |
4343
| Zavedení pluginů | 3.10 | V pořadí podle sekvence **STO_DATA:plugins.lst** jsou načteny do paměti, zavedeny a spuštěny instance uvedených pluginů - zásuvných modulů. |
4444
| Spouštění | 3.11 | Hlavní aplikační logika je načtena do paměti a spuštěna. |
4545
| Spouštění 2 | 3.12-3.14 | Data z nápovědy jsou aplikována a posílá se notifikační událost dokončení spuštění. Aplikace je připravena k práci. |

cs/techstack.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# 🛠️ Použité technologie
2+
3+
- 📄 HTML 5
4+
- 🎨 CSS 3 (čistý)
5+
- ⚡ JavaScript ES2021 (čistý)
6+
- 🛢️ Local storage
7+
8+
## 🗃️ Repozitář
9+
10+
- [HelpViewer][HVRepo]
11+
12+
## 🧩 Knihovny třetích stran
13+
14+
| Knihovna | Licence | Status integrace |
15+
| --- | --- | --- |
16+
| [JSZip library][JSZIP] | MIT | pevná |
17+
| [Marked][Marked] | MIT | odebratelné, plugin |
18+
| [Mermaid][Mermaid] | MIT | odebratelné, plugin |
19+
| [Prism][Prism] | MIT | odebratelné, plugin |
20+
21+
## 📦 Distribuce
22+
23+
- 🗜️ ZIP archiv
24+
25+
## ⚙️ Sestavení
26+
27+
- 🤖 CI/CD : GitHub Actions
28+
29+
[JSZIP]: http://jszip.org/ "JSZip - práce se ZIP soubory"
30+
[Marked]: https://marked.js.org/ "Marked - vypisování a formátování md souborů do HTML formátu"
31+
[Mermaid]: https://mermaid.js.org/ "Mermaid - vykresluje grafy a schémata podle speciálních textových definic"
32+
[Prism]: https://prismjs.com/ "Prism - zvýraznění syntaxe výpisů kódu"
33+
[HVRepo]: https://github.com/HelpViewer/HelpViewer "HelpViewer"

cs/tree.lst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
Dokumentace pro vývojáře|Dokumentace pro vývojáře||README.md
2+
🛠️ Použité technologie|Použité technologie a součásti||techstack.md
23
▶️ Spouštěcí sekvence|Spouštěcí sekvence||runseq.md
3-
Seznamy|Seznamy||
4+
Seznamy|Seznamy||lists.md
45
📄 Seznam stylů (css.lst)|Seznam stylů (css.lst)||css.lst.md
56
📄 Seznam skriptů (js.lst)|Seznam skriptů (js.lst)||js.lst.md
67
📄 Seznam pluginů (plugins.lst)|Seznam pluginů (plugins.lst)||plugins.lst.md

en/helpviewer.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Repository names are starting with **help\***. Due to the naming of the project,
2929
| [helpUser][RhelpUser] | Help file with starting instruction, UI description for HelpViewer users. It describes basic work with Viewer. |
3030
| [helpAuthorsGuide][RhelpAuthorsGuide] | Help file for help file authors. Describes all necessary steps for creation and publishing of your own help file. |
3131
| [helpDevelop][RhelpDevelop] | (This) Help file (pages) for developers. Describes the platform itself and possibilities for extensions including developing of custom plugins. |
32+
| [helpInternalRef][RhelpInternalRef] | Help file for developers. Describes system objects and event parameters that are distributed within the system. |
3233

3334
## Version publishing
3435

@@ -52,3 +53,4 @@ Repository names are starting with **help\***. Due to the naming of the project,
5253
[RhelpAuthorsGuide]: https://github.com/HelpViewer/helpAuthorsGuide
5354
[R.github]: https://github.com/HelpViewer/.github "Repository with basic information"
5455
[RPrism]: https://github.com/HelpViewer/prism
56+
[RhelpInternalRef]: https://github.com/HelpViewer/helpInternalRef "HelpViewer system object reference"

0 commit comments

Comments
 (0)