Advanced\Help APIHelp API\Web Help API

Web Help API

Web Help API can be called via command line.  The Web Help System will be opened by the browser installed on the client computer.  Currently it supports Microsoft Internet Explorer 6 to 10, Mozilla Firefox, Google Chrome, Apple Safari  and Opera.

You can open the URL via command line or ShellExecute of WinAPI.

The URL:

·         http://www.sample.com/webhelp/index.html

·         http://www.sample.com/webhelp/index.html#!parameters

The parameters:

·         Open a specify topic via file name

/index.html#!url=topic1.htm or

/index.html#!topic2.htm

·         Open a specify topic via HelpId (mapid)

/index.html#!id=1000 or

/index.html#!1001

·         Open a specify topic via Alias

/index.html#!id=topic1 or

/index.html#!topic2

·         Open Search tab

/index.html#!search=keyword1 or

/index.html#!search=keyword2#!display=0

·         Open Index tab

/index.html#!-index or

/index.html#!index=0

·         Open a specify topic for special action

/index.html#!xxxx#!-alone or

/index.html#!xxxx#!-print or

/index.html#!xxxx#!-close or

/index.html#!xxxx#!-alone#!-print#!-close

·         Open a specify topic without HelpId and Alias

/index.html#!i=0 or

/index.htlm#!1

·          Open a specify topic with anchor

/index.html#!xxxx#anchor1

 

Top of Page