Package com.deltaxml.dita.config

Class FormattingElementsConfig

java.lang.Object
com.deltaxml.dita.config.FormattingElementsConfig
public class FormattingElementsConfig extends Object
These parameters control which DITA elements are marked as inline formatting elements and how change within them is handled.

  • Constructor Details

    • FormattingElementsConfig

      public FormattingElementsConfig()
      Creates a new FormattingElementsConfig instance. These parameters control which DITA elements are marked as inline formatting elements and how change within them is handled.

    • FormattingElementsConfig

      public FormattingElementsConfig(boolean ignoreInlineFormatting)
      Creates a new FormattingElementsConfig instance, setting the value of the ignoreInlineFormatting parameter. These parameters control which DITA elements are marked as inline formatting elements and how change within them is handled.
      Parameters:
      ignoreInlineFormatting - the value of the ignoreInlineFormatting parameter.

  • Method Details

    • isIgnoreInlineFormatting

      public boolean isIgnoreInlineFormatting()
      Gets the value of the ignoreInlineFormatting parameter.
      Returns:
      the value of the ignoreInlineFormatting parameter

    • setIgnoreInlineFormatting

      public void setIgnoreInlineFormatting(boolean value)

      If set to true, any changes that consist only of the addition, deletion or modification of DITA inline markup elements are not noted as changes.

      When comparing the following 2 versions with ignore-inline-formatting switched on, no changes are marked up.

      <p>This is an important point</p>

      <p>This is an <b>important</b> point</p>

      Default: false

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

    • getInlineFormattingElements

      public String getInlineFormattingElements()
      Gets the value of the inlineFormattingElements parameter.
      Returns:
      the value of the inlineFormattingElements parameter

    • setInlineFormattingElements

      public void setInlineFormattingElements(String value)

      Sets the comma and/or space separated list of inline formatting elements. Only active when ignore-inline-formatting is set to true

      This parameter overrides the built in list of DITA inline elements. If the parameter ignore-inline-formatting is set to true then the addition, deletion or modification of these elements will not be treated as changes.

      The built in list is shown in the default.

      Default: "apiname, b, cite, cmdname, codeph, filepath, i, lines, msgnum, msgph, parmname, pre, q, sep, sub, sup, systemoutput, term, tm, tt, u, uicontrol, userinput, var, wintitle"

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

    • getAddInlineFormattingElements

      public String getAddInlineFormattingElements()
      Gets the value of the addInlineFormattingElements parameter.
      Returns:
      the value of the addInlineFormattingElements parameter

    • setAddInlineFormattingElements

      public void setAddInlineFormattingElements(String value)

      A comma and/or space separated list of inline formatting elements, which will be added to the value of the inline-formatting-elements parameter

      Use this list to add to the value of inline-formatting-elements which you wish to be ignored when considering change processing.

      Elements in this list are added to the set in inline-formatting-elements, before the set in remove-inline-formatting-elements has been removed.

      Default: ""

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

    • getRemoveInlineFormattingElements

      public String getRemoveInlineFormattingElements()
      Gets the value of the removeInlineFormattingElements parameter.
      Returns:
      the value of the removeInlineFormattingElements parameter

    • setRemoveInlineFormattingElements

      public void setRemoveInlineFormattingElements(String value)

      A comma and/or space separated list of inline formatting elements, which will be removed from the value of the inline-formatting-elements parameter

      Use this list to remove from the value of inline-formatting-elements when the defaults include elements you do not wish to be ignored when considering change processing.

      Elements in this list are removed from the set in inline-formatting-elements, after the set in add-inline-formatting-elements has been added.

      Default: ""

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