Package com.deltaxml.docbook.config

Class PhraseChanges

java.lang.Object
com.deltaxml.docbook.config.PhraseChanges
public class PhraseChanges extends Object
Settings that affect the behaviour of displaying text changes.

  • Constructor Details

    • PhraseChanges

      public PhraseChanges()
      Create a new PhraseChanges instance. Settings that affect the behaviour of displaying text changes.

  • Method Details

    • isShowNonPhraseChanges

      public boolean isShowNonPhraseChanges()
      Gets the value of the showNonPhraseChanges parameter.
      Returns:
      the value of the showNonPhraseChanges parameter

    • setShowNonPhraseChanges

      public void setShowNonPhraseChanges(boolean value)

      Sets whether to textually mark changes to text where <phrase>; elements are not allowed.

      If text has changed within an element where phrase markup is not allowed, some other means must be used to process the changes. If this parameter is set to true, the changed text is wrapped in textual delimiters e.g. -[[old text ]]- +[[new text ]]+. If the value is set to false, no markup is used and only the new text is output.

      Default: "true"

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

    • getAdditionalPhraseContainers

      public String getAdditionalPhraseContainers()
      Gets the value of the additionalPhraseContainers parameter.
      Returns:
      the value of the additionalPhraseContainers parameter

    • setAdditionalPhraseContainers

      public void setAdditionalPhraseContainers(String value)

      Sets the comma and/or space separated list of additional phrase elements using Clark notation.

      The Clark notation represents an element by a string that has the form '{namespace}localname'. Elements in the default namespace are represented by '{}localname' (or simply 'localname' - thought this is not strictly in Clark notation).

      This can be useful in situations where the DocBook has been customized to include some extra elements that contain phrase elements. Adding such elements via this parameter enables these elements to contain changes 'text changes' that are marked up using phrases.

      Default: ""

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