A Menu proxy allows you to create a menu based on your TOC file, allowing users to navigate to other topics. This proxy can be especially useful if you are creating HTML5 output and you want a context-sensitive menu to display next to each topic. When you build the output, the proxy is replaced with the generated menu.
- Open a master page that you will use when generating the target.
- Place your cursor where you want the menu to be shown in the output. You may need to press the down arrow on your keyboard and then press Enter at the correct location.
- Select Insert > Proxy > Insert Menu Proxy. The Menu Proxy dialog opens.
You can select the following options:
Use TOC, Browse Sequence, or Headings If you have more than one TOC file in your project, you can select the one that the Menu proxy should use. It is most common to base a menu on a TOC, but you can also select a browse sequence.
You also have the option of selecting “Headings,” which will display topic headings in the side menu instead. In other words, any headings or subheadings (e.g., h1, h2, h3, h4) that you’ve included in a topic will be shown in the side menu instead of other topics in the output.
Also, when viewing a topic that is set up like this—and the menu is fixed in place—each sub-heading section will be highlighted as you scroll down in the topic.
Context sensitive Select this check box if you want the menu to show only closely related entries in the TOC. In Flare's Top Navigation project templates, this kind of proxy was inserted into a master page to create a side menu for most of the topics in the output.
If you do not make the menu context-sensitive, it displays everything in the TOC (depending on the depth level you select).
Include parent If you have selected the Context sensitive option, you can select this check box to include the parent TOC item in the menu.
Include siblings If you have selected the Context sensitive option, you can select this check box to include TOC items in the menu that are on the same level as the open topic.
Include children If you have selected the Context sensitive option, you can select this check box to include TOC items in the menu that are children of the topic that is open.
- Levels to Show (Depth) This lets you choose how many levels of items deep in the TOC to include in the menu. If the Context sensitive option is disabled, this refers to the depth level overall for the TOC. If both the Context sensitive and the Include children options are enabled, it refers to the number of levels under the topic that is open.
Skin File If you have added a Menu skin component to your project and want to use it to control the look of the menu, you can select it from this field.
See Editing Skin Settings and HTML5 Skin Styles.
If you do not select a Menu skin component in this field, Flare uses the first one it finds in your project (if one exists). Otherwise, Flare provides a default design.
- Click OK. The proxy is added.
- Click to save your work.
After inserting a Menu proxy, you can edit it. To do this, open the topic or master page where the proxy is inserted, right-click on it, and select Edit Menu Proxy.
If you use a Menu skin component and proxy to include a topic menu in your HTML5 Top Navigation output, you can set that menu to be fixed in place. You can set a fixed menu for web, tablet, or mobile screens (or all of them).