Pseudo Code for WebServer Generated HTML based Help for WebForms
================================================================
Concept from Peter Koletzke
---------------------------
How to provide HTML help for a Forms application? I have not done hands-on experimenting, but I've seen it in production at a client site. All they do is have the HTML docs out there on the app server and use SHOW_DOCUMENT in web forms to issue the URL to the browser.
What about Designer-genning a WebServer app that queries the help text from the Designer repository or another table. No need to do MS Help and convert HLP to HTML. Combine that with the SHOW_DOCUMENT call in Forms and you have your help system.
Approach from Sunil Godithi
---------------------------
-- In Key-Help Trigger
-- Either Call a standard help routine or let Designer add the standard
routine
-- using the HELPFORM preference NOT MS HELP for Type of Help
-- Example:
CGHP$CALL_HELP_FORM(
'ofg4hlpf' /* IN : Help form name */
,'HT100' /* IN : Module name */
,'HTS' /* IN : Application name */
,'Hotline Tracking' /* IN : Title_1 */
,'' ); /* IN : Title_2 */
-- Modify procedure CGHP$CALL_HELP_FORM in ofg4tel.pll library supplied by Designer2K
-- Or write a similar one
--
-- Logic:
-- If user interface is WEB based
-- This procedure will built the URL on the fly and use Show_document to
-- display the page.
-- Prerequisite:
-- A Web Server Generator based Module using the Application's Help table
-- (similar or same as CG_REF_HELP
-- table generated by Designer). This HTML Module should expect following
-- parameters:
-- Block_Name
-- Item_Name
-- help_table
-- Module name
-- Application name
-- Title_1 like 'Hotline System'
-- Title_2 like 'Issue tracking system of USACE'
--
-- Else for all other interface types like MSWINDOWS and such, use the standard
-- forms based help.
Using HTML Help from inside Web Forms (and/or Client Server Forms) using
Microsoft HTML Help Compiler:
-- Convert Current Help file to HTML Help.
-- Add to WinAPI Library a wrapper for HtmlHelpA Function in HHCTRL.OCX.
-- Modify the Headstart's CALL_MS_HELP routine to accept an extra variable
-- which determines if the system used HTML HELP or Standard HLP.
-- Modify CALL_MS_HELP to Use SHOW_DOCUMENT if User_Interface = 'WEB' and USER_HTML = 'Y'
-- Modify CALL_MS_HELP to Use HTMLHELP if User_Interface = 'WINDOWS32'and USER_HTML = 'Y'