Skip to content

Conversation

@wh1tewolfxx
Copy link
Contributor

@wh1tewolfxx wh1tewolfxx commented Jun 18, 2025

Update links to reference latest epub3 specification. (#123)

This is:

  • a bug fix
  • an enhancement

Related issue: #123

Description

Update W3 links referencing epub specification to latest version. (https://www.w3.org/TR/epub/)

  • .github
  • Documentation
  • Source

Some section id's changed but most were reusable.

There was a deprecation from 3.2 -> 3.3 about defining collection types. Used best judgement to reference the correct sections for Schema/OPF/Collections/EpubCollection.cs.

See https://www.w3.org/TR/epub/#sec-defining-collection-types

Testing steps

Verify only comments should have been modified. No code changes.

@vers-one
Copy link
Owner

Thank you! I was actually planning to do this next week, so this is really helpful.

One minor suggestion: it would probably be better to use https://www.w3.org/TR/epub-33/ as the base URL, to avoid the documentation links pointing to EPUB 3.4 or EPUB 4 when they come out, since some of the links might get broken.

Copy link
Owner

@vers-one vers-one left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! I checked all links and everything seems to be correct.

I replaced links for collection metadata and collection links with package metadata and package links respectively. It's unfortunate that the descriptions for those elements were removed in EPUB 3.3, even though the elements themselves are still valid within the specification (only the new collection roles were deprecated), but having the links to the package elements is probably the best option here.

@vers-one vers-one added this to the 3.4.0 milestone Jun 21, 2025
@vers-one vers-one merged commit 0d0eb0d into vers-one:master Jun 21, 2025
4 checks passed
@vers-one
Copy link
Owner

This will be released in version 3.4.0.

@vers-one vers-one linked an issue Jun 21, 2025 that may be closed by this pull request
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

Successfully merging this pull request may close these issues.

Update links to EPUB specification to EPUB 3.3 spec

2 participants