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

Various editorial fixes on term definitions and references #48

Merged
merged 2 commits into from Mar 16, 2017

Conversation

tidoust
Copy link
Member

@tidoust tidoust commented Mar 15, 2017

A few updates that were initially meant to fix broken fragments reported by the Link Checker to be able to publish an updated Working Draft. This degenerated a bit in various improvements to internal references to better take advantage of ReSpec. Changes:

  • Added links to GitHub repository and issue tracker near the top of the spec
  • Adjusted terminology section to reference terms actually used by the spec and to use ReSpec new data-cite mechanism: https://github.com/w3c/respec/wiki/data--cite
  • Turned all references to IDL terms into links to the definition of the term
  • Used <var> throughout procedures where referring to variables
  • Dropped explicit IDs from the spec, typically those that ReSpec handles automatically
  • Similarly, simplified references to internal definition to just make use of ReSpec with a simple <a> instead of hardcoding the fragment anchor
  • Fixed broken fragment references

- Added links to GitHub repository and issue tracker near the top of the spec
- Adjusted terminology section to reference terms actually used by the spec
and to use ReSpec new `data-cite` mechanism:
https://github.com/w3c/respec/wiki/data--cite
- Turned all references to IDL terms into links to the definition of the term
- Used `<var>` throughout procedures where referring to variables
- Dropped explicit IDs from the spec, typically those that ReSpec handles
automatically
- Similarly, simplified references to internal definition to just make use
of ReSpec with a simple `<a>` instead of hardcoding the fragment anchor
- Fixed broken fragment references
@stevem-tw stevem-tw merged commit 3646758 into w3c:gh-pages Mar 16, 2017
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.

None yet

2 participants