Respec: Better integration with infra spec

Created on 20 Feb 2018  路  10Comments  路  Source: w3c/respec

Bikeshed has great integration with infra like, if you do for each you can easily refer to which one to use, like

[=set/For each=] or [=map/For each=] or [=list/For each=]

The infra spec:
http://infra.spec.whatwg.org

Most helpful comment

Agree. Might be something we do as part of #1502 if we get time.

All 10 comments

Would be nice to support these inlines... tho the syntax is kinda fugly.

Current solution:

  • <a data-cite="infra#set-iterate">For each</a>
  • <a data-cite="infra#map-iterate">For each</a>
  • <a data-cite="infra#list-iterate">For each</a>

Yes, it's much longer, but it's more clear... I'm open to suggestions on inlining, however... we could just use BS's syntax for compat.

@kenchris, do you know if you get any other bonus things from BikeShed from the above? Or just the linking?

I am not sure, but the syntax makes the text source very readable

Agree. Might be something we do as part of #1502 if we get time.

For folks following at home, what we need is a generic model for inlining things similar to: https://tabatkins.github.io/bikeshed/#autolinking

We should find a generic way to auto link with some inline syntax that's not super ugly. We don't need to follow BikeShed - the syntax should be intuitive and generalizable.

@kenchris, I can't find the integration in BikeShed... at least, it's not documented in the autolinking section. Where did you see this?

So this is no longer a part of #1502 ?

Still part of #1502. It鈥檚 quite a significant problem/task.

@marcoscaceres I saw this used in all the Generic Sensor APIs specs

Thanks! Will take a look at how it鈥檚 used there. I use an infra list in Payments, so would also benefit.

Fixed via #2261

Was this page helpful?
0 / 5 - 0 ratings

Related issues

marcoscaceres picture marcoscaceres  路  4Comments

andrea-perego picture andrea-perego  路  3Comments

noamr picture noamr  路  3Comments

sidvishnoi picture sidvishnoi  路  4Comments

marcoscaceres picture marcoscaceres  路  6Comments