More flexible title id generation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 806
- Forks
- 434
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 32
Description
Description of problem
URL to affected spec or repo:
https://w3c.github.io/wot-thing-description/ontology/td
What happened (e.g., it crashed)?: ReSpec always inserts the id title for the document title. However, if there is already a section id with value title in the document, it causes issues with linking to that section.
Expected behavior (e.g., it shouldn't crash): In such cases, respec should display a warning. It can also try to iterate and add title2 etc. Even better would be a configuration option to set a custom title id.
Optional, steps to reproduce:
- Go to https://w3c.github.io/wot-thing-description/ontology/td#title
- Expect to land at section 4.3.12 but the window moves to the top of the page, i.e. to the document title
Note: I am not sure why the title needs an id. Maybe removing that addition of the id can make sense?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the affected W3C Thing Description specification at https://w3c.github.io/wot-thing-description/ontology/td and reproduce the conflict at #title. Trace the title ID generation entry point, then decide how duplicate IDs, warnings, iteration, or a custom title ID should be handled. Done means links reach section 4.3.12 without being redirected to the document title.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100