IETF Logo Mail Archive

[rfc-i] line wrapping in XML

Mark Nottingham <mnot@mnot.net> Fri, 30 October 2020 00:23 UTC

Return-Path: <rfc-interest-bounces@rfc-editor.org>
X-Original-To: ietfarch-rfc-interest-archive@ietfa.amsl.com
Delivered-To: ietfarch-rfc-interest-archive@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 793683A0408; Thu, 29 Oct 2020 17:23:57 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.45
X-Spam-Level:
X-Spam-Status: No, score=-2.45 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_INVALID=0.1, DKIM_SIGNED=0.1, HEADER_FROM_DIFFERENT_DOMAINS=0.25, MAILING_LIST_MULTI=-1, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=fail (2048-bit key) reason="fail (message has been altered)" header.d=mnot.net header.b=P5jI1dZ7; dkim=fail (2048-bit key) reason="fail (message has been altered)" header.d=messagingengine.com header.b=f9ZyQNaN
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 8D_vkNIRKYJc; Thu, 29 Oct 2020 17:23:55 -0700 (PDT)
Received: from rfc-editor.org (rfc-editor.org [4.31.198.49]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id C02AF3A03FA; Thu, 29 Oct 2020 17:23:55 -0700 (PDT)
Received: from rfcpa.amsl.com (localhost [IPv6:::1]) by rfc-editor.org (Postfix) with ESMTP id D34C7F4071A; Thu, 29 Oct 2020 17:23:39 -0700 (PDT)
X-Original-To: rfc-interest@rfc-editor.org
Delivered-To: rfc-interest@rfc-editor.org
Received: from localhost (localhost [127.0.0.1]) by rfc-editor.org (Postfix) with ESMTP id B12ECF4071A for <rfc-interest@rfc-editor.org>; Thu, 29 Oct 2020 17:23:38 -0700 (PDT)
X-Virus-Scanned: amavisd-new at rfc-editor.org
Authentication-Results: rfcpa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=mnot.net header.b=P5jI1dZ7; dkim=pass (2048-bit key) header.d=messagingengine.com header.b=f9ZyQNaN
Received: from rfc-editor.org ([127.0.0.1]) by localhost (rfcpa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id xirub7sfRslM for <rfc-interest@rfc-editor.org>; Thu, 29 Oct 2020 17:23:34 -0700 (PDT)
Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com [66.111.4.25]) by rfc-editor.org (Postfix) with ESMTPS id 9B045F40716 for <rfc-interest@rfc-editor.org>; Thu, 29 Oct 2020 17:23:34 -0700 (PDT)
Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailout.nyi.internal (Postfix) with ESMTP id A3D0F5C00EC for <rfc-interest@rfc-editor.org>; Thu, 29 Oct 2020 20:23:47 -0400 (EDT)
Received: from mailfrontend1 ([10.202.2.162]) by compute2.internal (MEProxy); Thu, 29 Oct 2020 20:23:47 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=mnot.net; h=from :content-type:content-transfer-encoding:mime-version:subject :message-id:date:to; s=fm1; bh=szJ5xuMp18XGYykuLRJV4jf3ZOiKhPxMC 5mZ1F2SGf4=; b=P5jI1dZ7PLN4BELghb+i/T/9FPSqBWxvJJQz7HcWWYCo7C7UH hFIQ41Akwj3vqRqbkobbhOY4oZP8WCBZzkT9i8OCmGzAKcc453Ix4hKwtYpgselw L5q2mnkZnmetKD+2uCMg415DrbTmAkHmxXNFwILg4Ra8OgjPkt5Fe8brvg68m3St oCvyZ/rbx7gb4JMz50N8/2hczvnFdpfklpd/tSjtIc9UDBczOECwmbB+0N2d4nkI 5jNxqDzsI2Kqwxg0TE0AYHYVnFwwk9pKbQiTsgkRb6Y1PA2isOBd4iJJbiyM//CK rWc51PydmeBXAlwh/AHkrbFSqNJdxA4g9nHhw==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=content-transfer-encoding:content-type :date:from:message-id:mime-version:subject:to:x-me-proxy :x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s=fm1; bh=szJ5xu Mp18XGYykuLRJV4jf3ZOiKhPxMC5mZ1F2SGf4=; b=f9ZyQNaNip3/vCxO/3aORL a3S8UPfKakaBmSJKNTeY8khBC31QwiSQJD2x7hPP/3OxiJcjZTUyRktOB59GW9hh FKOGeu+LPj2/nTTHtIrCqlrBnV74m6gY2K7yQ8ack0AXBAnE1EF5WrEFo+bykKiI JLdJtd9U5excL/if3McTaL37mP078v1JIOie/oqPnQ84A80t4FQYzUEc13TwMiZT JDaErdkPHiDNy3lOW5LpS/XbsltKzH681HqRCYD+EhLre+43HzbIZI3Uz/Rds1HT +gKYfiTT/pXd9W0W2BPRxV3Ezv3Lc++K4v5hvdHHgYJWUity9a2bHezVz5avnRqA ==
X-ME-Sender: <xms:El2bX952gNugk-TnngZfOdLOz9fDdDRi7-KfRvpYFUq0ZN3V6oanmw> <xme:El2bX64sHEGs7w--zgpP4kltaszZ9n2_RDe7VF5_15ng8VujgIVDWeuoYTL9f4-U9 4pBR6iTzVh_yMeAgA>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedujedrleeggddvudcutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecunecujfgurhephfgtgfgguffkfffvofesthhqmhdthh dtvdenucfhrhhomhepofgrrhhkucfpohhtthhinhhghhgrmhcuoehmnhhothesmhhnohht rdhnvghtqeenucggtffrrghtthgvrhhnpefgveekieeigeeljeekfedvffeuffelhfduud dtteefudelfeffjedutddvgeefffenucffohhmrghinhepmhhnohhtrdhnvghtnecukfhp peduudelrddujedrudehkedrvdehudenucevlhhushhtvghrufhiiigvpedtnecurfgrrh grmhepmhgrihhlfhhrohhmpehmnhhothesmhhnohhtrdhnvght
X-ME-Proxy: <xmx:El2bX0ey6xQ1JW-oKqb73QQMf-kc_CT_OQovxbllNtUewtpMKYt4Ww> <xmx:El2bX2Ie3tozkGwg7UBo0_w5fG9-NSnENwklL8lVedY_mf8svgbkzw> <xmx:El2bXxLAevrexwbKMZ2pHfJ4D-68zXgEIREo3f5Ngb6N3PUtNa7bSg> <xmx:E12bX_jTAYlmN28rCWP0vo8nlqWHatm1q8etwYCFKjFs_R0feQVKlg>
Received: from [192.168.7.30] (119-17-158-251.77119e.mel.static.aussiebb.net [119.17.158.251]) by mail.messagingengine.com (Postfix) with ESMTPA id 59D1A3280059 for <rfc-interest@rfc-editor.org>; Thu, 29 Oct 2020 20:23:45 -0400 (EDT)
From: Mark Nottingham <mnot@mnot.net>
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.4\))
Message-Id: <30D23CA0-2A80-4BA3-AC18-285CF45FB5FF@mnot.net>
Date: Fri, 30 Oct 2020 11:23:42 +1100
To: rfc-interest@rfc-editor.org
X-Mailer: Apple Mail (2.3608.120.23.2.4)
Subject: [rfc-i] line wrapping in XML
X-BeenThere: rfc-interest@rfc-editor.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "A list for discussion of the RFC series and RFC Editor functions." <rfc-interest.rfc-editor.org>
List-Unsubscribe: <https://www.rfc-editor.org/mailman/options/rfc-interest>, <mailto:rfc-interest-request@rfc-editor.org?subject=unsubscribe>
List-Archive: <http://www.rfc-editor.org/pipermail/rfc-interest/>
List-Post: <mailto:rfc-interest@rfc-editor.org>
List-Help: <mailto:rfc-interest-request@rfc-editor.org?subject=help>
List-Subscribe: <https://www.rfc-editor.org/mailman/listinfo/rfc-interest>, <mailto:rfc-interest-request@rfc-editor.org?subject=subscribe>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: rfc-interest-bounces@rfc-editor.org
Sender: rfc-interest <rfc-interest-bounces@rfc-editor.org>

When editing a source document (especially Markdown), many people seem to find it best to NOT line-wrap paragraphs, so that diffs (e.g., on GitHub) are minimal; otherwise re-wrapping causes a lot of noise in diffs during the WG process.

Currently, XML created from markdown using kramdown-rc2629 seems to mirror what the source document contains; if there are line breaks, they will be preserved, but if not, they will not be created.

When an XML document goes to the RFC Editor, it will be line-wrapped (apparently manually). This causes difficulties in creating an XML diff from the source document to the one that's being offered for approval -- something that I feel is necessary, given that XML is now the canonical format.

Currently, I'm using Apple FileMerge to do the diff, because it has the ability to ignore whitespace; however, it still highlights it, so that's not optimal.

Is there something we can do to improve this? I don't think wrapping the source files is a solution, since that reduces utility for document authors, but off the top of my head:

1. Can we identify a freely available tool for correctly line-wrapping XML that people can insert into their toolchain pre-RPC, so that the RPC doesn't need to hand-wrap lines?

2. Can we ask the RPC to stop line-wrapping by default?

3. ???

Cheers,

--
Mark Nottingham   https://www.mnot.net/

_______________________________________________
rfc-interest mailing list
rfc-interest@rfc-editor.org
https://www.rfc-editor.org/mailman/listinfo/rfc-interest

v2.23.0 | Report a Bug | By Email