Proposed Correction extension for ReSpec?

TL;DR: There is a new ReSpec extension available for people authoring
specifications that contain Verifiable Credential examples. The structure of
this extension might be useful for the new Process 2021 proposed correction
stuff and this email explores that possibility.

The Verifiable Credentials extension to the ReSpec document authoring
environment enables specification authors to express simple examples of
credentials in their specification which are then enhanced by this extension
to show the digitally signed forms of the Verifiable Credential in different
tabs in the PRE.example blocks.

You can read more about the tool here:

https://github.com/digitalbazaar/respec-vc#readme

Or if you want to just play around with an example, you can do that here:

https://pr-preview.s3.amazonaws.com/w3c/vc-data-model/pull/834.html#example-usage-of-the-id-property

The structure of what's going on here is very similar to what I think we want
for the Proposed Correction stuff... multiple tabs showing "before", "after",
and "diff view".  What I need to know is:

1. Do others think that's the sort of thing we are looking
   for?

2. Is this an addition to ReSpec's code base, or a
   separate extension, and if so, is this[1] the right
   model to follow?

3. I expect there are accessibility/print issues with
   actively hiding/showing tabs... any pointers there?

4. Is this how a ReSpec extension should inject styles
   into the document?
   https://github.com/digitalbazaar/respec-vc/blob/main/index.js#L73-L104

5. Is this how a ReSpec extension should inject
   code into the document?
   https://github.com/digitalbazaar/respec-vc/blob/main/index.js#L106-L138

6. Is there a better way to get "default CSS colors for
   things" than this?
   https://github.com/digitalbazaar/respec-vc/blob/main/index.js#L94

7. Should this be a global? How should people export
   things we want postProcess to call?
   https://github.com/digitalbazaar/respec-vc/blob/main/index.js#L254-L257

8. Do we have a favoured Javascript-based diff'ing
   library we want to use?

If folks feel like this is a useful path, I'm happy to take a cut at an
extension that makes candidate/proposed corrections easier for spec editors.
I'm also happy to stand aside and let the experts address the issue. :)

-- manu

[1]https://github.com/digitalbazaar/respec-vc#usage

-- 
Manu Sporny - https://www.linkedin.com/in/manusporny/
Founder/CEO - Digital Bazaar, Inc.
News: Digital Bazaar Announces New Case Studies (2021)
https://www.digitalbazaar.com/

Received on Sunday, 21 November 2021 19:45:31 UTC