Skip to content

Commit 713e624

Browse files
committed
EN,CZ : Plugins loading and plugins.lst description extended for detail differences between application and help file locations and options
1 parent 73f5dd0 commit 713e624

File tree

4 files changed

+14
-4
lines changed

4 files changed

+14
-4
lines changed

cs/pluginLoad.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ Zavést instanci pluginu je v aplikaci možné dvěma způsoby:
1010
```javascript
1111
const pluginName = 'puiButtonObjectExplorer';
1212
const pluginId = '-load';
13-
await loadPlugin(pluginName, loadPluginListBasePath(pluginName));
13+
await loadPlugin(pluginName, loadPluginListBasePath(pluginName), STO_DATA);
1414
await activatePlugin(pluginName, pluginId);
1515
```
1616

1717
| Definice | Popis |
1818
|---|---|
1919
| pluginName | Jméno třídy pluginu |
2020
| loadPlugin | Zajistí načtení třídy pluginu, pokud zatím načtena nebyla. |
21-
| loadPluginListBasePath(pluginName) | Funkce, která zajistí sestavení správné cesty k souboru pluginu uvnitř balíku dat. Předpokládá, že se soubor pluginu bude nacházet v **plugins/(pluginName).js** |
21+
| loadPluginListBasePath(pluginName) | Funkce, která zajistí sestavení správné cesty k souboru pluginu uvnitř balíku dat. Předpokládá, že se soubor pluginu bude nacházet v **plugins/(pluginName).js**. Třetí parametr specifikuje, které úložiště se má prohlédávat: STO_DATA je výchozí, další možností je STO_HELP. |
2222
| activatePlugin | Zajistí vytvoření nové instance pluginu **pluginName** s id **pluginId** |
2323

2424
## Odebrání pluginu za běhu

cs/plugins.lst.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
- Jeden řádek = jedna položka
66
- Zalomení řádku uprostřed definice není povoleno
77

8+
## Umístění
9+
10+
- Soubor dat aplikace: zip/plugins.lst
11+
- Soubor nápovědy: helpProject/_base/plugins.lst
12+
813
## Struktura souboru
914

1015
```text

en/pluginLoad.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ There are two ways to load a plugin instance in the application:
1010
```javascript
1111
const pluginName = 'puiButtonObjectExplorer';
1212
const pluginId = '-load';
13-
await loadPlugin(pluginName, loadPluginListBasePath(pluginName));
13+
await loadPlugin(pluginName, loadPluginListBasePath(pluginName), STO_DATA);
1414
await activatePlugin(pluginName, pluginId);
1515
```
1616

1717
| Definition | Description |
1818
|---|---|
1919
| pluginName | Name of the plugin class |
2020
| loadPlugin | Ensures that the plugin class is loaded if it has not been loaded yet. |
21-
| loadPluginListBasePath(pluginName) | Function that ensures the correct path to the plugin file within the data package is constructed. Assumes that the plugin file will be located in **plugins/(pluginName).js** |
21+
| loadPluginListBasePath(pluginName) | Function that ensures the correct path to the plugin file within the data package is constructed. Assumes that the plugin file will be located in **plugins/(pluginName).js**. The third parameter specifies which storage to search: STO_DATA is the default, another option is STO_HELP. |
2222
| activatePlugin | Ensures that a new instance of the **pluginName** plugin with id **pluginId** is created |
2323

2424
## Removing a plugin during runtime

en/plugins.lst.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
- One line = one item
66
- Line breaks in the middle of a definition are not allowed
77

8+
## Location
9+
10+
- Application data file: zip/plugins.lst
11+
- Help file: helpProject/_base/plugins.lst
12+
813
## File structure
914

1015
```text

0 commit comments

Comments
 (0)