A proxy acts as a placeholder for auto-generated content or content that you have created elsewhere. When you build output, the content takes the place of that proxy. Proxies can be added to regular topics
- Body A Body proxy is a placeholder for content from your topics. If you manually enter additional content above the Body proxy bar in the master page, the content will display as a header (above the topic body) in the output. If you enter the content below the Body proxy bar in the master page, the content will display as a footer (below the topic body) in the output. A Body proxy is also used when you create a master page for Word or FrameMaker output. You can customize the page size, orientation, and margins for the printed pages by editing the Body proxy. If you want all of the pages in your output to share the same settings (page size, margins, etc.), you only need one Body proxy in the master page. However, if you want different pages to have different settings, you can add a Body proxy for each configuration. (If you are using page layouts instead of master pages, you can specify page margins, size, orientation, and other settings in those page layouts instead.) See Creating a Body Proxy.
- Breadcrumbs If a Breadcrumbs proxy is included in a master page, the output will display a "trail of breadcrumbs" composed of the table of contents (TOC) entries above the current topic in the TOC hierarchy. See Creating Breadcrumbs.
- Concepts You can use the Concepts proxy to generate a list of all of the concepts in your project, with links to the corresponding content. See Creating a List of Concepts.
- Endnotes If you intend to consolidate your endnotes at the end of a manual, you can use an Endnotes proxy. This proxy allows you to start the list of endnotes on a new page. See Creating an Endnotes Proxy.
- Glossary If you want your
print-basedoutput to include the glossary from your project, you need to create a topic specifically for this purpose and insert a Glossary proxy into it. See Creating a Glossary Manually for Print.
- Index If you want your
print-basedoutput to include the index from your project, you need to create a topic specifically for this purpose and insert an Index proxy into it. See Creating an Index Manually for Print.
- List-Of You can use the List-Of proxy to generate a list of various types of elements (e.g., tables, images) in your output, with links to the corresponding content. See Creating a List of Elements.
- Menu 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. See Creating a Topic Menu.
- Mini-TOC A Mini-TOC proxy allows you to generate a portion of your table of contents (TOC) or topic headings at a particular location in the output. A Mini-TOC proxy can be used for both online and print-based output. For online output, you can insert a Mini-TOC proxy into a master page or a topic. For print-based output formats, you can insert a Mini-TOC proxy into any topic where you want to generate a small TOC. For example, let's say you want the first page of each chapter in a manual to start out with a small TOC, showing the page numbers where subheadings occur within that chapter. In that case, you can insert a Mini-TOC proxy into each topic that you plan to use as the beginning of each chapter. If you insert the proxy into a master page, each topic using that master page will have a mini-TOC. If you insert the proxy into certain topics only, mini-TOCs will be generated only within those particular topics. See Creating a Mini-TOC.
- Page Footer If you want your
Word or FrameMakeroutput to have footers (to hold content such as text and page numbers), you can accomplish this by inserting a Page Footer proxy into a master page. The Page Footer proxy lets you insert content or automatic page numbering (specifically designated for the first page, even pages, or odd pages) in a master page. Use the Page Footer proxy to insert content and page numbering below the Body proxy. (If you are using page layouts instead of master pages, you can insert footer text, variables, and page numbers into page layout frames instead.) See Adding Page Header and Footer Proxies.
- Page Header If you want your
Word or FrameMakeroutput to have headers (to hold content such as chapter titles and page numbers), you can accomplish this by inserting a Page Header proxy into a master page. The Page Header proxy lets you insert content or automatic page numbering (specifically designated for the first page, even pages, or odd pages) in a master page. Use the Page Header proxy to insert content and page numbering above the Body proxy. (If you are using page layouts instead of master pages, you can insert header text, variables, and page numbers into page layout frames instead.) See Adding Page Header and Footer Proxies.
- Relationships Use this proxy if you want to create topic relationship links in your output. In other words, this kind of link lets users navigate to additional topics that you've determined are related to the current topic. This is similar to related topics links and concept links, except that it can be used for online as well as print-based output. A relationship link is especially designed for DITA users, although you do not need to use DITA or know anything about DITA in order to use relationship links. A relationship table can be created to identify which topics should be linked to one another. You then insert a Relationships proxy into individual topics or a master page. In online output, the end result is one or more hyperlinks that let users quickly open related topics. In print-based output, the end result is one or more references to related topics with the appropriate page number(s). See About Relationship Tables.
- Search Bar A Search Bar proxy allows you to create a field that can be used to perform searches in your output. When you build the output, the proxy is replaced with the generated search bar. See Creating a Search Bar.
- Search Results A Search Results proxy works with the Search Bar proxy and allows you to create a container that is used to display the results of end user searches in your output. When you build the output, the proxy is replaced with the generated search results. See Creating Search Results.
- TOC If you want your
print-basedoutput to include a table of contents (TOC), you need to create a topic specifically for this purpose and insert a TOC proxy into it. By default the TOC for your print-basedoutput is based on the h1 through h6 styles that you have applied to content in your topics. The generated TOC in the print output is NOT necessarily based on the structure of your "outline TOC", but the outline TOCIS used to determine the content to be included in the print-basedoutput. However, there is a switch on the Advanced tab in the Target Editor that lets you base the generated TOC on the structure of your outline TOC. See Creating a TOC Manually for Print.
- Topic Toolbar You can use the topic toolbar proxy to generate a web toolbar anywhere in any topics. This is an alternative (or an additional option) to the regular toolbar that can be included in all online outputs (via the Help Viewer or through the use of skins). The topic toolbar proxy is used to tell Flare where you want the topic toolbar to be displayed in the output. If you want the toolbar to be shown at the top of only a few topics, you can insert the proxy at the top of each of those topics. If you want the toolbar to be shown at the bottom of all topics in your output, you can insert the proxy into a master page to be used for that target. You can even insert the proxy in the middle of text in a topic if you want certain toolbar buttons to be displayed there. See Inserting and Editing a Topic Toolbar Proxy.
Options in the Advanced tab of print-based targets let you automatically add glossary, index, and TOC proxies to output. This means you do not need to create unique topics and insert proxies into them manually. The auto-generate method is much quicker and easier than the manual method. The manual method is more flexible but requires you to perform a number of extra steps, such as creating topics, inserting proxies, and adding files to the outline TOC. So if you simply want to quickly create print output with generated TOCs, glossaries, or indexes, the auto-generate option might be best for you. But if you want more control over the placement and look of the generated TOCs, glossaries, and indexes, you should use the manual method. See Auto-generating Glossaries, Indexes, and TOCs for Print Outputs.
Note: When you generate content from a proxy (e.g., list-of, mini-TOC proxies), keep in mind that some content may not show up in the output if you have used the option in the target to exclude content based on links. See Excluding Content not Linked Directly or Indirectly from Targets.