Re: [Rfc-markdown] [rfc-i] Markdown template for draft?

Jay Daley <exec-director@ietf.org> Wed, 02 February 2022 23:01 UTC

Return-Path: <exec-director@ietf.org>
X-Original-To: rfc-markdown@ietfa.amsl.com
Delivered-To: rfc-markdown@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 6E7D43A0841 for <rfc-markdown@ietfa.amsl.com>; Wed, 2 Feb 2022 15:01:39 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.898
X-Spam-Level:
X-Spam-Status: No, score=-1.898 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_BLOCKED=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 uOBqS5UC1y1L for <rfc-markdown@ietfa.amsl.com>; Wed, 2 Feb 2022 15:01:35 -0800 (PST)
Received: from ietfx.ietf.org (ietfx.amsl.com [4.31.198.45]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 400FE3A0836 for <rfc-markdown@ietf.org>; Wed, 2 Feb 2022 15:01:35 -0800 (PST)
Received: from localhost (localhost [127.0.0.1]) by ietfx.amsl.com (Postfix) with ESMTP id 26A544113626; Wed, 2 Feb 2022 15:01:35 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
Received: from ietfx.ietf.org ([4.31.198.45]) by localhost (ietfx.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id cMa6P59kavKJ; Wed, 2 Feb 2022 15:01:35 -0800 (PST)
Received: from smtpclient.apple (unknown [158.140.230.105]) by ietfx.amsl.com (Postfix) with ESMTPSA id 752B54113625; Wed, 2 Feb 2022 15:01:34 -0800 (PST)
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 15.0 \(3693.40.0.1.81\))
From: Jay Daley <exec-director@ietf.org>
In-Reply-To: <A553DDC3-4B27-4275-838A-E6F0CDDA057A@tzi.org>
Date: Thu, 03 Feb 2022 12:01:29 +1300
Cc: "rfc-interest@rfc-editor.org" <rfc-interest@rfc-editor.org>, rfc-markdown@ietf.org
Content-Transfer-Encoding: quoted-printable
Message-Id: <84F36740-4B3D-45D7-85AE-EFFE18564D61@ietf.org>
References: <c801cad9-c562-ff8b-cdc9-1ead2b4bfa7e@alum.mit.edu> <625BB285-2460-4A8F-B79A-5BB5ECF3B54C@akamai.com> <5a8f7b73-283e-4395-f056-52c416bad9c9@nostrum.com> <0FA92417-7E9D-4842-B4B7-83A6E1C9621F@tzi.org> <A553DDC3-4B27-4275-838A-E6F0CDDA057A@tzi.org>
To: Carsten Bormann <cabo@tzi.org>
X-Mailer: Apple Mail (2.3693.40.0.1.81)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/TCnU7fspzGl7NbUkxSlfR8Tp9_c>
Subject: Re: [Rfc-markdown] [rfc-i] Markdown template for draft?
X-BeenThere: rfc-markdown@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "rfc-markdown is a discussion list for people writing I-Ds and RFCs in Markdown and the authors of the tools used for that." <rfc-markdown.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/rfc-markdown>, <mailto:rfc-markdown-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/rfc-markdown/>
List-Post: <mailto:rfc-markdown@ietf.org>
List-Help: <mailto:rfc-markdown-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/rfc-markdown>, <mailto:rfc-markdown-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 02 Feb 2022 23:01:40 -0000

Thank you.

> On 3/02/2022, at 11:04 AM, Carsten Bormann <cabo@tzi.org> wrote:
> 
> On 2022-02-01, at 17:36, Carsten Bormann <cabo@tzi.org> wrote:
>> 
>> I think we are having a hard time with the word template here.
>> 
>> (1) Some of us are talking about an example input document (XML, markdown), an “I-D template”.
> 
> I put in a couple example documents that work as starting points into:
> 
> https://github.com/cabo/kramdown-rfc2629/tree/master/examples
> 
> These are based on the XML examples on authors.ietf.org, specifically those linked from https://authors.ietf.org/en/templates-and-schemas
> 
> The bare example,
> 
> https://raw.githubusercontent.com/cabo/kramdown-rfc2629/master/examples/draft-rfcxml-general-template-bare-00.xml-edited.md
> 
> …is sweet, short and not very useful (about the shortest that doesn’t get refused by xml2rfc; it doesn’t even have a docname).
> 
> The other one,
> 
> https://raw.githubusercontent.com/cabo/kramdown-rfc2629/master/examples/draft-rfcxml-general-template-standard-00.xml-edited.md
> 
> …is an example that you should be able to start from — delete what you don’t need, and refer to the example if you do need it later.
> 
> (Authors.ietf.org also has a Cadillac XML example; I haven’t got around to converting this to markdown yet and adding a few of the things that can make kramdown-rfc so useful — one of these days...)
> 
> You may also like Martin Thomson’s example:
> 
> https://raw.githubusercontent.com/martinthomson/i-d-template/main/example/draft-todo-yourname-protocol.md
> 
> Further suggestions are welcome!
> 
> Grüße, Carsten
> 
> _______________________________________________
> rfc-interest mailing list
> rfc-interest@rfc-editor.org
> https://www.rfc-editor.org/mailman/listinfo/rfc-interest

-- 
Jay Daley
IETF Executive Director
exec-director@ietf.org