[Rfc-markdown] 1.3.15: control typographic_symbols

Carsten Bormann <cabo@tzi.org> Thu, 29 October 2020 07:43 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 90C0A3A0AA4 for <rfc-markdown@ietfa.amsl.com>; Thu, 29 Oct 2020 00:43:26 -0700 (PDT)
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_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-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 jw27jJfLF_4A for <rfc-markdown@ietfa.amsl.com>; Thu, 29 Oct 2020 00:43:24 -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 2CAD33A0A16 for <rfc-markdown@ietf.org>; Thu, 29 Oct 2020 00:43:23 -0700 (PDT)
Received: from [192.168.217.118] (p548dcc60.dip0.t-ipconnect.de [84.141.204.96]) (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 4CMHVd56TtzyRj; Thu, 29 Oct 2020 08:43:21 +0100 (CET)
From: Carsten Bormann <cabo@tzi.org>
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
X-Mao-Original-Outgoing-Id: 625650201.170592-63b0fe6b8dcea757fdb2ab29a7bbe40e
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.4\))
Date: Thu, 29 Oct 2020 08:43:21 +0100
Message-Id: <516CBA9A-8C56-4F12-865E-46B17703D269@tzi.org>
To: rfc-markdown@ietf.org
X-Mailer: Apple Mail (2.3608.120.23.2.4)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/TlY-yCb58mADnQy6KxrD8RNWjFo>
Subject: [Rfc-markdown] 1.3.15: control typographic_symbols
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: Thu, 29 Oct 2020 07:43:26 -0000

To deal with unnecessarily large RFC editor diffs, there is now a control for kramdown’s typographic symbols feature.

(It was always possible to control this via `kramdown_options`, but the new control has more unromantic defaults.)

In the YAML header, there is now a setting `typographic_symbols`.  For v2, this defaults to true (no change), for v3, this defaults to false, which is an abbreviation for

typographic_symbols:
  mdash: "---"
  ndash: "--"
  hellip: "..."
  laquo_space: "<< "
  raquo_space: " >>"
  laquo: "<<"
  raquo: ">>"

i.e., kramdown’s typographical symbols are translated to ASCII surrogates.

V3 users can still get proper typography by explicitly specifying:

typographic_symbols: true

(or a fleshed out version like the above), but current xml2rfc --v3 will then go ahead and destroy them.

If any of the members of the option are set, these defaults are no longer active, e.g.

typographic_symbols:
  mdash: "⸺"

will change the rendition of the markdown em-dash (`---`) to a two-em dash, but keep the other (beyond-ASCII) translations that kramdown defaults to in place.

TL;DR:
v3 users now get smaller diffs from the RFC editor; people who care about type (and don’t care about the sorry current state of typography in RFCXMLv3) have more direct access to the controls.

Grüße, Carsten