Outputs Supported
A cross-reference is a dynamic navigation link that lets you connect one topic to another (or a bookmark within a topic). Cross-references are somewhat similar to text hyperlinks. However, cross-references differ from hyperlinks in a few ways. (1) They are based on format commands that help you keep the look of links consistent, using the MadCap|xref style. Commands are contained in brackets (e.g., {paratext}). (2) They are especially useful for print output because they let you automatically refer to specific areas and/or page numbers in the output. (3) Both the source and destination files must be part of the same target output within the same project.
Warning It is recommended that you avoid creating links to snippets.This is primarily due to the nature of snippets, which are designed to be inserted into multiple files.Let's say you have a heading style in a snippet and that snippet is then inserted into 12 different topics. In another topic, you might decide to create a cross-reference that points to the heading in that snippet. But which of those 12 topics is it supposed to point to in the output? There is no way for Flare to know this, so you could end up with some very undesirable results. For this reason, it's a good idea not to link to any content in a snippet.
Note You can use the built-in analysis tool and reports to find broken links.
Note You can generate a report to see places in your project where you might want to create a cross-reference. Essentially, Flare finds files where a hyperlink to a topic exists. Because cross-references are generally preferred over hyperlinks (due to the fact that they are dynamic), it suggests that you create a cross-reference instead.
