Skip to content

Commit d37a6a5

Browse files
committed
EN, CZ : Notes feature described, (notes, edit in repository : icons swapped), data values list and description updated, custom package feature mentioned, fulltext feature state updated
1 parent e70d0a6 commit d37a6a5

File tree

2 files changed

+25
-9
lines changed

2 files changed

+25
-9
lines changed

cs/README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Ve spodní části panelu najdete několik tlačítek:
1818
- 📇 Seznam klíčových slov
1919
*(viditelné jen pokud jej definoval autor nápovědy)*
2020
- 🔎 Hledání slov v textu kapitol
21-
*(viditelné jen pokud jej definoval autor nápovědy)*
21+
*(viditelné jen pokud jej definoval autor nápovědy nebo je aktivní funkcionalita indexace)*
2222

2323
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.
2424
📇 a 🔎 mají nahoře pole pro zadání fráze, kterou chcete vyhledávat.
@@ -36,6 +36,8 @@ Ve spodní části panelu najdete několik tlačítek:
3636
- 📚 Zobrazit všechny kapitoly jako jeden dokument
3737
*(po výběru zalomení stránek a způsobu tisku Unicode ikon v textu stačí podruhé kliknout na tlačítko a zobrazí se výsledek)*
3838
*(do výstupu se zahrnují pouze kapitoly zobrazené ve stromu témat, domovská stránka nápovědy, kapitoly, na které je v textu odkazováno)*
39+
- ✏️ Poznámky
40+
*Umožňuje přidávat, spravovat a přepínat zobrazení (👁️) nebo skrytí (🙈) uživatelských poznámek. Poznámky lze odstranit jednoduchým vymazáním jejich obsahu. Ty, které jsou zobrazené na obrazovce, se automaticky zahrnují i do tisku. Zobrazují se pouze při procházení jednotlivých kapitol. Poznámky jsou ukládány v místním prostředí uživatele a nejsou sdílené mezi uživateli, ale jsou společné pro různé jazykové a časové verze téhož souboru nápovědy.*
3941
- ↔ Přesunout levý panel na druhou stranu (nebo zpět)
4042
- 🔲 Přepnout full screen režim
4143
- 📽 Prezentační režim
@@ -56,32 +58,38 @@ Pravý panel zobrazuje hlavní část aplikace:
5658
- ⬅ Přejít k předchozí kapitole
5759
- ⬆ Přejít na nadřízenou kapitolu
5860
- ➡ Přejít k následující kapitole
59-
- ✏️ Editovat v repozitáři
61+
- 📝 Editovat v repozitáři
6062

6163
## Proč část prvků chybí?
6264

6365
Může to být z několika důvodů:
6466

6567
| Chybějící prvek | Proč? |
6668
|---|---|
67-
| 📖 / 📇 / 🔎 | Autor nápovědy nedefinoval potřebná data |
69+
| 📖 / 📇 | Autor nápovědy nedefinoval potřebná data |
70+
| 🔎 | Autor nápovědy nedefinoval potřebná data, funkce indexace je vypnutá nebo proces indexace nebyl zatím dokončen |
6871
| 🔖 | Kapitola nemá podkapitoly |
6972
| ☰ | Levý panel je viditelný |
7073
| Levý panel | Schoval jste levý panel, klikněte na horním panelu na tlačítko ☰ a panel se znovu zobrazí |
7174
| 🕘 | Nápověda nemá vazbu na veřejný online repozitář (např. není k dispozici připojení k internetu) |
7275

73-
## Data relace
76+
Funkce 📥 Vlastní balíček umožňuje upravit většinu funkcionality. Pokud byla při stažení aplikace použita, některé funkce mohou být nedostupné.
77+
78+
## Data nastavení
7479

7580
Aplikace ukládá část Vaší konfigurace do **local storage**:
7681

77-
| Key | Description |
82+
| Klíč | Popis |
7883
|---|---|
7984
| colorTheme | Schéma barev (🎨) |
8085
| sidebarVisible | Viditelnost levého panelu (❌︎ / ☰) |
8186
| language | Vybraný jazyk prostředí (🌐) |
8287
| keywordListingCount | Počet klíčových slov, která se budou zobrazovat v seznamech 📇, 🔎. |
8388
| sidebarSide | Strana levého panelu (↔ ; 0 = vlevo, 1 = vpravo) |
8489
| printIcons | Režim tisku unicode ikon; 0 = odstranit, 1 = ponechat, 2 = podle konfigurace autora |
90+
| notesVisible | Režim zobrazení uživatelských poznámek; 0 = skryté (🙈), 1 = zobrazené (👁️) |
91+
92+
Modul ✏️ Poznámky uchovává svá data v **IndexedDB** úložišti webového prohlížeče (databáze **HelpViewer**).
8593

8694
# Začínáme
8795

en/README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ At the bottom of this panel, you’ll find several buttons:
1818
- 📇 Keywords list / Glossary
1919
*(visible if defined by the help author)*
2020
- 🔎 Fulltext keywords list
21-
*(visible if defined by the help author)*
21+
*(visible if defined by the help author or the indexing functionality is active)*
2222

2323
These items are displayed as an expandable tree with clickable nodes. Clicking on an item expands its subcontent or opens the selected chapter.
2424
📇 and 🔎 have an input field at the top where you can search for an exact phrase.
@@ -36,6 +36,8 @@ At the bottom of this panel, you’ll find several buttons:
3636
- 📚 Show all chapters as book
3737
*(after selecting page breaks and the method of printing Unicode icons in the text, simply click the button a second time and the result will be displayed)*
3838
*(only chapters displayed in the topic tree, the help home page, and chapters referenced in the text are included in the output)*
39+
- ✏️ Notes
40+
*Allows you to add, manage, and toggle the display (👁️) or hiding (🙈) of user notes. Notes can be deleted by simply erasing their content. Those displayed on the screen are automatically included in the printout. They are only displayed when browsing individual chapters. Notes are stored in the user's local environment and are not shared between users, but are common to different language and time versions of the same help file.*
3941
- ↔ Move (toggle) sidebar to left/right
4042
- 🔲 Toggle UI to/from fullscreen
4143
- 📽 Presentation mode
@@ -56,21 +58,24 @@ The right panel displays the main content area:
5658
- ⬅ Go to the previous chapter
5759
- ⬆ Go one level up
5860
- ➡ Go to the next chapter
59-
- ✏️ Edit in repository
61+
- 📝 Edit in repository
6062

6163
## Why something might be missing?
6264

6365
There are several reasons why certain elements may not appear:
6466

6567
| Missing icon or feature | Why? |
6668
|---|---|
67-
| 📖 / 📇 / 🔎 | These were not defined by the help file author |
69+
| 📖 / 📇 | These were not defined by the help file author |
70+
| 🔎 | These were not defined by the help file author, the indexing function is disabled, or the indexing process has not been completed yet |
6871
| 🔖 | The current chapter has no subchapters |
6972
| ☰ | The left panel is already visible |
7073
| Left panel | You closed the app with the panel hidden. Just click ☰ in the top bar to bring it back |
7174
| 🕘 | Help is not linked to the public online repository or it is not accessible (e.g. no internet connection) |
7275

73-
## Session Data
76+
The 📥 Custom package feature allows you to customise most of the functionality. If it was used when downloading the application, some features may be unavailable.
77+
78+
## Configuration data
7479

7580
The application remembers your preferences using **local storage**:
7681

@@ -82,6 +87,9 @@ The application remembers your preferences using **local storage**:
8287
| keywordListingCount | Count of searched keywords in 📇, 🔎 lists. |
8388
| sidebarSide | Left panel side (↔ ; 0 = left, 1 = right) |
8489
| printIcons | Unicode icons (characters) printing mode; 0 = remove, 1 = keep, 2 = author's configuration |
90+
| notesVisible | User notes display mode; 0 = hidden (🙈), 1 = shown (👁️) |
91+
92+
The ✏️ Notes module stores its data in the web browser's **IndexedDB** storage (database: **HelpViewer**).
8593

8694
# Getting started
8795

0 commit comments

Comments
 (0)