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

Martin Thomson <mt@lowentropy.net> Wed, 02 February 2022 22:44 UTC

Return-Path: <mt@lowentropy.net>
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 E60643A23FB for <rfc-markdown@ietfa.amsl.com>; Wed, 2 Feb 2022 14:44:11 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.1
X-Spam-Level:
X-Spam-Status: No, score=-2.1 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_BLOCKED=0.001, RCVD_IN_MSPIKE_H2=-0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=lowentropy.net header.b=NsnUcgL1; dkim=pass (2048-bit key) header.d=messagingengine.com header.b=BxKmC1H/
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 fZilN6zQqM_x for <rfc-markdown@ietfa.amsl.com>; Wed, 2 Feb 2022 14:44:07 -0800 (PST)
Received: from wout3-smtp.messagingengine.com (wout3-smtp.messagingengine.com [64.147.123.19]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 3F1263A23FD for <rfc-markdown@ietf.org>; Wed, 2 Feb 2022 14:44:07 -0800 (PST)
Received: from compute2.internal (compute2.nyi.internal [10.202.2.46]) by mailout.west.internal (Postfix) with ESMTP id 8AA4C3202206 for <rfc-markdown@ietf.org>; Wed, 2 Feb 2022 17:44:06 -0500 (EST)
Received: from imap41 ([10.202.2.91]) by compute2.internal (MEProxy); Wed, 02 Feb 2022 17:44:06 -0500
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lowentropy.net; h=cc:content-transfer-encoding:content-type:date:date:from:from :in-reply-to:in-reply-to:message-id:mime-version:references :reply-to:sender:subject:subject:to:to; s=fm1; bh=qj0leJFakSLjVf P/wQhw9H+5IKRPUFtuh5xy2jHKtbY=; b=NsnUcgL1DCICZmdKBZhQW4eBMGJv98 6tzKN6L8+ygXDzN//iTn9ie2VwhWmsxmy7Vy0stlRhL2r9bmtWy6tXmh0CCM347G fk5SEXJWZblQA3Z8tQQ3Vlp4P6od1m969FjBJk481dc4uoTl/b1Q5P5au9ej825t 9M/uTA8WufRO6QajXndfZsY0CuSWbbxTpIefnNKVB0r9XKj17J7Lv/gVhXq3GLKX leEIULvT4W1Id9e32943DlCxeCIjLS7e+SHRBHMeqN7Xo0ReiPQyxjuT/Ut5UU5I pn/OzGOnd/QgN/AcKXBGmgBjLH+8ebW2t7C+DVqxtypFMGyd0fLleY2g==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:date:from:from:in-reply-to:in-reply-to:message-id :mime-version:references:reply-to:sender:subject:subject:to:to :x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s= fm2; bh=qj0leJFakSLjVfP/wQhw9H+5IKRPUFtuh5xy2jHKtbY=; b=BxKmC1H/ MlrGwxyJWbvEHlW6KQQ1hHd84j0zlH13HNkPN+QyIhG8P7M85jpmqzX/xzsBsk9H 5B0dsow+hK3j32gE5RHYbU9yOHbHex2IJGioBXFb7rGRKwSalswyJGUzenpgFVFQ m3hA+GgV7ZezEmMtjyORdWmLMkXeEm3iadiWTBbGDV6WNrRVVd8sbBAwRhNe6G9B lCLsRFLT/+c6yYFmAjSnzx41DyYWXmbxCORIK4WxcXUUsm0U+Dx92y/Ff6b5tsMZ n6+Z1U3svNd6a0prJWFZhkQ9ciFWLvSQulpVV/mV+SWRv3M5YTohOoL0IePRukWE 66IIfCkK1WJTvw==
X-ME-Sender: <xms:Ngn7YXDHiv8q8lfUyTvINmA5I-xiKPScEOsCC-JCwOJ-fgsswX4lyQ> <xme:Ngn7Ydime8CwN7TGXop-3r6utA0bFc_wuEwQDLFrAr9LfVCEaJDudh7HT2TnzyKhm v2dcSj3viUw5MCT8XU>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvvddrgeehgdduieegucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucenucfjughrpefofgggkfgjfhffhffvufgtgfesth hqredtreerjeenucfhrhhomhepfdforghrthhinhcuvfhhohhmshhonhdfuceomhhtsehl ohifvghnthhrohhphidrnhgvtheqnecuggftrfgrthhtvghrnhepheegkeelfffftdfgje evtdevfeekvdekkeeutedutedufeevveegteevteeihfefnecuffhomhgrihhnpehgihht hhhusghushgvrhgtohhnthgvnhhtrdgtohhmpdgurhgrfhhtqdhmthdqvghmphhthidrmh gupdhgihhthhhusgdrtghomhdpihgvthhfrdhorhhgpdigmhhlqdgvughithgvugdrmhgu pdgurhgrfhhtqdhtohguohdqhihouhhrnhgrmhgvqdhprhhothhotgholhdrmhgunecuve hluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrhhomhepmhhtsehlohif vghnthhrohhphidrnhgvth
X-ME-Proxy: <xmx:Ngn7YSlyDCMo889rFiOVR9EtU1ZkxR6EWYeEMWuIRTmJBSIkJ4mfPw> <xmx:Ngn7YZzdjCur2zAlUfixw_jcUEMkUR9Y_if-eDMYh3wUd_dgaa2RKQ> <xmx:Ngn7YcRHKOr3e1AaC3-Gp2rIv8KaSX2xvGaZjGM3blxTU3v-WxegRQ> <xmx:Ngn7YTewQhJEEqA5SqSz0bExfVvx6nl3Ld-aGVVJrG99za_EOcNQig>
Received: by mailuser.nyi.internal (Postfix, from userid 501) id 05CDD3C0471; Wed, 2 Feb 2022 17:44:06 -0500 (EST)
X-Mailer: MessagingEngine.com Webmail Interface
User-Agent: Cyrus-JMAP/3.5.0-alpha0-4585-ga9d9773056-fm-20220113.001-ga9d97730
Mime-Version: 1.0
Message-Id: <d1cd3a24-317e-4cd9-b0e1-8250354484a1@beta.fastmail.com>
In-Reply-To: <A553DDC3-4B27-4275-838A-E6F0CDDA057A@tzi.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>
Date: Thu, 03 Feb 2022 09:43:47 +1100
From: Martin Thomson <mt@lowentropy.net>
To: rfc-markdown@ietf.org
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/VtQg3_7qEEUXFhXZ-x2FM7bMEfc>
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 22:44:12 -0000

I recently decided to play Internet-Draft golf: https://raw.githubusercontent.com/martinthomson/empty-draft/main/draft-mt-empty.md

Not sure if that is as helpful as those other links, but it demonstrates how easy it is to use markdown.

On Thu, Feb 3, 2022, at 09:04, Carsten Bormann 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-markdown mailing list
> Rfc-markdown@ietf.org
> https://www.ietf.org/mailman/listinfo/rfc-markdown