Creating Named Destinations

example

Let's say you plan to generate a PDF file from Flare Project A. Once that is done, you plan to add the PDF to Flare Project B. And in one of the topics of Flare Project B, you create a hyperlink that points to a specific paragraph in the PDF.

First, you open the topic or snippet in Flare Project A where the destination paragraph will eventually exist in the PDF, and you insert a named destination at that location.

Next, you generate the output for the PDF.

Now you open Flare Project B. Let's say you use the External Resources feature to add the PDF to that project.

Now you open a topic in Flare Project B, and you create a hyperlink that points to the named destination in the PDF. You follow the steps for inserting the a link to a file in the project, and you select the PDF file. Then you click and select the named destination that you created.

Now when you generate the HTML5 output from Project B, you can click on the hyperlink in that output, and the PDF will open to the specified paragraph.

1. Open the PDF target that will contain the named destinations (i.e., hyperlinks in another file will point to these destinations).
2. Select the PDF Options tab.

3. In the Document Properties area, click Create named destinations for bookmarks.

   Note: This does not remove bookmarks. It simply creates named destinations next to other bookmarks in the generated PDF if they exist.

4. Select File>Save or press CTRL+S.
5. Generate and publish the PDF.

1. Open the topic where you want insert a named destination (i.e., hyperlinks in another file will point to the PDF holding this destination).
2. Click in the topic where you want to insert a named destination (e.g., in front of a subheading or a specific paragraph).

3. Do one of the following, depending on the part of the user interface you are using.

   • Ribbon Select the Insert ribbon. In the Links section, select Named Destination.

     Switching between ribbons and menus/toolbars… You can use the Options dialog to switch between ribbons and the classic menu/toolbar layout. See Switching Between Ribbons and Menus/Toolbars. More about ribbon options… Keep in mind that the smaller the application window becomes, the more the options in a ribbon shrink. Therefore, you might only see a small icon instead of text, or you might see only a section name displayed with a down arrow to access the options in it. You can hover over small icons to see tooltips that describe them. You can also enlarge the application window or click one of the section drop-downs in the ribbon to locate a hidden feature.

   • Menu Select Insert>Named Destination.

   The Named Destination dialog opens.

4. In the Name field, type a name for destination (do not use spaces).
5. Click OK. An icon is displayed at the appropriate location in the document (as long as your markers are turned on).
6. Select File>Save or press CTRL+S.
7. Generate and publish the PDF containing that topic.

1. Open the topic where you want the link to exist.
2. Highlight the text that you want to use as the link (or "hotspot").

3. Do one of the following, depending on the part of the user interface you are using.

   • Ribbon Select the Insert ribbon. In the Links section, select Hyperlink.

     Switching between ribbons and menus/toolbars… You can use the Options dialog to switch between ribbons and the classic menu/toolbar layout. See Switching Between Ribbons and Menus/Toolbars. 

     More about ribbon options… Keep in mind that the smaller the application window becomes, the more the options in a ribbon shrink. Therefore, you might only see a small icon instead of text, or you might see only a section name displayed with a down arrow to access the options in it. You can hover over small icons to see tooltips that describe them. You can also enlarge the application window or click one of the section drop-downs in the ribbon to locate a hidden feature.

   • Menu Select Insert>Hyperlink.
   • Local toolbar In the local toolbar of the XML Editor click .
   • Keyboard shortcut Press CTRL+K on your keyboard.
   • Right-click In the XML Editor, right-click and select Hyperlink.

   The Insert Hyperlink dialog opens.

4. From the Link to drop-down field select one of the following. Based on the option you choose, the section below the field gives you a list of selections or additional fields to complete.

   • File in Project This option lets you search for a file within your project. After you select this option, use the area below to navigate to the PDF file that you want to link to and select it. By using the buttons in the local toolbar, you can view all files in a list, view files in their folder structure, and use other options.

     	Shows all of the files in the project in a list in the area below. If you click the button again, it switches to a folder tree view. In the list, you can click the "File," "Type," or "Path" column headers to sort the list alphabetically by that column data.
     	Shows or hides the folders that the files are stored in.
     	Shows or hides the files. If you click this button when the Show Folders button is selected, the area splits into two halves. The folder is shown on the left side, and the files and subfolders within it are shown on the right.
     	If the Show Files button is the only one selected, you can click this button to move up one folder level.

   • External File This option lets you search for a file outside your project. After you select this option, enter the path to the PDF file in the field next to the External File button.

     For more information see Inserting Links to External Files.

     Note: Because the link usually needs to be relative, based on the final locations of your output files, it is preferable to enter the text directly into the field, rather than clicking the External File button.

5. After selecting the PDF, click .
6. In the dialog that opens, select the named destination and click OK.
7. (Optional) The Link text field displays the text that you highlighted in the topic, which will be used as the hyperlink. Leave the text as it is, unless you decide you would like to change it. If you want to change the link text, type the new text in the field. It will replace the previously selected text in the topic.

8. (Optional) In the Screen Tip field you can type a phrase that will appear when the end user hovers over the hyperlink in the output.

   When you enter a screen tip, it is added as a <title> tag in the markup. In addition, an <alt> (alternate text) tag is added with the same text. This is useful when it comes to accessibility.

   For more information see About Accessibility.

9. (Optional) Next to the Style Class field click the Select button. This opens the Select Class dialog, which lets you apply one of the defined hyperlink styles from your stylesheet to the link. You can change the appearance of the link in the Stylesheet Editor. After you select a style class in the dialog, click OK. The Style Class field displays the selected style. (If you do not specify a style class, Flare uses the parent <a> tag.)
10. (Optional) In the Target Frame field, click the drop-down arrow to select the way the linked destination will open (e.g., in another window, in a popup).
    • (default) The destination file will open in the same window as the output window.
    • Parent Frame_parent The destination file will open in the parent frame of the current topic while hiding that topic.
    • New Window_blank The destination file will open in a new browser window.
    • Same Frame_self The destination file will open in the same window frame as the current topic.
    • Top Frame_top The destination file will open in the same output window, removing all other framesets. You might use this option, for example, if the destination topic has its own frameset.
    • Popup Window The destination file will open in a popup box on top of the current topic.
11. Click OK. The hyperlink is added to the topic.
12. Select File>Save or press CTRL+S.