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

"Martin Thomson" <mt@lowentropy.net> Sun, 21 July 2019 17:55 UTC

Return-Path: <mt@lowentropy.net>
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 21895120146 for <xml2rfc-dev@ietfa.amsl.com>; Sun, 21 Jul 2019 10:55:12 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.701
X-Spam-Level:
X-Spam-Status: No, score=-2.701 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_LOW=-0.7, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=lowentropy.net header.b=p6r16bjO; dkim=pass (2048-bit key) header.d=messagingengine.com header.b=QgbOJF4w
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 HqsN56V-wrYV for <xml2rfc-dev@ietfa.amsl.com>; Sun, 21 Jul 2019 10:55:09 -0700 (PDT)
Received: from new3-smtp.messagingengine.com (new3-smtp.messagingengine.com [66.111.4.229]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 746F11200DE for <xml2rfc-dev@ietf.org>; Sun, 21 Jul 2019 10:55:09 -0700 (PDT)
Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailnew.nyi.internal (Postfix) with ESMTP id C0D7B2665; Sun, 21 Jul 2019 13:55:08 -0400 (EDT)
Received: from imap2 ([10.202.2.52]) by compute1.internal (MEProxy); Sun, 21 Jul 2019 13:55:08 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lowentropy.net; h=mime-version:message-id:in-reply-to:references:date:from:to :cc:subject:content-type:content-transfer-encoding; s=fm2; bh=lk byknuOEFe9FR777FZkWUUn8kMVfeQdxO4J14IeFtk=; b=p6r16bjO5Wk/0s6IeA a7IQUdD3RjWKa9sA8SXVBjMA9smK9rSU3varjxEsMRaZukSyZ+sWT7ZDCilPmSqs xP8mPPLlo9b60i0dUp1gD9mBngGP3zwbYD+KFwVkiZAtEb7yJO4sNDKE4IKclBWS Za/hF3Yu70J857Odr+m5z7H04TdxB7RaQ6uuvHY/mgkVKhcNpPyPsbVP3tn3dvpI dkpxipq/1+wV6H01LFddehkJg10lt6X3Kuv3T8iT7xvr+pftKuoj/aaPQ1xuAaHd KTn/SQ60Plj8bolQrLccgamHqaOHas2lBEsYGJNy9Pvu3EakTfCcPxXNvHodTJbY RCrw==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm3; bh=lkbyknuOEFe9FR777FZkWUUn8kMVfeQdxO4J14IeF tk=; b=QgbOJF4wBMpOY5FNy7YOOl0G1YIjvFylsRmBLIrSxP3Z5rF7e9+Wpr+m6 UbxL53IapbhL4O+nUnMS0f/NQr0wB6M7FRKyVekJ7isIREl+YMESYGF4NHCNb4HW 4T0O7KUk/DLrdDGf0xI8V719rALAxW2P5vlMuchTwU+mD2EJTi5JjtMi2VdYPGHh CiyaS4bcsUm8Z3sGAnXtlvlpbpBjH9Ld1fCE55mTfGLA2YwTxzDSWSdN/Aft47LI YsNLZhX3+exNG+e6hBZs8sp+jlrf7L6I3nAWoJrTccrg1A28emfYEBt94Q83GYZ/ +fBn7pmR0WZFxBJgnvhVWjpuGAcIQ==
X-ME-Sender: <xms:_KY0Xftp9AJOkiegxP3mQ7_MVKC6FjPValHBZonPsVTpZ_vD7pwA2w>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduvddrjedvgdduvdduucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhepofgfggfkjghffffhvffutgfgsehtqhertderreejnecuhfhrohhmpedfofgr rhhtihhnucfvhhhomhhsohhnfdcuoehmtheslhhofigvnhhtrhhophihrdhnvghtqeenuc ffohhmrghinheprhhftgdqvgguihhtohhrrdhorhhgpdhthihpohhgrhgrphhhhihfohhr lhgrfiihvghrshdrtghomhdpihgvthhfrdhorhhgpdhquhhitgifghdrohhrghenucfrrg hrrghmpehmrghilhhfrhhomhepmhhtsehlohifvghnthhrohhphidrnhgvthenucevlhhu shhtvghrufhiiigvpedt
X-ME-Proxy: <xmx:_KY0XSioXWOHurXZoz6FBUY1nvrd3GEUfOhOXVSFGFggCoHt3mJvBA> <xmx:_KY0Xc3QP5wE2mYd3J-JEP4ApRdHPP4VTDJVN3L07ihgRXgmJcsDGA> <xmx:_KY0XY4AaSXy-Ug5SJTI_uvcKN5V_6-2XwnElstGYojvk8VSQc1uuA> <xmx:_KY0XevXu9guwT0WCwpKLBycE4sySk3cHJZsUYCg0yhKdSBprN-16A>
Received: by mailuser.nyi.internal (Postfix, from userid 501) id F3356E0178; Sun, 21 Jul 2019 13:55:07 -0400 (EDT)
X-Mailer: MessagingEngine.com Webmail Interface
User-Agent: Cyrus-JMAP/3.1.6-736-gdfb8e44-fmstable-20190718v2
Mime-Version: 1.0
Message-Id: <02160baf-23d0-4388-9a73-c2a908005226@www.fastmail.com>
In-Reply-To: <8a75c18e-812b-43be-a2a3-9f767052aa75@www.fastmail.com>
References: <62908E23-2FC0-4ED7-84B2-E86454020206@amsl.com> <8a75c18e-812b-43be-a2a3-9f767052aa75@www.fastmail.com>
Date: Sun, 21 Jul 2019 13:55:07 -0400
From: Martin Thomson <mt@lowentropy.net>
To: Sandy Ginoza <sginoza@amsl.com>
Cc: xml2rfc-dev@ietf.org
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc-dev/_sT1j5SXKVxzFpo_WD6tw-G-l6o>
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 17:55:12 -0000

Hi Sandy,

Heather tells me that these style sheets are on GitHub and requested that I provide assistance in the form of pull requests.

I'd love to do that, but I can't find them.  Would you mind pointing me (and the list) at the repository?

Cheers,
Martin


On Sat, Jul 20, 2019, at 09:25, Martin Thomson 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
> >