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

Proposal for numbering examples for cross-referencing #673

Closed
andrea-perego opened this issue Jan 19, 2019 · 4 comments
Closed

Proposal for numbering examples for cross-referencing #673

andrea-perego opened this issue Jan 19, 2019 · 4 comments

Comments

@andrea-perego
Copy link
Contributor

I would suggest we number examples in the DCAT spec, so that they can be both cross-referenced inside the spec, and linked to from external documents.

If this makes sense, I can start and give it a try. There's also a script we used in the SDW BPs that can take care of creating the cross ref text automatically (as we do for sections with class sectionRef):

https://github.com/w3c/sdw/blob/6f532fc04ff55fead8278f5d46984830185c2a0d/bp/index.html#L9

This way the example number in the cross ref text will be dynamically inferred, and needn't be hard-coded.

Also noting the relevant feature request to ReSpec: https://github.com/w3c/respec/issues/1124

@andrea-perego
Copy link
Contributor Author

andrea-perego commented Jan 20, 2019

Proposed revision in PR #674

NB: I have not included yet the SDW BP script I mentioned above.

@davebrowning
Copy link
Contributor

That's all been merged, @andrea-perego, and looks pretty good even just from a layout perspective. If you get a chance to add the script then that would make it more useful (I don't fancy renumbering links every so often....)

@andrea-perego
Copy link
Contributor Author

Thanks, @davebrowning . I'll take care of creating the relevant PR.

@davebrowning
Copy link
Contributor

Done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
DCAT revision
  
Done
Development

No branches or pull requests

2 participants