Package com.deltaxml.docbook.config

Class FormattingElementsConfig

java.lang.Object
com.deltaxml.docbook.config.FormattingElementsConfig
public class FormattingElementsConfig extends Object
These parameters control which DocBook elements are marked as inline formatting elements and configures how changes are shown within them.

  • Constructor Details

    • FormattingElementsConfig

      public FormattingElementsConfig()
      Creates a new FormattingElementsConfig instance. These parameters control which DocBook elements are marked as inline formatting elements and configures how changes are shown within them.

    • FormattingElementsConfig

      public FormattingElementsConfig(boolean ignoreInlineFormatting)
      Creates a new FormattingElementsConfig instance, setting the value of the ignoreInlineFormatting parameter. These parameters control which DocBook elements are marked as inline formatting elements and configures how changes are shown within them.
      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 docbook inline markup elements are not noted as changes.

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

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

      <para>This is an <emphasis>important</emphasis> point</para>

      see http://tdg.docbook.org/tdg/5.0/ch02.html#s.inline for a full list of inline markup elements

      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 using Clark notation. Only active when ignore-inline-formatting is set to true

      This parameter overrides the built in list of docbook 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, it is taken from http://tdg.docbook.org/tdg/5.0/ch02.html#s.inline and the same section for Docbook v4.5. Elements, http://tdg.docbook.org/tdg/4.5/ch02.html#ch02-logdiv

      Those elements which do not contain content, such as xref and anchor are not included by default.

      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' - though this is not strictly in Clark notation). Whitespace in namespace or localname at end or beginning is removed. The occurence of '{' or '}' within namespace or localname is considered an error

      Default: "abbrev, acronym, emphasis, phrase, quote, trademark, citation, citerefentry, citetitle, firstterm, glossterm, link, olink, ulink, foreignphrase, wordasword, computeroutput, literal, markup, prompt, replaceable, sgmltag, userinput, inlineequation, mathphrase, subscript, superscript, accel, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, keycap, keycode, keycombo, keysym, menuchoice, mousebutton, shortcut, action, classname, constant, errorcode, errorname, errortype, function, interface, msgtext, parameter, property, returnvalue, structfield, structname, symbol, token, type, varname, application, command, envar, filename, medialabel, option, systemitem, database, email, hardware, optional, {http://docbook.org/ns/docbook}abbrev, {http://docbook.org/ns/docbook}acronym, {http://docbook.org/ns/docbook}emphasis, {http://docbook.org/ns/docbook}phrase, {http://docbook.org/ns/docbook}quote, {http://docbook.org/ns/docbook}trademark, {http://docbook.org/ns/docbook}citation, {http://docbook.org/ns/docbook}citerefentry, {http://docbook.org/ns/docbook}citetitle, {http://docbook.org/ns/docbook}firstterm, {http://docbook.org/ns/docbook}glossterm, {http://docbook.org/ns/docbook}link, {http://docbook.org/ns/docbook}olink, {http://docbook.org/ns/docbook}foreignphrase, {http://docbook.org/ns/docbook}wordasword, {http://docbook.org/ns/docbook}computeroutput, {http://docbook.org/ns/docbook}literal, {http://docbook.org/ns/docbook}markup, {http://docbook.org/ns/docbook}prompt, {http://docbook.org/ns/docbook}replaceable, {http://docbook.org/ns/docbook}tag, {http://docbook.org/ns/docbook}userinput, {http://docbook.org/ns/docbook}inlineequation, {http://docbook.org/ns/docbook}mathphrase, {http://docbook.org/ns/docbook}subscript, {http://docbook.org/ns/docbook}superscript, {http://docbook.org/ns/docbook}accel, {http://docbook.org/ns/docbook}guibutton, {http://docbook.org/ns/docbook}guiicon, {http://docbook.org/ns/docbook}guilabel, {http://docbook.org/ns/docbook}guimenu, {http://docbook.org/ns/docbook}guimenuitem, {http://docbook.org/ns/docbook}guisubmenu, {http://docbook.org/ns/docbook}keycap, {http://docbook.org/ns/docbook}keycode, {http://docbook.org/ns/docbook}keycombo, {http://docbook.org/ns/docbook}keysym, {http://docbook.org/ns/docbook}menuchoice, {http://docbook.org/ns/docbook}mousebutton, {http://docbook.org/ns/docbook}shortcut, {http://docbook.org/ns/docbook}classname, {http://docbook.org/ns/docbook}constant, {http://docbook.org/ns/docbook}errorcode, {http://docbook.org/ns/docbook}errorname, {http://docbook.org/ns/docbook}errortype, {http://docbook.org/ns/docbook}function, {http://docbook.org/ns/docbook}msgtext, {http://docbook.org/ns/docbook}parameter, {http://docbook.org/ns/docbook}property, {http://docbook.org/ns/docbook}returnvalue, {http://docbook.org/ns/docbook}symbol, {http://docbook.org/ns/docbook}token, {http://docbook.org/ns/docbook}type, {http://docbook.org/ns/docbook}varname, {http://docbook.org/ns/docbook}application, {http://docbook.org/ns/docbook}command, {http://docbook.org/ns/docbook}envar, {http://docbook.org/ns/docbook}filename, {http://docbook.org/ns/docbook}option, {http://docbook.org/ns/docbook}systemitem, {http://docbook.org/ns/docbook}database, {http://docbook.org/ns/docbook}email, {http://docbook.org/ns/docbook}hardware, {http://docbook.org/ns/docbook}optional"

      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 using Clark notation, which will be added to the value of the inline-formatting-elements parameter

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

      Elements in this set are added to the set in inline-formatting-elements, before the set in remove-inline-formatting-elements is 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 using Clark notation, which will be removed the list specified in the inline-formatting-elements parameter

      Use this list to remove names from the value of inline-formatting-elements when the defaults include elements you wish not to be ignored as changes.

      Elements in this set are removed to 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