Inserting Topic Toolbar Proxies

example

Let's say you want to add "Next" and "Previous" buttons, as well as the "Home" button, at the bottom of each topic in your WebHelp output. First, you open your skin and select the Topic Toolbar tab. The default settings already include the "NextTopic," "CurrentTopicIndex," and "PreviousTopic" items.

First, you select CurrentTopic Index in the "Selected" section and click at the bottom of the tab. This moves that item back to the "Available" section on the left.

Next, you select the Home item and click to move it to the "Selected" section.

Now that the settings in the Skin Editor are completed, you can save your changes and insert the topic toolbar proxy. If you had wanted the custom toolbar to display in only a few topics, you would probably insert the proxy directly into those topics. However, because you want the toolbar to display at the bottom of every topic, the best way to accomplish this is to insert the proxy into a master page.

After making sure both the skin and the master page are associated with the WebHelp target, you can generate the output.

Suppose you have created your own arrow images and want to use them instead of the images provided by Flare. You can simply select your image files in the Styles tab of the Skin Editor.

Afterwards, the output might look something like this:

1. Do one of the following:

   • Open a topic where you want the toolbar to appear. This is a good method if you only want the toolbar to be shown in one topic, or just a few topics. See Opening Topics.

     OR

   • Open a master page that you will use when generating the target. This is the best method if you want the toolbar to be shown on all topics in the output. See Opening Master Pages.
2. Place your cursor where you want the toolbar to be shown in the output (e.g., bottom or top of the topic or master page). If you are working in a master page, you may need to press the down arrow on your keyboard and then press Enter at the correct location.

3. Select Insert>Proxy>Insert Topic Toolbar Proxy.

   The Topic Toolbar Proxy dialog opens.

4. (Optional) In the Stylesheet class for proxy field, you can select a class to affect the look of the entire toolbar.

   You might create and use a proxy style class, for example, if you want to add a border around the toolbar. If you do not select a class from this field, the generated toolbar will use the style settings from the parent <MadCap|topicToolbarProxy> style. You have the option of creating a class for this proxy style in the Stylesheet Editor. To do this, select the MadCap|topicToolbarProxy style and click Add Class to create a class. The class will then be available from this field.

5. (Optional) The topic toolbar proxy will use whatever settings are specified on the Topic Toolbar tab in the Skin Editor. However, you can override those settings for an individual proxy.
   1. Click Select buttons.

   2. You can select specific features (buttons) below to include in the toolbar. You can select one or more buttons from the Available section (select multiple buttons by pressing the SHIFT or CTRL key and clicking a range or individual buttons, respectively). Then click to move the button(s) to the Selected section. (If you do not select "Enable Custom Layout," all of the available buttons will be used in the toolbar in the output.)

      • 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. See About MadCap Feedback and Specifying Fields for the Create Feedback Service Profile dialog.

        

      • 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). See About MadCap Feedback and How End Users Submit Topic Ratings.

        
        

   3. Click OK when you are finished.

6. Click OK.

   The proxy is added.

7. Press CTRL+S or click to save your work.