WebAIM - Web Accessibility In Mind

E-mail List Archives

Re: highlighting code changes on an html page


From: Tim Harshbarger
Date: Dec 24, 2019 3:37AM

Other things I have seen work would be including a description of the coding
changes that will be made in the code in the paragraphs of text prior to the
code or adding comments in the code indicating An old but still useful
approach is to describe the changes that will be made to the code in the
paragraphs of text prior to the code and/or include comments in the code
that indicate where changes or additions have been made.

Tim Harshbarger
Senior Accessibility Consultant
Deque Systems

-----Original Message-----
From: WebAIM-Forum < <EMAIL REMOVED> > On Behalf Of
Birkir R. Gunnarsson
Sent: Monday, December 23, 2019 3:48 PM
To: WebAIM Discussion List < <EMAIL REMOVED> >
Subject: Re: [WebAIM] highlighting code changes on an html page

How complicated is it?
Does the new code come in blocks or are there attributes that have been
added or changed and are visually highlighted as such?
If you can always separate the new code out by blocks you can use
role="region" and aria-label="added code" as one option for a screen reader.
If the changes are smaller than that, i.e. changes to individual attributes,
you have to get awfully creative (because screen readers have awfully poor
support for text level semantics).

On 12/23/19, Don Raikes < <EMAIL REMOVED> > wrote:
> I am working on a web tutorial that includes code snippets.
> The existing tutorial uses bold text to highlight what code has been
> added to the snippet. Since a screen reader wouldn't necessarily know
> that text is bolded, is there a "best practice" for how to indicate
> changed code in this scenario?
> --
> Thanks, Donald
> "As a leader, to be successful, is to help the people around you to be
> successful." - Kent Boucher
> Accessibility, like security, is better when built-in from the
> beginning rather than bolted on at the end.
> http://www.oracle.com/
> Donald Raikes | Accessibility Specialist
> Mobile: HYPERLINK "tel:+15202717608"+15202717608 | VOIP: HYPERLINK
> "tel:+15205744033"+15205744033
> Oracle Accessibility Program Office
> | Tucson, Arizona
> http://www.oracle.com/commitment
> Oracle is committed to developing practices and products that help
> protect the environment
> > > archives at http://webaim.org/discussion/archives
> >

Work hard. Have fun. Make history.