Re: [xml2rfc] RfcMarkup not authoritative, HTML is gone?

Paul Kyzivat <pkyzivat@alum.mit.edu> Mon, 16 September 2019 18:35 UTC

Return-Path: <pkyzivat@alum.mit.edu>
X-Original-To: xml2rfc@ietfa.amsl.com
Delivered-To: xml2rfc@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 68B33120086 for <xml2rfc@ietfa.amsl.com>; Mon, 16 Sep 2019 11:35:33 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.2
X-Spam-Level:
X-Spam-Status: No, score=-4.2 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, 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 G5D-EPZFvI7a for <xml2rfc@ietfa.amsl.com>; Mon, 16 Sep 2019 11:35:27 -0700 (PDT)
Received: from outgoing-alum.mit.edu (outgoing-alum.mit.edu [18.7.68.33]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id D07E112004A for <xml2rfc@ietf.org>; Mon, 16 Sep 2019 11:35:26 -0700 (PDT)
Received: from Kokiri.localdomain (c-24-62-227-142.hsd1.ma.comcast.net [24.62.227.142]) (authenticated bits=0) (User authenticated as pkyzivat@ALUM.MIT.EDU) by outgoing-alum.mit.edu (8.14.7/8.12.4) with ESMTP id x8GIZMe8014106 (version=TLSv1/SSLv3 cipher=AES128-SHA bits=128 verify=NOT); Mon, 16 Sep 2019 14:35:22 -0400
To: Julian Reschke <julian.reschke@gmx.de>, Anders Rundgren <anders.rundgren.net@gmail.com>, xml2rfc@ietf.org
References: <94358f7d-3465-4161-1597-f1dbfba73b3f@gmail.com> <d44ac5f1-e4c2-1239-4bea-714a721115b8@levkowetz.com> <9ceb0697-c3ae-4f14-606c-4e089f04e2f2@gmail.com> <a4874a50-ffc3-80f5-cb42-09f82072644c@gmx.de> <04713f10-5c19-2ad5-2fa6-2db5f1ed5599@gmail.com> <f5554cd0-9c74-3a8c-5af9-25b947d499d8@gmx.de> <7bb2a5fb-262d-39b5-3bb0-72e068923ea7@gmail.com> <c3c8db0e-e719-32e6-ca3c-736e25ce8936@gmx.de> <f2f49552-091d-50e4-e2e2-2fdd30cbb7ae@gmail.com> <bd07ad5a-a0a7-f821-54ec-c09ee5614e2a@gmx.de> <d9883584-1d5e-4d34-9bde-00d32dc49435@gmail.com> <599cb714-89e8-271c-4d5e-ba294fa7d3cf@alum.mit.edu> <ee1a1699-a5e3-3c2b-ad53-ff80a120f7eb@gmail.com> <19509146-279f-4fb7-4b44-3feea81e87f9@alum.mit.edu> <37d53cf7-3e99-e4dc-d66a-7bd452e0f3ea@gmx.de>
From: Paul Kyzivat <pkyzivat@alum.mit.edu>
Message-ID: <75e85e74-944f-85b0-b3b1-1c5af6ec513b@alum.mit.edu>
Date: Mon, 16 Sep 2019 14:35:22 -0400
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.13; rv:60.0) Gecko/20100101 Thunderbird/60.9.0
MIME-Version: 1.0
In-Reply-To: <37d53cf7-3e99-e4dc-d66a-7bd452e0f3ea@gmx.de>
Content-Type: text/plain; charset="utf-8"; format="flowed"
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc/DsG1c6F-hbSGzAbStQxJJQcZYS0>
Subject: Re: [xml2rfc] RfcMarkup not authoritative, HTML is gone?
X-BeenThere: xml2rfc@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: <xml2rfc.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/xml2rfc>, <mailto:xml2rfc-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/xml2rfc/>
List-Post: <mailto:xml2rfc@ietf.org>
List-Help: <mailto:xml2rfc-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/xml2rfc>, <mailto:xml2rfc-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 16 Sep 2019 18:35:34 -0000

On 9/16/19 11:53 AM, Julian Reschke wrote:
> On 16.09.2019 17:32, Paul Kyzivat wrote:
>> On 9/16/19 10:46 AM, Anders Rundgren wrote:
>>> On 2019-09-16 16:27, Paul Kyzivat wrote:
>>>> On 9/16/19 1:22 AM, Anders Rundgren wrote:
>>>>> On 2019-09-14 11:41, Julian Reschke wrote:
>>>>> <snip>
>>>>>>
>>>>>> RfcMarkup has no official standing (and yes, I like it as well, 
>>>>>> and it
>>>>>> has served us well for a very long time). It apparently generates
>>>>>> XHTML,
>>>>>> but the content is served as text/html on tools.ietf.org. It might be
>>>>>> good to change it to produce valid HTML5.
>>>>>
>>>>> This in interesting and but also rather confusing since this is the by
>>>>> far most used method for communicating RFCs by developers.
>>>>
>>>> Do you have any data to backup this claim?
>>>
>>> No, OTOH, since I mostly work with JSON-based stuff, the documents are
>>> fairly recent.
>>
>> I don't recall every having seen a reference to an RfcMarkup.
> 
> Funny enough, that is the tool that is creating the HTNLized versions.

Interesting. But what ends up being referenced is the resulting HTML.

>>> What I'm sure that I have newer seen in wild are references to PDF RFCs
>>
>> Nor have I.
> 
> PDF RFCs have been possible in the past, but certainly not encouraged.
> 
>> The most common references I see are to either the "HTMLized" form, the
>> plain text, or the datatracker page.
>>
>> Personally I much prefer to work with the HTMLized form. It gives easy
>> ability to jump around in the document, the extra info in the header
>> including links to related tools, etc. and yet the text is almost
>> identical to the plain text form which makes it easy to jump back and
>> forth between a diff and the full document. It is also convenient to cut
>> and paste bits of the document into email. I much prefer this format to
>> the HTML format generated directly from xml.
> 
> There are multiple tools that do this, so it would be good to be more
> specific here (xml2rfc in v2 mode? in v3 mode? rfc2629.xslt?)

I'm speaking here mostly as a consumer of rfcs and drafts, though I also 
author them. As a consumer I just see the results, not how they were 
produced. But I presume most have been produced from v2 xml using 
xml2rfc in v2 mode.

I look forward to seeing what might be available as v3 comes into use. 
If there is a good side by side diff tool for the html format or 
directly for the xml, that will be a start. Even then it will be 
interesting to see how easy it is to move back and forth between the 
diff and the full text.

(Sometimes I would prefer the side by side diff to include the full text 
so that there is complete context. But other times that would make it 
very convenient to see what has changed.)

Note that I'm only relating this to the way *I* have learned to work 
using the available tools. Perhaps new and better ways to work will be 
possible with the new format and related tools.

	Thanks,
	Paul