Skip to content

Commit bb479ca

Browse files
committed
EN, CZ : Section list description updated to state after last changes (no slugify anymore, strict counters approach)
1 parent 142aeb2 commit bb479ca

File tree

2 files changed

+40
-4
lines changed

2 files changed

+40
-4
lines changed

cs/texts.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,31 @@
22

33
HelpViewer předpokládá, že text bude ve znakové sadě **UTF-8 no BOM (65001)**.
44

5-
V rámci textu kapitol můžete použít veškerou standardní syntaxi **[md][MDSyntax]** dokumentu jako například **#** značku s nadpisy až do úrovně 6 (tedy například **###### Nadpis**). Tyto nadpisy pak **HelpViewer** použije, aby automaticky sestavil seznam částí (🔖) a nabídl jej uživateli k procházení. Pokud kromě **h1** nebude v kapitole žádný další nadpis, seznam se uživateli nenabídne.
5+
V rámci textu kapitol můžete použít veškerou standardní syntaxi **[md][MDSyntax]** dokumentu jako například **#** značku s nadpisy až do úrovně 6 (tedy například **###### Nadpis**).
66

77
Také můžete md kód v případě potřeby prokládat s html nebo javascript kódem.
88

99
V dalších podkapitolách této sekce jsou uvedeny další informace, které byste měli znát a také funkce HelpViewer, které můžete použít.
1010

11-
## Ikonky
11+
## 🔖 Seznam částí
12+
13+
**HelpViewer** automaticky sestaví z nadpisů (h1-6, # ... ######), seznam částí (🔖) a nabídne jej uživateli k rychlému a pohodlnému procházení textem kapitoly.
14+
15+
- Pokud dokument obsahuje pouze hlavní nadpis (h1 / #), žádný seznam se nezobrazí.
16+
- Přehled je dostupný, pokud se v dokumentu nachází alespoň jeden další nadpis.
17+
18+
Záložky jsou automaticky pojmenovávány v tomto formátu: #h-(úroveň)-(pořadí).
19+
- úroveň je číslo od 1 do 6 podle úrovně nadpisu (h1 = 1, ..., h6 = 6)
20+
- pořadí je index od 0, který určuje pořadí výskytu nadpisů dané úrovně v rámci celé kapitoly
21+
22+
Určování pořadí:
23+
- Počítadlo je oddělené pro každou úroveň (h1 má svůj vlastní čítač, h2 jiný atd.)
24+
- Pořadí se přiděluje při načítání dokumentu zleva doprava, shora dolů.
25+
- ⚠ Pokud do dokumentu vložíte nový nadpis (např. mezi dvě stávající), automaticky převezme index nadpisu, který byl na jeho místě. Nadpisy následující za ním se o jedno pořadí posunou.
26+
27+
Tímto je zajištěno, že záložky zůstanou konzistentní a předvídatelné, i když se struktura dokumentu v budoucnu změní.
28+
29+
## 🖼️ Ikonky
1230

1331
V rámci textu můžete vkládat také unicode znaky. Některé z nich představují ikonky, které je možno použít bez nutnosti další externí knihovny.
1432

en/texts.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,31 @@
22

33
HelpViewer predicts all texts will be coded in **UTF-8 no BOM (65001)** code page.
44

5-
In chapter text you can use all the standard syntax of **[md][MDSyntax]** document as e.g. **#** tag for heading even to lovel 6 (e.g. **###### Heading**). These headings are used by **HelpViewer** to build sub chapters (🔖) structure automatically and offers this TOC to user for improve browsing experience. If there will not be any more headings in chapter (excluding **h1**)then not any list will be shown to user.
5+
In chapter text you can use all the standard syntax of **[md][MDSyntax]** document as e.g. **#** tag for heading even to lovel 6 (e.g. **###### Heading**).
66

77
You can also intersperse the md code with html or javascript code if needed.
88

99
In next subchapters of this chapter there are more information which you should know and also HelpViewer features you can use.
1010

11-
## Icons
11+
## 🔖 Sections List
12+
13+
**HelpViewer** automatically assembles a list of sections (🔖) based on the document's headings (h1-h6, i.e. # ... ######), providing users with a quick and convenient way to navigate through the chapter.
14+
15+
- If the document contains only a main heading (h1 / #), the list will not be shown.
16+
- The list becomes available as soon as there is at least one additional heading of any level (h1-h6).
17+
18+
Headings are automatically named in the following format: #h-(level)-(order).
19+
- level is a number from 1 to 6 indicating the heading level (h1 = 1, ..., h6 = 6)
20+
- order is a zero-based index that reflects the heading’s position among headings of the same level across the entire chapter.
21+
22+
Determining the order:
23+
- Each heading level has its own counter (h1, h2, ..., h6 are tracked separately).
24+
- Headings are indexed in the order they appear - left to right, top to bottom.
25+
- ⚠ If a new heading is inserted between two existing ones, it inherits the index of the heading that originally occupied that position. All subsequent headings at the same level are automatically shifted.
26+
27+
This ensures that anchors remain consistent and predictable, even as the document structure evolves.
28+
29+
## 🖼️ Icons
1230

1331
Inside chapter text you can insert unicode letters/characters also. Some of them stands for icons which you can use without need to install any other external library.
1432

0 commit comments

Comments
 (0)