Re: [Rfc-markdown] Triple Parentheses vs. Triple Braces

Carsten Bormann <cabo@tzi.org> Tue, 11 August 2020 15:41 UTC

Return-Path: <cabo@tzi.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 C965C3A1110 for <rfc-markdown@ietfa.amsl.com>; Tue, 11 Aug 2020 08:41:23 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.897
X-Spam-Level:
X-Spam-Status: No, score=-1.897 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=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 QX7ZhQ4FpB9j for <rfc-markdown@ietfa.amsl.com>; Tue, 11 Aug 2020 08:41:21 -0700 (PDT)
Received: from gabriel-vm-2.zfn.uni-bremen.de (gabriel-vm-2.zfn.uni-bremen.de [134.102.50.17]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 661303A116E for <rfc-markdown@ietf.org>; Tue, 11 Aug 2020 08:41:14 -0700 (PDT)
Received: from [192.168.217.116] (p5089ae91.dip0.t-ipconnect.de [80.137.174.145]) (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 4BQxrT0HNhzywJ; Tue, 11 Aug 2020 17:41:13 +0200 (CEST)
Content-Type: text/plain; charset=utf-8
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.1\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <bb826d2b-2706-7075-130f-6902c25b67a8@petit-huguenin.org>
Date: Tue, 11 Aug 2020 17:41:12 +0200
Cc: rfc-markdown@ietf.org, Ronald Tse <tse@ribose.com>
X-Mao-Original-Outgoing-Id: 618853272.472011-e81e9dfcf51bd5c91b39031cf2aa3847
Content-Transfer-Encoding: quoted-printable
Message-Id: <B89D6469-EFA3-4D1E-BAD1-11095AAB7278@tzi.org>
References: <05A1A64E-E8DD-4F05-BD49-6133A1B6A75F@tzi.org> <bb826d2b-2706-7075-130f-6902c25b67a8@petit-huguenin.org>
To: Marc Petit-Huguenin <marc@petit-huguenin.org>
X-Mailer: Apple Mail (2.3608.120.23.2.1)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/OedZhbmCH-OKvKkRMHP7xZ0UniQ>
Subject: Re: [Rfc-markdown] Triple Parentheses vs. Triple Braces
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: Tue, 11 Aug 2020 15:41:24 -0000

(Shortening to rfc-markdown:)

> On 2020-08-11, at 17:18, Marc Petit-Huguenin <marc@petit-huguenin.org> wrote:
> 
> [contact]#Nguyễn Ái Quốc#

If I do take this as a potential suggestion for kramdown-rfc, I have to say this is not much better than directly writing <contact fullName=“Nguyễn Ái Quốc”/>.

What I specifically do not like in the markdown context is that it inserts additional words into what would otherwise just be a slightly decorated, readable paragraph.  Brackets/braces/parentheses are also designed to invade less into their content than what the hash-mark does here.  Compare:

> [contact]#Nguyễn Ái Quốc#
> {{{Nguyễn Ái Quốc}}}

https://asciidoctor.org/docs/user-manual/#index-terms suggests something like 

> contact:[Nguyễn Ái Quốc]

which is a bit better, but still has the additional word that breaks the reading flow.

Grüße, Carsten