KSSW Html Help Workshop

Das Html Help API

API: Application Program Interface
Das API ist eine Schnittstelle über die zwei Programme kommunizieren.

Soll der Help-Viewer an ein anderes Programm angebunden werden wie zum Beispiel eine Hilfe-Datei eines Softwareproduktes, so erfolg dies in der Regel über eine definierte Schnittstelle, das API.

Anbindung der Dokumentation ohne API

Falls keine kontextsensitive Hilfe benötigt wird, und der Help-Viewer nur gestartet werden soll so genügt der Aufruf des Help-Viewers vom Aufrufenden Programm. Beim Windos-Betriebssystem erfolgt dies durch die Windows-Funktion "ShellExecute".

Beispiel für C/C++

HINSTANCE hInst = ShellExecute(NULL, "open", sViewerPathFile, NULL, NULL,
SW_SHOWNORMAL);

Hinweis:
Für andere Programmiersprachen wie z.B.: Visual Basic, C# existiert eine gleichnamige Funktionen

Anzeige einer bestimmten Html-Datei

Die Funktion ShellExecute bietet die Möglichkeit einen Laufzeitparameter mit zu übergeben. Der KSSW-HelpViewer interpretiert diesen Parameter als anzuzeigende Html-Datei

Beispiel für ein C/C++ MB/ANIS Programm

// Programmcode für C/C++:
// HelpViewer: MyHelpViewer.exe (im gleichen Ordner wie das
//  aufrufende Programm)
// Anzuzeigende Html-Datei: help/myindex.html


char sViewer[] = "MyHelpViewer.exe";
char sParam[] = "help/myindex.html";
ShellExecute(NULL, "open", sViewer, sParam, NULL, SW_SHOWNORMAL);

Gleiches Beispiel für ein C/C++ Unicode Programm

// Programmcode für C/C++:
// HelpViewer: MyHelpViewer.exe (im gleichen Ordner wie das
//  aufrufende Programm)
// Anzuzeigende Html-Datei: help/myindex.html


wchar_t sViewer[] = _T("MyHelpViewer.exe");
wchar_t sParam[] = _T("help/myindex.html");
ShellExecute(NULL,_T("open"),sViewer,sParam,NULL,SW_SHOWNORMAL);

Die Help API Lib

Dem KSSW Html Help Workshop liegen statische C/C++ Bibliotheken (.lib) bei, die eine komfortable Anbindung an ein Softwareprojekt ermöglichen.

KSSW-HViewer-API_A_D.lib		ANSI/MB, MFC-Dll, Release
KSSW-HViewer-API_A_D_D.lib		ANSI/MB, MFC-Dll, Debug
KSSW-HViewer-API_A_S.lib		ANSI/MB, MFC statisch, Release
KSSW-HViewer-API_A_S_D.lib		ANSI/MB, MFC statisch, Debug
KSSW-HViewer-API_W_D.lib		UNICODE, MFC-Dll, Release
KSSW-HViewer-API_W_D_D.lib		UNICODE, MFC-Dll, Debug
KSSW-HViewer-API_W_S.lib		UNICODE, MFC statisch, Release
KSSW-HViewer-API_W_S_D.lib		UNICODE, MFC statisch, Debug

Die API Deklaration

Die API-Deklaration befindet sich in der beigefügten Header-Datei "KSSW-HelpViewerAPI.h"

// HelpViewer-API initialisieren:
//   LPCWSTR/LPCSTR sViewerPath: Pfad-Dateiname zum HelpViewer
//   LPCWSTR/LPCSTR sViewerTitle: beliebiger Titel (Viewer-Name)
//   HWND hWndMain:  Hwnd des Hauptfensters dieser Applikation
void WINAPI KSSW_HelpViewerAPI_Init(LPCWSTR sViewerPath,LPCWSTR sViewerTitle,
HWND hWndMain);


// Viewer öffnen
void WINAPI KSSW_HelpViewerAPI_OpenViewer();


// Viewer schliessen
void WINAPI KSSW_HelpViewerAPI_CloseViewer();


// Ein Help-Viewer starten und Html-Dokument im Viewer anzeigen. Das Html-
//   Dokument wird in den Laufzeitparametern übergeben
//   LPCWSTR/LPCSTR: anzuzeigendes Help-Dokument
void WINAPI KSSW_HelpViewerAPI_OpenShowHtmlFile(LPCWSTR sHtmlFile);


// Ein Html-Dokument im Viewer anzeigen (ggf wird der Help-Viewer gestartet)
//   LPCWSTR/LPCSTR: anzuzeigendes Help-Dokument
void WINAPI KSSW_HelpViewerAPI_ShowHtmlFile(LPCWSTR sHtmlFile);


void WINAPI KSSW_HelpViewerAPI_ShowHelpIP(int nHelpID);

Frontend Menu Creator
Frontend Menu Creator für CD / DVD oder USB erstellen. KSSW-FrontendMenu ist so einfach wie Drag&Drop.

KSSW-Frontendmenu

Autorun CD Menu Creator
Fügen Sie Ihrer CD-, DVD-, USB-Präsentation ein professionelles Autorun Menü hinzu.

CDMenuPro

Help Authoring Tool

Html Help Workshop

Bedienung

Html Help API

Der Help-Viewer

Über KSSW Html Help Workshop

Über KS-SW