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

Carsten Bormann <cabo@tzi.org> Wed, 28 October 2020 22:41 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 F19DB3A09AC; Wed, 28 Oct 2020 15:41:24 -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 MEEela_uN4L6; Wed, 28 Oct 2020 15:41:23 -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 9021C3A09A8; Wed, 28 Oct 2020 15:41:23 -0700 (PDT)
Received: from rfcpa.amsl.com (localhost [IPv6:::1]) by rfc-editor.org (Postfix) with ESMTP id 8B6A8F40711; Wed, 28 Oct 2020 15:41:10 -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 4581DF40711 for <rfc-interest@rfc-editor.org>; Wed, 28 Oct 2020 15:41:10 -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 dGLGbVLq5oMo for <rfc-interest@rfc-editor.org>; Wed, 28 Oct 2020 15:41:07 -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 96D60F4070F for <rfc-interest@rfc-editor.org>; Wed, 28 Oct 2020 15:41:07 -0700 (PDT)
Received: from client-0212.vpn.uni-bremen.de (client-0212.vpn.uni-bremen.de [134.102.107.212]) (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 4CM3T92lP9zykZ; Wed, 28 Oct 2020 23:41:17 +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: <508a1288-ee51-81e6-9d4b-6284fdcb036d@alum.mit.edu>
Date: Wed, 28 Oct 2020 23:41:17 +0100
X-Mao-Original-Outgoing-Id: 625617676.942721-f842363cce5ef44849e0ecbf87671111
Message-Id: <F6DD272E-8730-4D49-92AA-1F2B4B668FA6@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>
To: Paul Kyzivat <pkyzivat@alum.mit.edu>
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-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-28, at 16:20, Paul Kyzivat <pkyzivat@alum.mit.edu> wrote:
> 
> it is possible, and perhaps desirable, for the ietf to move to a system totally detached from plain text.

I have been working with and on (writing, using, educating, researching) various text processing systems for about four decades now.

The one development that I couldn’t have predicted was when, shortly after 2000, structured document formats such as those based on XML or HTML were supplanted again on the authoring side by plain text formats (“humane markup”) such as asciidoc and markdown.
Of course, these are structured documents as well, but there is finally attention to being able to work with them as an authoring format.
(Those of us that were living in nroff/troff or LaTeX can sympathize, but these formats were too intricately tied up with their formatters.)

Having embraced this move to humane markup in a number of markdown- and asciidoc-based authoring formats for I-Ds and RFCs in the last decade, I don’t think we will move away from that.  The main reason is that it is really easy to collaborate on humane markup using tools like git and github, and the IETF document generation process is fundamentally collaborative, much more so than in other SDOs.

W3C is maybe an exception, and they have an amazing tool called respec that is based on HTML authoring and a ton of Javascript.  This is an interesting alternative direction, but not one that I think would work so well with the diversity of authors we have in the IETF(*).

So I think plain text (with humane markup) will be our preferred authoring side for some time to be.  A plaintext formatted rendition fits well with many ancillary processes we use during authoring and reviewing.  Even if the occasional SVG figure drops in only on the HTML/PDF side.

Grüße, Carsten

(*) respec is profoundly an ART-area tool, and I’m not even sure about the RAI part of ART.  That fits W3C, but not the IETF.

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