Skip to content

Commit c71df38

Browse files
committed
EN,CZ : admonitions mentioned, linked to branding, branding contains details about admonitions styling, categorization
1 parent 56be4be commit c71df38

12 files changed

Lines changed: 150 additions & 10 deletions

cs/admonitions.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# 📢 Vyznačené informační bloky (admonitions)
2+
3+
Implementace vyznačených informačních bloků vychází ze stylu admonitions běžně používaného v dokumentaci (např. GitHub Docs) a je navržena tak, aby byla s tímto stylem kompatibilní. Tuto součást aplikace může administrátor při instalaci odebrat - v takovém případě bude syntaxe stále platná, ale bloky se zobrazí jen jako běžný, zleva odsazený odstavec (blockquote).
4+
5+
- Notace psaní je **> [!TYP]Text informace.**
6+
- Definovány jsou typy: NOTE, TIP, IMPORTANT, WARNING, CAUTION. Jakýkoli jiný typ se označí pouze stříbrnou čarou
7+
- Odkazy uvnitř textu informace musí být uvedeny včetně cílové cesty uvnitř tohoto bloku (odkaz do zápatí stránky není dovolen - viz ukázka níže)
8+
9+
```markdown
10+
> [!NOTE]**Poznámka**
11+
Popis na dalším řádku.
12+
Popis na třetím řádku.
13+
14+
> [!TIP]Tip pro čtenáře
15+
> [!IMPORTANT]Tento bod je významný.
16+
Důležité upozornění pro bloky ```<script>``` si můžete přečíst na stránce s [ukázkou](innerJS.md "Ukázka")
17+
18+
> [!WARNING]Pozor: žlutý vykřičník!
19+
20+
> [!CAUTION]Pozor: červený vykřičník!
21+
22+
> [!MYTEST]Blok neznámého typu
23+
```
24+
25+
Ukázka:
26+
27+
> [!NOTE]**Poznámka**
28+
Popis na dalším řádku.
29+
Popis na třetím řádku.
30+
31+
> [!TIP]Tip pro čtenáře
32+
> [!IMPORTANT]Tento bod je významný.
33+
Důležité upozornění pro bloky ```<script>``` si můžete přečíst na stránce s [ukázkou](innerJS.md "Ukázka")
34+
35+
> [!WARNING]Pozor: žlutý vykřičník!
36+
37+
> [!CAUTION]Pozor: červený vykřičník!
38+
39+
> [!MYTEST]Blok neznámého typu
40+
41+
Kapitola 🏷️ [Vizuální identita][Branding] popisuje možnosti úpravy vzhledu těchto bloků, včetně definice vlastního typu bloku.
42+
43+
[Branding]: branding.md#h-3-8 "🏷️ Vizuální identita"

cs/branding.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,29 @@ ARIAHEADER|contentinfo
151151

152152
Tímto způsobem se aktivuje nová instance pluginu **puiHeader** s názvem **Down**. Současně je nutné založit konfigurační soubor přesně s uvedeným názvem, aby se konfigurace automaticky načetla. Výsledkem bude nový panel umístěný pod panelem obsahu kapitoly, který bude zobrazovat text z klíče **TEXT**. Tento text bude uživateli vždy zobrazen na obrazovce a bude například součástí výstupu pro tisk. Klíč **ARIAHEADER** určuje roli přístupnosti obsahu.
153153

154+
### Vlastní typ admonition bloku
155+
156+
V rámci řešení vyznačení bloků je dovoleno si dodefinovat vlastní typ podle instrukcí v kapitole 🛠️ [Vlastní UI prohlížeče][customUI] a dále tímto způsobem v **custom.css** v nápovědě:
157+
158+
```css
159+
:root {
160+
--c-border-note-mytest:rgb(207, 207, 34);
161+
}
162+
.note-mytest {
163+
border-color: var(--c-border-note-mytest);
164+
}
165+
166+
.note-mytest p::before {
167+
content: "MT ";
168+
}
169+
```
170+
171+
s použitím jaké je obvyklé u ostatních typů:
172+
173+
```markdown
174+
> [!MYTEST]Blok neznámého typu
175+
```
176+
154177
[TocIcon]: tocIcon.md "Ikony stromu témat"
155178
[customUI]: customUI.md "Vlastní UI prohlížeče"
156179
[DGuide]: ?d=hlp-dguide/Help-__.zip "Dokumentace pro vývojáře"

cs/files.lst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,4 @@ https://discord.gg/J2SjcmqHSZ|Uživatelská skupina
3333
sectionList.md|Seznam částí
3434
print.md|Tisk
3535
export.md|Export
36+
admonitions.md|Vyznačené informační bloky

cs/keywords-files.lst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
0;1;3;25;26;34
22
1;2;34
33
2;6;13;22;25
4-
3;6;7;11;10;21;26
4+
3;6;7;11;10;21;26;35
55
3
6-
4;25
6+
4;25;35
77
4;2;3;24;26;28
8-
5;10;11;12
8+
5;10;11;12;35
99
5
1010
6
1111
7;34
1212
5
13-
8;16
13+
8;16;35
1414
9;34
15-
10;11
15+
10;11;35
1616
11;21
1717
10
1818
12;17;18;19;20
@@ -29,3 +29,4 @@
2929
27;28;29;30
3030
26
3131
34
32+
35

cs/keywords.lst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,4 @@ HelpViewer
2929
Odkaz
3030
Identita;Branding;Vizuál
3131
Export
32+
Admonition;upozornění;Blok;infoblok;vyznačení

cs/tree.lst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Nová kapitola|Nová kapitola||newTopic.md
1515
🔗 Odkazy|Odkazy v textech||links.md
1616
🖼️ Obrázky|Obrázky v textech||images.md
1717
🧾 Kódový výpis|Kódový výpis v textech||code.md
18+
📢 Informační bloky|Vyznačené informační bloky||admonitions.md
1819
📊 Diagram|Diagram||diagram.md
1920
🧩 JavaScript|Vložený JavaScript blok||innerJS.md
2021
🖨️ Tisk|Tisk||print.md

en/admonitions.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# 📢 Highlighted information blocks (admonitions)
2+
3+
The implementation of marked information blocks is based on the admonitions style commonly used in documentation (e.g., GitHub Docs) and is designed to be compatible with this style. This part of the application can be removed by the administrator during installation - in this case, the syntax will still be valid, but the blocks will only be displayed as a normal, left-aligned paragraph (blockquote).
4+
5+
- The notation is **> [!TYPE]Information text.**
6+
- The following types are defined: NOTE, TIP, IMPORTANT, WARNING, CAUTION. Any other type is marked only with a silver line
7+
- Links within the text of the information must be included with the target path within this block (links to the footer of the page are not allowed - see example below)
8+
9+
```markdown
10+
> [!NOTE]**Note**
11+
Description on the next line.
12+
Description on the third line.
13+
14+
> [!TIP]Tip for readers
15+
> [!IMPORTANT]This point is important.
16+
Important notice for ```<script>``` blocks can be found on the [example](innerJS.md "Example") page.
17+
18+
> [!WARNING]Warning: yellow exclamation mark!
19+
20+
> [!CAUTION]Warning: red exclamation mark!
21+
22+
> [!MYTEST]Block of unknown type
23+
```
24+
25+
Example:
26+
27+
> [!NOTE]**Note**
28+
Description on the next line.
29+
Description on the third line.
30+
31+
> [!TIP]Tip for readers
32+
> [!IMPORTANT]This point is important.
33+
Important note for ```<script>``` blocks can be found on the [example](innerJS.md "Example") page.
34+
35+
> [!WARNING]Warning: yellow exclamation mark!
36+
37+
> [!CAUTION]Warning: red exclamation mark!
38+
39+
> [!MYTEST]Block of unknown type
40+
41+
Chapter 🏷️ [Branding][Branding] describes the options for customizing the appearance of these blocks, including defining your own block type.
42+
43+
[Branding]: branding.md#h-3-8 "🏷️ Branding"

en/branding.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,29 @@ ARIAHEADER|contentinfo
151151

152152
This activates a new instance of the **puiHeader** plugin named **Down**. At the same time, it is necessary to create a configuration file with the exact name specified so that the configuration is loaded automatically. The result will be a new panel located below the chapter content panel, which will display the text from the **TEXT** key. This text will always be displayed to the user on the screen and will be included in the print output, for example. The **ARIAHEADER** key specifies the accessibility role of the content.
153153

154+
### Custom admonition block type
155+
156+
As part of the information blocks (admonition) solution, you can define your own type according to the instructions in the chapter 🛠️ [Viewer Custom UI][customUI] and also in this way in **custom.css** in the help:
157+
158+
```css
159+
:root {
160+
--c-border-note-mytest:rgb(207, 207, 34);
161+
}
162+
.note-mytest {
163+
border-color: var(--c-border-note-mytest);
164+
}
165+
166+
.note-mytest p::before {
167+
content: "MT ";
168+
}
169+
```
170+
171+
using the same method as for other types:
172+
173+
```markdown
174+
> [!MYTEST]Block of unknown type
175+
```
176+
154177
[TocIcon]: tocIcon.md "TOC icons"
155178
[customUI]: customUI.md "Viewer Custom UI"
156179
[DGuide]: ?d=hlp-dguide/Help-__.zip "Documentation for developers"

en/files.lst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,4 @@ https://discord.gg/J2SjcmqHSZ|User group
3333
sectionList.md|Sections list
3434
print.md|Print
3535
export.md|Export
36+
admonitions.md|Admonitions

en/keywords-files.lst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
0;1;3;25;26;34
22
1;2;34
33
2;6;13;22;25
4-
3;6;7;11;10;21;26
4+
3;6;7;11;10;21;26;35
55
3
6-
4;25
6+
4;25;35
77
4;2;3;24;26;28
8-
5;10;11;12
8+
5;10;11;12;35
99
5
1010
6
1111
7;34
1212
5
13-
8;16
13+
8;16;35
1414
9;34
15-
10;11
15+
10;11;35
1616
11;21
1717
10
1818
12;17;18;19;20
@@ -29,3 +29,4 @@
2929
27;28;29;30
3030
26
3131
34
32+
35

0 commit comments

Comments
 (0)