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

Migrate CSS2 prop/value/type dfn to Bikeshed/Shepherd syntax #4880

Closed
gsnedders opened this issue Mar 16, 2020 · 5 comments · Fixed by #4884
Closed

Migrate CSS2 prop/value/type dfn to Bikeshed/Shepherd syntax #4880

gsnedders opened this issue Mar 16, 2020 · 5 comments · Fixed by #4884
Assignees
Labels

Comments

@gsnedders
Copy link
Contributor

Shepherd currently has magic support for how CSS2 is marked up; this will break when we republish as we'll no longer be using a[name] for them.

While we could just modify Shepherd here, for propdefs it's essentially no work (changing the build system), and for the others it's probably worthwhile in case we want to move CSS2 to BS in future.

@gsnedders gsnedders added the CSS2 label Mar 16, 2020
@gsnedders gsnedders self-assigned this Mar 16, 2020
@tabatkins
Copy link
Member

Note that Shepherd will not use the weird heuristics if the dfn is marked up normally for Bikeshed, so no changes to Shepherd should be required as we update things.

@gsnedders
Copy link
Contributor Author

Note that Shepherd will not use the weird heuristics if the dfn is marked up normally for Bikeshed, so no changes to Shepherd should be required as we update things.

The heuristics rely on a[name] and we can't use a[name] as it isn't conforming [[HTML]] [[PUBRULES]].

@tabatkins
Copy link
Member

I'm confused; your response feels like a non sequitur.

What I mean is that if we update things to be marked up properly for Bikeshed, Shepherd will automatically pick those up instead of trying to use heuristics, so we shouldn't need to do anything with Shepherd's code. We can just update css2 to use bs markup and we'll be fine.

@plinss
Copy link
Member

plinss commented Mar 16, 2020

Shepherd also has a number of other heuristics, as long as the anchor has or is inside an ancestor with a 'propdef'/'valuedef'/'valdef'/'vdef'/'typedefdef' class you'll be fine. But I agree, modifying the css2 build system to output proper dfn markup will be better for everyone. Seems like you're modifying it anyway to remove the a[name]s.

@gsnedders
Copy link
Contributor Author

I think we're talking past each other. Yes, if we use <dfn> everything will just work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants