Skip to content

Commit 292ed00

Browse files
VitSimonVitSimon
committed
EN, CZ : 1st version
0 parents  commit 292ed00

5 files changed

Lines changed: 171 additions & 0 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
## 20250608
4+
- 1st version of documentation
5+
6+
## Introduced
7+
- File introduced

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 HelpViewer
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# helpUser
2+
Help file for user guide. This file is being included into application deployment package. Each subdir stands for one language help file, _invariant means shared for languages

‎cs/README.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# 📖Help Viewer přehled
2+
3+
Aplikace je rozdělena na dvě hlavní oblasti:
4+
5+
## Levý panel
6+
7+
Levý panel umožňuje procházet soubor nápovědy.
8+
9+
Ve spodní části panelu najdete několik tlačítek:
10+
11+
### Navigace v nápovědě
12+
13+
- 📖 Strom témat
14+
*(viditelné jen pokud jej definoval autor nápovědy)*
15+
- 🔖 Seznam podkapitol
16+
*(viditelné jen pokud má vybraná kapitola podkapitoly)*
17+
- 📇 Seznam klíčových slov
18+
*(viditelné jen pokud jej definoval autor nápovědy)*
19+
20+
Tyto položky jsou zobrazeny jako rozbalovací strom s uzly, na které lze kliknout. Kliknutím na položku se rozbalí její dílčí část nebo se otevře vybraná kapitola.
21+
22+
- 🏡 Přejít na hlavní stránku nápovědy (README.md)
23+
24+
### Nastavení prohlížeče
25+
26+
- 🌐 Výběr jazyka prostředí
27+
- 🎨 Nastavit schéma barev
28+
*(barevné, stupně šedi, bílá a černá, černá a bílá)*
29+
- 🔲 Přepnout full screen režim
30+
- ❌︎ Schovat levý panel
31+
32+
## Pravý panel
33+
34+
Pravý panel zobrazuje hlavní část aplikace:
35+
36+
- Obsah vybrané kapitoly
37+
- Nadpis kapitoly v horním panelu
38+
- Tlačítka:
39+
40+
- ☰ Zobrazit levý panel
41+
*(pokud je skrytý)*
42+
- 📄 Vytisknout kapitolu
43+
- ⬅ Přejít k předchozí kapitole
44+
- ⬆ Přejít na nadřízenou kapitolu
45+
- ➡ Přejít k následující kapitole
46+
47+
## Proč část prvků chybí?
48+
49+
Může to být z několika důvodů:
50+
51+
| Chybějící prvek | Proč? |
52+
|---|---|
53+
| 📖 / 📇 | Autor nápovědy nedefinoval potřebná data |
54+
| 🔖 | Kapitola nemá podkapitoly |
55+
| ☰ | Levý panel je viditelný |
56+
| Left panel | Schoval jste levý panel, klikněte na horním panelu na tlačítko ☰a panel se znovu zobrazí |
57+
58+
## Data relace
59+
60+
Aplikace ukládá část Vaší konfigurace do **local storage**:
61+
62+
| Key | Description |
63+
|---|---|
64+
| colorTheme | Schéma barev (🎨) |
65+
| sidebarVisible | Viditelnost levého panelu (❌︎ / ☰) |
66+
| language | Vybraný jazyk prostředí (🌐) |
67+
68+
## Otevření souboru nápovědy
69+
70+
Přidejte do adresního řádku parametr **?d={cesta}**. Pokud toto neuděláte, bude použita výchozí hodnota: **hlp/Help-{jazyk}.zip** a prohlížeč se pokusí načíst data z tohoto souboru.

‎en/README.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# 📖Help Viewer quick guide
2+
3+
The application is divided into two main areas:
4+
5+
## Left panel
6+
7+
The left panel lets you navigate through the help file.
8+
9+
At the bottom of this panel, you’ll find several buttons:
10+
11+
### Help navigation
12+
13+
- 📖 Hierarchical TOC (Table of Contents) tree
14+
*(visible if defined by the help author)*
15+
- 🔖 Subchapter list
16+
*(shown if the current chapter has subchapters)*
17+
- 📇 Keywords list / Glossary
18+
*(visible if defined by the help author)*
19+
20+
These items are displayed as an expandable tree with clickable nodes. Clicking on an item expands its subcontent or opens the selected chapter.
21+
22+
- 🏡 Go to the help file’s homepage (README.md)
23+
24+
### Viewer customization
25+
26+
- 🌐 UI Language selection
27+
- 🎨 Switch color mode
28+
*(color, greyscale, white to black, black to white)*
29+
- 🔲 Toggle UI to/from fullscreen
30+
- ❌︎ Close left sidebar
31+
32+
## Right panel
33+
34+
The right panel displays the main content area:
35+
36+
- Current chapter/topic content
37+
- Chapter title in the upper bar
38+
- Action buttons:
39+
40+
- ☰ Show left panel back
41+
*(if hidden)*
42+
- 📄 Print current chapter
43+
- ⬅ Go to the previous chapter
44+
- ⬆ Go one level up
45+
- ➡ Go to the next chapter
46+
47+
## Why something might be missing?
48+
49+
There are several reasons why certain elements may not appear:
50+
51+
| Missing icon or feature | Why? |
52+
|---|---|
53+
| 📖 / 📇 | These were not defined by the help file author |
54+
| 🔖 | The current chapter has no subchapters |
55+
| ☰ | The left panel is already visible |
56+
| Left panel | You closed the app with the panel hidden. Just click ☰ in the top bar to bring it back |
57+
58+
## Session Data
59+
60+
The application remembers your preferences using **local storage**:
61+
62+
| Key | Description |
63+
|---|---|
64+
| colorTheme | Selected color mode (🎨) |
65+
| sidebarVisible | Visibility of the left panel (❌︎ / ☰) |
66+
| language | Selected UI language (🌐) |
67+
68+
## Opening helpfile
69+
70+
Append **?d={path}** to the viewer's URL to open a custom help file.
71+
If omitted, the default file **hlp/Help-{selected language}.zip** will be loaded automatically.

0 commit comments

Comments
 (0)