-
Notifications
You must be signed in to change notification settings - Fork 821
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
Proposal of accessMode, accessModeSufficient, and accessibilitySummary properties for e.g. epubs #1100
Comments
…/wiki/ePub-3.1-Accessibility--Proposal-To-Schema.org Not currently defining via enumeration - should it?
Thanks for the detailed proposal. I have made a pass at implementing it for wider review and discussion. Draft available at:
In putting this together the most obvious question to ask was about the values of these properties. Schema.org has the notion of an Enumeration, which allows us to define natural-language-neutral URLs for well known property values (e.g. http://schema.org/True). Our previous accessibility-related properties e.g. http://schema.org/accessibilityFeature haven't yet used this construct and instead documented rough lists of possible values in a Wiki. I have for now followed that approach here, and have made a JSON-LD example which shows repeated use of a property for multiple values. This will look somewhat more verbose in RDFa/Microdata. Was this approach your intention or should we look to define more rigid enumerations for accessMode and accessibilitySummary? /cc @betehess who has been investigating the tradeoffs around strings vs enumerated URLs for opening hours ("Monday" vs http://schema.org/Monday etc.).
Also: accessibilitySummary ... can we think through whether this broadly-named property could also serve a purpose for real world / physical accessibility eg. of places? We have discussed such functionality previously (#254). /cc @chaals @vholland @rvguha @pmika @scor @shankarnat @tmarshbing |
So interpreting what the array means is where I got stuck. In your example, you need all the modes. But many resources have multiple sets of accessModeSufficient. So given a movie which requires either audio, or visual+text, to be usable, does something like the following work?
Yes, it wouldn't be a bad start. |
Charles,
Use of accessibilitySummary for general description of accessible places makes sense. We would need to edit the definition, and I would suggest adding a warning that if structured metadata fields are available, they should be used instead of or in addition to a plain-text summary. If summary is the only field adopted widely, we will have less functionality than if accessMode and accessibilityFeature are adopted widely. |
@madeleinerothberg yes it makes sense to add the @danbri does my syntax give the right structure? I've got a head full of 'flu, but it strikes me that there should be a node in the middle, so the resulting data doesn't look like resource -> accessModeSufficient -> (the two arrays, merged). ? |
Ah, yes it sounds like some substructure is needed then. Also I think related to @chaals' point: there's a convention that we try to stick to which is that the meaning of one property/value pair ought not to be undermined by a nearby additional property/value pair, to avoid confusion if the data is subsetted. I don't think we always stick to it though. Sorry that isn't the most helpful explanation, I'll try to work through an example asap. |
Yes, we need some way for each accessModeSufficient statement to remain separate. I wouldn't say that one statement "undermines" the next; each one adds more data about the resource being described without changing the truthfulness of the previous statements. But that might be different than your intended meaning for undermined. |
I think we should move forward on accessibilitySummary while we figure out how to get the model right for the other two. It would indeed be a very valuable property to describe places and products. |
@madeleinerothberg - yes, I was trying to say that we want an additive design as you outline |
I'd be happy to move forward with accessibilitySummary and accessMode (which does not require complicated modeling), but let's not delay figuring out the model for accessModeSufficient. Having summary without the others would encourage use of less structured data when more structure is ultimately going to provide better results. The EPUB community is also eager to get this metadata in place and is moving toward a version 3.1. How can we work this out? Would a synchronous call for interested participants be helpful? |
With Schema 3.0 launched, I'd like to see these accessibility proposals included in the next release. What is necessary to do that? |
Per email exchange, let's try to have a call with @chaals and any other interested parties in early-mid June. |
parses to _:b0 http://schema.org/accessMode "textual" . |
rough example attempt { but I don't see what I expect in http://json-ld.org/playground/ per https://www.w3.org/TR/json-ld/#sets-and-lists |
Here is an alternative formulation that does not use RDF (ie. JSON-LD + RDFa friendly) lists, but instead uses the ListItem construction we have within schema.org:
The triples view from JSON-LD parser (the Playground tool again) is: _:b0 http://schema.org/accessMode "textual" . Tradeoff is that this design is syntax-neutral and works equally well or badly in Microdata. In doing so it opts out of the syntax-level support in JSON-LD (via "@list") and in RDFa 1.1 (via @inlist ). |
Q: to what extent could these concepts be applied to description of Events? |
FWIW I don't think that modelling things as untyped lists of lists is very human-friendly, or in fact good modelling. Doubly so as none of the lists in question are in fact ordered, which means they aren't really lists... Semantically, this is saying that At this point we're really better off having a new class, says {
"@context": "http://schema.org/",
"@type": "Movie",
"name": "Some graphic novel",
"accessMode": ["textual", "visual"],
"accessModeSufficient": [
{
"@type": "AccessModality",
"requiredModality": ["textual", "visual"],
"name": "Closed-captioning"
},
{
"@type": "AccessModality",
"requiredModality": ["audio"],
"description": "Audio description",
"url": "http://berjon.com/singing-some-beyonce.mp3"
}
]
} This might further obviate the need for |
Your approach sounds interesting, will be interested to hear what others think. This approach would not replace the need for accessibilitySummary as this can be used outside of accessModeSufficient for other accessibility descriptions needed in other disciplines other than Digital Publishing. |
@darobin. - the motivation for a list is that it becomes harder to accidentally subset the data, casually altering its semantics quite strongly. The encoding of OWL rules in RDF/S exploited similar structures. It ain't pretty, for sure, but when what you want to say doesn't really partition into independent triples the options are awkward. |
Writing existing use cases in the syntax DanBri proposed, we get these examples. Comments and corrections welcome. Use case 2.B from: "Alice in Wonderland" – Children's book with illustrations According to syntax in:
If instead we use the syntax in:
|
@danbri That can support the case for Also I'm not sure about the "accidentally subset data" problem; I mean this could happen at any time, and is very dependent on how you process the data. We can't be defensive against all such arbitrary cases, unless we start hashing, no? |
|
All of these decisions look fine to me except that I would argue to keep "colorDependent" in the accessMode vocabulary. It is used to flag material which would be difficult to use for someone with color blindness, which is one of the more common visual impairments. In addition, I would argue to keep textOnVisual, which has been a feature of access mode going back several iterations in IMS (with the name textOnImage). Again, this is a common problem for accessibility, when text is included in an image and cannot be adjusted visually or read aloud by TTS. The proposal to add accessMode and its vocabulary doesn't currently include definitions for each term, but as part of this process we will create documentation that includes those definitions and any other materials that the community would like. Would that help alleviate the concerns about these terms? |
@madeleinerothberg can you point us to definitions for these. Currently the draft definitions are just a list of mysterious (to the uninitiated...) strings. Is there an URL elsewhere that e.g. 'textOnVisual' should link to, or a short phrase defining it? |
ColorDependent and textOnImage are both defined in the IMS Access for All v3 public draft in the Data Element Specification document, linked below. We can use these short definitions or improve them, as seems best to this community. We will post additional definitions so that all terms in the schema vocabularies have definitions. Definition of colorDependent from IMS is "Information is conveyed that requires the ability to perceive colour." (It lists the term as "colour", but IMS has decided to adopt the schema.org suggestion of colorDependent since that is a much clearer name; updates to be published soon.) Definition of textOnImage from IMS is "Information is conveyed using text where the text is embedded in an image." |
Is this what everyone has in mind for ItemList syntax? Example 1
Example 2
|
Hi @danbri , we are about to go into IP review with the IDPF next week. It would really be helpful to have this hammered out and if possible some URI's we can point to when we submit our documents for review. |
Ok, I think we're pretty much there.
I'll work on getting the webschemas pending version in a form you can all say "looks good" to, tomorrow. After which I will move them directly out of "pending" into the candidate v3.2 release for final review and publication. Since we have had quite detailed discussions involved schema.org steering group members here there should be no big hurdles beyond that. |
Looks good to me, let's ship :) I'd be grateful if someone can write up an example as RDFa or microdata, not because I think it is a majority use case - although it seems like in catalogs it makes sense to serialise the data out in readable form - but to check that it matches my mental model… |
Pinging as a reminder that the new examples need to be implemented in the pending pages for accessMode and accessModeSufficient. |
accessibilityFeature is already in schema.org These really ought to have better non-markup summaries, and RDFa/Microdata versions.
Thanks for the nudge @madeleinerothberg Done - see http://pending.webschemas.org/accessModeSufficient etc. |
Odd, it works for me. Is http://pending.webschemas.org/accessModeSufficient There are sometimes delays with the site due to multiple servers, caching On 18 October 2016 at 19:48, Charles LaPierre notifications@github.com
|
At that address, I see boilerplate for 4 examples, but the first one is still the older syntax with no item list. (The other three all say "See also https://github.com/daisy/epub-revision-a11y/wiki/ePub-3.1-Accessibility--Proposal-To-Schema.org".) |
Yes I believe it was a caching issue as it is working now. Thanks @danbri |
@danbri I still don't see the new itemlist examples on the pending page -- either on webschemas.org or schema.org. Should those be visible now? See attached image. |
You should see them on http://pending.webschemas.org/accessMode These will get pushed to the stable-released-snapshots version of the schema.org site with our next release. |
Hi @danbri Yes I do see this but the Example # 1 JSON-LD doesn't look right compared with Examples # 2, # 3, # 4 etc.. which do have itemListElement, but example # 1 looks different. I didn't realize that the JSON-LD tabs were specific to each example as they were all pointing to the same See also https://github.com/daisy/epub-revision-a11y/wiki/ePub-3.1-Accessibility--Proposal-To-Schema.org in the "Without-Markup" tab. IE whereas { |
Hello @danbri so we are getting close to the end of the IP review for the EPUB 3.1 Specification where we currently have the following: Every conformant EPUB Publication must include the following [schema.org] accessibility metadata: How close are the new accessMode, accessModeSufficient and accessibilitySummary being adopted in Schema.org is there anything left to do? |
This issue is being tagged as Stale due to inactivity. |
This issue can be closed. The properties were integrated some time back. |
Yes! we got there. Can any of you summarise (or link) to any information on how these properties show up in the world of epub standards? |
Including the metadata in the package document is a required/recommended part of conforming to the EPUB Accessibility specification. There are also more specific examples of how the metadata is expressed in the techniques document. They're also a recommended part of the upcoming W3C Audiobooks specification. And we also detail them in the publishing knowledge base. |
This proposal comes from the digital publishing community, and specifically from the Epub 3.1 Accessibility Working Group (with support from the whole Epub 3.1 group).
This proposal addresses use cases in digital publishing for accessible ebooks for which current metadata is not sufficient. These use cases require distinguishing between an ebook which has the complete text and audio of the work, one with the complete text and partial audio, and one with the complete audio and partial text. Additional permutations of this sort arise as multimedia in ebooks is factored in, requiring an access mode-based solution rather than a vocabulary of types of books.
Like the existing accessibility properties, these new properties can apply to any CreativeWork. They might apply to physical books in some cases (particularly braille books and audio books on physical media) but this work is probably separate from the bibliographic extension.
We are proposing three properties:
accessMode: The human sensory perceptual system or cognitive faculty through which a person may process or perceive information.
accessModeSufficient: A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource.
accessibilitySummary: A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
accessMode is important for defining the basic contents of a file. Is this an ebook with audio or plain text? Are there visuals? Having this information allows a more personalized search process because tools can support users who are looking for materials that meet their needs with or without accessibilityFeatures.
accessModeSufficient is important for distinguishing the various ebook types described above. The use cases in our proposal show in detail why this is necessary to permit fine-grained description of accessible ebooks. It permits a metadata author to be specific about what combinations of access modes will give full access to a resource. Some metadata authors may not wish to author this property; they will still be able to make use of accessMode, which is simpler. Publishers working intensively on accessible ebooks will be motivated to understand and use both properties.
accessModeSufficient may also be useful to search engines seeking to filter resources for users. In some cases, it serves as an encoding of the combination of accessModes and accessibilityFeatures, revealing, for example, that a silent video is accessible even though it lacks captions, because there is no audio to be captioned, or that a web page that has images is accessible to a non-visual user because the images have been described.
accessibilitySummary offers a backup for subtle information that is hard to communicate with structured metadata but might be important to readers searching for a suitable ebook or other resource.
These properties are suitable for non-ebook use as well. Any multimedia resource can be better described with these properties.
The proposal is detailed at the following page, including use cases:
https://github.com/daisy/epub-revision-a11y/wiki/ePub-3.1-Accessibility--Proposal-To-Schema.org
The text was updated successfully, but these errors were encountered: