Následující text popíše, jak ve spuštěné aplikaci (v runtime) spouštět nápovědy, které jsou napsány v následujících formátech:
- Soubor s příponou HLP. Je to zastaralý ale používaný formát, ve kterém je strukturovaná dokumentace. Soubor v sobě obsahuje více textových dokumentů identifikovaných číslem. Soubor HLP lze vytvořit například pomocí programu Microsoft Help, atd.
- Soubor s příponou CHM. Je to strukturovaná dokumentace. Soubor v sobě obsahuje více HTML dokumentů identifikovaných cestou. Soubor CMH lze vytvořit například pomocí programu Microsoft HtmlHelp, atd. V tomto formátu je psána celá dokumentace systému PROMOTIC (soubor PromoticCs.chm).
- Soubor s příponou HTM. Je to HTML dokument o jedné stránce.
1) Globální zadání help souboru:
V objektu
PmaRoot je konfigurátor "
Cesta k runtime helpům".
Pokud chcete v aplikaci používat pouze jeden
CHM (
HLP) soubor, pak je zde vhodné k němu zadat cestu.
V případě elektronické dokumentace PROMOTIC by se zde napsalo například
C:\Promotic\PmVXXYY\PromoticCs.chm.
2) Konfigurace nápovědy pro konkrétní obraz:
V objektu
PmaPanel je konfigurátor "
PmaPanel > Obraz > Téma nápovědy obrazu". Zde lze zadat identifikátor vnitřního dokumentu, který se zobrazí, pokud v obrazu (pokud je aktivní) stiskněte klávesu F1. V případě CHM souboru se zde zadává cesta (v případě souboru HLP - číslo) k vnitřnímu dokumentu. Například pokud byste chtěli zobrazit popis objektu
PmaData v
PromoticCs.chm, pak by to byla cesta:
/pmdoc/Objects/Promotic/PmaData/Desc.htm. (Aby to fungovalo, musí být nastaven konfigurátor z bodu 1).
3) Otevření nápovědy ve skriptu:
Konkrétní nápovědu můžete otevřít metodou
Pm.ShowHelp.
Příklad1:
JavaScriptVBScriptVyber a zkopíruj do schránky
// Případ kdy nemusí být vyplněn konfigurátor z bodu 1)
Pm.ShowHelp("C:\\Promotic\\PmVXXYY\\PromoticCs.chm", "/pmdoc/Objects/Promotic/PmaData/Desc.htm");
// Případ kdy musí být vyplněn konfigurátor z bodu 1)
Pm.ShowHelp("", "/pmdoc/Objects/Promotic/PmaData/Desc.htm");
' Případ kdy nemusí být vyplněn konfigurátor z bodu 1)
Pm.ShowHelp "C:\Promotic\PmVXXYY\PromoticCs.chm", "/pmdoc/Objects/Promotic/PmaData/Desc.htm"
' Případ kdy musí být vyplněn konfigurátor z bodu 1)
Pm.ShowHelp "", "/pmdoc/Objects/Promotic/PmaData/Desc.htm"Nápovědu lze také otevřít metodou
Pm.ShellExecute. Například:
Zde lze sice zadat, jak se help má objevit (maximalizovaně, normálně, atd.), ale nelze zadat vnitřní dokument. Hodí se proto spíše pro prohlížení jednoho HTM dokumentu.