Następujący tekst opisuje, w jaki sposób w uruchomionej aplikacji (w runtime) można uruchamiać pomoc, która może być napisana w następujących formatach:
- Plik z rozszerzeniem HLP. Chodzi o przestarzały lecz wciąż stosowany format, w którym znajduje się strukturowana dokumentacja. Plik zawiera w sobie wiele dokumentów tekstowych określanych przez numer. Plik HLP można wytworzyć na przykład przy pomocy oprogramowania Microsoft Help, itd.
- Plik z rozszerzeniem CHM. Chodzi o dokumentację strukturowaną. Plik zawiera w sobie wiele dokumentów HTML określonych przez ścieżkę do nich. Plik CMH można wytworzyć na przykład przy pomocy oprogramowania Microsoft HtmlHelp, itd. W tym formacie jest pisana cała dokumentacja systemu PROMOTIC (plik PromoticPl.chm).
- Plik z rozszerzeniem HTM. Jest to HTML dokument o jednej stronie.
1) Globalne określenia pliku pomocy:
W obiekcie
PmaRoot znajduje się konfigurator "
Ścieżka do pomocy runtime".
Jeżeli w aplikacji zachodzi potrzeba stosowania tylko jednego pliku
CHM (
HLP), wtedy jest to odpowiednim miejscem do określenia ścieżki do niego.
W przypadku dokumentacji PROMOTIC w tym miejscu znajdował by się tekst na przykład
C:\Promotic\PmVXXYY\PromoticPl.chm.
2) Konfiguracja pomocy dla konkretnego panelu graficznego:
W obiekcie
PmaPanel znajduje się konfigurator "
PmaPanel > Panel > Temat pomocy panela". W tym miejscu można wprowadzić identyfikator wewnętrznego dokumentu, który zostanie wyświetlony, jeżeli w panelu (jeżeli jest aktywny) naciśnij klawisz F1. W przypadku pliku CHM wprowadzana powinna być ścieżka (w przypadku pliku HLP - numer) dokumentu wewnętrznego. Na przykład jeżeli chciałbyś wyświetlić opis obiektu
PmaData w
PromoticPl.chm, wtedy chodziłoby o ścieżkę:
/pmdoc/Objects/Promotic/PmaData/Desc.htm. (Żeby takie ustawienie funkcjonowało, to musi być odpowiednio ustawiony konfigurator z punktu 1).
3) Otwarcie pomocy w skrypcie:
Konkretną stronę pomocy można otworzyć przy pomocy metody
Pm.ShowHelp.
Przykład1:
JavaScriptVBScriptWybierz oraz skopiuj do schowka
// Przypadek, kiedy nie musi być wypełniony konfigurator z punktu 1)
Pm.ShowHelp("C:\\Promotic\\PmVXXYY\\PromoticPl.chm", "/pmdoc/Objects/Promotic/PmaData/Desc.htm");
// Przypadek, kiedy musi być wypełniony konfigurator z punktu 1)
Pm.ShowHelp("", "/pmdoc/Objects/Promotic/PmaData/Desc.htm");
' Przypadek, kiedy nie musi być wypełniony konfigurator z punktu 1)
Pm.ShowHelp "C:\Promotic\PmVXXYY\PromoticPl.chm", "/pmdoc/Objects/Promotic/PmaData/Desc.htm"
' Przypadek, kiedy musi być wypełniony konfigurator z punktu 1)
Pm.ShowHelp "", "/pmdoc/Objects/Promotic/PmaData/Desc.htm"Pomoc można otworzyć również przy pomocy metody
Pm.ShellExecute. Na przykład:
W ten sposób można wprwdzie określić, w jaki sposób ma zostać wyświetlona pomoc (maksymalizowana, normalna, itd.), lecz nie można określić dokumentu wewnętrznego. Z tego powodu ten sposób jest bardziej dogodny do przeglądania jednego dokumentu HTML.