Skip to content
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

Add note about xml:id valid values, and improve examples #274

Open
2 tasks
nigelmegitt opened this issue Nov 21, 2024 · 0 comments
Open
2 tasks

Add note about xml:id valid values, and improve examples #274

nigelmegitt opened this issue Nov 21, 2024 · 0 comments
Labels
editorial implementation feedback Feedback about the specification from implementers

Comments

@nigelmegitt
Copy link
Contributor

Feedback from @magicbadger:

the contents of the xml:id attribute don’t jump out at me.

Also:

The thing that perhaps caught me is not appreciating that I was creating “Script Events” and that in that case, “xml:id” is mandatory. The error likely comes from me seeing some fairly lean examples at the start of the document that do not have an xml:id. Perhaps it could be worth giving some different use case examples towards the start of the document?

Suggested actions:

  • add note that each xml:id attribute must have a unique value within the document and a summary of the formatting requirements, e.g. must not begin with a digit.
  • make sure the introduction examples include xml:id on <div> elements
@nigelmegitt nigelmegitt added editorial implementation feedback Feedback about the specification from implementers labels Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial implementation feedback Feedback about the specification from implementers
Projects
None yet
Development

No branches or pull requests

1 participant