search

speced / bikeshed

:bike: A preprocessor for anyone writing specifications that converts source files into actual specs.
https://speced.github.io/bikeshed
Creative Commons Zero v1.0 Universal
1.1k stars 199 forks source link

Have a way to show errata (open issues) and provisional material (expected updates) #1523

Open dwsinger opened 5 years ago

dwsinger commented 5 years ago

It would be great if errata and provisional updates could be maintained by highlights inline in the spec., in the sections to which they apply. Ideally, whether these are visible could be turned on/off. Errata visibility would help maintenance, I believe (and improves honesty with implementers).

frivoal commented 5 years ago

The kind of output we want to achieve is probably something like: http://files.florian.rivoal.net/edit-rec-sample/2020-05-01.html#principal-flow

The source markup might look something like

<p>This is the <del errata-id=e123>original</del><ins errata-id=e123>modified</ins> spec text.

<div class=errata id=e123>
A minimal change to the spec just to show what this would look like.
</div>

Probably not quite that, but you get the idea.

dwsinger commented 5 years ago

I think that linking to the issue(s) is also desirable (essential), as that enables readers to see and possibly contribute to the conversation.

fantasai commented 4 years ago

Well, we've formalized this in the Process, and there's proposed updates in tr-design now also, see http://fantasai.inkedblade.net/style/design/w3c-restyle/2020/readme#amendment