Skip to content
This repository has been archived by the owner on Apr 26, 2022. It is now read-only.

Update index.html #102

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update index.html #102

wants to merge 1 commit into from

Conversation

gcyrillus
Copy link

@gcyrillus gcyrillus commented Nov 27, 2021

typo within example about role="list" where a p is closed with an </li> on line 161

typo within example about role="list" where a p is closed with an </li> on line 161
@mattgarrish
Copy link
Member

The fix is correct, but be aware that the example is no longer valid. ARIA changed their rules after we released the module, so list item roles from modules do not satisfy the requirement for the core list role. (It'll work fine in AT, but is conceptually invalid.) You can skip doc-biblioentry on list items, as the updated module defines how AT can infer these from the parent doc-bibliography role on the section.

These documents need figuring out more generally, though. They should be in W3C, but the IDPF ones are more recently updated than these ports. Plus these documents were never formally published, so it seems people are finding their way into outdated drafts.

@gcyrillus
Copy link
Author

Sorry, I landed here from https://www.w3.org/community/epub3/ . I was trying to figure out which epub version to use so it is compatible with most readers and learn from the beginning how to do it with the best practice and advise i can find, before generating one. (trying to create a plugin for a cms to turn articles into an epub file to keep & read offline).

@mattgarrish
Copy link
Member

No worries. My comment about what to do with these files was directed to the community group folks that follow this repository.

There are two basic problems with what you've discovered: one is that the example is wrong (and outdated) and the other is that we shouldn't have two sets of documents for the guides and whatever else is in this repository. For example, you can find the "official" (as far as my maintaining it) version of the same document here: https://idpf.github.io/epub-guides/epub-aria-authoring/

Compounding the problem is that this repository looks like it may be abandoned, as I believe the Publishing CG is using this one now: https://github.com/w3c/publishingcg

Having two repositories for the CG is a bit odd.

To fix the problems, we need a strategy for updating and publishing these documents so that they aren't maintained in two places.

But these aren't details you need to concern yourself about.

For now, I'd recommend reading the IDPF guides, as they've been more recently updated. There's an index of them here: https://idpf.github.io/epub-guides/

Best of luck with your project!

@gcyrillus
Copy link
Author

Thank you very much ! Hope you find a way to sort this out. Take care.

@mattgarrish
Copy link
Member

/cc @mteixeira-wwn @Jeffxz

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants