IETF Logo Mail Archive

Re: [xml2rfc] Inline use of <sourcecode>

Anders Rundgren <anders.rundgren.net@gmail.com> Mon, 18 January 2021 13:13 UTC

Return-Path: <anders.rundgren.net@gmail.com>
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 CA8E93A1323 for <xml2rfc@ietfa.amsl.com>; Mon, 18 Jan 2021 05:13:28 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.36
X-Spam-Level:
X-Spam-Status: No, score=-2.36 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, FREEMAIL_FROM=0.001, NICE_REPLY_A=-0.262, 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 (2048-bit key) header.d=gmail.com
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 WpYT57Ic2z20 for <xml2rfc@ietfa.amsl.com>; Mon, 18 Jan 2021 05:13:26 -0800 (PST)
Received: from mail-wm1-x333.google.com (mail-wm1-x333.google.com [IPv6:2a00:1450:4864:20::333]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id F24C73A1327 for <xml2rfc@ietf.org>; Mon, 18 Jan 2021 05:13:25 -0800 (PST)
Received: by mail-wm1-x333.google.com with SMTP id g10so13736374wmh.2 for <xml2rfc@ietf.org>; Mon, 18 Jan 2021 05:13:25 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=subject:from:to:references:message-id:date:user-agent:mime-version :in-reply-to:content-language:content-transfer-encoding; bh=GV/jPgV9PWOPH3iYudIizWW9A6vaEd02uKCQfbSxY+Q=; b=Owkb/FAWD/rDHxAj2s6FsLO9yFRyx9yCwhcnj8f5g+3CTkIpFvbylUqy88qjl70/c2 DI6KlAZSdsuVlAEXTrbb7f2+Pn8p6TSscs60U+qnXHa3xEkipHR9deOSvzTljhVIeINm xHKnTL7z1Kna0W8cYlUwnRhv8IHv2Ac5GJrSgYIKvMs+C1PRAuzYYQJrVGjGoskRRW7p j22krVDUYDEOGYRHcZdD0E2S/VbEKpJPJvimgzSui9mCW9uRGl4livaVrq8qAWyeIJct lCLuXUWBPWhN7Xu792SdKMvA0CotPc/KvS19006unPiSsBMPIOzVs86wG8Kc6xj5+rJu 7qbQ==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:from:to:references:message-id:date :user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=GV/jPgV9PWOPH3iYudIizWW9A6vaEd02uKCQfbSxY+Q=; b=rAOOkADBjLcKmrVIdtsY8qJaG1tQMo60WO7tedhRCwCvHANkzWh/D/W3m21P87uOVC asBktQDrPNh961Bs/efG0jVPunXW+CNW9iFLMDidaccd9ck/NSirKKv0Khkg646/3Cp/ ZXoljnWWf6EWKKv58/w/qccMHRAZcVK7hiWmpNsYkHEUQZm5C9Onne5iqB6qrG4MBp4e KJ6fPmnpwGaCv9LZErr/J3QBnN13sgCpTJE4lJ3dAwuqtyCKX7Gmd1aBzvt4NGwyqel+ Z01rdle03sT9Czfr4fZdwi+6sUxlQaU4CdRc2G3Q7ja1Y8fmiwe08V4QJEXS/MCsj5uh B7gA==
X-Gm-Message-State: AOAM53282RIk98yssa0CvtfiwmWplKebSXiJ0PqqWZT73YkhwfKZAZUz BUC9K0sHrs/QsjJ6CWbLjO/hG4K/Zh0=
X-Google-Smtp-Source: ABdhPJyiLf5zpGtnRzL+4nmZaQQJZIoaKNdC6qZ38X1O2O3MopmZQJ3fT/v8PVWPZc/sQjtXdj8g6w==
X-Received: by 2002:a1c:2003:: with SMTP id g3mr9263178wmg.90.1610975603931; Mon, 18 Jan 2021 05:13:23 -0800 (PST)
Received: from [192.168.1.79] (25.131.146.77.rev.sfr.net. [77.146.131.25]) by smtp.googlemail.com with ESMTPSA id a62sm25630120wmf.7.2021.01.18.05.13.22 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 18 Jan 2021 05:13:23 -0800 (PST)
From: Anders Rundgren <anders.rundgren.net@gmail.com>
To: Roger Price <roger@rogerprice.org>, xml2rfc Mailing List <xml2rfc@ietf.org>
References: <alpine.DEB.2.20.2101181313160.26613@maria.rogerprice.org> <2ce15a98-58d9-724e-7918-ac51170d08f9@gmail.com>
Message-ID: <4b281400-3e05-f4c7-ab3c-ca1cea1f05b9@gmail.com>
Date: Mon, 18 Jan 2021 14:13:21 +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: <2ce15a98-58d9-724e-7918-ac51170d08f9@gmail.com>
Content-Type: text/plain; charset="iso-8859-15"; format="flowed"
Content-Language: en-US
Content-Transfer-Encoding: 8bit
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc/qZZ8wSjoRwRdMp8hdQRWidZI7U8>
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:13:29 -0000

Pardon me, the "ugly" is still there for RfcMarkup..

Anders

On 2021-01-18 14:09, Anders Rundgren wrote:
> On 2021-01-18 13:58, Roger Price wrote:
>> 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>.
> 
> Hi Roger,
> I have used <tt> successfully:
> 
> https://www.ietf.org/archive/id/draft-jordan-jws-ct-01.html#name-canonicalize-the-json-objec
> https://tools.ietf.org/html/draft-jordan-jws-ct-01#section-3.1.2
> 
> Are you using the on-line version?
> The "" around <tt> objects for RfcMarkup appears to have been removed; 8 months ago they were there...
> 
> Thanx,
> Anders
> 
>>
>> 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?
>>
>> Roger
>>
>>
>> _______________________________________________
>> xml2rfc mailing list
>> xml2rfc@ietf.org
>> https://www.ietf.org/mailman/listinfo/xml2rfc
>>
>

v2.23.0 | Report a Bug | By Email