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

"Martin Thomson" <mt@lowentropy.net> Thu, 01 August 2019 05:19 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 4EB8C12002E for <xml2rfc-dev@ietfa.amsl.com>; Wed, 31 Jul 2019 22:19:12 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.7
X-Spam-Level:
X-Spam-Status: No, score=-2.7 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, URIBL_BLOCKED=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=D2nT83Oa; dkim=pass (2048-bit key) header.d=messagingengine.com header.b=GVr/uqE6
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 UkpuBO364snR for <xml2rfc-dev@ietfa.amsl.com>; Wed, 31 Jul 2019 22:19:10 -0700 (PDT)
Received: from out4-smtp.messagingengine.com (out4-smtp.messagingengine.com [66.111.4.28]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id DCF6B12000F for <xml2rfc-dev@ietf.org>; Wed, 31 Jul 2019 22:19:09 -0700 (PDT)
Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id 037E321F9F for <xml2rfc-dev@ietf.org>; Thu, 1 Aug 2019 01:19:09 -0400 (EDT)
Received: from imap2 ([10.202.2.52]) by compute1.internal (MEProxy); Thu, 01 Aug 2019 01:19:09 -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 :subject:content-type:content-transfer-encoding; s=fm2; bh=aJL4o RPszsPgodQb+Q958ktNPK5Qjj7gT9phUzImvM8=; b=D2nT83OawUlkbyhmYzDEA ZSrW6Exz1RBNUPQNO+Tpk5zzr2UBv/SJ6yevg49Cm0YJl0q/Xi9ldC42+XSUrw8m N93qjxMO8JXjxRrBKD8KkW6pgJaS8eArFILjLwcTVs4SXKHObBtNk/jlvPyEjhyD ly7YsIam7hxPYxboD/v706kQZxQbckwdtEIN3WjvCUpgQaaUK+X2O+ySZD3pc5AR BSsP/9uRinouY7qPC5W73BkfXEwJlQ8p85/B+AnFUV5tTS0AIG78qhtSc+qjPE43 xpcbEFLd85e5T1FwpCaO9xaCWJDcZUFRbQZf1eRHxRDTQ7DhR79pU1IvDFnMHkEM g==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=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=aJL4oRPszsPgodQb+Q958ktNPK5Qjj7gT9phUzImv M8=; b=GVr/uqE6SiI2wl/pNb7QzfyLLKYndMuMBsyB4AD2cJLuUh7ycD5YZYLFB U3o9OKlABOyd84sBNFq2pP9RJ9ibYZxRzsEZmVjKZr90wieJWfU1CcTltxw1BQi5 WbbN4Kd5vWuJRU/mFqGKyU0Nc7y89z+2r983UPhZnOe+ZgrJjkhV9JoZ7/X93T+q 9Usp2bvLKNCnfWPJVEk/sglhKXb82E2dojzBFDvzsp6FIfZhEx6SYXlreeBdPjjB mMm31HHxZT/dnKe9O/LtBMgaCCb40aJgZWFL+x5qK43+gJheimm+2ROvqTVceL/q 3VbUP+DEpW018K9McMQz0XNBz58Tw==
X-ME-Sender: <xms:THZCXaSEN8FXMhEVAkVOf_CMBjpJVf7iV96qu3cuqCz7yTk-_rbZGg>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduvddrleeigdeludcutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecuogfuuhhsphgvtghtffhomhgrihhnucdlgeelmdenuc fjughrpefofgggkfgjfhffhffvufgtgfesthhqredtreerjeenucfhrhhomhepfdforghr thhinhcuvfhhohhmshhonhdfuceomhhtsehlohifvghnthhrohhphidrnhgvtheqnecuff homhgrihhnpehrfhgtqdgvughithhorhdrohhrghdpghhithhhuhgsrdhiohdpghhithhh uhgsrdgtohhmpdhivghtfhdrohhrghenucfrrghrrghmpehmrghilhhfrhhomhepmhhtse hlohifvghnthhrohhphidrnhgvthenucevlhhushhtvghrufhiiigvpedt
X-ME-Proxy: <xmx:THZCXZH-sdcB_Hp3x8Qgcd0ra1EWayRmDKemIuAI5MCesoD01Xwj-g> <xmx:THZCXWn0qJuZJB0ApxkduBbfHvqymZT5-dEJ97CGJupY6SpEkf-rXA> <xmx:THZCXRC3L28sspoRWR7_LkKJMJ_UV7TruU5JlqU8AbSSHnrZbFJiXA> <xmx:THZCXXsE8pqvuClGWDcvLAmMLlq62FJp-uaTjxW9V1mMG_iYYh1Dbw>
Received: by mailuser.nyi.internal (Postfix, from userid 501) id 67864E00A2; Thu, 1 Aug 2019 01:19:08 -0400 (EDT)
X-Mailer: MessagingEngine.com Webmail Interface
User-Agent: Cyrus-JMAP/3.1.6-799-g925e343-fmstable-20190729v1
Mime-Version: 1.0
Message-Id: <c3568b4e-37c5-4ad7-b9e9-51c16dee5ffe@www.fastmail.com>
In-Reply-To: <62908E23-2FC0-4ED7-84B2-E86454020206@amsl.com>
References: <62908E23-2FC0-4ED7-84B2-E86454020206@amsl.com>
Date: Thu, 01 Aug 2019 15:19:11 +1000
From: Martin Thomson <mt@lowentropy.net>
To: 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/NXn5sILGcj7mnquTUxhv7GljV84>
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: Thu, 01 Aug 2019 05:19:13 -0000

Hi Sandy,

I've been looking at the stylesheet.  Is https://github.com/rfc-format/draft-iab-rfc-css-bis still the right place to go for that?  It looks like the issues list hasn't had any attention in some while, despite some of the issues having been addressed (I found and closed one).  If that is the right place to go, I'll submit a pull request with what I have.

You can see the work in progress here: https://martinthomson.github.io/i-d-template/sample.html and https://martinthomson.github.io/i-d-template/sample2.html

In addition to the stylesheet, I have found several problems with content.  These would need changes in xml2rfc to fix.

To aid in styling, these probably need to include <meta name="viewport" content="initial-scale=1.0"> in the <head>.  Viewing the html on a phone does strange things to certain elements.  For instance, <dt> is oddly shrunken on my phone.

In the second document there are several cases of
<span class="bcp14">MUST</span> NOT
where the "NOT" needs to be under the span.

The first sample has empty commas in author blocks.

The first sample puts the editor's name *after* affiliation.

Figure 3 in the first sample has a pilcrow after the figure, where other figures don't.  

I see that there is a blank line for a pilcrow for all figures without captions.  This might be fixed with styling, but I haven't done that yet as it changes the width of those images.

Section 3.1 of the second sample has some very odd formatting.  It has lots of indentation of varying sizes, and some blank lines that I can't really grok.  Maybe it looks OK in text, but the HTML is hard to look at.

Tables are captioned inconsistently across both documents.

The contributors section in both documents looks terrible in HTML.   Probably because there is no defined way to add contributors in a way that renders in a manner consistent with authors in text formats, so the authors choose to use <pre>/<artwork> for that section.  We need to fix that somehow.

Not sure whether this is a styling issue, but refusing to wrap links does odd things like add horizontal scrolling on narrow screens.

The script for managing the ToC on a narrow screen is much more complex than it needs to be.  Here is what I did:

<script>
  const toc = document.getElementById("toc");
  toc.querySelector("h2").addEventListener("click", e => { toc.classList.toggle("active"); });
  toc.querySelector("nav").addEventListener("click", e => { toc.classList.remove("active"); });
</script>

with styles to support that:
  #toc nav { display: none; } /*already present*/
  #toc.active nav { display: block; }


On Thu, Jul 18, 2019, at 16: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
>