Documentation Center

Default link label for topic references and cross-references

When a cross-reference is created, the Text to display field is left empty because it adopts the same behavior as topic references: <navtitle> elements labels are dynamically resolved.

The Text to display field is located at the bottom of the Insert dialog when you create the cross reference from your XML Editor, for example.

If you want to change the default behavior of reference's label, you should configure XML Editors (XMetal, oXygen) and Publication Manager the same way. The new behavior will apply to topic references and cross-references.

You can
  • Have the link label pre-filled (depending on the option you choose):
    • with the topic logical object title (as defined in the metadata) when you create cross-references (<xref> elements) pointing to topics or to any element inside a topic. There is always one such title.
    • with the element title when you create cross-references (<xref> elements) pointing to specific elements, if the element has a title. If the element has no title, the label will be empty.
  • Have the <navtitle> take the title of the topic it references.

Customize XML Editor through TemplateSpecification.xml

Change the value of selecteditem:text to either textortitle or textordefault.

Customize Publication Manager through MetadataConfig.xml

Uncomment
  • Dita.TopicRef.Form.Add and Dita.Part.Form.Add DITA form definitions in the Form_Load script.
  • HRefField DITA field definition in the Field_ValueChanged script.