Help Module

Overview

The Help module allows power users to create and maintain context-sensitive help within QBO. For example, as new workflows are created, power users can create a help page for their users that describes the business context of the workflow. 

When a Help popup is rendered, if the user has HelpEdit permissions, the help topic will be a hyperlink that will open a new tab on the Help Summary page so the user can edit the content.

Help entries are based on three key data points:
  • ApplicationPage: (a relative URL)
  • Object/ObjectID: for template-specific help, these columns bind a Help entry to a specific template
When the basic help delegate is used (see examples below), you are welcome to specify these data points explicitly. If you do not specify them, the delegate will calculate the ApplicationPage as:

document.location.href.substring(document.baseURI.length)

which is essentially {Project}/{Module}.ashx/{Operation}

Recommended usage

In Breadcrumbs

A help icon should be placed at the end of a breadcrumb on Home and Summary pages to render help for the URL the user is viewing. 

<ul class="breadcrumb">
<li>
<xsl:text>Dashboards</xsl:text>
<span class="divider">/</span>
</li>
<li>
<xsl:text>Scoring</xsl:text>
</li>
<i class="pull-right icon-question-sign" data-trigger="help"></i>
</ul>

In Panels

A help menu item should be placed in panels (typically *.Search.xslt) to render help in using the panel. For example, from Attachment.Search.xslt and Attachment.ListByTemplate.xslt:

<li data-trigger="help" data-help-options="{{ 'page': 'Attachment/Attachment.ashx/Search' }}">
<a>
<i class="icon-question-sign" />
<xsl:text> Help</xsl:text>
</a>
</li>

Note in this example, there are two 'views' (XSLTs) that can be rendered in the same panel, so both should render the same help content.

With Templates

Templated modules such a Decision, Ledger and Score should offer template specific help. For example, the DecisionTemplate.Select.xslt has:

<li data-trigger="help" data-help-options="{{ 'help': '{DecisionTemplate}', 'page': 'Decision/Decision.ashx/Summary', 'object': 'DecisionTemplate', 'id': '{DecisionTemplateID}' }}">
<a>
<i class="icon-question-sign" />
<xsl:text> Help</xsl:text>
</a>
</li>

while the corresponding entry in the DecisionStep.Search.xslt has:

<li data-trigger="help" data-help-options="{{ 'help': '{//Decision[1]}', 'page': 'Decision/Decision.ashx/Summary', 'object': 'DecisionTemplate', 'id': '{//DecisionTemplateID[1]}' }}">
<a>
<i class="icon-question-sign" />
<xsl:text> Help</xsl:text>
</a>
</li>



Comments