A framework that the web tools could use to easily provide information about help, demo and new features. The aim is that any new user visiting a tool should become familiar with the tool quickly and should have a low barrier to understand the tool.
- [WebHelp]
WebHelp
- WebHelp :
object
Kind: global class
this: WebHelp
new WebHelp
Creates the WebHelp object with the specified settings
| Param | Type | Default | Description |
|---|---|---|---|
| WebHelpOptions | Object |
The configuration options for WebHelp | |
| [WebHelpOptions.appName] | String |
'DefaultApp' |
The App name that you wish to use for your app |
| [WebHelpOptions.sequencesBaseUrl] | String |
'/WebHelp/' |
The URL you wish to pull your sequence file from |
| [WebHelpOptions.visitedBaseUrl] | String |
'/weblications/etc/getPrefs.epl' |
The URL you wish to pull your visited sequences from |
| [WebHelpOptions.usesFontAwesome] | Boolean |
false |
Does your app use Font Awesome ? (Defaults to bootstrap glyphicons if not) |
| [WebHelpOptions.usesIframes] | Boolean |
false |
Does your app use iframes ? (Used for some additional workarounds) |
| [WebHelpOptions.usesFlexbox] | Boolean |
false |
Does your app use flexbox ? (Used for some additional workarounds) |
Kind: global namespace
- WebHelp :
object
Programmatically trigger the sequence list modal when in consumption mode
Kind: instance method of WebHelp
Access: public
Get a list of all visited sequences by sequence ID
Kind: instance method of WebHelp
Returns: Array - A deep clone of the viewed sequence ID list
Access: public
Get the sequence ID for a given sequence name
Kind: instance method of WebHelp
Returns: int - The sequence ID The ID of the sequence
Access: public
| Param | Type | Description |
|---|---|---|
| sequenceName | String |
The name of the sequence |
Get the sequence name for a given sequence ID
Kind: instance method of WebHelp
Returns: String - sequenceName The sequence name
Access: public
| Param | Type | Description |
|---|---|---|
| sequenceId | int |
The sequence ID |
Given a seqence ID or name, check if the sequence has been previously seen or not
Kind: instance method of WebHelp
Returns: Boolean - Whether the sequence has been previously viewed
Access: public
| Param | Type | Description |
|---|---|---|
| options | Object |
The options object |
| [options.seqId] | int |
The sequence ID for the given sequence |
| [options.seqName] | String |
The sequence name for the given sequence |
Play a sequence programmatically given its identifier (name or ID)
Kind: instance method of WebHelp
this: WebHelp
Access: public
| Param | Type | Description |
|---|---|---|
| nameOrId | String | int |
The sequence name or ID for a given sequence - Name preferred |