WebAIM - Web Accessibility In Mind

E-mail List Archives

Thread: "Q&A" content presentation question

for

Number of posts in this thread: 3 (In chronological order)

From: Piscitelli, JoAnn
Date: Wed, Jan 08 2020 10:54AM
Subject: "Q&A" content presentation question
No previous message | Next message →

Dear WebAIM Forum,

I have a question regarding content formatting for a Q&A page presentation.

Traditionally, Q&A on a web page is presented like this:

Q: Phasellus lacinia, dui id pretium volutpat, ante mi tempor mauris, luctus tempor dolor urna et odio?
A: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut porttitor congue felis ut hendrerit. Mauris fermentum orci enim, vel tempor ex ullamcorper ut. Donec varius ut libero fermentum vulputate. Nulla mauris orci, scelerisque in felis in, semper scelerisque lectus. Ut porta turpis sit amet est volutpat, quis euismod leo rutrum. In posuere ante ut erat malesuada congue. Sed gravida nibh eu mauris tincidunt euismod.

With accessibility in mind, should the ‘Q' and ‘A' be spelled out, ‘question' and ‘answer', to be formatted like this:

Question: Phasellus lacinia, dui id pretium volutpat, ante mi tempor mauris, luctus tempor dolor urna et odio?
Answer: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut porttitor congue felis ut hendrerit. Mauris fermentum orci enim, vel tempor ex ullamcorper ut. Donec varius ut libero fermentum vulputate. Nulla mauris orci, scelerisque in felis in, semper scelerisque lectus. Ut porta turpis sit amet est volutpat, quis euismod leo rutrum. In posuere ante ut erat malesuada congue. Sed gravida nibh eu mauris tincidunt euismod.

I'm asking this for users that may use a screen reader.

I look forward to your feedback and advice!

Happy New Year to all!

Jo

From: glen walker
Date: Wed, Jan 08 2020 11:42AM
Subject: Re: "Q&A" content presentation question
← Previous message | Next message →

There might be some users where spelling out "question" and "answer"
instead of Q and A will be helpful They aren't necessarily visually
impaired users. It could be a cognitive issue.

There's not really a compliance reason to spell it out because it's
generally accepted that Q and A means questions and answers but you can
certainly do it for usability reasons.

I would more concerned with semantically marking up the code properly to
make it easy to navigate with a screen reader. A dl/dt/dd list is probably
the closest semantically to what you want, but support for those lists is
different among the different screen readers. Some treat every dt and dd
as a list item, so it sounds like the list is twice as big as it is. So I
usually use a simple ul (or you can use an ol if you want to number your
questions). The problem with ul is that if you turn off the bullet points
using list-type:none, then some screen readers (Voiceover) will not treat
the list as a list so you have to add back in ARIA attributes to make it a
list (https://www.scottohara.me/blog/2019/01/12/lists-and-safari.html).

There are a lot of ways to organize it. Here's a quick one that I'm sure
can be improved upon. It hides Q from the screen reader and says
"question" instead. That doesn't help cognitive sighted users but you can
choose whether to do that or not. The screen reader user can use the L key
to find the list itself and the I (eye) key to navigate to each list item
to quickly jump from question to question.

<ul>
<li>
<p><span aria-hidden="true">Q</span><span
class="sr-only">Question</span>: Lorem ipsum...</p>
<p><span aria-hidden="true">A</span><span
class="sr-only">Answer</span>: Lorem ipsum...</p>
</li>
<li>...</li>
<li>...</li>
</ul>


On Wed, Jan 8, 2020 at 10:54 AM Piscitelli, JoAnn < = EMAIL ADDRESS REMOVED = >
wrote:

> Dear WebAIM Forum,
>
> I have a question regarding content formatting for a Q&A page presentation.
>
> Traditionally, Q&A on a web page is presented like this:
>
> Q: Phasellus lacinia, dui id pretium volutpat, ante mi tempor mauris,
> luctus tempor dolor urna et odio?
> A: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut porttitor
> congue felis ut hendrerit. Mauris fermentum orci enim, vel tempor ex
> ullamcorper ut. Donec varius ut libero fermentum vulputate. Nulla mauris
> orci, scelerisque in felis in, semper scelerisque lectus. Ut porta turpis
> sit amet est volutpat, quis euismod leo rutrum. In posuere ante ut erat
> malesuada congue. Sed gravida nibh eu mauris tincidunt euismod.
>
> With accessibility in mind, should the ‘Q' and ‘A' be spelled out,
> ‘question' and ‘answer', to be formatted like this:
>
> Question: Phasellus lacinia, dui id pretium volutpat, ante mi tempor
> mauris, luctus tempor dolor urna et odio?
> Answer: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut
> porttitor congue felis ut hendrerit. Mauris fermentum orci enim, vel tempor
> ex ullamcorper ut. Donec varius ut libero fermentum vulputate. Nulla mauris
> orci, scelerisque in felis in, semper scelerisque lectus. Ut porta turpis
> sit amet est volutpat, quis euismod leo rutrum. In posuere ante ut erat
> malesuada congue. Sed gravida nibh eu mauris tincidunt euismod.
>
> I'm asking this for users that may use a screen reader.
>
> I look forward to your feedback and advice!
>
> Happy New Year to all!
>
> Jo
>
> > > > >

From: Piscitelli, JoAnn
Date: Wed, Jan 08 2020 12:54PM
Subject: Re: "Q&A" content presentation question
← Previous message | No next message

Thank you VERY much! And very much appreciated!

Best wishes,

Jo

On 1/8/20, 1:44 PM, "glen walker" < = EMAIL ADDRESS REMOVED = > wrote:

There might be some users where spelling out "question" and "answer"
instead of Q and A will be helpful They aren't necessarily visually
impaired users. It could be a cognitive issue.

There's not really a compliance reason to spell it out because it's
generally accepted that Q and A means questions and answers but you can
certainly do it for usability reasons.

I would more concerned with semantically marking up the code properly to
make it easy to navigate with a screen reader. A dl/dt/dd list is probably
the closest semantically to what you want, but support for those lists is
different among the different screen readers. Some treat every dt and dd
as a list item, so it sounds like the list is twice as big as it is. So I
usually use a simple ul (or you can use an ol if you want to number your
questions). The problem with ul is that if you turn off the bullet points
using list-type:none, then some screen readers (Voiceover) will not treat
the list as a list so you have to add back in ARIA attributes to make it a
list (https://nam05.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.scottohara.me%2Fblog%2F2019%2F01%2F12%2Flists-and-safari.html&amp;data%7C01%7Cjoann.piscitelli%40yale.edu%7Cf5309d13eaea45f443da08d7946abbfb%7Cdd8cbebb21394df8b4114e3e87abeb5c%7C0%7C0%7C637141058455596990&amp;sdata=WW5ILjrAUApVLxm63B5o84RvTut6JD%2BDp%2B6p1Bt%2Fidc%3D&amp;reserved=0).

There are a lot of ways to organize it. Here's a quick one that I'm sure
can be improved upon. It hides Q from the screen reader and says
"question" instead. That doesn't help cognitive sighted users but you can
choose whether to do that or not. The screen reader user can use the L key
to find the list itself and the I (eye) key to navigate to each list item
to quickly jump from question to question.

<ul>
<li>
<p><span aria-hidden="true">Q</span><span
class="sr-only">Question</span>: Lorem ipsum...</p>
<p><span aria-hidden="true">A</span><span
class="sr-only">Answer</span>: Lorem ipsum...</p>
</li>
<li>...</li>
<li>...</li>
</ul>


On Wed, Jan 8, 2020 at 10:54 AM Piscitelli, JoAnn < = EMAIL ADDRESS REMOVED = >
wrote:

> Dear WebAIM Forum,
>
> I have a question regarding content formatting for a Q&A page presentation.
>
> Traditionally, Q&A on a web page is presented like this:
>
> Q: Phasellus lacinia, dui id pretium volutpat, ante mi tempor mauris,
> luctus tempor dolor urna et odio?
> A: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut porttitor
> congue felis ut hendrerit. Mauris fermentum orci enim, vel tempor ex
> ullamcorper ut. Donec varius ut libero fermentum vulputate. Nulla mauris
> orci, scelerisque in felis in, semper scelerisque lectus. Ut porta turpis
> sit amet est volutpat, quis euismod leo rutrum. In posuere ante ut erat
> malesuada congue. Sed gravida nibh eu mauris tincidunt euismod.
>
> With accessibility in mind, should the ‘Q' and ‘A' be spelled out,
> ‘question' and ‘answer', to be formatted like this:
>
> Question: Phasellus lacinia, dui id pretium volutpat, ante mi tempor
> mauris, luctus tempor dolor urna et odio?
> Answer: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut
> porttitor congue felis ut hendrerit. Mauris fermentum orci enim, vel tempor
> ex ullamcorper ut. Donec varius ut libero fermentum vulputate. Nulla mauris
> orci, scelerisque in felis in, semper scelerisque lectus. Ut porta turpis
> sit amet est volutpat, quis euismod leo rutrum. In posuere ante ut erat
> malesuada congue. Sed gravida nibh eu mauris tincidunt euismod.
>
> I'm asking this for users that may use a screen reader.
>
> I look forward to your feedback and advice!
>
> Happy New Year to all!
>
> Jo
>
> > > > >