Documentation
link - wordaddins.com/products/cross-references/
link - wordaddins.com/support/cross-reference-fields-in-word/
The user interface is in English but the add-in can be used with any language version of Word.
Cross-references in Word documents are used to refer to related content elsewhere in the same document. Word has built-in functionality that lets you create cross-references to different types of targets.
This add-in lets you do everything you can do with cross-references in Word using the built-in cross-reference functionality. But you can do it easier and faster. In addition, DocTools CrossReferenceManager includes smart and efficient cross-reference features that are not found elsewhere.
A cross-reference in Word is a field, i.e. set of codes that instructs Word to automatically insert material into a document
Once you have inserted cross-references in a document using DocTools CrossReferenceManager, those cross-references will work precisely as if they had been inserted using Word's built-in functionality. This means that users who don't have DocTools CrossReferenceManager installed can work with your documents as they would normally do.
If you hover the mouse over a command, you will see a short description of the command. When you select a command that opens a dialog box, the dialog box will show information about what to do. In addition, the Help command in the Help menu provides comprehensive help.
Story behind the add-in
Several years ago, I developed some special cross-reference tools to be used with documents based on a customer-specific set of Word templates.
The tools were included in a customer-specific add-in.
The tools saved a lot of time for the users and helped secure consistency across documents.
Since 2007, I have provided help on cross-reference problems to anyone via a Word Tips article on my website www.thedoctools.com.
The article includes a set of videos that illustrate some of the problems that can occur in relation to cross-references and how to solve and prevent them.
From the number of visitors to that article and the videos and the feedback I have received, I know that cross-references in Word cause problems to many users and cost a lot of time.
The idea of developing an advanced cross-reference add-in that could make the work with cross-references in Word easier and smarter and that could be used with any Word document in any language was born years ago.
But I also realized that it would be quite difficult to make an add-in that could do all the things I wanted and that the development would require a lot of time.
In spring 2016, the first version of the DocTools CrossReferenceManager add-in was ready to be published as a productivity tool on this website.
Version 2.0 was the first version available from this website.
Custom cross-reference texts
You can save language-specific custom cross-reference texts that contain placeholders for multiple cross-reference fields. You can insert any of your custom cross-reference texts, including all the cross-references, with a single click. See the cross-reference example below (field shading is turned on to make it easy to identify fields):
Insert cross-references to headings based on selected text
You do not even need to open the Insert Cross-reference dialog box to insert a cross-reference to a heading.
Simply type the heading number or text (e.g. '1.2' or '3.5.1', 'Article II', 'My heading text'), select it, right-click and select Replace Selection with Cross-reference to Matching Heading. The command replaces the selection with a cross-reference to a heading that matches the selection. The inserted cross-reference will be based on the current default settings for heading cross-references in the document. This means that it can be e.g. a cross-reference to the heading text, heading number, or a custom text including one or more cross-references.
TIP: You only need to type enough text to uniquely identify the heading you want to reference. Sometimes, a few letters are sufficient.
If more than one heading matches the selected text, the Insert Cross-reference dialog box opens, letting you select the relevant heading.
Note that the Replace Selection with Cross-reference to Matching Heading command is also available in the Cross-reference Tools menu.
Fast filtering of cross-reference targets for easy selection
The Insert Cross-reference dialog box lets you filter target items. This is a real time saver. You can quickly reduce the list of target items to precisely the one you need.
You can now set the Filter field as the default field for even faster selection. You can filter target items to show all Heading / outline levels or only level 1, 1-2, 1-3, or 1-4.
Easy insertion of cross-references to headings that don't have Heading 1-9 styles applied to them
You can not only insert cross-references to target items supported by the built-in cross-reference functionality in Word. You can easily insert cross-references to headings that have not had one of the Heading 1-9 styles applied to them.
Any paragraph that has been applied outline level 1-9 will automatically be listed as a target item. This means that you do not need to manually add a bookmark to such heading in order to cross-reference it.
Insert cross-references to only caption number (without the label)
You can insert cross-references to only the caption number of a caption (without the label). This makes it easy to create cross-references like e.g. "See Figures 12 to 15" where the last item shows the number only.
Automatically apply a character style to cross-references you insert
You can automatically apply a character style to cross-references you insert. A command also lets you apply a character style to all cross-reference fields in the entire document in one operation. This is a fast and easy way to make sure the formatting is consistent. Or you can reset the formatting of all cross-reference fields if you change your mind.
You can now also apply a character style to any part(s) of a custom text instead of applying the style to all cross-reference fields in a custom text. Learn about style tags below.
Check and repair cross-references
You can use Check and Repair Cross-references command as your cross-reference checker. It checks the document for errors in cross-reference bookmarks and cross-reference fields. The command also provides tools for repairing any cross-reference errors found. In addition, the add-in includes functionality that can prevent certain types of errors such as cross-references pointing to number 0 (zero).
Define default settings for cross-references
You can define default settings that will be used as the initial settings in all documents the first time you insert a cross-reference. The Insert Cross-reference dialog box will then open with those settings already selected. You can change the default settings whenever you wish.
Each document remembers your latest cross-reference settings
Once you have inserted a cross-reference in a specific document, the document will remember your latest cross-reference settings used in that document the next time you open the dialog box. Furthermore, the document will remember the different settings you made for each type of cross-reference. Even the target item you selected will be remembered so it is easy to insert more cross-references to the same target item.
You can resize the Insert Cross-reference dialog box
You can resize the Insert Cross-reference dialog box so you can see more target items and longer target items. The dialog box will remember both its size and position - even between Word sessions.
About the Insert Cross-reference command
It is fast and easy to insert a cross-reference. Simply click where you want the cross-reference and select Insert Cross-reference. The first time you select this command, you will be asked to fill in the Set Cross-reference Defaults dialog box so the Insert Cross-reference dialog box can open with the defaults you want.
TIP: You can also open the Insert Cross-reference dialog box using the keyboard shortcut Alt+Ctrl+Shift+X or by selecting the command from the right-click menu:
The Insert Cross-reference dialog box lets you define everything in relation to the cross-reference(s) you are going to insert:
You can use the Filter target items field to quickly reduce the list of target items instead of trying to find a specific target item in a long list:
Note that the straight quotes in the selected custom text have been automatically converted to smart quotes because the Smart quotes in custom text option was turned on.
About the Set Cross-reference Defaults command
Via the Set Cross-reference Defaults dialog box, you can define the settings you want as the initial defaults for all documents. Those settings will automatically be preselected the first time you insert a cross-reference via the Insert Cross-reference command in a specific document, if applicable.
In addition, the General settings group in the dialog box lets you apply other settings that are helpful. You will find details about how it works in the dialog box itself and in Help in CrossReferenceManager.
As also explained in the dialog box, once you have inserted a cross-reference of a specific type in a document, the document will remember the settings you selected most recently for that type of cross-reference in that document and automatically offer those specific settings as the defaults for new cross-references of the same type.
The option Switch style if pressing Enter in empty bullet/number paragraph, found in the General settings for all documents group is new in version 3.6. The new option is turned off by default.
About adding and editing custom texts - allowing you to insert multiple cross-references at a time
You can save language-specific custom texts for headings and for captions. You can save up to 200 custom texts for each type and for each language - that is most likely more than you would ever need.
The custom cross-reference texts you define are stored in a configuration file locally on your computer. If more users need the same custom cross-reference texts, you can replace the configuration file on one computer with a copy of the file that includes the custom cross-reference texts that were set up on another computer. This way, you can make sure that a whole group of users can easily use cross-references consistently both within and across documents.
The illustrations below show the dialog boxes for adding/editing customs texts for headings and captions, respectively. The placeholders you can insert differ but except from that, the dialog boxes work the same way. You open the dialog boxes illustrated below via the Define Custom Cross-reference Texts command. The initial dialog box that opens will list all currently defined custom texts for the language you select. It also lets you delete and rearrange the custom texts (that dialog box is not illustrated here).
You can use the Insert special character buttons to easily insert nonbreaking spaces, nonbreaking hyphens, En dashes, Em dashes, line breaks and tab characters in custom texts.
You can use the Start Style and End Style buttons to insert special style tags to specify special part(s) of a custom text to which you want to automatically apply a character style. If you turn on the Style check box in the Insert Cross-reference dialog box, the selected character style will be applied to the part(s) of the custom text enclosed in style tags. If you do not turn on the Style check box, the style tags will be ignored.
You can use style tags in custom texts for both Headings and Captions.
Custom text with style tags, <$> and </$>, around the Text placeholder, {T}:
For further details, please refer to Section {N}, "<$>{T}</$>", page {P}.
Result when inserted if the selected character style applies italic - the text surrounded by style tags is applied italic whereas the remaining text is not:
Progress bar
A progress bar will be shown when you perform operations that may take more than a few seconds.
Overview of all the commands
Command Name | Description |
Replace Selection with Cross-reference to Matching Heading | Before selecting this command, select a manually typed number or text that matches a heading in the document (e.g. '1.2' or '3.5.1', 'Article II', 'My heading text'). The command replaces the selection with a cross-reference to a heading that matches the selection. The inserted cross-reference will be based on the current default settings for heading cross-references in the document. This means that it can be e.g. a cross-reference to the heading text, heading number, or a custom text including one or more cross-references.
TIP: To change the default settings for heading references in the document, insert a cross-reference to heading via 'Insert Cross-reference' with the desired settings. If more than one heading matches the selected text, the 'Insert Cross-reference' dialog box opens, letting you select the relevant heading. TIP: This command is also available from the context menu that appears when you right-click. |
Update All Fields | Updates all fields, i.e. fields of any type, in the entire document including headers, footers, etc. However, locked fields, if any, will not be updated. |
Browse Cross-reference Fields | Lets you select the cross-reference fields in the active document one by one, starting from the cursor position if the selection is in the main text story. A dialog displays the field code of the selected field. |
Check and Repair Cross-references | Lets you check the entire document for problems with and inconsistencies between cross-reference bookmarks and cross-reference fields and lets you correct the errors, if any. Possible problems will be found one by one in order for you to handle them individually. The command also lets you mark a possible error with red highlight for later check. |
Apply Red Highlight to Cross-reference Fields with Missing Target | Checks all cross-reference fields in the document and applies red highlight to fields with missing target, i.e. fields that refer to bookmarks that do not exist. |
Find Red Highlight in Bookmarks | Lets you check the entire document for bookmarks with red highlight. It will stop at each occurrence, if any, and let you remove the highlight or stop to fix a problem manually.
Red highlight may be applied during check of cross-references to mark cross-reference bookmarks with possible problems. |
Find Red Highlight in Cross-reference Fields | Lets you check the entire document for cross-reference fields with red highlight. The command will start from the cursor position if the selection is in the main text story. It will stop at each occurrence, if any, and let you remove the highlight or stop to fix a problem manually.
Red highlight may be applied during check of cross-references to mark cross-reference fields with possible problems. Red highlight may also be applied to all cross-reference fields with missing target using the command above. |
Apply Green Highlight to All Cross-reference Fields | Applies green highlight to all cross-reference fields, i.e. fields of the types REF, PAGEREF and NOTEREF. The cross-reference fields will be updated.
Unlocked fields will be applied bright green highlight. Locked fields will be applied dark green highlight. |
Remove Highlight from All Cross-reference Fields | Removes highlight from all cross-reference fields (locked and unlocked), i.e. fields of the types REF, PAGEREF and NOTEREF. The cross-reference fields will be updated. |
Apply Blue Highlight to All Cross-reference Bookmarks | Applies blue highlight to all cross-reference bookmarks, i.e. bookmarks whose names start with _Ref. Note that any manually added bookmarks used by cross-reference fields with other types of names will not be marked.
You can, for example, use this command as a supplement to the 'Check and Repair Cross-references' to check whether cross-reference bookmarks include the correct text. |
Remove Highlight from All Cross-reference Bookmarks | Removes highlight from all cross-reference bookmarks, i.e. bookmarks whose names start with _Ref. |
Apply Character Style to Cross-reference Fields | This command lets you apply character formatting to all cross-reference fields in the main text story or in the entire document. You can select from all character styles and linked styles currently found in the document.
Note: Any existing character formatting will be removed from the cross-reference fields. Any changed field will be updated unless the field is locked and thereby prevented from updating. |
Reset Formatting of Cross-reference Fields | This command lets you remove character formatting from all cross-reference fields in the main text story or in the entire document.
The command removes the CHARFORMAT and MERGEFORMAT switches from the field code, if found. Any direct formatting will be cleared. Any changed field will be updated unless the field is locked and thereby prevented from updating. |
Browse Cross-reference Fields and Targets Side by Side | Displays the active document in two windows side by side. A dialog box lets you step through cross-reference fields one by one. The found field will be marked by blue highlight in the window to the left and the related target, if any, will be selected in the window to the right. Information related to the field and target will be shown. |
Generate Overview of Cross-references | Creates a new document including information about all cross-references in the active document. In this way, you can see all cross-references in one place. For each cross-reference, the report will include misc. information about the location and content of both the field and the target. |
Define Custom Cross-reference Texts | Lets you add, edit, delete and organize language-specific, custom cross-reference texts. A custom text can e.g. be a whole sentence including several cross-reference placeholders. A custom text can be inserted into any document with a single click. The placeholders will automatically be replaced by cross-reference fields to the selected target. |
Set Cross-reference Defaults | Lets you define default values that will be used the first time you insert a cross-reference in a document via the Insert Cross-reference command in the DocTools tab. |
Reset Cross-reference Settings in Active Document to Default | This command resets all cross-reference settings in the active document to the default settings.
This will not change any cross-references in the document but only influence the settings initially shown in the Insert Cross-reference dialog box. |
Restore Position of Insert Cross-reference Dialog Box | Lets you fix the problem if the Insert Cross-reference dialog box doesn't seem to open when selecting the command. For example, the dialog box may be positioned outside the visible area if you are using another monitor setup than last time you used the Insert Cross-reference command. |
Field Shading | Lets you select how fields are displayed on the screen. It is recommended to have field shading shown always. |
Show/Hide Highlight | Turns the display of highlight on or off. If the option has been turned off, highlight colors will not be displayed in documents. The highlight, if any, will still be present and will reappear if you turn on the setting again. |
Show/Hide Bookmarks | Turns the display of bookmarks on or off. Displayed bookmarks appear as gray brackets ([...]) on the screen but not in print. A bookmark that does not include content appears as an I-beam because the brackets overlap. Hidden bookmarks, i.e. bookmarks that start with an underscore
( _ ), are never displayed. |
Show Bookmark Dialog Box | Opens the built-in Bookmark dialog box. |
Show Standard Cross-reference Dialog Box | Opens the built-in Cross-reference dialog box. That dialog box will not be influenced by the DocTools CrossReferenceManager functionality. |
Command Name Description |
Replace Selection with Cross-reference to Matching Heading Before selecting this command, select a manually typed number or text that matches a heading in the document (e.g. '1.2' or '3.5.1', 'Article II', 'My heading text'). The command replaces the selection with a cross-reference to a heading that matches the selection. The inserted cross-reference will be based on the current default settings for heading cross-references in the document. This means that it can be e.g. a cross-reference to the heading text, heading number, or a custom text including one or more cross-references. TIP: To change the default settings for heading references in the document, insert a cross-reference to heading via 'Insert Cross-reference' with the desired settings. If more than one heading matches the selected text, the 'Insert Cross-reference' dialog box opens, letting you select the relevant heading. TIP: This command is also available from the context menu that appears when you right-click. |
Update All Fields Updates all fields, i.e. fields of any type, in the entire document including headers, footers, etc. However, locked fields, if any, will not be updated. |
Browse Cross-reference Fields Lets you select the cross-reference fields in the active document one by one, starting from the cursor position if the selection is in the main text story. A dialog displays the field code of the selected field. |
Check and Repair Cross-references Lets you check the entire document for problems with and inconsistencies between cross-reference bookmarks and cross-reference fields and lets you correct the errors, if any. Possible problems will be found one by one in order for you to handle them individually. The command also lets you mark a possible error with red highlight for later check. |
Apply Red Highlight to Cross-reference Fields with Missing Target Checks all cross-reference fields in the document and applies red highlight to fields with missing target, i.e. fields that refer to bookmarks that do not exist. |
Find Red Highlight in Bookmarks Lets you check the entire document for bookmarks with red highlight. It will stop at each occurrence, if any, and let you remove the highlight or stop to fix a problem manually. Red highlight may be applied during check of cross-references to mark cross-reference bookmarks with possible problems. |
Find Red Highlight in Cross-reference Fields Lets you check the entire document for cross-reference fields with red highlight. The command will start from the cursor position if the selection is in the main text story. It will stop at each occurrence, if any, and let you remove the highlight or stop to fix a problem manually. Red highlight may be applied during check of cross-references to mark cross-reference fields with possible problems. Red highlight may also be applied to all cross-reference fields with missing target using the command above. |
Apply Green Highlight to All Cross-reference Fields Applies green highlight to all cross-reference fields, i.e. fields of the types REF, PAGEREF and NOTEREF. The cross-reference fields will be updated. Unlocked fields will be applied bright green highlight. Locked fields will be applied dark green highlight. |
Remove Highlight from All Cross-reference Fields Removes highlight from all cross-reference fields (locked and unlocked), i.e. fields of the types REF, PAGEREF and NOTEREF. The cross-reference fields will be updated. |
Apply Blue Highlight to All Cross-reference Bookmarks Applies blue highlight to all cross-reference bookmarks, i.e. bookmarks whose names start with _Ref. Note that any manually added bookmarks used by cross-reference fields with other types of names will not be marked. You can, for example, use this command as a supplement to the 'Check and Repair Cross-references' to check whether cross-reference bookmarks include the correct text. |
Remove Highlight from All Cross-reference Bookmarks Removes highlight from all cross-reference bookmarks, i.e. bookmarks whose names start with _Ref. |
Apply Character Style to Cross-reference Fields This command lets you apply character formatting to all cross-reference fields in the main text story or in the entire document. You can select from all character styles and linked styles currently found in the document. Note: Any existing character formatting will be removed from the cross-reference fields. Any changed field will be updated unless the field is locked and thereby prevented from updating. |
Reset Formatting of Cross-reference Fields This command lets you remove character formatting from all cross-reference fields in the main text story or in the entire document. The command removes the CHARFORMAT and MERGEFORMAT switches from the field code, if found. Any direct formatting will be cleared. Any changed field will be updated unless the field is locked and thereby prevented from updating. |
Browse Cross-reference Fields and Targets Side by Side Displays the active document in two windows side by side. A dialog box lets you step through cross-reference fields one by one. The found field will be marked by blue highlight in the window to the left and the related target, if any, will be selected in the window to the right. Information related to the field and target will be shown. |
Generate Overview of Cross-references Creates a new document including information about all cross-references in the active document. In this way, you can see all cross-references in one place. For each cross-reference, the report will include misc. information about the location and content of both the field and the target. |
Define Custom Cross-reference Texts Lets you add, edit, delete and organize language-specific, custom cross-reference texts. A custom text can e.g. be a whole sentence including several cross-reference placeholders. A custom text can be inserted into any document with a single click. The placeholders will automatically be replaced by cross-reference fields to the selected target. |
Set Cross-reference Defaults Lets you define default values that will be used the first time you insert a cross-reference in a document via the Insert Cross-reference command in the DocTools tab. |
Reset Cross-reference Settings in Active Document to Default This command resets all cross-reference settings in the active document to the default settings. This will not change any cross-references in the document but only influence the settings initially shown in the Insert Cross-reference dialog box. |
Restore Position of Insert Cross-reference Dialog Box Lets you fix the problem if the Insert Cross-reference dialog box doesn't seem to open when selecting the command. For example, the dialog box may be positioned outside the visible area if you are using another monitor setup than last time you used the Insert Cross-reference command. |
Field Shading Lets you select how fields are displayed on the screen. It is recommended to have field shading shown always. |
Show/Hide Highlight Turns the display of highlight on or off. If the option has been turned off, highlight colors will not be displayed in documents. The highlight, if any, will still be present and will reappear if you turn on the setting again. |
Show/Hide Bookmarks Turns the display of bookmarks on or off. Displayed bookmarks appear as gray brackets ([...]) on the screen but not in print. A bookmark that does not include content appears as an I-beam because the brackets overlap. Hidden bookmarks, i.e. bookmarks that start with an underscore ( _ ), are never displayed. |
Show Bookmark Dialog Box Opens the built-in Bookmark dialog box. |
Show Standard Cross-reference Dialog Box Opens the built-in Cross-reference dialog box. That dialog box will not be influenced by the DocTools CrossReferenceManager functionality. |