Skip to content

Commit a1130e8

Browse files
committed
EN,CZ : firstPlugin : plugin classes divided to 3 basic subchapters
1 parent 9d564a0 commit a1130e8

File tree

2 files changed

+30
-4
lines changed

2 files changed

+30
-4
lines changed

cs/firstPlugin.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ a dále postupujte podle kapitoly **Balík programu**.
2020

2121
Pokud plugin chcete přidat do sestavení HelpVieweru:
2222

23-
3. Do seznamu [pluginů][plugins] zaveďte plugin definičním řádkem:
23+
3. Do [seznamu pluginů][plugins] zaveďte plugin definičním řádkem:
2424
- **[jméno třídy]** pokud má být plugin pouze načten (je předkem pro jiné pluginy, ale není určen k samostatné práci)
2525
- **[jméno třídy]:[jméno instance]** pokud má být plugin načten a je určen k zajištění funkcionality
2626
4. Do umístění **zip/plugins-config/[jméno třídy]_[jméno instance].cfg** vložte konfigurační definice pro novou instanci.
@@ -63,11 +63,22 @@ Plugins.catalogize(pMinPlugin);
6363
|---|---|
6464
| 🔌 [IPlugin][IPlugin] | Základní plugin pro všechny pluginy v systému. Poskytuje základní funkce pro obecný plugin. Je určen pro pluginy služeb nebo posluchačů událostí, které samy nebudou zajišťovat žádný prvek uživatelského rozhraní. |
6565
| 🔌 [pConvertSysEventToEvent][pConvertSysEventToEvent] | Plugin převádí definovanou javascript událost na událost aplikace, která může být zachycena jiným pluginem. |
66-
| 🖼️ [pTRPhasePlugin][pTRPhasePlugin] | Plugin přijímá událost ⚡ [ShowChapterResolutions][ShowChapterResolutions] od pluginu 🖼️ [pTopicRenderer][pTopicRenderer] a provede jednotlivý krok procesního zpracování. Jednou z jeho aplikací je například parsování md souboru pro výpis do textu kapitoly. |
66+
| 🔌 [pServicePlugin][pServicePlugin] | Plugin pro rozšiřující služby. Základem jsou obsluhy napojené na události pluginu 🔌 [pPluginManagement][pPluginManagement]. |
67+
68+
### Uživatelské rozhraní
69+
70+
| Název | Popis |
71+
|---|---|
6772
| 🖥️ [puiButton][puiButton] | 🔘 Tlačítko pro uživatelské rozhraní. Obsluha akce musí být součástí zdroje pluginu. |
6873
| 🖥️ [puiButtonTab][puiButtonTab] | 🔘🎛️ Tlačítko a karta bočního panelu. |
6974
| 🖥️ [puiButtonTabTree][puiButtonTabTree] | 🔘🎛️📂 Tlačítko a karta bočního panelu s komponentou strom. |
7075

76+
### Výpis textu kapitol
77+
78+
| Název | Popis |
79+
|---|---|
80+
| 🖼️ [pTRPhasePlugin][pTRPhasePlugin] | Plugin přijímá událost ⚡ [ShowChapterResolutions][ShowChapterResolutions] od pluginu 🖼️ [pTopicRenderer][pTopicRenderer] a provede jednotlivý krok procesního zpracování. Jednou z jeho aplikací je například parsování md souboru pro výpis do textu kapitoly. |
81+
7182
## Příklady implementací
7283

7384
- 🖼️ [pTREmptyPlugin][pTREmptyPlugin]
@@ -82,3 +93,5 @@ Plugins.catalogize(pMinPlugin);
8293
[puiButtonTab]:puiButtonTab.md "puiButtonTab"
8394
[puiButtonTabTree]: puiButtonTabTree.md "puiButtonTabTree"
8495
[plugins]: plugins.lst.md "Seznam pluginů"
96+
[pServicePlugin]: pServicePlugin.md "pServicePlugin"
97+
[pPluginManagement]: :_plg:pPluginManagement.md "pPluginManagement"

en/firstPlugin.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ and then proceed according to the **Program package** chapter.
2020

2121
If you want to add the plugin to the HelpViewer build:
2222

23-
3. Add the plugin to the [plugins] list with a definition line:
23+
3. Add the plugin to the [plugins list] with a definition line:
2424
- **[class name]** if the plugin is only to be loaded (it is a parent for other plugins, but is not intended to work independently)
2525
- **[class name]:[instance name]** if the plugin is to be loaded and is intended to provide functionality
2626
4. Place the configuration definitions for the new instance in **zip/plugins-config/[class name]_[instance name].cfg**.
@@ -63,11 +63,22 @@ Plugins.catalogize(pMinPlugin);
6363
|---|---|
6464
| 🔌 [IPlugin][IPlugin] | Basic plugin for all plugins in the system. Provides basic functions for a general plugin. It is intended for service plugins or event listeners that do not provide any user interface elements themselves. |
6565
| 🔌 [pConvertSysEventToEvent][pConvertSysEventToEvent] | The plugin converts a defined JavaScript event into an application event that can be captured by another plugin. |
66-
| 🖼️ [pTRPhasePlugin][pTRPhasePlugin] | The plugin receives the ⚡ [ShowChapterResolutions][ShowChapterResolutions] event from the 🖼️ [pTopicRenderer][pTopicRenderer] plugin and performs a single step of process handling. One of its applications is, for example, parsing an md file for listing into chapter text. |
66+
| 🔌 [pServicePlugin][pServicePlugin] | Plugin for extended services. It is based on handlers connected to plugin events 🔌 [pPluginManagement][pPluginManagement]. |
67+
68+
### User interface
69+
70+
| Name | Description |
71+
|---|---|
6772
| 🖥️ [puiButton][puiButton] | 🔘 Button for the user interface. The action handler must be part of the plugin source. |
6873
| 🖥️ [puiButtonTab][puiButtonTab] | 🔘🎛️ Sidebar button and tab. |
6974
| 🖥️ [puiButtonTabTree][puiButtonTabTree] | 🔘🎛️📂 Sidebar button and tab with tree component. |
7075

76+
### Chapter text rendering
77+
78+
| Name | Description |
79+
|---|---|
80+
| 🖼️ [pTRPhasePlugin][pTRPhasePlugin] | The plugin receives the ⚡ [ShowChapterResolutions][ShowChapterResolutions] event from the 🖼️ [pTopicRenderer][pTopicRenderer] plugin and performs a single step of process handling. One of its applications is, for example, parsing an md file for listing into chapter text. |
81+
7182
## Implementation examples
7283

7384
- 🖼️ [pTREmptyPlugin][pTREmptyPlugin]
@@ -82,3 +93,5 @@ Plugins.catalogize(pMinPlugin);
8293
[puiButtonTab]:puiButtonTab.md "puiButtonTab"
8394
[puiButtonTabTree]: puiButtonTabTree.md "puiButtonTabTree"
8495
[plugins]: plugins.lst.md "List of plugins"
96+
[pServicePlugin]: pServicePlugin.md "pServicePlugin"
97+
[pPluginManagement]: :_plg:pPluginManagement.md "pPluginManagement"

0 commit comments

Comments
 (0)