Package com.deltaxml.dita.config

Class DitaConfig

java.lang.Object
com.deltaxml.dita.config.DitaConfig
public class DitaConfig extends Object
The DITA configuration parameters apply to all output formats. They are used to control both conflict resolution and which topics are considered to be part of the document.

  • Constructor Details

    • DitaConfig

      public DitaConfig()
      Create a new DitaConfig instance. The DITA configuration parameters apply to all output formats. They are used to control both conflict resolution and which topics are considered to be part of the document.

    • DitaConfig

      public DitaConfig(boolean useIdsAsKeys)
      Create a new DitaConfig instance, specifies whether to use id attribute value as keys in order to provide identity during comparison. The DITA configuration parameters apply to all output formats. They are used to control both conflict resolution and which topics are considered to be part of the document.
      Parameters:
      useIdsAsKeys - specifies whether to use id attribute value as keys in order to provide identity during comparison.

  • Method Details

    • getRemoveRevAttributeRegex

      public String getRemoveRevAttributeRegex()
      Gets the value of the removeRevAttributeRegex parameter.
      Returns:
      the value of the removeRevAttributeRegex parameter

    • setRemoveRevAttributeRegex

      public void setRemoveRevAttributeRegex(String value)

      'rev' attributes in the input could be confused with those used to represent change in the output. This parameter specifies the regular expression that matches 'rev' attributes to be stripped.

      'rev' attributes that match this regex pattern are only stripped when the 'add-revision-atts' property is true.

      Default: "deltaxml-.*"

      Parameters:
      value - the value to set for the removeRevAttributeRegex parameter
      Throws:
      IllegalArgumentException - if the value is null

    • getStepsConflictResolution

      public StepsConflictResolution getStepsConflictResolution()
      Gets the value of the stepsConflictResolution parameter.
      Returns:
      the value of the stepsConflictResolution parameter

    • setStepsConflictResolution

      public void setStepsConflictResolution(StepsConflictResolution value)

      Specifies how to resolve conflicts between a task body's mutually exclusive steps and steps-unordered elements.

      A task's body must have precisely one of either the steps or steps-unordered elements. When one input's task body has a steps element and the other a steps-unordered element, the output cannot contain both. Therefore, the comparison is configured to compare the children of the steps and steps-unordered elements, and choose the name of the parent element as follows:

      Default: StepsConflictResolution.PREFER_B

      Parameters:
      value - the value to set for the stepsConflictResolution parameter
      Throws:
      IllegalArgumentException - if the value is null

    • isUseIdsAsKeys

      public boolean isUseIdsAsKeys()
      Gets the value of the useIdsAsKeys parameter.
      Returns:
      the value of the useIdsAsKeys parameter

    • setUseIdsAsKeys

      public void setUseIdsAsKeys(boolean value)

      Specifies whether to use id attribute value as keys in order to provide identity during comparison.

      If set to true, elements with the same name and id value at the same XML tree level will always be matched, regardless of their content.

      This setting should only be used if id attribute values are consistent across versions.

      Default: false

      Parameters:
      value - the value to set for the useIdsAsKeys parameter

    • isStrictTaskModel

      public boolean isStrictTaskModel()
      Gets the value of the strictTaskModel parameter.
      Returns:
      the value of the strictTaskModel parameter

    • setStrictTaskModel

      public void setStrictTaskModel(boolean value)

      Specifies whether to use the strict task model.

      If set to true, the order of elements underneath <taskbody> as specified in DITA 1.0/1.1 is enforced and corrected. Set to false if using DITA 1.2 or 1.3 with the general task model.

      Default: true

      Parameters:
      value - the value to set for the StrictTaskModel parameter