The <marginrule-properties/> command

The <marginrule-properties/> directive sets the properties of margin rules and deletion markers. The command format is:

<marginrule-properties
 width="VALUE" 
 align="VALUE"
 color="COLOR"
 topindent="VALUE"	
 botindent="VALUE"	
 content-level="LEVEL"	
 dmwidth="VALUE"
 dmheight="VALUE"
 dmvshift="VALUE"
 dmalign="VALUE"
 dmcolor="COLOR"
 dmchar="VALUE"
 dmvchar="VALUE"
 dmweight="WEIGHT"
 />

where

  • width specifies a measure that defines the thickness of the margin rule. If this option is not specified, then the margin rule width is the value of the rule weight declared in the Format Options dialog. The maximum width of a margin rule is defined by the width of the margin rule block.

  • align specifies the horizontal alignment of the margin rule with respect to the left and right margins of the margin rule region. The value is one of left, right, center, inside or outside. The default alignment is center.

  • color specifies the margin-rule color. See “Colors” for a description of how colors are specified. The default margin rule color is black.

  • topindent and botindent specify a measure for how much to indent the rule from its start or end point, respectively. A positive value causes the rule to be shorter; a negative value can be used to extend it. Beware of using large indent values — if the total indent is larger than the length of the rule it will not be displayed.

  • content-level specifies a content ranking level assigned to margin rules and deletion markers. The content level assigns a rank from 0 (the default) through to 9 (the highest) that can be used by the TopLeaf PDF builder to exclude content from generated PDF documents. You can also use the content level to force TopLeaf to ignore margin rules and deletion markers when comparing pages for output differences.

  • dmwidth specifies the maximum horizontal width of a deletion marker change bar rule. If this option is not specified then the margin rule width is assumed.

  • dmheight specifies the preferred height of a deletion marker change bar rule or deletion marker character. If this option is not specified, the value of width is assumed when rendering a deletion marker change bar rule, and the font size declared in the $document mapping is assumed when rendering a deletion marker character.

  • dmvshift specifies a deletion marker baseline shift. A negative value raises the vertical position of the deletion marker and a positive value lowers the vertical position of the deletion marker. By default, the vertical position of a deletion marker rule is calculated using the baseline of the associated reference line, whereas a deletion marker character will center vertically about the font leading mid-point of the associated reference line.

  • dmalign specifies the horizontal alignment of the deletion marker with respect to the left and right margins of the margin rule region. The value is one of left, right, center, inside or outside. If this option is not specified, then the deletion marker alignment is defined by the margin rule alignment.

  • dmcolor specifies the color of a deletion marker. See “Colors” for a description of how colors are specified. If this option is not specified, then the deletion marker color will default to the margin rule color.

  • dmchar specifies the hexadecimal or decimal value of a deletion marker character. The height of the deletion marker character is defined by the value of dmheight. If the value of dmchar is not specified, deletion markers are rendered as a horizontal rule of width dmwidth and height dmheight.

  • dmvchar specifies the hexadecimal or decimal value of a deletion marker character output on a verso page. If this parameter is not specified the value of dmchar is used to render deletion marker characters on recto and verso pages.

  • dmweight specifies the preferred font weight for the deletion marker character. The value is one of normal, or bold. If this option is not specified, then a normal weight is assumed. If the delete marker character is not present in the font defined by the $document mapping (for example, if the character is determined using a character map) then the deletion marker character is rendered using the normal weight.

[Note] Note
  • A request to start and end a margin rule or define a deletion marker has no effect unless margin rules have been set up in the Layout Editor.

  • A request to start and end a margin rule or define a deletion marker has no effect unless the request is made from a data block that declares a margin rule region.

  • The <marginrule-properties/> command should only be used within the $document mapping.

Example

In the following command, change bars will be aligned on the inside margin of the margin rule region, and deletion markers will be rendered on the outside margin of the margin rule region as either a right pointing arrow (recto pages) or left pointing arrow (verso pages) :

<marginrule-properties align="inside" dmalign="outside" dmchar="x2192" dmvchar="x2190" dmheight="19pt" />