EN,CZ : pServicePlugin description, tree and files list pdated

VitSimon · VitSimon · commit 5c6667a6ac8c · 2025-09-23T02:53:18.000+02:00
diff --git a/cs/files.lst b/cs/files.lst
@@ -40,3 +40,5 @@ resource.md|Zdroj/Balíček
 routingmc.md|Směrování kliknutí myši
 objDoc.md|Dokumentace objektů
 deps.lst.md|Seznam závislostí (deps.lst)
+plugLocStrings.md|Lokalizace pluginů
+pServicePlugin.md|pServicePlugin
diff --git a/cs/pServicePlugin.md b/cs/pServicePlugin.md
@@ -0,0 +1,61 @@
+# 🔌 pServicePlugin
+
+## Účel pluginu
+
+Tento plugin je určen k definici rozhraní pro rozšiřující služby.
+
+Základem jsou obsluhy napojené na události pluginu 🔌 [pPluginManagement][pPluginManagement].
+
+## Implementace
+
+1. Nový plugin vždy bude mít [pServicePlugin][pServicePlugin] jako svou bázovou třídu.
+
+```javascript
+class pNewServicePlugin extends pServicePlugin {
+  init() {
+    super.init();
+  }
+
+  _pluginActivated(pluginName, instanceName, instance, storageName) {
+    if (instance) {
+      // pokud instance splňuje nějakou podmínku, provést zavedení do seznamu pluginů a další akce
+      this.addPlugin(pluginName, instanceName);
+    }
+  }
+
+  _pluginDeactivated(pluginName, instanceName, instance, storageName) {
+  }
+
+  onET...(evt) {
+    this._doForAllInstances(this._pluginActivated.bind(this));
+  }
+}
+
+Plugins.catalogize(pNewServicePlugin);
+```
+
+2. Základní plugin musí definovat vhodné události (včetně jejich obsahu), aby se na jeho procesy bylo možné efektivně napojit.
+
+- _pluginActivated - zajišťuje zpracování pro aktivaci nové instance pluginu
+- addPlugin - přidání pluginu a jeho instance do seznamu pluginů, které služba bude spravovat. Musí se volat ručně.
+- _pluginDeactivated - zajišťuje zpracování pro odebrání instance pluginu, automaticky provede odebrání instance pluginu ze seznamu pluginů ve službě
+- onET...(evt) - služba možná bude potřebovat obsluhu nějaké události, kterou zajišťuje zbytek systému nebo jiný plugin, pro který bude tato služba rozšířením. 
+- **evt** - bude představovat konkrétní objekt události v závislosti na procesu, který budete vyvíjet
+- this._doForAllInstances(this._pluginActivated.bind(this)); - volá metodu _pluginActivated pro všechny evidované instance pluginu. Použití **bind(this)** je nutné, aby se při předání metody **zachoval kontext this**.
+
+## Popis funkčnosti
+
+- Plugin naslouchá událostem ⚡ [PluginActivated][PluginActivated] (volá funkci **\_pluginActivated**) a ⚡ [PluginDeactivated][PluginDeactivated] (volá funkci **\_pluginDeactivated**)
+- Plugin naslouchá dalším událostem podle deklarovaných obsluh
+- V případě ověření, že instance pluginu splňuje požadavky služby ji zaveďte do seznamu voláním funkce **addPlugin**. 
+- Odebrání instance se provede automaticky s přijetím ⚡ [PluginDeactivated][PluginDeactivated]
+
+## Příklady implementací
+
+- ⚙️ [pServiceLocalization][pServiceLocalization] a další potomci třídy 🔌 [pServicePlugin][pServicePlugin]
+
+[pPluginManagement]: :_inst:pPluginManagement:.md "pPluginManagement"
+[pServiceLocalization]: :_plg:pServiceLocalization.md "pServiceLocalization"
+[PluginActivated]: :_evt:PluginActivated.md "PluginActivated"
+[PluginDeactivated]: :_evt:PluginDeactivated.md "PluginDeactivated"
+[pServicePlugin]: :_plg:pServicePlugin.md "pServicePlugin"
diff --git a/cs/plugLocStrings.md b/cs/plugLocStrings.md
@@ -21,7 +21,7 @@ Kapitola 🌐 [Nový jazyk prohlížeče][ViewerNewLang] dále popisuje:
 
 ## Samostatný lokalizační slovník pro plugin
 
-Pomocí komponenty 🧩 [pServiceLocalization][pServiceLocalization] (součást základního balíčku) lze přidat vlastní lokalizace pro každý plugin. Stačí založit příslušné soubory na správném místě.
+Pomocí komponenty 🔌 [pServiceLocalization][pServiceLocalization] (součást základního balíčku) lze přidat vlastní lokalizace pro každý plugin. Stačí založit příslušné soubory na správném místě.
 
 Povinné soubory:
 
diff --git a/cs/tree.lst b/cs/tree.lst
@@ -21,6 +21,7 @@ Implementace pluginů|Implementace pluginů||implPlug.md
  🔌 pConvertSysEventToEvent|pConvertSysEventToEvent||pConvertSysEventToEvent.md
  🖼️ pTRPhasePlugin|pTRPhasePlugin||pTRPhasePlugin.md
  🖼️ pTopicRenderer|pTopicRenderer||pTopicRenderer.md
+ 🔌 pServicePlugin|pServicePlugin||pServicePlugin.md
 Definice objektů|Definice objektů||objDef.md
  ⚙️ Konfigurační volba|Konfigurační volba||cfgopt.md
  ⚡ Událost|Událost||event.md
diff --git a/en/files.lst b/en/files.lst
@@ -40,3 +40,5 @@ resource.md|Resource/Package
 routingmc.md|Mouse click routing
 objDoc.md|Documenting objects
 deps.lst.md|List of dependencies (deps.lst)
+plugLocStrings.md|Plugin localization
+pServicePlugin.md|pServicePlugin
diff --git a/en/pServicePlugin.md b/en/pServicePlugin.md
@@ -0,0 +1,61 @@
+# 🔌 pServicePlugin
+
+## Purpose of the plugin
+
+This plugin is designed to define interfaces for extension services.
+
+It is based on handlers connected to plugin events 🔌 [pPluginManagement][pPluginManagement].
+
+## Implementation
+
+1. A new plugin will always have [pServicePlugin][pServicePlugin] as its base class.
+
+```javascript
+class pNewServicePlugin extends pServicePlugin {
+  init() {
+    super.init();
+  }
+
+  _pluginActivated(pluginName, instanceName, instance, storageName) {
+    if (instance) {
+      // if the instance meets a condition, add it to the plugin list and perform other actions
+      this.addPlugin(pluginName, instanceName);
+    }
+  }
+
+  _pluginDeactivated(pluginName, instanceName, instance, storageName) {
+  }
+
+  onET...(evt) {
+    this._doForAllInstances(this._pluginActivated.bind(this));
+  }
+}
+
+Plugins.catalogize(pNewServicePlugin);
+```
+
+2. The basic plugin must define appropriate events (including their content) so that its processes can be effectively connected.
+
+- _pluginActivated - ensures processing for activating a new plugin instance
+- addPlugin - adds a plugin and its instance to the list of plugins that the service will manage. Must be called manually.
+- _pluginDeactivated - ensures processing for removing the plugin instance, automatically removes the plugin instance from the list of plugins in the service
+- onET...(evt) - the service may need to handle an event provided by the rest of the system or another plugin for which this service will be an extension.
+- **evt** - will represent a specific event object depending on the process you are developing
+- this._doForAllInstances(this._pluginActivated.bind(this)); - calls the _pluginActivated method for all registered instances of the plugin. The use of **bind(this)** is necessary to **preserve the context of this** when passing the method.
+
+## Functionality description
+
+- The plugin listens for events ⚡ [PluginActivated][PluginActivated] (calls the **\_pluginActivated** function) and ⚡ [PluginDeactivated][PluginDeactivated] (calls the **\_pluginDeactivated** function)
+- The plugin listens for other events according to the declared handlers
+- If the plugin instance meets the service requirements, add it to the list by calling the **addPlugin** function.
+- The instance is removed automatically upon receiving ⚡ [PluginDeactivated][PluginDeactivated]
+
+## Implementation examples
+
+- ⚙️ [pServiceLocalization][pServiceLocalization] and other descendants of the class 🔌 [pServicePlugin][pServicePlugin]
+
+[pPluginManagement]: :_inst:pPluginManagement:.md "pPluginManagement"
+[pServiceLocalization]: :_plg:pServiceLocalization.md "pServiceLocalization"
+[PluginActivated]: :_evt:PluginActivated.md "PluginActivated"
+[PluginDeactivated]: :_evt:PluginDeactivated.md "PluginDeactivated"
+[pServicePlugin]: :_plg:pServicePlugin.md "pServicePlugin"
diff --git a/en/plugLocStrings.md b/en/plugLocStrings.md
@@ -21,7 +21,7 @@ The chapter 🌐 [New language for Viewer][ViewerNewLang] further describes:
 
 ## Separate localization dictionary for the plugin
 
-Using the 🧩 [pServiceLocalization][pServiceLocalization] plugin (part of the basic package), you can add your own localizations for each plugin. Just create the appropriate files in the right place.
+Using the 🔌 [pServiceLocalization][pServiceLocalization] plugin (part of the basic package), you can add your own localizations for each plugin. Just create the appropriate files in the right place.
 
 Required files:
 
diff --git a/en/tree.lst b/en/tree.lst
@@ -21,6 +21,7 @@ Plugin implementation|Plugin implementation||implPlug.md
  🔌 pConvertSysEventToEvent|pConvertSysEventToEvent||pConvertSysEventToEvent.md
  🖼️ pTRPhasePlugin|pTRPhasePlugin||pTRPhasePlugin.md
  🖼️ pTopicRenderer|pTopicRenderer||pTopicRenderer.md
+ 🔌 pServicePlugin|pServicePlugin||pServicePlugin.md
 Object definitions|Object definitions||objDef.md
  ⚙️ Configuration option|Configuration option||cfgopt.md
  ⚡ Event|Event||event.md
