IETF Logo Mail Archive

Re: [xml2rfc] Inline use of <sourcecode>

Julian Reschke <julian.reschke@gmx.de> Mon, 18 January 2021 13:20 UTC

Return-Path: <julian.reschke@gmx.de>
X-Original-To: xml2rfc@ietfa.amsl.com
Delivered-To: xml2rfc@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 2A1483A132A for <xml2rfc@ietfa.amsl.com>; Mon, 18 Jan 2021 05:20:52 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.18
X-Spam-Level:
X-Spam-Status: No, score=-2.18 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, FREEMAIL_FROM=0.001, NICE_REPLY_A=-0.262, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=gmx.net
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 Ly0XKT-JwHue for <xml2rfc@ietfa.amsl.com>; Mon, 18 Jan 2021 05:20:49 -0800 (PST)
Received: from mout.gmx.net (mout.gmx.net [212.227.17.21]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 1CB103A1329 for <xml2rfc@ietf.org>; Mon, 18 Jan 2021 05:20:48 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1610976044; bh=ELSmzaxWDzTdmN6g8g5K1TSUYKJpwyYE3tE+arT5rJo=; h=X-UI-Sender-Class:Subject:To:References:From:Date:In-Reply-To; b=Ni577nrF7n3LAJC87iKm5/ztIVYUKQFEgPYg0KuYbjF6SNKjYtvTWb/X/6NeSvZzS PPrdR4poqQuEscGAV76Q4domuTalMYwRC3YkNnVTonn8ABf+56OyptTN15/qPlDuwh WYU40ZPaiqeHgxq9g2Kvl+AJXMiPuWOGZI031dFY=
X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c
Received: from [192.168.1.236] ([5.10.171.186]) by mail.gmx.com (mrgmx105 [212.227.17.168]) with ESMTPSA (Nemesis) id 1MFKGP-1lGek11k6L-00FgRh for <xml2rfc@ietf.org>; Mon, 18 Jan 2021 14:20:44 +0100
To: xml2rfc@ietf.org
References: <alpine.DEB.2.20.2101181313160.26613@maria.rogerprice.org>
From: Julian Reschke <julian.reschke@gmx.de>
Message-ID: <ee8a89be-24d7-d060-c237-47bb572743fc@gmx.de>
Date: Mon, 18 Jan 2021 14:20:44 +0100
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:78.0) Gecko/20100101 Thunderbird/78.6.1
MIME-Version: 1.0
In-Reply-To: <alpine.DEB.2.20.2101181313160.26613@maria.rogerprice.org>
Content-Type: text/plain; charset="iso-8859-15"; format="flowed"
Content-Transfer-Encoding: quoted-printable
X-Provags-ID: V03:K1:jgZT1lsicL3xbVb8PI/xxGk9Kz2n4bfpqlwus7ZNE8lpRt1z/Pk QxUPfK/AijOYpzxnGOn4dw1Wj/R6TtR3UcwBc4C+OWPrYMtFdUld5HO9MfVDnTxsGqiIxH4 QrP6jV1fREcEMmYN0JV9hYMSeNlcZkAjHMv9uuTKzW9l8oLm7NWfxsNdLEpfLtRwkJp2Uid XF57CWiiay35K0XE7b5HA==
X-UI-Out-Filterresults: notjunk:1;V03:K0:rK9o3MvWjjE=:PpK77+KqZ9ILxhE8CpTDLz OITO80BnqETOMdwumYeqzhmiyogPgwl2fhZ36Y/Ns/zFhG6z0F577iyG2/L+UgKCgKZhfJ7cQ Of5UAhVls3bvfHBeo9FqtVMZAFzNTr4WhNf27VzVBdbZiX0k+IN4Pq30wzK0hxsGkVMp3tiZS RNfPLqWU8msVjkaDrHCvaHk6I64WO1r91My27aO3sWJYVpCBkqXgilejUXPdcexc4UP0z82qK zif+14qBfhNGKclzX4nSuiDfQ9T3xDzeV8dqV5Gb0WZR+CUhWdXH8i5unSkupJW5z4QDxsNie OI2I5FjNGoSuI7C2uCg5+CsuSI7blSKDLvgL10qqk87eSBMkzb5TtZnfgJF5TBWP/0PyWfFTj YPuXCpFij4rf9U2H8v73GBUhgVkeSPQxk3Blati55k+G5IYFWkUdEvybMypiG80RmEeLnMhJk Ba8AAaYX7h0HwK/ozYY/GpuQeYg5cUCBQ6y56Lz+MqJgQOHsfYTU/8ceLTH75ipk4BPLBuVnD 5Ohq0kU4kIyhhGV9/mkeu08XuvYuRml+iwzfjsh3vYOdnrIkSzcLGKJpxzEBJtNZQP1g32v8f r7drukeEmsBVVKUW+Y9G9dpv1xKgT4DR5Q+hW4Lk7VF/q7iqXyjjz8cAt9ooLvQmLtN2rcSqR vep8WusVNH9eLeSsd0t4XecqIQ5fQ13qCaIcZILoUBXaLv8uNr6a2T7dhd6OGPzoCxUnpZJHq jFfMw25FP2OFS5Sf6DI5VZoUg4asvpijNIwBCZIPYKT/ey8WAZaIZVPJ3vS0m3zb0ysWIfcBH +vD+uwXmGaKbg5yrpgW0WMquuwRV9XatxWfd7vxPWsBS4ZKM3fyE8fT3GidAz8NgEgk2RPZAE DCWBTTuZiE84gE/fHSWg==
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc/jhg_CwQAy_FbdLKXAytibu5n3UA>
Subject: Re: [xml2rfc] Inline use of <sourcecode>
X-BeenThere: xml2rfc@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: <xml2rfc.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/xml2rfc>, <mailto:xml2rfc-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/xml2rfc/>
List-Post: <mailto:xml2rfc@ietf.org>
List-Help: <mailto:xml2rfc-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/xml2rfc>, <mailto:xml2rfc-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 18 Jan 2021 13:20:52 -0000

Am 18.01.2021 um 13:58 schrieb Roger Price:
> I'm trying to work out how to markup a protocol token in running text
> since there seems be no inline version of <sourcecode> in the way that
> HTML has <code>.
>
> It looks as if <sourcecode> is the correct element since RFC 7991 clause
> 2.48 https://tools.ietf.org/html/rfc7991#page-59 says:
>
>   « ...  When <sourcecode> is a child of <figure> or <section>, it provides
>     full control of horizontal whitespace and line breaks...
>     (When <sourcecode> is a child of other elements, it flows with the text
>     that surrounds it.) »
>
> I tried the markup:
>
>   <t>(a) Protocol token <sourcecode>LB</sourcecode> <t>indicates a low
> battery.
>   <t>(b) Protocol token <tt>LB</tt> indicates a low battery.
>
> In the .txt file it produces
>
>     (a) Protocol token
>
>     LB
>
>     indicates a low battery.
>
>     (b) Protocol token "LB" indicates a low battery.
>
> and in the .html file it produces
>
>    (a) Protocol token
>
>        LB
>
>    indicates a low battery.
>
>    (b) Protocol token LB indicates a low battery.
>
> Comments:
>
> 1. Correct: The LB's are correctly formatted in the HTML in a monospaced
> font.
>
> 2. Bug: In both outputs (a), although <sourcecode> is a child of <t> it
> does not flow with the text as stated in the RFC.
>
> 3. Ugly: In the txt file, (b) sees the token OB adorned with quote
> characters which are not part of the protocol.  The txt and html files
> do not agree.
>
> 4. Ugly: A <t> element is needed after <sourcecode> since <sourcecode>
> is not behaving as a true inline element.
>
> What is the recommended way of marking up inline source code?

There currently is no provision for inline source code. The statement

>    [RFC5234] or the RNC notation used in this document).  (When
>    <sourcecode> is a child of other elements, it flows with the text
>    that surrounds it.)  Tab characters (U+0009) inside of this element
>    are prohibited.

is misleading because <sourcecode> is a true block-level element, see
<https://greenbytes.de/tech/webdav/rfc7991.html#rfc.section.2.48.p.6>.

If xml2rfc "accepts" it as a child element of <t>, that's a bug.

Best regards, Julian

v2.23.0 | Report a Bug | By Email