Skip to content

Commit 0d4ce7f

Browse files
VitSimonVitSimon
committed
EN,CZ : custPackage : custom package configuration description
1 parent 66e26cc commit 0d4ce7f

File tree

6 files changed

+146
-0
lines changed

6 files changed

+146
-0
lines changed

‎cs/custPackage.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# 📥 Vlastní balíček
2+
3+
V **helpHello** nápovědě je k dispozici funkce **📥 Vlastní balíček**.
4+
5+
Funkcionalitu zajišťuje plugin 🖥️ [puiButtonCustPackage][puiButtonCustPackage].
6+
7+
Podrobnosti o konfiguraci pluginu naleznete v následujících kapitolách.
8+
9+
## Přehled
10+
11+
Konfigurace je rozdělena mezi následující umístění:
12+
13+
| Soubor | Význam |
14+
| --- | --- |
15+
| plugins-config/puiButtonCustPackage__tree.cfg | Strom závislostí |
16+
| plugins-config/puiButtonCustPackage_.cfg | Data o komponentách |
17+
| puiButtonCustPackage/*/lstr.txt | 🌐 [Překlady][ViewerNewLang] interních jmen komponent pro uživatele. Hvězdička zastupuje zkratku jazyka. |
18+
19+
Pouze přidáním potřebných informací do všech těchto míst vytvoříte plnohodnotnou novou komponentu.
20+
21+
## Strom závislostí
22+
23+
- Soubor **plugins-config/puiButtonCustPackage__tree.cfg** obsahuje [hierarchický strom][treedata] pouze s interními názvy komponent.
24+
- Každá mezera zleva označuje jednu úroveň vnoření - komponenta je tedy podřízena té, která je nad ní a má o jednu mezeru méně.
25+
26+
## Překlady
27+
28+
- Soubor **puiButtonCustPackage/(zkratka-jazyka)/lstr.txt** obsahuje překladový klíč, který má název podle jména komponenty ze [stromu závislostí][treedep].
29+
- Hodnotou klíče je překlad, který se zobrazuje uživateli.
30+
- Vše je dále popsáno v kapitole 🌐 [Nový jazyk][ViewerNewLang].
31+
32+
## Data o komponentách
33+
34+
Soubor **plugins-config/puiButtonCustPackage_.cfg** obsahuje standardní formát [konfigurace][cfgPlug] pro plugin.
35+
36+
### Pravidla formátu
37+
38+
- ⚠️ Tento formát je velmi přísný, prosím, dodržujte pravidla přesně.
39+
- Seznamy v tomto souboru nekončí středníky.
40+
- Jednotlivé položky seznamů v klíčích jsou odděleny středníky.
41+
- Celé adresáře končí lomítkem **/**.
42+
- Soubory i adresáře jsou uváděny v relativních cestách ke kořeni balíčku (**hvdata/data.zip**). Nezačínají žádným prefixem.
43+
Například **styles/** je odkaz na složku **styles** uvnitř tohoto zip souboru.
44+
45+
### Základní data
46+
47+
Každá komponenta zde definuje základní 3 klíče:
48+
49+
- **I**-JMENO - Ikona komponenty
50+
- **P**-JMENO - Seznam pluginů (plugin) a instancí pluginu (plugin:id)
51+
- **F**-JMENO
52+
Seznam souborů a adresářů v datech celého balíčku, které ke komponentě patří. Soubory jsou uváděny v relativních cestách. Celé adresáře končí lomítkem **/**. Běžný adresář s daty pro plugin (./jmeno-tridy-pluginu hledá puiButtonCustPackage automaticky).
53+
54+
JMENO = jméno komponenty ze [stromu závislostí][treedep]
55+
56+
### Další data
57+
58+
- **C**-JMENO
59+
Komponenta JMENO může záviset na dalších komponentách uvedených v seznamu. Tyto závislé komponenty se automaticky připojí k výběru, pokud si uživatel zvolí komponentu JMENO jako součást balíčku. Cílem tohoto zápisu je poskytnout vedle [stromu závislostí][treedep] i paralelní textovou definici, která lépe vystihuje případy, kdy komponenta závisí na více dalších komponentách současně. Tento klíč je nepovinný a nemusí být uveden.
60+
- **DE**
61+
Seznam pluginů, které jsou vždy odebrány z výsledného balíčku, který připraví tato funkcionalita pro uživatele.
62+
Například po provedení této funkcionality uživatel vždy získá balíček, který již nepodporuje další vytvoření vlastního balíčku.
63+
- **DE-(jmeno-tridy-pluginu)**
64+
Seznam pluginů, které jsou odebrány, pokud je plugin **(jmeno-tridy-pluginu)** zcela odebrán z balíčku.
65+
Například **pIndexFile** a jeho podpora pro **práci s klíčovými slovy a přehledové stránky slovníku**.
66+
67+
[puiButtonCustPackage]: :_plg:puiButtonCustPackage.md "puiButtonCustPackage"
68+
[ViewerNewLang]: newLangViewer.md#h-3-1 "Nový jazyk prohlížeče"
69+
[treedata]: ?d=hlp-aguide/Help-__.zip&p=mdata%2Ftree.lst.md "Formát dat stromových struktur"
70+
[cfgPlug]: pluginConfig.md "Konfigurace pluginů"
71+
[treedep]: #h-2-1 "Strom závislostí"

‎cs/files.lst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,4 @@ plugLocStrings.md|Lokalizace pluginů
4444
pServicePlugin.md|pServicePlugin
4545
milestones.md|Milníky
4646
puiButtonSelect.md|puiButtonSelect
47+
custPackage.md|Vlastní balíček

‎cs/tree.lst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ UI prvky|UI prvky||uiobject.md
3535
🎛️ Karta|Karta||uitab.md
3636
📂 Strom|Strom||uitree.md
3737
📑 Dokumentace objektů|Dokumentace objektů||objDoc.md
38+
📥 Vlastní balíček|Vlastní balíček||custPackage.md
3839
🌐 Nový jazyk|Nový jazyk||newLangViewer.md
3940
Projekt HelpViewer|Projekt HelpViewer||helpviewer.md
4041
📍 Milníky|Milníky||milestones.md

‎en/custPackage.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# 📥 Custom package
2+
3+
The **📥 Custom package** feature is available in the **helpHello** help.
4+
5+
The functionality is provided by the 🖥️ [puiButtonCustPackage][puiButtonCustPackage] plugin.
6+
7+
Details on configuring the plugin can be found in the following chapters.
8+
9+
## Overview
10+
11+
The configuration is divided between the following locations:
12+
13+
| File | Meaning |
14+
| --- | --- |
15+
| plugins-config/puiButtonCustPackage__tree.cfg | Dependency tree |
16+
| plugins-config/puiButtonCustPackage_.cfg | Component data |
17+
| puiButtonCustPackage/*/lstr.txt | 🌐 [Translations][ViewerNewLang] of internal component names for users. The asterisk represents the language abbreviation. |
18+
19+
Only by adding the necessary information to all these locations will you create a fully-fledged new component.
20+
21+
## Dependency tree
22+
23+
- The file **plugins-config/puiButtonCustPackage__tree.cfg** contains a [hierarchical tree][treedata] with only internal component names.
24+
- Each space from the left indicates one level of nesting - a component is therefore subordinate to the one above it and has one less space.
25+
26+
## Translations
27+
28+
- The file **puiButtonCustPackage/(language-abbreviation)/lstr.txt** contains a translation key named after the component from the [dependency tree][treedep].
29+
- The value of the key is the translation that is displayed to the user.
30+
- Everything is described in more detail in the chapter 🌐 [New Language][ViewerNewLang].
31+
32+
## Component data
33+
34+
The file **plugins-config/puiButtonCustPackage_.cfg** contains the standard [configuration][cfgPlug] format for the plugin.
35+
36+
### Format rules
37+
38+
- ⚠️ This format is very strict, so please follow the rules exactly.
39+
- Lists in this file do not end with semicolons.
40+
- Individual items in lists in keys are separated by semicolons.
41+
- Entire directories end with a slash **/**.
42+
- Files and directories are listed in relative paths to the root of the package (**hvdata/data.zip**). They do not start with any prefix.
43+
For example, **styles/** is a reference to the **styles** folder inside this zip file.
44+
45+
### Basic data
46+
47+
Each component defines three basic keys here:
48+
49+
- **I**-NAME - Component icon
50+
- **P**-NAME - List of plugins (plugin) and plugin instances (plugin:id)
51+
- **F**-NAME
52+
List of files and directories in the entire package data that belong to the component. Files are listed in relative paths. Entire directories end with a slash **/**. A common directory with data for the plugin (./plugin-class-name is searched for automatically by puiButtonCustPackage).
53+
54+
NAME = component name from [dependency tree][treedep]
55+
56+
### Additional data
57+
58+
- **C**-NAME
59+
The NAME component may depend on other components listed in the list. These dependent components are automatically added to the selection if the user selects the NAME component as part of the package. The purpose of this entry is to provide a parallel text definition to the [dependency tree][treedep] that better captures cases where a component depends on multiple other components at the same time. This key is optional and does not need to be specified.
60+
- **DE**
61+
List of plugins that are always removed from the resulting package prepared by this functionality for users.
62+
For example, after executing this functionality, the user always receives a package that no longer supports the creation of another custom package.
63+
- **DE-(plugin-class-name)**
64+
List of plugins that are removed if the **(plugin-class-name)** plugin is completely removed from the package.
65+
For example, **pIndexFile** and its support for **working with keywords and dictionary overview pages**.
66+
67+
[puiButtonCustPackage]: :_plg:puiButtonCustPackage.md "puiButtonCustPackage"
68+
[ViewerNewLang]: newLangViewer.md#h-3-1 "New language for Viewer"
69+
[treedata]: ?d=hlp-aguide/Help-__.zip&p=mdata%2Ftree.lst.md "Tree structure data format"
70+
[cfgPlug]: pluginConfig.md "Plugin configuration"
71+
[treedep]: #h-2-1 "Dependency tree"

‎en/files.lst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,4 @@ plugLocStrings.md|Plugin localization
4444
pServicePlugin.md|pServicePlugin
4545
milestones.md|Milestones
4646
puiButtonSelect.md|puiButtonSelect
47+
custPackage.md|Custom package

‎en/tree.lst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ UI elements|UI elements||uiobject.md
3535
🎛️ Tab|Tab||uitab.md
3636
📂 Tree|Tree||uitree.md
3737
📑 Documenting objects|Documenting objects||objDoc.md
38+
📥 Custom package|Custom package||custPackage.md
3839
🌐 New language|New language||newLangViewer.md
3940
HelpViewer Project|HelpViewer Project||helpviewer.md
4041
📍 Milestones|Milestones||milestones.md

0 commit comments

Comments
 (0)