diff --git a/parameters/configuration-properties-file.dita b/parameters/configuration-properties-file.dita index cdd6ef9c..d984b97f 100644 --- a/parameters/configuration-properties-file.dita +++ b/parameters/configuration-properties-file.dita @@ -76,8 +76,12 @@ compatibility.keyref.treat-blank-as-empty -

Enables compatibility mode that incorrectly processes key references that have only whitespace - content.

+

When set to true, this property enables a compatibility mode that processes key + references that contain only whitespace characters like earlier versions of DITA-OT (prior to version + 4.2.4). This behavior is not correct according to the DITA specification, but this setting ensures that + existing content that relies on this behavior will be processed in the same way as in earlier versions. + Set this property to false to skip these references as intended in the DITA + specification.

This property can only be set in configuration.properties.
diff --git a/release-notes/index.dita b/release-notes/index.dita index 30f2c889..43e23358 100644 --- a/release-notes/index.dita +++ b/release-notes/index.dita @@ -67,12 +67,13 @@ #4540, #4547 -
  • Previous versions of DITA-OT incorrectly processed keyreffing elements that contain only - whitespace characters, where the DITA specification requires them to be skipped. This bug has been fixed, - but the fix is not yet enabled. The incorrect behavior is retained for backwards compatibility to ensure - that existing content that relies on this behavior will be processed in the same way. - A new compatibility.keyref.treat-blank-as-empty property can be used to switch off the - incorrect behavior. The fix will be enabled by default in the next minor or major version. +
  • Previous versions of DITA-OT incorrectly processed key references that contain only whitespace + characters, where the DITA specification requires them to be skipped. This bug has been fixed, but the fix + is not yet enabled. The incorrect behavior is retained for backwards compatibility to ensure that existing + content that relies on this behavior will be processed in the same way as in earlier versions. + A new compatibility.keyref.treat-blank-as-empty property can be set in + configuration.properties to switch off the incorrect + behavior. The fix will be enabled by default in the next minor or major version. #4543, #4544