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

"Martin Thomson" <mt@lowentropy.net> Mon, 05 August 2019 00:47 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 F003D120131 for <xml2rfc-dev@ietfa.amsl.com>; Sun, 4 Aug 2019 17:47:49 -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=ftCEbuf2; dkim=pass (2048-bit key) header.d=messagingengine.com header.b=xkrgGU3s
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 HsbX8TB0tIAh for <xml2rfc-dev@ietfa.amsl.com>; Sun, 4 Aug 2019 17:47:48 -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 18D3E120135 for <xml2rfc-dev@ietf.org>; Sun, 4 Aug 2019 17:47:48 -0700 (PDT)
Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id 23F9621903 for <xml2rfc-dev@ietf.org>; Sun, 4 Aug 2019 20:47:47 -0400 (EDT)
Received: from imap2 ([10.202.2.52]) by compute1.internal (MEProxy); Sun, 04 Aug 2019 20:47:47 -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=Owdg6 Yzp4WI6JHkQrd9Na51yfUrdX9j3wyrmC+4DKgA=; b=ftCEbuf2anMJYtUz0EZfq fY+mDZifobSG3QhA0KiCzf3tUqiKjOPPS/tzA90Xf7e+X/IefR5uP29uFbqmDdA3 axyJEjeyylpPUr565AxTmrjeHs2IKYZjyfrz8PvpKMrxjHqq1dvow5ISOColi4Na x8QHuRx7mr5u4v6inuESseXvrArmSpeFOCUgG5CUzU4h5ff16/JM+Z7f7am/3/bs BeEKR0qEdOcc9rnBrRBh8iLSRiHFIihk23LbXSXkjMiSv2VxL/mBMg6WJGBwTWg/ NJtLpcogyC9dav3yQnZJu0rVU6EVge4OLyFqzDCDNC96KussRJZsdvIhYJqu5BCy 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=Owdg6Yzp4WI6JHkQrd9Na51yfUrdX9j3wyrmC+4DK gA=; b=xkrgGU3skVLu0CflT6Gv0mV/PHCCHX4zdjMq6p5Ns7xsws7sfHfYobGJp NXxT5J3oAT7qZia60Tsgg2S0J8CHl1H6g1e30KJkwr8NrXQwoBh6Xqndx+4cVN7T StrWmM/YOrdUASzK6uvSgrgWgLU8ndAh0TL/lygxwYl5eTJto2BRP+dl/Npy6fYb E3Xox/3GTT61Cn9Z8ShWJXWoPulGFhlZKCovEI95wWij5EA7tHO13rCvW4MDkBAv WpSzZSDbOX7474KMEjO6sbNHyKs9e6D9ZFaXtpaYFIVTKgG5XXGFX3B8ABCJJrCC ETW9UpL2mZNuWCD9ZqsbaK7muUFxA==
X-ME-Sender: <xms:snxHXfGgHK3ghYlyx42jtritkCnM0N2BMWcSlpy3BBJzUpWGr32X3g>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduvddruddtiedgfeejucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucenucfjughrpefofgggkfgjfhffhffvufgtgfesth hqredtreerjeenucfhrhhomhepfdforghrthhinhcuvfhhohhmshhonhdfuceomhhtsehl ohifvghnthhrohhphidrnhgvtheqnecurfgrrhgrmhepmhgrihhlfhhrohhmpehmtheslh hofigvnhhtrhhophihrdhnvghtnecuvehluhhsthgvrhfuihiivgeptd
X-ME-Proxy: <xmx:snxHXTOIVjSimzcgOzrHNiq8WmIN58Eu4K5XcoaovF15n9ZBLtYfjA> <xmx:snxHXeFQy9r6GkL8f-2aoUa58UG3eBQPTtN6tFhvDy1JjEqqO78GKA> <xmx:snxHXaOfeu73Z3FEjdsU-yWXXjc1BxsW0P9iKsce5ZUqZ-0Aef8C-A> <xmx:s3xHXeQi3sD6dnyu4mml0d9Xjgu7Gq3pvDU8vmp87UEiBFr2-2ICNw>
Received: by mailuser.nyi.internal (Postfix, from userid 501) id 562B9E00A2; Sun, 4 Aug 2019 20:47:46 -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: <dfcffec4-7928-4717-b6cb-bcfc1a49a8dc@www.fastmail.com>
In-Reply-To: <6AFC0271-060C-4A2F-84EE-CB40DD328039@amsl.com>
References: <6D7CF9A5-F8FA-4D78-9001-ADC7CD0B2A36@amsl.com> <6AFC0271-060C-4A2F-84EE-CB40DD328039@amsl.com>
Date: Mon, 05 Aug 2019 10:47:46 +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/Iy8FtmQ0lDEO4r-PWlNSof2qY8c>
Subject: Re: [xml2rfc-dev] [v3] 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: Mon, 05 Aug 2019 00:47:50 -0000

On Sat, Aug 3, 2019, at 06:05, Sandy Ginoza wrote:
> a) one of the things we talked about is making the RFC number stand out 
> somehow.  Right now it’s getting lost and because there are no longer 
> page headers/footers, it’s the only place where the RFC number appears. 
>  Henrik had some suggestions about how to do this, but I don’t think 
> any final decisions were made.  

I don't think that this is necessary.
 
> b) as you noted below, longer URLs are getting truncated by the toc in 
> the HTML/PDF (the text file is ok).  No matter how wide I make my 
> screen, I can’t see the full URL and I can’t scroll right. [Note, 
> however: it is possible to scroll right if the window is smaller, so 
> that the TOC doesn’t appear on the right.]  More info below.

I found the offending style rule.  This was clearly an intentional decision by the original designer.  I didn't revert that change, but will do so based on your feedback.  It's not like you need the text of the link to know where it points to in HTML.

> c) potentially add a line break after long citation tags in the 
> references section.  

That's something that I've wanted to know how to do for a long time.  My CSS chops are fairly primitive, so maybe there is a way, but I just don't know how.  The fix here, at least in my opinion, is to use shorter tags.  In kramdown-rfc2629, you construct links using {{?SHORT-TAG=I-D.ietf-some-really-long-draft-name}}.  The same is possible in XML, but it's been too long since I did any of that for me to remember.

> > 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.
> 
> Agree - I think we can make this better by updating the XML a bit 
> differently.  
> This is part of a discussion we’ve having with Heather regarding 
> whether we need to use the seemingly right list style vs get the right 
> display.  

I think that the problem here adjacent lists and <aside>, which have similar styling, except that <aside> is given extra padding above and below.  It's almost like this could benefit from reducing the variance in spacing and using other styling to denote <aside>, like italics.

Regarding the pilcrow on uncaptioned figures, it might be possible to put the pilcrow beside the figures if they could be narrowed relative to the page.  The current design allows 70 column figures with essentially no additional space, so that would be a very disruptive change to the entire design.