w3c / epub-specs

Shared workspace for EPUB 3 specifications.
Other
305 stars 60 forks source link

Add links to wcag level definitions #2591

Closed mattgarrish closed 11 months ago

mattgarrish commented 1 year ago

Adds a tags to the references in the Accessibility and Techniques documents and fixes a link that only referenced the parent section.

Fixes #2589

Edit: Fixed the broken diff links from the first post.

mattgarrish commented 1 year ago

Shouldn't we add this to the changes' section? At least for the Rec document...

We haven't documented class 1 or 2 changes to date. If we start with this one, should we go back and add the other non-substantive changes?

iherman commented 1 year ago

Shouldn't we add this to the changes' section? At least for the Rec document...

We haven't documented class 1 or 2 changes to date. If we start with this one, should we go back and add the other non-substantive changes?

Class 1 can be safely ignored. For class 2, I think it is a bit of a case-by-case basis. At first, I had the feeling that it is better to add this one, although I am not that sure any more... :-)

mattgarrish commented 1 year ago

Class 1 can be safely ignored.

Isn't this a class 1 change?

We're only adding a hyperlink to existing text -- and it doesn't alter the meaning of that text -- so I assume it falls into the "No changes to text content" bucket.

iherman commented 1 year ago

Class 1 can be safely ignored.

Isn't this a class 1 change?

We're only adding a hyperlink to existing text -- and it doesn't alter the meaning of that text -- so I assume it falls into the "No changes to text content" bucket.

Heh, just for the sake of arguments... I could argue that it adds info to the text because it now opens up the hyperlinks to the reader, which was not there before... Who knows where the boundaries are? But I think we all have better things to do than to discuss these minute things...😀

mattgarrish commented 1 year ago

But I think we all have better things to do than to discuss these minute things...

Ya, my perspective on the change log is that it should only contain things people need to know. That you can now link directly to the level definitions instead of going through the wcag reference doesn't affect anyone's understanding of the specification. Saves you one whole click.. 😄

mattgarrish commented 11 months ago

Merging this one, as well, as these are just links.