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

DPUB "notice" role should have clarifying text and/or a required context role #43

Closed
joanmarie opened this issue Apr 23, 2015 · 10 comments

Comments

@joanmarie
Copy link
Contributor

In the context of published content, an object of role "notice" seems a lot like a tip or comment or annotation. Presumably a non-interactive one.(?) In the context of a web application, however, a "notice" might be something that pops up when you give focus to a password field to let you know Caps Lock is locked or that you're about to be logged out from your banking site. In the former case, a screen reader might want to provide a means to navigate to it on demand; in the latter case, the screen reader should potentially announce it automatically. In the former case, on my platform, the mapping would be ATK_ROLE_COMMENT; in the latter case ATK_ROLE_NOTIFICATION.

The current definition of role "notice" doesn't say anything about whether or not a "notice" is interactive or not, whether a screen reader should automatically present it or not, in what context it should appear or not. I think it would be helpful if such text was added for content/app, user agent, and AT developers.

@joanmarie
Copy link
Contributor Author

Might also be worth pointing to https://rawgit.com/w3c/aria/master/aria/aria.html#alert in the clarifying text.

@mattgarrish
Copy link
Member

Some brief history from epub: originally we had both notice and warning, but consolidated them into one common term. The "notice" name was generally agreed upon as being the most neutral way to refer to the group of warnings, cautions, alerts, etc. that appear in books.

notice and tip are similar, but the distinction is one of importance. A notice contains information that has to be presented to reader at the point they encounter it, whereas a tip is secondary information that could potentially be skipped if the reader only wants to follow the logical reading order.

Currently, neither are conceived as interactive, and notice is not intended to be a live region like the existing alert role.

I definitely agree that we can, and should, provide more guidance. I was expecting we'd get to fleshing out some more detail post-FPWD, as there are other roles I'm sure would likewise benefit from more info. Right now they're mostly just definitions and characteristic tables.

@joanmarie
Copy link
Contributor Author

Another idea occurs to me based on what you said, what I'm concerned about, and related(ish) needs for web apps for document editing: What about a superclass "annotation" or "note" role? Your notice and tip roles might fit nicely under there. A "comment" role for document-editing web apps would too. And anything that is a subclass of an annotation/note is (I would hope) clearly not an interactive thing. :)

@joanmarie
Copy link
Contributor Author

Sorry for being spammy. But you said:

a tip is secondary information that could potentially be skipped if the reader only wants to follow the logical reading order.

And currently you have the superclass role of tip being region. Were you aware that region became a subclass of landmark? See https://rawgit.com/w3c/aria/master/aria/aria.html#substantive-changes-since-the-last-public-working-draft under "29-Jan-2015." (And yes, we really do need to get a new heartbeat draft of the ARIA spec out. We plan to do so soon.)

@mattgarrish
Copy link
Member

Ah, that is problematic. And tips are not intended for inclusion in a table of contents.

Note definitely looks like a more appropriate choice.

@joanmarie
Copy link
Contributor Author

I think note would be a cool superclass that ultimately would be useful in ARIA core. We (ARIA core) wordsmith things pretty thoroughly (I am amongst the guilty), but if you all like it in DPUB it could start there. :)

@mattgarrish
Copy link
Member

I just pushed an update to change.

@TzviyaSiegman
Copy link
Contributor

@joanmarie @mattgarrish is this sufficiently resolved by revision of document in accordance with https://www.w3.org/WAI/PF/wiki/ARIAExtensions? Superclass is still region. Is this candidate for 1.1?

@mattgarrish
Copy link
Member

That's interesting. I pushed a change to the superclass, so no idea where it went. Please leave open as we'll have to update again.

@mattgarrish
Copy link
Member

Updated again.

pkra pushed a commit that referenced this issue May 20, 2024
pkra pushed a commit that referenced this issue May 20, 2024
pkra pushed a commit that referenced this issue May 20, 2024
editorial: fix respec references
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

No branches or pull requests

3 participants