Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise landmark examples to implement the WAI site and APG example templates #2835

Open
mcking65 opened this issue Oct 10, 2023 · 1 comment
Labels
enhancement Any addition or improvement that doesn't fix a code bug or prose inaccuracy Example Page Related to a page containing an example implementation of a pattern

Comments

@mcking65
Copy link
Contributor

mcking65 commented Oct 10, 2023

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
@mcking65 mcking65 added enhancement Any addition or improvement that doesn't fix a code bug or prose inaccuracy Example Page Related to a page containing an example implementation of a pattern labels Oct 10, 2023
@mcking65 mcking65 added this to the H2/2023 Content Updates milestone Oct 10, 2023
@css-meeting-bot
Copy link
Member

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//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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Any addition or improvement that doesn't fix a code bug or prose inaccuracy Example Page Related to a page containing an example implementation of a pattern
Development

No branches or pull requests

2 participants