-
Open the topic style sheet that you want to modify.
-
Complete one of the following sets of steps, depending on whether you want to use the Simplified view or Advanced view in the Stylesheet Editor.
- Simplified The Simplified view is better for new users. It provides an easier way to apply properties to styles, with format options available from a toolbar (similar to the way one would use the Text Format toolbar to change the look topic content without a style). In many cases, only the most common property options are available in the Simplified view (e.g., font, letter/word spacing, paragraph alignment/indentation, auto-numbering format, borders, background). One advantage of the Simplified view is that you can apply a property to multiple styles at the same time. You can also click a check box to hide the properties in the editor, allowing you to see only the styles.
- Advanced The Advanced view displays style classes and properties in hierarchical tree structures. It is not as quick as using the Simplified view, but it allows you to edit a great deal more settings than are available in the Simplified view.
Warning: When editing styles, make sure the proper medium is selected in the Stylesheet Editor before you begin (you can do this from the Medium drop-down list). Flare remembers the last medium that you used when working in the style sheet, so it may or may not be the one that you want to use the next time around. If you want all mediums to use the same setting, select the "default" medium and the properties will "trickle down" to the other mediums. If you are not using different mediums, you do not need to worry about selecting one when you edit styles. See About Style Sheet Mediums.
If using the Simplified view:
- In the local toolbar, make sure the first button displays
(which means that the Simplified view is currently shown in the editor). If the button displays 
instead, then click it.
- In the upper-left corner of the editor, click in the Show Styles field
and select Show Link Styles.
- On the left side of the Stylesheet Editor, select the MadCap|xref tag (or a class of it) that you want to edit.
- In the local toolbar of the editor, click
. The Properties dialog opens.
- Select the Format tab.
- Click the Edit button. The Cross-Reference Format dialog opens.
-
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: For print-based output you can create context-sensitive cross-references, which automatically change the text in the link based on the relationship of the cross-reference and the target location. See Creating Context-Sensitive Cross-References and Editing Text for Context-Sensitive Cross-References.
- Click OK.
- In the Properties dialog, click OK.
If using the Advanced view:
- In the local toolbar, make sure the first button displays (which means that the Advanced view is currently shown in the editor). If the button displays instead, then click it.
- In the upper-left corner of the editor, click in the Show Styles field and select Show Link Styles.
- On the left side of the Stylesheet Editor, select the MadCap|xref tag (or a class of it) that you want to edit.
- From the Show Properties drop-down list
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.
- Click in the value column on the right side of the mc-format property.
-
In the Enter format field, provide the format for the class. This 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, adding them 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: For print-based output you can create context-sensitive cross-references, which automatically change the text in the link based on the relationship of the cross-reference and the target location. See Creating Context-Sensitive Cross-References and Editing Text for Context-Sensitive Cross-References.
- Click OK.
- Press CTRL+S or click
to save your work.
- (Optional) To make sure 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.
How to edit a cross-reference style format at the point of insertion
See Also