Online-Hilfe für Makro-Bausteine schreiben

In iCon-L besitzen in der Regel alle Funktionsbausteine eine Online-Hilfe. Die Hilfe für den Baustein wird über das Kontext-Menü des Bausteins aufgerufen. Die Hilfeinhalte für die einzelnen Bausteine sind in Baustein-Bibliothek organisiert. Für jede Bausteinbibliothek existiert also eine Hilfedatei. Die jeweilige Hilfe für den einzelnen Baustein wird dann über Einsprunkpunkte adressiert.

Den gleichen Mechanismus kann man auch für Bibliotheksprojekte nutzen. Man kann also für jedes Makro in einem solchen Bibliothekprojekt einen eigene Hilfe bereitstellen.

In iCon-L werden aktuell *.chm Dateien für die Bereitstellung der Hilfen verwendet.

Um einen einzelnen Baustein adressieren zu können, müssen die Einsprungpunkte nach festgelegten Konventionen definiert werden.

 keyword=<Bausteinnamebzw.Makro>-Modul
 displaytitle=Kurzname
 linktag=IDX_<Bausteinname>
 

Wichtig : Bei keyword muss auf jeden Fall die Erweiterung -Modul hinter dem Bausteinnamen stehen.

ProSign nutzt aktuell das kommerzielle Tool „Doc2Help 2008“ zur Erzeung der Hilfe (lizenzpflichtig)

Damit das iCon-L Hilfesystem auch Makro-Bausteine berücksichtig, muß iCon-L entsprechen konfiguriert werden.

Entweder globale in der icon.ini Datei im BIN-Verzeichnis von iCon-L oder aber der projektspezifischen Konfiguration <projektname>.IWS Datei.

[system]
... 
sblockhelp=On
...