How to edit a cross-reference style format at the point of insertion- Open a topic containing a cross-reference that you want to edit.
- In the XML Editor, right-click inside the cross-reference and from the context menu select Edit Cross-Reference. The Insert Cross-Reference dialog opens.
-
In the Cross-Reference Properties section, select the MadCap:xref style that you want to edit.
<MadCap:xref> is the parent tag and default selection
-
Click Edit. The Edit Cross-Reference Style Class dialog opens.
- (Optional) In the Stylesheet to modify field, you can select the appropriate style sheet (if different from the one shown).
- In the Enter format field, provide the format for the class. This format can be a combination of text that you type and automated commands that you select. You can select commands from the list by double-clicking them. They are then added to the "Enter format" field.
Command Description b
Start bold text
/b
End bold text
bg
Start new background color
/bg
End background color
color
Start new text color
/color
End text color
default
Reset all font changes
ext
File extension
family
Start new font family
/family
End font family
file
File name, including extension
filename
File name, without extension
h1
Text of first heading 1 paragraph
h2
Text of first heading 2 paragraph
h3
Text of first heading 3 paragraph
h4
Text of first heading 4 paragraph
h5
Text of first heading 5 paragraph
h6
Text of first heading 6 paragraph
i
Start italic text
/i
End italic text
page
Page number
pagecount
Page count
pageref
Context-sensitive page reference
paranum
The auto-number text of bookmarked paragraph.
paranumonly
The auto-number only of bookmarked paragraph
paratext
Text of bookmarked paragraph
paraxml
Text and markup of bookmarked paragraph
path
File path
size
Start new font size
/size
End font size
sub
Start subscript text
/sub
End subscript text
sup
Start superscript text
/sup
End superscript text
title
Title of document
u
Start underlined text
/u
End underlined text
url
File path, URL syntax
example
If you want the cross-reference to include text (such as "For more information see"), simply type it in this field. You can also double-click any of the commands to add them to this field. For example, you might want to add the text of the first paragraph in the destination file to the cross-reference format. The command for this is {paratext}. Descriptions for each command are displayed in the list.
Some commands include a start tag and an end tag. For example, if you want a portion of the cross-reference to be displayed in bold, you would place your cursor in the "Enter format" field where want to start the bold font and double-click b in the list below. Then place your cursor where you want the bold font to end and double-click /b from the list.
So in the end, your cross-reference format might include a combination of text and multiple commands, such as:
For more information see {b}{paratext}{/b}
A format such as this one might display a link in the output like this:
For more information see My Destination Topic
For additional information and examples, see About Cross-References.
Note:
- Click OK.
-
Press CTRL+S or click
to save your work. - (Optional) To make sure other cross-references in your project display the new format, you can update the cross-references in a topic (Tools>Update Cross-References). However, all of the cross-references in your project will be updated automatically when you generate the output, so this is not a mandatory task.
(which means that the Simplified view is currently shown in the editor). If the button displays 
instead, then click it.
and select Show Link Styles.
. The Properties dialog opens.
on the upper-right side of the editor, select Show: Assorted Relevant Properties. The most relevant properties for that style are shown on the right side of the editor.
See Also