Package com.deltaxml.dita.config

Class TrackedChanges

java.lang.Object
com.deltaxml.dita.config.TrackedChanges
public class TrackedChanges extends Object
The tracked changes output format specific parameters provide a way of configuring tracked change output and editor/format specific output.

  • Constructor Details

    • TrackedChanges

      public TrackedChanges()
      Creates a new TrackedChanges instance. The tracked changes output format specific parameters provide a way of configuring tracked change output and editor/format specific output.

  • Method Details

    • getTrackedChangesAuthor

      public String getTrackedChangesAuthor()
      Gets the author name that will be embedded into the generated tracked changes instructions.
      Returns:
      the value used as the author

    • setTrackedChangesAuthor

      public void setTrackedChangesAuthor(String value)

      Specifies the author name that is embedded into the generated insertion and deletion processing instruction.

      Default: "deltaxml"

      Parameters:
      value - new author
      Throws:
      IllegalArgumentException - if the value is null

    • getTrackedChangesDate

      public String getTrackedChangesDate()
      Gets the time-stamp that will be embedded into the generated tracked changes instructions.
      Returns:
      the value used as tracked changes date

    • setTrackedChangesDate

      public void setTrackedChangesDate(String value)

      Specifies the time-stamp that is embedded into the generated insertion and deletion processing instruction. The default time-stamp is that of the time that the comparison is run.

      Default: "xsl date"

      Parameters:
      value - timestamp used in tracked changes instructions.
      Throws:
      IllegalArgumentException - if the value is null

    • getOxygenTrackChangesDeletedSpaceMode

      public OxygenTrackChangesDeletedSpaceMode getOxygenTrackChangesDeletedSpaceMode()
      Gets the value of the oxygenTcsDeletedSpaceMode parameter.
      Returns:
      the value of the oxygenTcsDeletedSpaceMode parameter

    • setOxygenTrackChangesDeletedSpaceMode

      public void setOxygenTrackChangesDeletedSpaceMode(OxygenTrackChangesDeletedSpaceMode value)

      Specifies how deleted spaces should be handled.

      Prior to oXygen 14 whitespace within the deleted content of a processing instruction were sometimes not displayed correctly. A work-around was to normalise the space within a deleted region.

      Default: OxygenTrackChangesDeletedSpaceMode.AUTOMATIC

      Parameters:
      value - the value to set for the oxygenTcsDeletedSpaceMode parameter
      Throws:
      IllegalArgumentException - if the value is null
      See Also:

    • getOxygenTcsVersion

      public String getOxygenTcsVersion()
      Gets the value of the oxygenTcsVersion property.
      Returns:
      the value of the oxygenTcsVersion parameter

    • setOxygenTcsVersion

      public void setOxygenTcsVersion(String value)

      Specifies the version of oXygen editor used to display, accept and reject the tracked changes.

      The format of the version is either '[0-9]+' or '[0-9]+.[0-9]+' without the enclosing string quotes, where: the first number sequence is the major number; and the optional second number sequence is the minor number.

      This parameter is used to automatically set the relevant backwards compatibility options related to the oXygen tracked changes format. For example, prior to oXygen 14.0 release deleted whitespace needed to be normalised in order to consistently generate a reasonable result.

      Default: "11.2"

      Parameters:
      value - the version of the oXygen editor tracked changes handling to be used
      Throws:
      IllegalArgumentException - if the value is null

    • getXmetalTrackChangesTableChangeMode

      public XmetalTrackChangesTableChangeMode getXmetalTrackChangesTableChangeMode()
      Gets the value of the xmetalTcsTableChangeMode parameter.
      Returns:
      the value of the xmetalTcsTableChangeMode parameter

    • setXmetalTrackChangesTableChangeMode

      public void setXmetalTrackChangesTableChangeMode(XmetalTrackChangesTableChangeMode value)

      Specifies how changes in tables should be tracked.

      The XMetaL editor cannot track the addition or deletion of a row or cell within a table. Such changes can be pushed down to the cell level, pushed up to the table level (e.g. a CALS or HTML 'table' element), or ignored. The advantage of pushing the changes down to the cell content level, is that this provides the highest level of change granularity, at the cost of having to accept or reject every changed cell in the table independently.

      The push up processing means that any table that contains a row or cell level update is represented by a table level add and delete.

      The ignore option is similar to the way in which track changes within tables are handled in XMetaL; as neither row insertion and deletion or cell splitting and merging is tracked. However, for clarity this mode of operation ignores all changes within a table, it simply produces the 'B' version of the table.

      Default: XmetalTrackChangesTableChangeMode.DOWN

      Parameters:
      value - the value to set for the xmetalTcsTableChangeMode parameter
      Throws:
      IllegalArgumentException - if the value is null
      See Also:

    • getFrameMakerTrackChangesTableChangeMode

      public FrameMakerTrackChangesTableChangeMode getFrameMakerTrackChangesTableChangeMode()
      Gets the value of the framemakerTcsTableChangeMode parameter.
      Returns:
      the value of the framemakerTcsTableChangeMode parameter

    • setFrameMakerTrackChangesTableChangeMode

      public void setFrameMakerTrackChangesTableChangeMode(FrameMakerTrackChangesTableChangeMode value)

      Specifies how changes in tables should be tracked.

      The FrameMaker editor cannot track the addition or deletion of a row or cell within a table. Such changes can be pushed down to the cell level, pushed up to the table level (e.g. a CALS or HTML 'table' element), or ignored. The advantage of pushing the changes down to the cell content level, is that this provides the highest level of change granularity, at the cost of having to accept or reject every changed cell in the table independently.

      The push up processing means that any table that contains a row or cell level update is represented by a table level add and delete.

      The ignore option is similar to the way in which track changes within tables are handled in FrameMaker; as neither row insertion and deletion or cell splitting and merging is tracked. However, for clarity this mode of operation ignores all changes within a table, it simply produces the 'B' version of the table.

      Default: FrameMakerTrackChangesTableChangeMode.DOWN

      Parameters:
      value - the value to set for the framemakerTcsTableChangeMode parameter
      Throws:
      IllegalArgumentException - if the value is null
      See Also: