Re: [rfc-i] The role of txt format in ietf document development

Carsten Bormann <cabo@tzi.org> Thu, 29 October 2020 11:54 UTC

Return-Path: <rfc-interest-bounces@rfc-editor.org>
X-Original-To: ietfarch-rfc-interest-archive@ietfa.amsl.com
Delivered-To: ietfarch-rfc-interest-archive@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 828FF3A0B04; Thu, 29 Oct 2020 04:54:00 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.65
X-Spam-Level:
X-Spam-Status: No, score=-2.65 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, HEADER_FROM_DIFFERENT_DOMAINS=0.25, MAILING_LIST_MULTI=-1, SPF_PASS=-0.001, URIBL_BLOCKED=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 afZSIyNX0Ix7; Thu, 29 Oct 2020 04:53:58 -0700 (PDT)
Received: from rfc-editor.org (rfc-editor.org [4.31.198.49]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id D133F3A0AD6; Thu, 29 Oct 2020 04:53:58 -0700 (PDT)
Received: from rfcpa.amsl.com (localhost [IPv6:::1]) by rfc-editor.org (Postfix) with ESMTP id 33302F406F6; Thu, 29 Oct 2020 04:53:45 -0700 (PDT)
X-Original-To: rfc-interest@rfc-editor.org
Delivered-To: rfc-interest@rfc-editor.org
Received: from localhost (localhost [127.0.0.1]) by rfc-editor.org (Postfix) with ESMTP id 7192FF406F6 for <rfc-interest@rfc-editor.org>; Thu, 29 Oct 2020 04:53:43 -0700 (PDT)
X-Virus-Scanned: amavisd-new at rfc-editor.org
Received: from rfc-editor.org ([127.0.0.1]) by localhost (rfcpa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id Zb9GdFdiMVih for <rfc-interest@rfc-editor.org>; Thu, 29 Oct 2020 04:53:39 -0700 (PDT)
Received: from gabriel-vm-2.zfn.uni-bremen.de (gabriel-vm-2.zfn.uni-bremen.de [134.102.50.17]) by rfc-editor.org (Postfix) with ESMTPS id 1A9F9F406CB for <rfc-interest@rfc-editor.org>; Thu, 29 Oct 2020 04:53:39 -0700 (PDT)
Received: from [192.168.217.118] (p548dcc60.dip0.t-ipconnect.de [84.141.204.96]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by gabriel-vm-2.zfn.uni-bremen.de (Postfix) with ESMTPSA id 4CMP3f24bvzyhV; Thu, 29 Oct 2020 12:53:50 +0100 (CET)
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.4\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <31101.1603971678@localhost>
Date: Thu, 29 Oct 2020 12:53:49 +0100
X-Mao-Original-Outgoing-Id: 625665229.778128-2fdd46e55831bbd7ce104e49f9defda2
Message-Id: <105C3AA8-D08E-4603-A8C4-0475C0C5B499@tzi.org>
References: <20201026215117.GY39170@kduck.mit.edu> <20201026222427.8D3B624F19C4@ary.qy> <20201026235341.GA39170@kduck.mit.edu> <47e062c3-0f1f-02fd-d77f-645863af93aa@gmail.com> <f647c3b1-37aa-f43b-6b57-cd7d895f3c23@alum.mit.edu> <f4726c74-7857-e5cb-b441-dc8b897452bf@gmail.com> <508a1288-ee51-81e6-9d4b-6284fdcb036d@alum.mit.edu> <F6DD272E-8730-4D49-92AA-1F2B4B668FA6@tzi.org> <ce1c66c5-3b7b-436c-9440-5ba69a563b08@www.fastmail.com> <31101.1603971678@localhost>
To: Michael Richardson <mcr+ietf@sandelman.ca>
X-Mailer: Apple Mail (2.3608.120.23.2.4)
Subject: Re: [rfc-i] The role of txt format in ietf document development
X-BeenThere: rfc-interest@rfc-editor.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "A list for discussion of the RFC series and RFC Editor functions." <rfc-interest.rfc-editor.org>
List-Unsubscribe: <https://www.rfc-editor.org/mailman/options/rfc-interest>, <mailto:rfc-interest-request@rfc-editor.org?subject=unsubscribe>
List-Archive: <http://www.rfc-editor.org/pipermail/rfc-interest/>
List-Post: <mailto:rfc-interest@rfc-editor.org>
List-Help: <mailto:rfc-interest-request@rfc-editor.org?subject=help>
List-Subscribe: <https://www.rfc-editor.org/mailman/listinfo/rfc-interest>, <mailto:rfc-interest-request@rfc-editor.org?subject=subscribe>
Cc: rfc-interest@rfc-editor.org
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: base64
Errors-To: rfc-interest-bounces@rfc-editor.org
Sender: rfc-interest <rfc-interest-bounces@rfc-editor.org>

On 2020-10-29, at 12:41, Michael Richardson <mcr+ietf@sandelman.ca> wrote:
> 
> Signed PGP part
> 
> Martin Thomson <mt@lowentropy.net> wrote:
>> However, I still find that people routinely refer to the rendered
>> versions.  Many outside reviews refer to text by section numbers (which
>> is not in the source, ouch).  For people working on QUIC, we've mostly
> 
> Yes. That's really an annoyance.  In XML land how many of us have:
> 
>   <!-- section 4.5.6 -->
>   <section title="FOO" ..>
> 
> I don't know how to do this in markdown, as there isn't really a useable
> comment system, except using XML.

But using XML is the markdown comment system.
(Except that it inherits the inability to have double-hyphens in comments; kramdown therefore has {::comment}…{:/} as well.)

More interesting is the question whether we can get editors (such as markdown-mode in Emacs) to display the current section number or visit a given one.  SMOP (*); highlighting already knows the section headers, so it’s a matter of counting them.

>> moved to direct references to the editor's copy.  The addition of
>> pilcrows on paragraphs has been a huge help in improving our ability to
>> reference text.  I wish that we could teach more people to do that.
> 
> I'm confused: what is it that we need to teach?

Sending precise links instead of phrasing the reference in English.

It would be nice if there were a less contorted way to actually open the HTML for a document so you can link to places inside it; right now that is 3 or 4 klicks, most of which have a 6-second wait for datatracker.

Grüße, Carsten

(*) Yeah, I know.  Probably a day.

_______________________________________________
rfc-interest mailing list
rfc-interest@rfc-editor.org
https://www.rfc-editor.org/mailman/listinfo/rfc-interest