Re: [xml2rfc-dev] Please help review v3 files

Tom Pusateri <pusateri@bangj.com> Sun, 21 July 2019 18:00 UTC

Return-Path: <pusateri@bangj.com>
X-Original-To: xml2rfc-dev@ietfa.amsl.com
Delivered-To: xml2rfc-dev@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 209EC120169 for <xml2rfc-dev@ietfa.amsl.com>; Sun, 21 Jul 2019 11:00:41 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.001
X-Spam-Level:
X-Spam-Status: No, score=-2.001 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=bangj.com
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id S4_sHgyC2nuN for <xml2rfc-dev@ietfa.amsl.com>; Sun, 21 Jul 2019 11:00:38 -0700 (PDT)
Received: from oj.bangj.com (69-77-154-174.static.skybest.com [69.77.154.174]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 7A86A120161 for <xml2rfc-dev@ietf.org>; Sun, 21 Jul 2019 11:00:38 -0700 (PDT)
Received: from dhcp-9d0b.meeting.ietf.org (dhcp-9d0b.meeting.ietf.org [31.133.157.11]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by oj.bangj.com (Postfix) with ESMTPSA id 6E6EB302A5; Sun, 21 Jul 2019 14:00:37 -0400 (EDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=bangj.com; s=201907; t=1563732037; bh=285wEBsj1duwtUnqEAg8GFaKhR3u4FFtshwqwhXGt+I=; h=Subject:From:In-Reply-To:Date:Cc:References:To:From; b=S5UOC5/HvHlfZoh+++PI1jVs2riqwFAQNx6ajdEG9Eyy2hD+dmP11btTDeFKJCe5S ia6r/1YlmiD9YTcvLQG/St4T/z3COKG937PijbnbT65EGVnDn9vXmGoHTdt6hBTQBm kFXCM4nfnh9pUTT3mhluaFOUfSpRR/MQjqG6EEs+qiBHOqw3zJXFCzyrhZSRxR639H 2S2CFjIPVfL9oIAPVjJKrUoTIJak3iWYn8oA48STbPWmW2IopFej+sX5O7CTwBLiMJ eX5QaJH9YO4dwL0mTKx/7OKst6nZWCPioS/J4LN0/VHmYuIDr4plSVNlb0AXhTK5F/ wsdNrEhMrBBdg==
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 13.0 \(3566.0.1\))
From: Tom Pusateri <pusateri@bangj.com>
In-Reply-To: <8a75c18e-812b-43be-a2a3-9f767052aa75@www.fastmail.com>
Date: Sun, 21 Jul 2019 14:00:36 -0400
Cc: xml2rfc-dev@ietf.org
Content-Transfer-Encoding: quoted-printable
Message-Id: <D2B94504-E932-4865-8116-130D2CE575A0@bangj.com>
References: <62908E23-2FC0-4ED7-84B2-E86454020206@amsl.com> <8a75c18e-812b-43be-a2a3-9f767052aa75@www.fastmail.com>
To: Martin Thomson <mt@lowentropy.net>
X-Mailer: Apple Mail (2.3566.0.1)
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc-dev/6PxP4wtQjWq-9AphnycKqLnrfuI>
Subject: Re: [xml2rfc-dev] Please help review v3 files
X-BeenThere: xml2rfc-dev@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "Discussion about particulars of xml2rfc V3 design, development and code." <xml2rfc-dev.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/xml2rfc-dev>, <mailto:xml2rfc-dev-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/xml2rfc-dev/>
List-Post: <mailto:xml2rfc-dev@ietf.org>
List-Help: <mailto:xml2rfc-dev-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/xml2rfc-dev>, <mailto:xml2rfc-dev-request@ietf.org?subject=subscribe>
X-List-Received-Date: Sun, 21 Jul 2019 18:00:41 -0000

Martin,
	your version of the QUIC draft is very well done. I support merging your changes into the HTML template.

Tom

> On Jul 20, 2019, at 9:25 AM, Martin Thomson <mt@lowentropy.net> wrote:
> 
> I only looked at the first example.
> 
> The table of contents overlay is not great for the reasons Carsten cited.  The spacing between items there is strange.
> 
> The references are similarly strangely formatted.  I think that is just the choice of really large anchor names [I-D.ietf-blablabla] rather than using shorter symbolic names though.
> 
> I don't like the choice of font, but I concede that this is subjective.
> 
> The use of small caps for the "(EDITOR)" designation is jarring.
> 
> The weight of the paragraph anchors is enough that it is very distracting.
> 
> Line lengths are too long.  https://typographyforlawyers.com/line-length.html
> 
> There are too many different font styles in use, particularly in the front matter.  The guidance we got from a professional designer is that you need to reduce the number of variations and that each change should only alter one thing (size, italic, bold, font, etc...)
> 
> There are also a bunch of things that are likely the result of problems in the source document.
> 
> The contributors section seems to be badly formatted in HTML.
> 
> The formatting of the insets in Section 4.2.1 is odd.
> 
> The indentation in Section 4.3 is odd.
> 
> Authors have errant commas.
> 
> The ordering of the trailing sections is a little hard to understand.  There are contributors, then references, then authors.
> 
> In comparison, https://quicwg.org/base-drafts/draft-ietf-quic-transport.html has none of these problems.  It also (subjectively) looks much nicer.
> 
> On Thu, Jul 18, 2019, at 02:19, Sandy Ginoza wrote:
>> Hi all,
>> 
>> As you know, the transition to XMLv3 is quickly approaching.  As part 
>> of our preparation, the RPC is  converting some XMLv2 files to XMLv3.  
>> We’re hoping some of you will take the time to review the files and 
>> provide feedback regarding whether the updates are as expected and the 
>> XMLv3 files are considered “good” v3 files.  
>> 
>> A couple of notes:
>> - we focused on format only; we did not make editorial updates. 
>> - the diff files compare the initial v2v3 output with the files we edited.
>> 
>> Please review the following files:
>> 
>> 1) draft-ietf-spring-segment-routing-msdc
>> https://www.ietf.org/id/draft-ietf-spring-segment-routing-msdc-11.txt
>> 
>> https://www.rfc-editor.org/v3test/draft-ietf-spring-segment-routing-msdc-11-MS.v2v3.html
>> https://www.rfc-editor.org/v3test/draft-ietf-spring-segment-routing-msdc-11-MS.v2v3.pdf
>> https://www.rfc-editor.org/v3test/draft-ietf-spring-segment-routing-msdc-11-MS.v2v3.txt
>> https://www.rfc-editor.org/v3test/draft-ietf-spring-segment-routing-msdc-11-MS.v2v3.xml
>> 
>> rfc-xmldiff:
>> https://www.rfc-editor.org/v3test/draft-ietf-spring-segment-routing-msdc-11-MS.v2v3-xmldiff.html
>> 
>> htmlwdiff:
>> file:///Volumes/rfcpa/inc-work/v3test/draft-ietf-spring-segment-routing-msdc-11-MS.v2v3-htmlwdiff.html
>> 
>> 
>> 2) draft-ietf-isis-l2bundles
>> https://www.ietf.org/id/draft-ietf-isis-l2bundles-07.txt
>> 
>> Please pay particular attention to lists and the use of <aside>.  We 
>> experimented with list styles and used <aside> for notes.  Using 
>> <aside> in this way required some changes because <aside> can’t be used 
>> within lists.  
>> 
>> https://www.rfc-editor.org/v3test/draft-ietf-isis-l2bundles-07-SG.v2v3.html
>> https://www.rfc-editor.org/v3test/draft-ietf-isis-l2bundles-07-SG.v2v3.pdf
>> https://www.rfc-editor.org/v3test/draft-ietf-isis-l2bundles-07-SG.v2v3.txt
>> https://www.rfc-editor.org/v3test/draft-ietf-isis-l2bundles-07-SG.v2v3.xml
>> 
>> rfc-xmldiff:
>> https://www.rfc-editor.org/v3test/draft-ietf-isis-l2bundles-07-SG.orignal.v2v3-xmldiff.html
>> 
>> htmlwdiff:
>> https://www.rfc-editor.org/v3test/draft-ietf-isis-l2bundles-07-SG.orignal.v2v3-htmlwdiff.html
>> 
>> 
>> Thanks for your help!
>> Sandy
>> 
>> _______________________________________________
>> xml2rfc-dev mailing list
>> xml2rfc-dev@ietf.org
>> https://www.ietf.org/mailman/listinfo/xml2rfc-dev
>> 
> 
> _______________________________________________
> xml2rfc-dev mailing list
> xml2rfc-dev@ietf.org
> https://www.ietf.org/mailman/listinfo/xml2rfc-dev