aria-practices

aria-practices copied to clipboard

Since the launch of the redesigned APG in May 2022, the landmark example pages, e.g., Main Landmark: ARIA Landmarks Example, are the only remaining APG pages that do not implement the WAI site design template nor the APG example template. Because of this, they will be excluded from WAI site search (see w3c/wai-website#357 and w3c/wai-website#362) until they follow site standards. A related issue is #2340.

The current landmark example pages have a significant amount of content that is redundant with the landmark practices page. That was deemed useful when the APG was a TR Note, but that rationale for the redundancy is no longer valid.

Goals of this issue:

• Implement one or more landmarks example pages that utilize standard site and example templates.
• Consider having one landmark example page that includes all 8 landmarks.
• Exploit the fact that all APG pages include 5 of the 8 landmark roles.
• Move non-example content, e.g., resources, to the practices section.
• Eliminate redundant content.
• • Remove jQuery

The ARIA Authoring Practices (APG) Task Force just discussed Issue 2835 - Revise landmark example pages to use site template.

The full IRC log of that discussion

<Matt_King> TOPIC: Issue 2835 - Revise landmark example pages to use site template
<Matt_King> github: https://github.com/w3c/aria-practices/issues/2835
<jongund> MK: Landmark example pages do not use WAI templates
<jongund> MK: Problems loading the APG website
<jongund> MK: We had a highlight feature on the example pages and used a range of landmarks of each page
<jongund> MK: I would like to use a the APG template for the landmark page
<jongund> MK: We could make an example page with all the landmark types, including FORM, SEARCH and REGION
<jongund> MK: The code that is the example would be spread throughout the template
<jongund> MK: Not sure how to address ther coding example
<jongund> MK: The code for landmarks is simple
<jongund> JG: You want to take out the coding examples, they are to simples
<jongund> MK: There would be just one page in the example directory, there is not keyboard
<jongund> MK: Maybe a control to highlight all or individual landmark
<jongund> MK: Visually highlighting the landmarks is important
<jongund> JG: I agree on the highlighting
<jongund> Siri: Mostly I tell people what types of landmarks to use
<jongund> MK: Do you point to the APG examples
<jongund> Siri: I point them to a page using good landmarks
<jongund> AC: I don't reference landmarks a ton in our work
<jongund> Siri: The website is slow
<jongund> JG: Landmarks are not considered a WCAG requirement and in compliance driven process there are more important
<jongund> MK: The HTML defaults are both helpful and problems
<jongund> JG: When people are interested landmarks what should the example tell them
<jongund> MK: We ned to focus on what the landmark example page
<jongund> JG: Do you want me to draft something?
<jongund> MK: What is the best approach here?
<jongund> MK: Some design criteria, what the biggest issue is the words on the page
<siri> https://www.w3.org/WAI/ARIA/apg/patterns/landmarks/examples/main.html
<jongund> MK: I would like to get this done by the end of the year, what is the most important for the example page
<jongund> rrsagent, draft minutes
<RRSAgent> I have made the request to generate https://www.w3.org/2023/10/10-aria-apg-minutes.html jongund

The ARIA Authoring Practices (APG) Task Force just discussed Issue 2835 - Restructuring landmark examples.

The full IRC log of that discussion

<jugglinmike> Topic: Issue 2835 - Restructuring landmark examples
<jugglinmike> github: https://github.com/w3c/aria-practices/issues/2835
<jugglinmike> Matt_King: jongund has a pull request related to this, but I was imagining that we would take a very different approach to the solution
<jugglinmike> jongund: The approach that I was going to try (I don't know when I will have time) was to create an example page that had source code as its primary content
<jugglinmike> jongund: I don't know how that will interfere with the environment
<jugglinmike> Matt_King: Well, there are a couple of things that we could do instead of putting source code there
<jugglinmike> Matt_King: There are some parts of the example template that we could modify. We could take out the "source code" section, for example
<jugglinmike> Matt_King: I'm imagining that we put the source code example in (so it ends up becoming a bunch of named entities), but I liked before where we had these buttons that would highlight the landmarks on the page
<jugglinmike> Matt_King: I'm kind of wondering, though. If you look at any example page--e.g. the example for the accordion. On this page, the landmarks we have are "banner", "navigation", "main", "complimentary"...
<jugglinmike> Matt_King: We could show how the current page uses landmarks visually
<jugglinmike> jongund: I think we want code examples. I think it's important for people to know
<jugglinmike> Matt_King: We already have that code on the "practices" page, though
<jugglinmike> Matt_King: We could eliminate the "landmarks" examples entirely and just tell people to look at the practices page
<jugglinmike> jongund: I think the important information on the current "patterns" pages is, "what to screen readers do with this stuff?" and links to tools that allow people to analyze them
<jugglinmike> Matt_King: We can add a section to the "practices" pages for that
<jugglinmike> jongund: Just as long as we have something like this, so that at least people who have never used a screen reader can have an idea of what the user experience is like
<jugglinmike> Matt_King: I want to really trim down the external links
<jugglinmike> Matt_King: We might be able to solve this whole problem by just adding one or two sections to the current "practices" page. Content that's unique to what's currently in the examples subdirectly
<jugglinmike> Matt_King: We could leave the pattern page there in its current form, or we could remove it entirely
<jugglinmike> Matt_King: Maybe because this is so important, we should talk about the landmarks on the patterns page
<jugglinmike> jongund: I think that solves the problem for the APG. That's good--it's been an outlier for a long time.
<jugglinmike> jongund: But FYI, I would probably take what we have in the current "patterns" page and create a little website that's unaffiliated with the W3C
<jugglinmike> jongund: And maybe update the look and feel a little bit
<jugglinmike> jongund: We have enough problems maintaining the APG. I think it's a good idea
<jugglinmike> Matt_King: I want to make sure we are getting users information that they find helpful. I want the APG to be actionable and helpful. I think the current "practices" page provides a lot of helpful information; we can supplement it
<jugglinmike> Matt_King: For the ARIA-AT work, they will have to be standalone examples. That might be better, anyway
<jugglinmike> Matt_King: But that's a whole different topic
<jugglinmike> Matt_King: So yes, if you can move in that direction with your pull request (whether that means creating a brand new pull request or retrofitting your existing one), that would be great
<jugglinmike> Matt_King: Thank you for helping to make this a very productive meeting, jongund!
<jugglinmike> Zakim, end the meeting