tag_display (Command)

This command tailors the Edit pane display of the tags specified.

If you have applied an alias map to the document, tagname can be either an alias or a real name.

If no tag name is given, -caret (the default) indicates the first tag to the left of the cursor. -mouse indicates the tag under the mouse arrow, or, if the mouse arrow is not on a tag, the first tag to the left of the arrow.

To change the display of every occurrence of a tag, use the -global option (the default). One or more tag names may be specified, in which case -caret and -mouse have no effect.

To change the display of one particular instance of a tag, use the -local option. (In this case, the tag must be indicated by the cursor or mouse arrow position; any tag name that does not match results in an error message.)

Local settings have precedence over global ones. A global setting does not affect a tag with a local setting. Use the command tag_display -local-default to remove local settings.

The remaining options change the display as follows:

• -full — Displays the specified tags in full in all tag display modes.

• -partial — Displays the specified tags as the following small icon in all tag display modes: This is an image of two unfilled arrowheads pointing toward each other, with their tips touching.

This is an image of two unfilled arrowheads pointing toward each other, with their tips touching.

Singleton tags display as a diamond icon in partial display.

• -none — Indicates that the specified tags are not displayed in any tag display mode.

• -hide — Hides the specified tags and the contents of these tags in any tag display mode.

• -icon — Displays the tags and their contents as the following icon in all tag display modes: This is an image of an arrow with two heads, one pointing up and one pointing down.

This is an image of an arrow with two heads, one pointing up and one pointing down.

• -toggle — (the default) switches between settings as follows:

◦ If the global tag display setting for a tag pair is -icon, it switches between the thin icon and the previous setting; otherwise, switches between collapsing and exposing detail.

◦ For singleton tags, it switches between the thin icon and the previous setting.

• -default — Depends on the changes you are making:

◦ If you are making global changes to tag display, this option sets the tag display to the default for the tag as set by Arbortext Editor.

◦ If you are making local changes to the display of a particular tag, this option sets tag display to any global tag display setting you may have set; if there is none, it sets tag display to the default as set by Arbortext Editor.

The tag display mode is set with the set tagdisplaycommand.

Elements configured by the tag_display command to not be displayed can be recognized and operated on by the spell and find commands by setting set hiddentagscan to on.

tag_display -icon indexterm
td -default indexterm
td -mouse
td -icon _ignore
td -local -toggle
td -local -none
td -icon indexterm footnote _comment
td -toggle indexterm