search

w3c / dpub-aria

Digital Publishing WAI-ARIA Module
https://w3c.github.io/dpub-aria/
11 stars 10 forks source link

Add doc-pageheader, doc-pagefooter #28

Closed aleventhal closed 4 years ago

aleventhal commented 4 years ago

Closes https://github.com/w3c/dpub-aria/issues/10

Also deals with some of the use cases in https://github.com/w3c/aria/issues/1044

Preview | Diff

aleventhal commented 4 years ago

Also seeking reviews from @mcking65 @carmacleod @cookiecrook

aleventhal commented 4 years ago

Thanks @carmacleod and @mattgarrish, I've incorporated your suggestions. Please take a look.

aleventhal commented 4 years ago

Matt already added most of the comments I was going to make. I think it would also be worth explaining that this is for circumstances when contentinfo (which is how I treat running headers now) is insufficient)

Thanks Tzviya. Two problems with contentinfo:

  1. It will add lots of extra items to the landmark navigation cycle in a screen reader. If there are 500 pages, this is a lot of landmarks!
  2. It doesn't indicate that the content can be optionally skipped over while reading

I would avoid using contentinfo for these. Because of #1, it would be better to use group or section, until doc-pageheader/doc-pagefooter are available.

Where did you want us to add this info to the PR.

mattgarrish commented 4 years ago

on what element/role to use for the title/author content of a header/footer

I don't think you'd want to identify these in a running header/footer. I would think it would have the effect of repeating this information on every (virtual) page of the document. As the information may be truncated, it's not always equatable with the formal author/title designation.

We were also advised against using ARIA for general metadata when we did the 1.0 release. Once we open the door to author and title tagging, there's a never-ending queue of others that we may get requested (publishers, imprints, illustrators, tranlators, etc., etc., etc.). There are other technologies to support this information, too (package metadata in EPUB, jsonld/RDFa/microdata in HTML).

aleventhal commented 4 years ago

As such, I think using a plain <div> is fine for the author or title.

aleventhal commented 4 years ago

I'm thinking we should get rid of doc-pagenum.

aleventhal commented 4 years ago

I'm thinking we should get rid of doc-pagenum.

  • It's already possible to specify the page number as the name of a doc-pagebreak so removing doc-pagenum avoids a confusing redundancy
  • In the case of there only being a page number in the repeated content, the author can still wrap it in a doc-pageheader or doc-pagefooer

@mattgarrish WDYT?

jongund commented 4 years ago

@aleventhal Looks good to me.

sinabahram commented 4 years ago

This seems quite helpful. Thank you @aleventhal for your work on this.

aleventhal commented 4 years ago

Thanks for these email +1s. Is the GitHub UI letting you mark it as +1 in the interface for the PR? These reviews aren't showing up there. You may need to add yourself as a reviewer.

On Fri, Oct 2, 2020 at 2:49 PM Sina Bahram notifications@github.com wrote:

This seems quite helpful. Thank you @aleventhal https://github.com/aleventhal for your work on this.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/w3c/dpub-aria/pull/28#issuecomment-702900069, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAKQAZRAFDVVM3MORTXUVCTSIYOELANCNFSM4RYZPTPA .

sinabahram commented 4 years ago

@aleventhal not sure I can add myself as a reviewer. Looking to see if I have permission to do so.

aleventhal commented 4 years ago

@mattgarrish @michael-n-cooper we got +1's in the email list from @sinabahram and @jongund, but they couldn't be added as reviewers, presumably because they aren't in the project.