Re: Things that used to be clear (was Re: Evolving Documents (nee "Living Documents") side meeting at IETF105.)

Phillip Hallam-Baker <phill@hallambaker.com> Wed, 10 July 2019 18:40 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 2B621120702 for <ietf@ietfa.amsl.com>; Wed, 10 Jul 2019 11:40:57 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -0.126
X-Spam-Level:
X-Spam-Status: No, score=-0.126 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, FREEMAIL_FORGED_FROMDOMAIN=0.247, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.249, HTML_MESSAGE=0.001, PDS_NO_HELO_DNS=1.295, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=no 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 pZf7YeajFnq0 for <ietf@ietfa.amsl.com>; Wed, 10 Jul 2019 11:40:55 -0700 (PDT)
Received: from mail-ot1-f50.google.com (mail-ot1-f50.google.com [209.85.210.50]) (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 8D1501206FC for <ietf@ietf.org>; Wed, 10 Jul 2019 11:40:44 -0700 (PDT)
Received: by mail-ot1-f50.google.com with SMTP id x21so3144686otq.12 for <ietf@ietf.org>; Wed, 10 Jul 2019 11:40:44 -0700 (PDT)
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=3upppDw+cs4I5go+7pML19Wc0xobUan+niINI+kYTZw=; b=nmjmDQ8z7gtd0gv3hPap5ijIFQoPfBqZip5HNVzqeMYrgBXAzIaPGPuU74PFCwMnf6 W4EXQYjsCeBGLhH6FuBqB4pes6tHLbUne73C3zz8GuJMHJfgWMXS4Rrms+BQpCbcjooL Lo0XtjwS5+SC93ol8wIfT+wII1vucuDKA2natg2XoubzPMEub08pDnKQdZoyhWomJ8/2 /MNxPRHXZq/Z6jghlvns7cW8QpJgVmn0Aat9CodNameJBbtz7JXw35/KvMDlUej2JdAY aRXgG5JjsGZJbqngx6DJx3tx0pX/NHkPmOs1whlE+jUHgDP7b2Bd6UYoIJeksse50s5x 25fQ==
X-Gm-Message-State: APjAAAUHRTSqNKYhBhsZkiF1n6HmdxEvpgt99CQsdY5IrH5Dkx+G1FhY 0EiQ35w2vSTotZzRvtXwvo+qP2crRs8HvuzLcZ4=
X-Google-Smtp-Source: APXvYqyF/gqgl79+yNsEn0UWZHhCUjEFTXNk8VN59hbX9BohA++epyjDVOio02W0lDsd889xIXAvM6X4XG4d3ZY6lik=
X-Received: by 2002:a05:6830:1206:: with SMTP id r6mr25235637otp.37.1562784043571; Wed, 10 Jul 2019 11:40:43 -0700 (PDT)
MIME-Version: 1.0
References: <20190704140552.GE49950@hanna.meerval.net> <b0943792-1afc-0c94-51b7-f2d393ef39c5@network-heretics.com> <20190705205723.GI55957@shrubbery.net> <20190706185415.GB14026@mit.edu> <CABcZeBPgNr5UqQ0pLwwNu5wh0g9L9wCd6YyYKCUDO37SPru-_Q@mail.gmail.com> <20190708202612.GG60909@shrubbery.net> <9ae14ad1-f8d5-befb-64e4-fff063c88e02@network-heretics.com> <CABcZeBOH9LH8Jrz-A5eu9arqUb+bx8xs_eKWi0pyoh7a3qpOPA@mail.gmail.com> <20190708223350.GO3508@localhost> <af3b25d6-af16-a96a-c149-61d01afb4d01@network-heretics.com> <20190708233438.GP3508@localhost>
In-Reply-To: <20190708233438.GP3508@localhost>
From: Phillip Hallam-Baker <phill@hallambaker.com>
Date: Wed, 10 Jul 2019 14:40:32 -0400
Message-ID: <CAMm+LwgnQAAjxxZzhPvc_g4w0h64_nCG1bXh+iAyauqbKY_SJA@mail.gmail.com>
Subject: Re: Things that used to be clear (was Re: Evolving Documents (nee "Living Documents") side meeting at IETF105.)
To: Nico Williams <nico@cryptonector.com>
Cc: Keith Moore <moore@network-heretics.com>, IETF Discussion Mailing List <ietf@ietf.org>
Content-Type: multipart/alternative; boundary="000000000000c71f00058d580391"
Archived-At: <https://mailarchive.ietf.org/arch/msg/ietf/vDKH8Tz54ZpkjaUvZQBwx0Er5mA>
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: Wed, 10 Jul 2019 18:40:57 -0000

If people want document editing tools, may I recommend my RFCTool?

It is written in C#, runs on Linux, OSX and Windows and is MIT License.

It accepts as input formats: xml2rfc, markdown, Word, HTML
It generates as output formats: xml2rfc, markdown, Word, HTML, TXT

It converts citations of the form <norm="RFC322"> to the proper reference
automatically and builds tables of figures, contents and normative language.


The main limitation is that it is designed to target the new formats and so
I haven't made it a priority of late till the tooling for those is ready. I
wanted to be able to make use of diagrams and math notation in my docs:

http://mathmesh.com/Documents/draft-hallambaker-mesh-architecture.html

If it was to be taken further, the main change I would make is to change
the markdown format to use the same tags that GitHub uses as this has
emerged as the standard.

The code is here:

https://github.com/hallambaker/PHB-Build-Tools



On Mon, Jul 8, 2019 at 7:40 PM Nico Williams <nico@cryptonector.com> wrote:

> On Mon, Jul 08, 2019 at 07:22:20PM -0400, Keith Moore wrote:
> > On 7/8/19 6:33 PM, Nico Williams wrote:
> >
> > > xml2rfc is great, but it lacks wiki-ness, though we could probably
> > > develop HTML+JS tooling to give xml2rfc that missing wiki-ness.
> >
> > Actually I'd love it if xml2rfc were phased out in favor of something
> > better.   IMO it imposes a significant barrier to contributions,
> especially
> > from newer IETF participants, but really from everybody.   But I realize
> > that it's hard for IETF to build and maintain real document editing tools
> > that run on everybody's platforms.   It's hard enough to maintain
> xml2rfc.
> > And I could certainly imagine worse tools, like (gasp!) Word.
> >
> > (I'm not exactly fond of wikis' UIs either.)
>
> Well, I don't really care what it is, as long as a) we get the
> typesetting right, b) we get the UI right.
>
> Markdown seems incomplete.
>
> XML with webby $EDITOR tooling would do.
>
> > > Also, think of the channel binding type IANA registry, which doesn't
> > > require an RFC for each type, just a specification somewhere.  A lot of
> > > what we do in the IETF doesn't really need a publication process as
> > > heavy-duty as the RFC publication process.
> >
> > Well, IANA exists for the case you're citing already.   (such things
> used to
> > be published in RFCs)   What other cases do you have in mind?
>
> PKIX extensions (e.g., SANs).  Kerberos extensions.  TLS extensions.
> SSHv2 extensions.  And so on and on.
>
> > > None of the above addresses the need for I-D stability markers.  We're
> > > identifying a lot of related issues and thinking up possible solutions.
> > > Let's not lose track of the specific needs/problems we identify.
> >
> > Keeping explicit track of those things in one place seems like a good
> next
> > step.
>
> Yes.  And I think we have enough material to justify a BoF.
>
>