Re: document writing/editing tools used by IETF

Phillip Hallam-Baker <phill@hallambaker.com> Sat, 27 February 2021 19:35 UTC

Return-Path: <hallam@gmail.com>
X-Original-To: ietf@ietfa.amsl.com
Delivered-To: ietf@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 05C263A1302 for <ietf@ietfa.amsl.com>; Sat, 27 Feb 2021 11:35:52 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -6.399
X-Spam-Level:
X-Spam-Status: No, score=-6.399 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, FREEMAIL_FORGED_FROMDOMAIN=0.249, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.25, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, 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 nJAKbIrLTWlC for <ietf@ietfa.amsl.com>; Sat, 27 Feb 2021 11:35:49 -0800 (PST)
Received: from mail-yb1-f181.google.com (mail-yb1-f181.google.com [209.85.219.181]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 11D873A1301 for <ietf@ietf.org>; Sat, 27 Feb 2021 11:35:48 -0800 (PST)
Received: by mail-yb1-f181.google.com with SMTP id m188so12528420yba.13 for <ietf@ietf.org>; Sat, 27 Feb 2021 11:35:48 -0800 (PST)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=FTDMe101Hw8NV+W4pluSB26B/j4RahCgsFLjDACzU10=; b=WsP+6/DUxAH+lc6f1sDm20dsvUXvfF0NADccGYB9q5yhiux8zfDPXaRvzhv3o0NkEL zaR1Q507ouCTkwnz7QmSXoEkOWGQVLJoMMAA0JI+9BsKeMdgqeUX+It4TsE5tgjNEcYB Q1AnZ9eJSXpCYIW3Fze4rTy87iY29kJjMySrz6Li0QvmicqDLLYAl/3qMUayvLazoasT n8o/QluXV/x2pRrXobKvb71wVK25up5fOaOwWbz0g9ARZhSu4FBeupYPGPjcC2W7PEnq ENGf7Y8oPXbEDzLF4Fq5pqxptTxW4RDrdhfv7WVdqgPPHvVb/8QnyOzoebcVCSFQz7HO NJgw==
X-Gm-Message-State: AOAM531nbeX/n6LxUYKuAjAtjNl480h4vmIkwA67TLNqimJi62QHeKiP xhLB5bMcjRnEfGu09g2wturFUvGi4Hmha1CChiQ=
X-Google-Smtp-Source: ABdhPJy3M8BXjMbRWZkotkJYMd4FDdlCJJ3V5Ge1HwpX4rn5q1WN9tAhdgSYQxGPPc9Ofqfsbim8DfyNwf39tykgfLI=
X-Received: by 2002:a25:2307:: with SMTP id j7mr13690019ybj.518.1614454548053; Sat, 27 Feb 2021 11:35:48 -0800 (PST)
MIME-Version: 1.0
References: <37eecb9b-f0eb-e21c-b162-b1f0339e4981@si6networks.com> <3c2d646d-f18d-4d88-b458-29dbd486432b@beta.fastmail.com> <446A8D6B-E624-49E0-B67E-D1F8AFC794E2@lastpresslabel.com> <28ac1e86-f641-b9e8-0f61-6ff442feaa90@si6networks.com> <LO2P265MB057322BA95B1B44D4175356BC29E9@LO2P265MB0573.GBRP265.PROD.OUTLOOK.COM> <089096b1-10d2-3eac-d37c-f040a1930061@network-heretics.com> <37142313-C251-40DC-9336-D3A2F0FB69AD@tzi.org> <001d01d70be3$ff0972d0$fd1c5870$@acm.org> <CAMm+LwhkLTKkp3q4s97TBA-=WpJPof861mygPSjJttowpDjGuw@mail.gmail.com> <8b42a18a-181e-cad7-7333-3e950e643665@gmx.de> <C51C3823-59DA-4E61-B3A9-968BA355EEE2@depht.com> <DM6PR02MB692412D75E013F8EC314DAC6C39D9@DM6PR02MB6924.namprd02.prod.outlook.com> <CAMm+LwhOqy2MCmAY5eO2OcpkM99UOS7A5hJaj+thA3SuO+g8FA@mail.gmail.com> <48263A88-E146-4484-8031-BE410C146EE0@tzi.org>
In-Reply-To: <48263A88-E146-4484-8031-BE410C146EE0@tzi.org>
From: Phillip Hallam-Baker <phill@hallambaker.com>
Date: Sat, 27 Feb 2021 14:35:37 -0500
Message-ID: <CAMm+LwhXzcPVwtYNk5R3k_=r6gP04dg+pgxZ0VLmBiDHYvqXOA@mail.gmail.com>
Subject: Re: document writing/editing tools used by IETF
To: Carsten Bormann <cabo@tzi.org>
Cc: "ietf@ietf.org" <ietf@ietf.org>
Content-Type: multipart/alternative; boundary="000000000000d7c16105bc567da1"
Archived-At: <https://mailarchive.ietf.org/arch/msg/ietf/hK0RE7YpfV8x-E_P6X6Yf8LWtig>
X-BeenThere: ietf@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: IETF-Discussion <ietf.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/ietf>, <mailto:ietf-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/ietf/>
List-Post: <mailto:ietf@ietf.org>
List-Help: <mailto:ietf-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/ietf>, <mailto:ietf-request@ietf.org?subject=subscribe>
X-List-Received-Date: Sat, 27 Feb 2021 19:35:52 -0000

On Sat, Feb 27, 2021 at 2:10 PM Carsten Bormann <cabo@tzi.org> wrote:

> On 2021-02-27, at 19:31, Phillip Hallam-Baker <phill@hallambaker.com>
> wrote:
> >
> > pandoc markdown used by Carsten's tool
>
> That would be a different tool.
>
> Kramdown-rfc is based on kramdown, one of the longstanding
> well-established markdown parsers.
> (Its github history reaches back 12 years to 2008, and it already was an
> established project by then.
> By the way, kramdown is a Patreon creator — if you like kramdown-rfc, you
> may want to consider becoming a patron to its parent project.)
>

With respect, we are both mistaken on this.

The plaintext escape on github is ''''
The plaintext escape in pandoc is ~~~~

And rather than aligning with github, what I seem to have actually done is
to switch to align with your tool in the examples I generate. As I recall,
my tool now accepts either. At this point the only difference in the tools
is the approach to handling the initial input of metadata and some details
about how references are handled.

I see the github/pandoc thing as a consequence of there not having been a
specification written for markdown which has held things back.


(Pandoc would have taken the world already, but development requires ghc,
> the Glasgow Haskell compiler, which is a self-bootstrapping compiler that
> can be rather capricious to install.
> A threshold that is worth crossing!)
>

My tool runs on Windows, macOS and Linux without any additional
installations. Its just a single executable at this point.