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

Heather Flanagan <rse@rfc-editor.org> Sun, 21 July 2019 18:06 UTC

Return-Path: <rse@rfc-editor.org>
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 A73CE120133 for <xml2rfc-dev@ietfa.amsl.com>; Sun, 21 Jul 2019 11:06:12 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.198
X-Spam-Level:
X-Spam-Status: No, score=-4.198 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, HTML_MESSAGE=0.001, MIME_QP_LONG_LINE=0.001, RCVD_IN_DNSWL_MED=-2.3, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
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 DhRLDNxSH-JH for <xml2rfc-dev@ietfa.amsl.com>; Sun, 21 Jul 2019 11:06:11 -0700 (PDT)
Received: from mail.amsl.com (c8a.amsl.com [4.31.198.40]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id F3428120132 for <xml2rfc-dev@ietf.org>; Sun, 21 Jul 2019 11:06:10 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by c8a.amsl.com (Postfix) with ESMTP id 2E2EF1C1363; Sun, 21 Jul 2019 11:05:58 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
Received: from c8a.amsl.com ([127.0.0.1]) by localhost (c8a.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id SKZYELOhN5Nm; Sun, 21 Jul 2019 11:05:58 -0700 (PDT)
Received: from [IPv6:2001:67c:1232:144:8899:f7f8:c05:9229] (unknown [IPv6:2001:67c:1232:144:8899:f7f8:c05:9229]) by c8a.amsl.com (Postfix) with ESMTPSA id B3A8B1C1361; Sun, 21 Jul 2019 11:05:57 -0700 (PDT)
Content-Type: multipart/alternative; boundary="Apple-Mail-52D4B37D-EE6B-40DA-A62D-2135FA6AD6CC"
Mime-Version: 1.0 (1.0)
From: Heather Flanagan <rse@rfc-editor.org>
X-Mailer: iPad Mail (16F203)
In-Reply-To: <02160baf-23d0-4388-9a73-c2a908005226@www.fastmail.com>
Date: Sun, 21 Jul 2019 14:06:08 -0400
Cc: Sandy Ginoza <sginoza@amsl.com>, xml2rfc-dev@ietf.org
Content-Transfer-Encoding: 7bit
Message-Id: <127357E8-458C-4BA8-9CCA-5A7D580967DB@rfc-editor.org>
References: <62908E23-2FC0-4ED7-84B2-E86454020206@amsl.com> <8a75c18e-812b-43be-a2a3-9f767052aa75@www.fastmail.com> <02160baf-23d0-4388-9a73-c2a908005226@www.fastmail.com>
To: Martin Thomson <mt@lowentropy.net>
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc-dev/izw0MaB8usjwbxzrA2q_2HXiyQo>
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:06:13 -0000

Here you go:

https://github.com/rfc-format/draft-iab-rfc-css-bis/tree/master/docs

And than you in advance for your PRs!

-Heather

Sent from my iPad

> On Jul 21, 2019, at 13:55, Martin Thomson <mt@lowentropy.net> wrote:
> 
> 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
>>> 
> 
> _______________________________________________
> xml2rfc-dev mailing list
> xml2rfc-dev@ietf.org
> https://www.ietf.org/mailman/listinfo/xml2rfc-dev