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

Consider associating extract items with the section that contains them #1611

Open
tidoust opened this issue Jul 2, 2024 · 1 comment
Open

Comments

@tidoust
Copy link
Member

tidoust commented Jul 2, 2024

To improve reporting of potential anomalies, and to be able to locate things more easily in a spec, it might be useful to provide some means to associate individual items that appear in extracts with the section that defines them.

That could be done in individual extracts, but that approach might be too verbose. Since we added href properties where ever we could, the mapping between these href properties and sections could perhaps rather be done only once in the IDs extracts.

Regardless of the solution considered, the create-outline module already creates that mapping as a by-product of the outline creation.

Note that the links and refs extracts do not have href properties but we may also want to link back to sections (e.g., to know which sections reference a given spec).

@tidoust
Copy link
Member Author

tidoust commented Jul 2, 2024

Forgot to mention that we already do that mapping for dfns. What's to consider is whether that would make sense for other extracts as well.

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

No branches or pull requests

1 participant