Editorial Changes #2
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Per @iherman's wonderful recommendations, some changes and amendments to the audiobooks spec.
iherman
approved these changes
Apr 9, 2019
mattgarrish
reviewed
Apr 9, 2019
index.html
Outdated
| @@ -55,9 +55,9 @@ <h1>Introduction</h1> | |||
|
|
|||
| <p>This specification is a module of the <a>Web Publication</a> specification. It will describe the requirements to create an Audiobook profile of a Web Publication.</p> | |||
|
|
|||
| <p>An Audiobook is defined as a collection of audio resources grouped together by a reading order, metadata, and resources, all contained in a manifest. This Audiobook can live on the Open Web Platform, or packaged using the <a href="https://w3c.github.io/wpub/index.htmlpackaged-web-publications">Packaged Web Publications</a> specification.</p> | |||
| <p>An Audiobook is defined as a collection of audio resources grouped together by a reading order, metadata, and resources, all contained in a manifest. This Audiobook can live on the Open Web Platform, or packaged using a specification to be determined by the Working Group.</p> | |||
There was a problem hiding this comment.
A minor word of caution would be to make "to be determined by the working group" an ednote, as writing it into the spec prose has a way of leading to it being forgotten over time.
index.html
Outdated
|
|
||
| <p>This specification is intended to bring clear standards to the audiobooks distribution model on the web. It should facilitate different user agent architectures for the consumption of Audiobooks. The primary goal is to bring clarity to a part of the publishing industry currently underserved by standards, while opening Audiobooks to the Open Web Platform and new user agents.</p> | ||
| <p>This specification is intended to bring clear standards to the audiobooks distribution model on the web and between businesses. It should facilitate different user agent architectures for the consumption of Audiobooks. The primary goal is to bring clarity to a part of the publishing industry currently underserved by standards, while opening Audiobooks to the Open Web Platform and new user agents.</p> |
There was a problem hiding this comment.
"clear standards" is one of those subjective kinds of claims that has a way of arousing passions. Just saying it "standardizes" might be all you need here.
index.html
Outdated
| <p>The table of contents is expressed via an [[html]] element (typically a <a href="https://www.w3.org/TR/html/sections.html#the-nav-element"><code>nav</code> element</a>) in one of the <a href="https://w3c.github.io/wpub/indexwp-resources">resources</a>. This element MUST be identified by the <code>role</code> attribute [[html]] value "<code>doc-toc</code>" [[dpub-aria-1.0]], and MUST be the first element in the document — in <a href="https://dom.spec.whatwg.org/#concept-tree-order">document tree order</a> [[dom]] — with that <code>role</code> value.</p> | ||
|
|
||
| <p>If the table of contents is not located in the <a href="https://w3c.github.io/wpub/index#wp-primary-entry-page">primary entry page</a>, the manifest SHOULD <a href="#table-of-contents">identify the resource</a> that contains the structure.</p> | ||
| <p>The Web Publication specification [[wpub]] defines the <a href="https://w3c.github.io/wpub/index.html#wp-table-contents">general structure</a> of the Table of Contents, defined in HTML [[html]].</p> |
There was a problem hiding this comment.
Minor nit, but "define" is used twice in the sentence. I think you can just drop the comma and second instance so it reads "defines the general structure ... in HTML"
|
Although, it looks like there might be a bigger problem with pr-preview right now: tobie/pr-preview#30 |
Updating thanks to Matt's feedback :)
|
@mattgarrish I addressed your comments (and tried to tackle the links, but I will run it through the link checker again once merged). |
mattgarrish
approved these changes
Apr 9, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Per @iherman's wonderful recommendations, some changes and amendments to the audiobooks spec.