Inserting links to footnotes in a topic

Last Updated : Apr 03, 2024 |

When you want to add a footnote, you typically just insert the <fn> element and enter the footnote text. When you insert a footnote, in the output, the footnote marker with the number appears in the text and the footnote appears at the bottom of the page. However, in an HTML output, you can also link to the footnote from another element in the same topic by inserting a cross-references to the footnote element.

Note:

Links to footnotes are only supported in HTML outputs. Use footnotes sparingly, only when they are really needed.

About this task

To use the same footnote in multiple procedures, conref the footnote element into the other procedure rather than inserting a cross-reference. That way, the users see the footnote at the bottom of the page they’re reading rather than having to jump to another page.

As per the DITA processing standards for footnotes:

  • In PDF outputs, the footnote marker does not link to the footnote at the bottom.

  • In HTML outputs, the footnote marker links to the footnote text.

Procedure

  1. In the publication, check out the topic in Oxygen XML Author.
  2. Put your cursor where you want to insert the footnote1, press Enter, and select fn.
  3. Insert the footnote text within the fn element.

    If you do not need to insert links from other locations in the topic, the adding footnote action is complete and you can check in the topic.

  4. To insert a link from an element in the same topic to an existing footnote element in that topic, you must first add an ID to the footnote element and then insert the xref:
    1. Double-click or select the fn element and add an ID for the footnote in the id field.
    2. Check in the topic.

      You must do this for the ID on the footnote to be available for selection when you insert the xref.

    3. Check out the topic.
    4. Place your cursor in the location where you want to add the cross reference and press Enter and insert the xref (cross reference) element.
    5. In the Cross reference (xref) dialog box, browse to and select the topic that contains the footnote to reference.
    6. Select the footnote element to cross reference, and then click Insert and close.

      You do not have to enter the number of the footnote for the link text. The correct footnote number is automatically inserted in the output during production.

    7. Double-click or select the xref element.
    8. In the Attributes window, type fn in the type field and then click OK.
  5. Check in the topic, publish the output, and verify that the footnotes are appearing as expected.
1