Generating revision bars

If you use Antenna House Formatter or RenderX XEP, you can generate revision bars in your PDF output by using the @changebar and @color attributes of the DITAVAL <revprop> element.

Note: The Apache Formatting Objects Processor (FOP 2.3) bundled with DITA-OT does not yet support the XSL fo:change-bar formatting object. A patch has been submitted to enable this support in a future version of FOP.
The DITA specification for @changebar simply says:
@changebar
When flag has been set, specify a changebar color, style, or character, according to the changebar support of the target output format. If flag has not been set, this attribute is ignored.

The current version of DITA Open Toolkit uses two <revprop> attribute values to define revision bars:

  • The @changebar attribute value defines the style to use for the line. The list of possible values is the same as for other XSL-FO rules (see @change-bar-style). The default value is groove.

  • The @color attribute value specifies the change bar color using any color value recognized by XSL-FO, including the usual color names or a hex color value. The default value is black.

Figure 1. Sample revision bar configuration
<revprop action="flag" changebar="solid" color="green"/>

DITA-OT uses a default offset of 2 mm to place the revision bar near the edge of the text column. The offset, placement and width are not currently configurable via attribute values.

XSL-FO 1.1 does not provide for revision bars that are not rules, so there is no way to get text revision indicators instead of rules, for example, using a number in place of a rule. Antenna House Formatter provides a proprietary extension to enable this, but the DITA-OT PDF transformation does not take advantage of it.