Skip to main content
MindTouch Success Center

Configure global contextual help options

This page applies to:MindTouch (current)

DEPRECATED! This page has been deprecated. Content on this page is no longer supported. Please contact Support or search our Success Center for supported solutions.

The following table lists the contextual help configuration fields. These fields can be used for the global contextual help configuration when opening the contextual help dialog programmatically.
 

Field Options

Field Name Type Description
host string Hostname of the MindTouch documentation site (default: 'help.mindtouch.us').
page string

Page path to start page in the dialog (default: '/').

page number Page ID to start page in the dialog.
page function Callback invoked on the context of the element clicked (when available).  Returned value must either be a string or a number.
home string Page path to associated with the Home button (default: '/').
home number Page ID to associate with the Home button.
selector string jQuery selector used for binding the open dialog command (default '.F1').
stylesheet string Link to stylesheet for help dialog. Included by all browsers.
stylesheetIE string Link to stylesheet for help dialog. Included by all versions of Microsoft Internet Explorer.
stylesheetIE6 string Link to stylesheet for help dialog. Included only by Microsoft Internet Explorer 6.x.
stylesheetIE7 string Link to stylesheet for help dialog. Included only by Microsoft Internet Explorer 7.x.
stylesheetIE8 string Link to stylesheet for help dialog. Included only by Microsoft Internet Explorer 8.x.
stylesheetIE9 string Link to stylesheet for help dialog. Included only by Microsoft Internet Explorer 9.x.
contentStylesheet string Link to stylesheet for page content. Included by all browsers.
contentStylesheetIE string Link to stylesheet for page content. Included by all versions of Microsoft Internet Explorer.
contentStylesheetIE6 string Link to stylesheet for page content. Included only by Microsoft Internet Explorer 6.x.
contentStylesheetIE7 string Link to stylesheet for page content. Included only by Microsoft Internet Explorer 7.x.
contentStylesheetIE8 string Link to stylesheet for page content. Included only by Microsoft Internet Explorer 8.x.
contentStylesheetIE9 string Link to stylesheet for page content.Included only by Microsoft Internet Explorer 9.x.
width number Dialog width in pixels (default: 828).
height number Dialog height in pixels (default: 600).
text object Object to customize labels in the modal dialog.
onOpen function Callback function invoked when the dialog is about to open (default: null).
onClose function Callback function invoked when the dialog has closed (default: null).
$ function Callback function mapped to jQuery (default: window.jQuery).
version string (read-only) MindTouch F1 script version. Format is minor.mabjor.release (e.g. '1.0.0').

 

 



 

  • Was this article helpful?