docs icon indicating copy to clipboard operation
docs copied to clipboard

Fixing message severities

Open stefan-jung opened this issue 8 months ago • 2 comments

Expected Behavior

The suggested severity values mentioned in the docs are not correct in the plugin-messages.dita topic.

Image

The affected element is:

<dl conkeyref="messages-push/severity-levels">
  <dlentry>
    <dt/>
    <dd/>
  </dlentry>
</dl>

The values listed here are no valid attribute values. When looking at the messages_template.xml, I assume the values should be:

  • FATAL
  • ERROR
  • WARN
  • INFO

stefan-jung avatar Apr 03 '25 08:04 stefan-jung

What part is not correct?

plugin-messages.dita uses the push-replace mechanism with @conkeyref="messages-push/severity-levels.

From source-files.ditamap:

<keydef keys="error-messages-details messages-push" href="../topics/error-messages-details.xml"/>

In error-messages-details.xml is:

<dl id="severity-levels">
        <dlentry>
          <dt>Info (I)</dt>
          <dd>Informational messages highlight the progress of transformation and call attention to conditions of which
            you should be aware. For example, draft comments are enabled and will be rendered in the output.</dd>
        </dlentry>
        <dlentry>
          <dt>Warning (W)</dt>
          <dd>The toolkit encountered a problem that should be corrected. Processing will continue, but the output might
            not be as expected.</dd>
        </dlentry>
        <dlentry>
          <dt>Error (E)</dt>
          <dd>The toolkit encountered a more severe problem, and the output is affected. For example, some content is
            missing or invalid, or the content is not rendered in the output</dd>
        </dlentry>
        <dlentry>
          <dt>Fatal (F)</dt>
          <dd>The toolkit encountered a severe condition, processing stopped, and no output is generated.</dd>
        </dlentry>
 </dl>

I have the latest commit and it resolves for me. Or did you mean something else?

lief-erickson avatar Apr 03 '25 14:04 lief-erickson

@lief-erickson, the values.

  • Fatal (F) ➡️ FATAL
  • Error (E) ➡️ ERROR
  • Warning (W) ➡️ WARN
  • Info (I) ➡️ INFO

I assume that

<message id="DOTA011W" type="Warning (W)">
    <reason>The '%1' argument is deprecated.</reason>
    <response>This argument is no longer supported.</response>
</message>

will not work. You probably need to write

<message id="DOTA011W" type="WARN">
    <reason>The '%1' argument is deprecated.</reason>
    <response>This argument is no longer supported.</response>
</message>

stefan-jung avatar Apr 04 '25 06:04 stefan-jung