Re: how to generate diff for webauthn specs?

[ Hi Rolf, apologies for latency, was distracted by nice snow last week 
:)   also am cc'g public-webauthn@, hope that is ok ]

On 2/21/18, 12:06 PM, "Rolf Lindemann" <rlindemann@noknok.com> wrote:>
 > do you know how to generate nice looking diffs for WebAuthentication
 > specs (e.g. WD07 to current ED)? Did you use DaisyDiff for that in the
 > past?

good question.

For "rendered (inline) HTML diffs" I'm using both Daisydiff-1.2
<https://code.google.com/archive/p/daisydiff/downloads> and whichever of
the W3C HTML Diff tools is wired into "pr-previw" ("pull request
preview") tool we hooked into the github.com/w3c/webauthn/ repo that
automatically generates a rendered HTML "inline" diff on a per-PR basis
and auto-adds a link to the most-current diff to the "original post"
(OP) of the PR, e.g.:

 
<https://pr-preview.s3.amazonaws.com/w3c/webauthn/821/e3c1ad4...gmandyam:241a56b.html>


Additionally, I personally prefer side-by-side diffs, but there does not
seem to be such for "rendered" HTML diffs, and so I also often generate
a "text-only" side-by-side diff using lynx [1] to extract a text-only
version of the bikeshed-generated HTML, then using kdiff3 (a *nix-based
tool I installed on Mac using homebrew; for windows see [2]) to generate
the side-by-side diff, and then printing that to a PDF file [3]. E.g.:

  • kdiff3-style PDF side-by-side text-only Diff
    <http://kingsmountain.com/doc/diff/diff-webauthn-WD-07--from--WD-06.pdf>

this does not work well for specs with lots of HTML tables, such as the
CTAP spec -- the table structure is not preserved and all the text runs
together :(

but all the above works ok for the WebAuthn spec, see [4]

HTH,

=JeffH


[1] lynx -crawl -dump file:///<path from root dir to html file to render
text only>/<input rendered HTML filename>   >    <output filename>

[2] AFAIK one can install the "windows subsystem for Linux" on Win 10
and then install a Linux distro and kdiff3 ought to just be there or you
can then install it using whichever distro-specific package manager
you're using.

[3] the pdf printing settings I use are:
     * paper: US Legal 11x17"
     * orientation: landscape
     * kdiff3 display font:
       monospaced and as small as possible (on my system that's 9pts)

[4] Diffs of WebAuthn WD-07 from WD-06:

• W3C-style rendered HTML “inline” Diff
 
<https://services.w3.org/htmldiff?doc1=&doc2=https%3A%2F%2Fwww.w3.org%2FTR%2F2017%2FWD-webauthn-20171205%2F>
   (see also: <https://services.w3.org/htmldiff>)

• Daisydiff-style rendered HTML “inline” Diff
   <http://kingsmountain.com/doc/diff/diff-webauthn-WD-07--from--WD-06.html>

• kdiff3-style PDF side-by-side text-only Diff
   <http://kingsmountain.com/doc/diff/diff-webauthn-WD-07--from--WD-06.pdf>


---
end

Received on Monday, 26 February 2018 18:47:39 UTC