detail
detail [[ -selection] | -caret | -mouse | -all] [ -full | -none | n | tagname | -toggle]
This command collapses the contents of the specified tag pair to a plus sign with surrounding brackets, [+], or expands the contents of a collapsed structure. Special handling for divisions (such as chapters) causes the division heading text to continue to be displayed when the division is collapsed.
The first set of options determines the region on which the command operates:
• -selection (the default) indicates the region that is currently selected (or highlighted) if there is a selection; otherwise, the region enclosed by the document tag pair (that is, the entire document). However, -toggle is not a valid option for -selection.
• -caret indicates the region enclosed by the first tag pair to the left of the cursor.
• -mouse can indicate one of two regions: the region enclosed by the tag pair to which the pointer is pointing or the region enclosed by the first tag pair to the left of the pointer.
• -all indicates the region enclosed by the document tag pair (that is, the entire document).
The rest of the options determine how much detail to show:
• -full expands all collapsed structures in the indicated region so that all detail is shown.
• -none collapses all structures in the indicated region so that no detail is shown.
• n allows you to type a number indicating the level of detail to be shown. If the number is entered without a leading + or - sign, detail is shown down to the nth level (relative to the beginning of the region being operated on) and collapsed below that. -n shows n less levels of detail. +n shows n more levels of detail.
• tagname allows you to specify the type of tag pair to be collapsed. Arbortext Editor determines the nesting level for the first occurrence of the tag tagname, and then collapses everything from that nesting level down.
|
If you have applied an alias map to the document, tagname can be either an alias or a real name.
|
• -toggle (the default) is used to alternate between two levels of detail. For -mouse and -caret, it toggles between collapsing and expanding the tag indicated. If less than full detail is currently shown and -all is specified, the current level of detail is remembered, and full detail is shown. If full detail is currently shown, then detail is shown to the last remembered level. -toggle is not a valid option for a selection.
• -panel displays the detail dialog box to collapse or expand divisions.
Examples
det
det -1
det -all
det -selection par
det -all 5
det -selection +1
det -selection -1
det -all -toggle