If you incorporate MadCap Feedback into your Flare project and generate HTML Help output, a Web toolbar is automatically added to the top of each topic in the CHM file. However, this toolbar is not only for MadCap Feedback. Even if you are not using MadCap Feedback in your project, you can add the Web toolbar to your HTML Help output. See Adding a Web Toolbar to HTML Help Output.
In addition to submitting topic ratings and comments, the default buttons in the Web toolbar let users expand or collapse Dynamic HTML effects (e.g., drop-down text, expanding text), search, go to the next or previous topic, and more. You can change the buttons included in the Web toolbar, removing ones you do not want and adding others.
How to specify custom toolbar settings for HTML Help output
After adding the Web toolbar for HTML Help output, complete the following steps.
to move items from the "Available" section to the "Selected" section.The number of options available depends on whether you are working in a Standard skin or a WebHelp Mobile Skin. The WebHelp Mobile skin only includes the following options: PreviousTopic, CurrentTopicIndex, NextTopic, CollapseAll, ExpandAll, Separator.
Below are descriptions of the various items.
AddTopicToFavorites Lets users add the active topic to the Favorites pane so that they can quickly access the topic in the future.
Back Lets users open the topic that was viewed previously.
CollapseAll Lets users collapse all elements such as togglers, drop-down effects, and expanding text effects in a topic (if they are expanded).
CurrentTopicIndex Lets users see the display for the current topic in the sequence. This label is typically used in conjunction with the "NextTopic" and "PreviousTopic" buttons when the topic in question exists in a browse sequence. Flare finds the current topic in a browse sequence and display its position in relation to the rest of the topics in that sequence. (The root node is used to determine the count; in other words, if there are "child" topics in the sequence structure under the current topic, they will be included in the count.)
EditUserProfile Lets users edit their Feedback registration profile settings.
ExpandAll Lets users expand all elements such as togglers, drop-down effects, and expanding text effects in a topic (if they are not yet expanded).
Forward Lets users open the next topic in a previously viewed sequence.
Home Lets users open a designated home page (such as your company's website).
Next Topic Lets users open the next topic in the sequence. First, Flare attempts to find the current topic in a browse sequence and navigate to the next topic from there. If you do not have a browse sequence, Flare looks at the position of the current topic in your table of contents (TOC) and opens the next topic after it.
Previous Topic Lets users open the previous topic in the sequence. First, Flare attempts to find the current topic in a browse sequence and navigate to the previous topic from there. If you do not have a browse sequence, Flare looks at the position of the current topic in your table of contents (TOC) and opens the previous topic before it.
Print Lets users open the Print dialog so that they can send the open topic to the printer.
QuickSearch Lets users initiate a search in the active topic for the word or phrase that has been typed in the field next to the button.
Refresh Lets users update the content of the topic being viewed.
RemoveHighlight After a user performs a quick search in a topic, the search text found in the topic is highlighted. This button lets users turn the highlights off.
SelectBrowseSequence Lets users open the Browse Sequence feature.
SelectFavorites Lets users open the Favorites feature.
SelectGlossary Lets users open the Glossary feature.
SelectIndex Lets users open the Index feature.
SelectSearch Lets users open the Search feature.
Note: The "Select TOC" and "Select Search" buttons are not supported in DotNet Help and HTML Help outputs.
SelectTOC Lets users open the TOC feature.
Note: The "Select TOC" and "Select Search" buttons are not supported in DotNet Help and HTML Help outputs.
Stop Lets users prevent a page from downloading file information.
ToggleNavigationPane Lets users toggle between hiding and showing the navigation pane in the output window.
TopicRatings Lets users submit ratings for a topic (if you have incorporated your output with MadCap Feedback).
| Opens the New Toolbar Button dialog, which lets you add a custom button to the toolbar. After creating the custom button, select it and click Unless you specify otherwise, in the output the new button will display the text for the name you gave it. However, you can change this by editing the control type for the new button. To do this, you can select the Styles tab in the Skin Editor, expand the Type property group, and from the ControlType field select Button. To choose an image for the button, expand the General property group on the Styles tab and select image files in the Icon fields. If you want to provide a command for the custom button (e.g., so that clicking the button opens a website), you can select the Styles tab in the Skin Editor, expand the Type property group, and enter a command in the OnClick field. For example, the following command opens the MadCap Software website when a user clicks the button:
Alternatively, you can use the JavaScript area to enter a command for the button. See the next step. |
| Removes the selected custom button from the "Available" section. |
| Moves the selected item up in the order in the "Selected" section. In the output, buttons are displayed left to right according to the order in which they appear on this tab, with the item at the top being the first button shown on the left in the output. |
| Moves the selected item down in the order in the "Selected" section. |
| Removes the selected item(s) from the "Selected" section. |
| Adds a separator to the "Selected" section. A separator is the divider between the toolbar buttons and the navigation pane. |
| Resets the toolbar to the default settings. |
(Optional) If you want to include custom JavaScript in the toolbar, click Edit in the area to the right. This opens the Toolbar JavaScript dialog, which you can use to enter or load custom JavaScript for the toolbar.
For example, the following command opens the MadCap Software website when a user clicks the button:
function MyFunction()
{
window.open("http://www.madcapsoftware.com");
}
to save your work.Note: You can also specify which buttons should be included in the navigation toolbar at the top of the CHM window. See Specifying Buttons for HTML Help Output.
Note: You can also add a Web toolbar that is displayed within topic content. This can be done with the help of a topic toolbar proxy.
Make sure that you associate the skin with the target.