equal-access icon indicating copy to clipboard operation
equal-access copied to clipboard

[BUG]: DCS WFM Accessibility: sometimes content in <pre class=msgblock> indicate needs review and Verify that ASCII art has a text alternative because it thinks the characters are ASCII

Open patsmith-public opened this issue 2 years ago • 3 comments

Project

IBM Docs Digital Content Services (DCS) Workflow Manager (WFM)

Browser

Firefox

Operating system

Windows

Description

An instance of a msgblock (

) is showing "Needs review" with "Verify that ASCII art has a text alternative.   https://able.ibm.com/rules/archives/preview/doc/en-US/RPT_Pre_ASCIIArt.html. It appears to think that some combination of characters in the verbatim message from the product is ASCII art.

Steps to reproduce

*Go to Product CPD 4.x REVIEW (SSQNUZ_4.x_test) accessibility reports: https://wfm.dcs.ibm.com/product/2f863dc5387ff99eeef9d36ef811af28/reports *Click on report for svc-dv. *Sort by Rule description and look for any instance of RPT_Pre_ASCIIArt * *See snippet".

Example is here: https://ibmdocs-test.mybluemix.net/docs/en/SSQNUZ_4.x_test/svc-dv/ts-provisioning-fails.html

It would be better if the contents of msgblock wasn't analyzed to this degree or somehow the accessibility checker knew that this wasn't ASCII Art but just message text.

patsmith-public avatar Apr 08 '22 19:04 patsmith-public

I think I agree that certain elements should be ignored, however, if an element is used to create ASCII art, then that element should be flagged as potentially having ASCII art. The other elements NOT used for ASCII art should be ignored by the Checker. The Checker does not always know the intent of the developer, except by the correct use of the element type.

Element type that is commonly be used to create ASCII art: <pre ...

Other element types that are not used for ASCII art and should be ignored (not be checked) by the Checker: <code ... <ruby ... <samp ... <script ... etc.

philljenkins avatar Apr 11 '22 16:04 philljenkins

So will the list of element types that will ignore anything that looks like ASCII art include msgph and msgblock, which are used for error messages and phrases?

patsmith-public avatar Apr 12 '22 22:04 patsmith-public

Need to look at our ASCII detection algorithm and determine if there's something we can tighten up here. However, it wouldn't be appropriate to trigger off of msgph and msgblock since those are not meaningful in HTML. This engine is not specific to DCS, so we cannot make assumptions that are specific to DCS.

tombrunet avatar Apr 15 '22 15:04 tombrunet

we may disable the rule for this. (comment out the ruleset).

shunguoy avatar Sep 07 '23 19:09 shunguoy

Decision in planning 9/7/23 that this and the emoticon rule are causing more reviews that we see actual problems in content. Decision to turn these rules off:

  • emoticons_alt_exists
  • asciiart_alt_exists

tombrunet avatar Sep 07 '23 19:09 tombrunet

request for Tom to review on 9/8.

shunguoy avatar Sep 08 '23 14:09 shunguoy

merged

ErickRenteria avatar Sep 19 '23 18:09 ErickRenteria