EN,CZ : contextHelp : Plugin for contextual help described in better detail

VitSimon · VitSimon · commit 15937440522e · 2026-03-21T13:11:52.000+01:00
diff --git a/cs/contextHelp.md b/cs/contextHelp.md
@@ -0,0 +1,65 @@
+# ❔ Kontextová nápověda pro web
+
+V rámci řešení HelpViewer je k dispozici [plugin][PluginR] pro prohlížeče s jádrem Chromium (Chrome, Edge).
+
+## Funkce
+
+Plugin zajišťuje přidání akce ❔ **Co je zde?** do menu pravého tlačítka myši, která následně otevře kapitolu konkrétní kapitoly v konkrétním souboru nápovědy stejným způsobem, jako to bylo v minulosti obvyklé u operačních systémů.
+
+## Instalace
+
+**Systémový administrátor** musí plugin nainstalovat na stanicích uživatelů v **režimu pro vývojáře** (chrome://extensions/). Plugin není v Chrome Web Store.
+
+## Propojení aplikace a nápovědy
+
+**Napojení nápovědy v aplikaci zajistí programátor**.  
+Stačí definovat **objekt hvHelpFile** ve webové aplikaci:
+
+```javascript
+var hvHelpFile = {
+  file: 'hlp-user/Help-__.zip',
+  viewer: 'https://helpviewer.github.io/index.html',
+  //viewer: '$/index.html', // relativní cesta k prohlížeči odvozená z umístění aplikace
+  routing: false
+  //, extension: '.md'
+  //, offset: 0
+}
+```
+
+Definici lze měnit dynamicky podle kontextu (např. podle stránky). Více detailů v [dokumentaci pluginu][PluginR].
+
+## Získání seznamu kapitol
+
+Pro autory nápovědy jsou klíčové názvy kapitol, odvozené z atributu **id** ovládacích prvků v aplikaci.  
+**Programátor je musí poskytnout** – odpovídá za konfiguraci pluginu.
+
+### Kroky pro programátora
+
+1. Otevřete konzoli pro vývojáře (F12) na stránce aplikace.
+2. Získejte všechna ID prvků:
+
+```javascript
+allElements = Array.from(document.body.querySelectorAll('*')).map(x => x.id).filter(x => x);
+```
+
+3. Pro sloučené ID (např. stromy, seznamy - sloučí se jen předpony před **|**):
+
+```javascript
+allElements = [...new Set(Array.from(document.body.querySelectorAll('*')).map(x => x.id).filter(x => x).map(x => x.split('|')[0]))];
+```
+
+4. **Ověřte chování** na cílovém prostředí - parametry **routing, extension a offset** ovlivňují finální jméno kapitoly.
+
+## Speciální případy
+
+- Pro **prvky bez ID** se otevírá kapitola **noid.md** (nebo noid.(extension) z konfigurace)
+- Testujte na různých stránkách/formulářích podle architektury aplikace
+
+## Ladění a tipy
+
+1. Pokud položka ❔ chybí, zkontrolujte **hvHelpFile** v konzoli: console.log(hvHelpFile).
+2. Jméno otevřené kapitoly je chybné nebo se nezobrazuje žádný text kapitoly? Ověřte ID prvku pod kurzorem a konfiguraci offset/routing/extension. Ověřte také zda jste soubor kapitoly v nápovědě založili.
+3. Použijte **\$/index.html** pro samostatné nasazení s aplikací - **\$** zde znamená relativní cesta vzhledem k současné URI aplikace (záložky ze které se spustil příkaz ❔).
+4. Bezpečnost: Plugin běží v izolovaném kontextu a neovlivňuje aplikaci.
+
+[PluginR]: ?d=https://raw.githubusercontent.com/HelpViewer/PluginChromeHelpViewer/master/ "PluginChromeHelpViewer"
diff --git a/cs/files.lst b/cs/files.lst
@@ -34,3 +34,4 @@ sectionList.md|Seznam částí
 print.md|Tisk
 export.md|Export
 admonitions.md|Vyznačené informační bloky
+contextHelp.md|Kontextová nápověda pro web
diff --git a/cs/keywords-files.lst b/cs/keywords-files.lst
@@ -30,3 +30,4 @@
 26
 34
 35
+36
diff --git a/cs/keywords.lst b/cs/keywords.lst
@@ -30,3 +30,4 @@ Odkaz
 Identita;Branding;Vizuál
 Export
 Admonition;upozornění;Blok;infoblok;vyznačení
+Kontext;Kontextové menu;Pravé tlačítko;Co je zde
diff --git a/cs/tree.lst b/cs/tree.lst
@@ -30,4 +30,5 @@ Vydání verze nápovědy|Vydání verze nápovědy||publish.md
 📥 Export|Export||export.md
 🌐 Nový jazyk|Nový jazyk||newLang.md
 🤝 Integrace s aplikacemi|Integrace s aplikacemi||integration.md
+ ❔ Kontextová nápověda pro web|Kontextová nápověda pro web||contextHelp.md
 💬 Uživatelská skupina|Uživatelská skupina Discord||https://discord.gg/J2SjcmqHSZ
diff --git a/en/contextHelp.md b/en/contextHelp.md
@@ -0,0 +1,65 @@
+# ❔ Contextual help for the web
+
+The HelpViewer solution includes a [plugin][PluginR] for browsers based on the Chromium engine (Chrome, Edge).
+
+## Features
+
+The plugin adds the ❔ **What's here?** action to the right-click menu, which then opens a specific chapter in a specific help file in the same way that was common in operating systems in the past.
+
+## Installation
+
+**The system administrator** must install the plugin on user workstations in **developer mode** (chrome://extensions/). The plugin is not available in the Chrome Web Store.
+
+## Integrating the application and help
+
+**The programmer is responsible for integrating the help into the application**.  
+Simply define the **hvHelpFile object** in the web application:
+
+```javascript
+var hvHelpFile = {
+  file: 'hlp-user/Help-__.zip',
+  viewer: 'https://helpviewer.github.io/index.html',
+  //viewer: '$/index.html', // relative path to the viewer derived from the application location
+  routing: false
+  //, extension: '.md'
+  //, offset: 0
+}
+```
+
+The definition can be changed dynamically based on context (e.g., by page). More details in the [plugin documentation][PluginR].
+
+## Retrieving the list of chapters
+
+For help authors, chapter names—derived from the **id** attribute of controls in the application—are key.  
+**The programmer must provide them**—they are responsible for configuring the plugin.
+
+### Steps for the programmer
+
+1. Open the developer console (F12) on the application page.
+2. Retrieve all element IDs:
+
+```javascript
+allElements = Array.from(document.body.querySelectorAll('*')).map(x => x.id).filter(x => x);
+```
+
+3. For combined IDs (e.g., trees, lists—only prefixes before **|** are combined):
+
+```javascript
+allElements = [...new Set(Array.from(document.body.querySelectorAll('*')).map(x => x.id).filter(x => x).map(x => x.split('|')[0]))];
+```
+
+1. **Verify behavior** in the target environment—the **routing, extension, and offset** parameters affect the final chapter name.
+
+## Special cases
+
+- For **elements without an ID**, the **noid.md** chapter opens (or noid.(extension) from the configuration)
+- Test on different pages/forms according to the application architecture
+
+## Debugging and tips
+
+1. If the ❔ item is missing, check **hvHelpFile** in the console: console.log(hvHelpFile).
+2. Is the name of the opened chapter incorrect, or is no chapter text displayed? Verify the element ID under the cursor and the offset/routing/extension configuration. Also verify that you have created the chapter file in the help.
+3. Use **\$/index.html** for standalone deployment with the application—**\$** here denotes a relative path relative to the current application URI (the tab from which the ❔ command was launched).
+4. Security: The plugin runs in an isolated context and does not affect the application.
+
+[PluginR]: ?d=https://raw.githubusercontent.com/HelpViewer/PluginChromeHelpViewer/master/ "PluginChromeHelpViewer"
diff --git a/en/files.lst b/en/files.lst
@@ -34,3 +34,4 @@ sectionList.md|Sections list
 print.md|Print
 export.md|Export
 admonitions.md|Admonitions
+contextHelp.md|Contextual help for the web
diff --git a/en/keywords-files.lst b/en/keywords-files.lst
@@ -30,3 +30,4 @@
 26
 34
 35
+36
diff --git a/en/keywords.lst b/en/keywords.lst
@@ -30,3 +30,4 @@ Link;Hyperlink
 Branding;Visual;Brand;Identity
 Export
 Admonition;warning;Block;info block;marking;highlight;callouts;callout block
+Context;Contextual;What is here
diff --git a/en/tree.lst b/en/tree.lst
@@ -30,4 +30,5 @@ Publishing of help|Publishing of help||publish.md
 📥 Export|Export||export.md
 🌐 New language|New language||newLang.md
 🤝 Integration with application|Integration with application||integration.md
+ ❔ Contextual help for the web|Contextual help for the web||contextHelp.md
 💬 User group|Discord user group||https://discord.gg/J2SjcmqHSZ

Original file line number	Diff line number	Diff line change
`@@ -30,3 +30,4 @@`
`30`	`30`	`26`
`31`	`31`	`34`
`32`	`32`	`35`
	`33`	`+36`