Skip to content

Add doc-pageheader, doc-pagefooter #28

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

Merged
merged 13 commits into from
Oct 2, 2020
Merged

Add doc-pageheader, doc-pagefooter #28

merged 13 commits into from
Oct 2, 2020

Conversation

aleventhal
Copy link
Contributor

@aleventhal aleventhal commented Sep 24, 2020

Closes #10

Also deals with some of the use cases in w3c/aria#1044


Preview | Diff

@aleventhal
Copy link
Contributor Author

Also seeking reviews from @mcking65 @carmacleod @cookiecrook

Copy link
Contributor

@carmacleod carmacleod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aleventhal Looks good so far! Just a few little things to fix up. See comments.

@jnurthen dpub-aria roles that inherit from section or landmark (maybe others) are missing "(deprecated on this role in ARIA 1.2)" on aria-disabled, aria-errormessage, aria-haspopup, and aria-invalid. Do you know what needs to be done to fix this?

[Edit: Opened #31 for flagging the 4 deprecated aria-* global attributes]

aleventhal and others added 10 commits September 25, 2020 12:00
Co-authored-by: Carolyn MacLeod <Carolyn_MacLeod@ca.ibm.com>
Co-authored-by: Carolyn MacLeod <Carolyn_MacLeod@ca.ibm.com>
Co-authored-by: Carolyn MacLeod <Carolyn_MacLeod@ca.ibm.com>
Co-authored-by: Carolyn MacLeod <Carolyn_MacLeod@ca.ibm.com>
Co-authored-by: Carolyn MacLeod <Carolyn_MacLeod@ca.ibm.com>
@aleventhal
Copy link
Contributor Author

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

Copy link
Contributor

@TzviyaSiegman TzviyaSiegman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Contributor

@carmacleod carmacleod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Almost +1, but I'll approve now. Thanks for all the fixes!

It just needs @mattgarrish or @TzviyaSiegman to comment on what element/role to use for the title/author content of a header/footer. Right now, it's just div (no role) which is fine with me, but I don't know if there may be something better.

@aleventhal
Copy link
Contributor Author

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
Copy link
Member

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
Copy link
Contributor Author

aleventhal commented Sep 29, 2020

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

@aleventhal aleventhal closed this Sep 29, 2020
@aleventhal aleventhal reopened this Sep 29, 2020
@aleventhal
Copy link
Contributor Author

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

@aleventhal
Copy link
Contributor Author

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?

…redundant with identifying the page number via a name on the doc-pagebreak.
@aleventhal aleventhal changed the title Add doc-pageheader, doc-pagefooter, doc-pagenum Add doc-pageheader, doc-pagefooter Oct 2, 2020
@jongund
Copy link

jongund commented Oct 2, 2020

@aleventhal
Looks good to me.

@sinabahram
Copy link

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

@aleventhal
Copy link
Contributor Author

aleventhal commented Oct 2, 2020 via email

@sinabahram
Copy link

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

@aleventhal
Copy link
Contributor Author

@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.

@mattgarrish mattgarrish merged commit 6b54c8f into master Oct 2, 2020
@mattgarrish mattgarrish deleted the header-footer-num branch October 2, 2020 22:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Need DPub roles for page-level running headers and footers
7 participants