[Xml-sg-cmt] question re: ref to a BCP or STD that contains one RFC

Alice Russo <arusso@amsl.com> Mon, 17 May 2021 21:24 UTC

Return-Path: <arusso@amsl.com>
X-Original-To: xml-sg-cmt@ietfa.amsl.com
Delivered-To: xml-sg-cmt@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 245BA3A45AC for <xml-sg-cmt@ietfa.amsl.com>; Mon, 17 May 2021 14:24:47 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.199
X-Spam-Level:
X-Spam-Status: No, score=-4.199 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_MED=-2.3, 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 n92-FHXs3967 for <xml-sg-cmt@ietfa.amsl.com>; Mon, 17 May 2021 14:24:44 -0700 (PDT)
Received: from mail.amsl.com (c8a.amsl.com [4.31.198.40]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 6D3B73A45AF for <xml-sg-cmt@ietf.org>; Mon, 17 May 2021 14:24:44 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by c8a.amsl.com (Postfix) with ESMTP id 47F8538A055 for <xml-sg-cmt@ietf.org>; Mon, 17 May 2021 14:24:44 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
Received: from c8a.amsl.com ([127.0.0.1]) by localhost (c8a.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id WMcKe7qjZ3da for <xml-sg-cmt@ietf.org>; Mon, 17 May 2021 14:24:44 -0700 (PDT)
Received: from [IPv6:2601:602:8501:8b10:f5d5:ffff:3435:3f51] (unknown [IPv6:2601:602:8501:8b10:f5d5:ffff:3435:3f51]) by c8a.amsl.com (Postfix) with ESMTPSA id 23EF338A054 for <xml-sg-cmt@ietf.org>; Mon, 17 May 2021 14:24:44 -0700 (PDT)
From: Alice Russo <arusso@amsl.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
Mime-Version: 1.0 (Mac OS X Mail 10.3 \(3273\))
Message-Id: <731C4379-1A86-4DB5-86F3-EB1ED312C4F3@amsl.com>
Date: Mon, 17 May 2021 14:24:43 -0700
To: "xml-sg-cmt@ietf.org" <xml-sg-cmt@ietf.org>
X-Mailer: Apple Mail (2.3273)
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml-sg-cmt/zswCFYbLlWNAKrckNUghpWxUcYo>
Subject: [Xml-sg-cmt] question re: ref to a BCP or STD that contains one RFC
X-BeenThere: xml-sg-cmt@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Working list for the xml and style guide change management team <xml-sg-cmt.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/xml-sg-cmt>, <mailto:xml-sg-cmt-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/xml-sg-cmt/>
List-Post: <mailto:xml-sg-cmt@ietf.org>
List-Help: <mailto:xml-sg-cmt-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/xml-sg-cmt>, <mailto:xml-sg-cmt-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 17 May 2021 21:24:59 -0000

Greetings,

When referencing a subseries identifier (BCP or STD) that contains only one RFC, is it better to 
A) use <referencegroup> around a single <reference> (as done in the citation library [1]) or 
B) create a reference with the desired target (using the <reference> for the RFC as the starting point)?

For example (where BCP 145 contains exactly one RFC):

A) would be [1] https://xml2rfc.ietf.org/public/rfc/bibxml9/reference.BCP.0145.xml

B) would be the same as the RFC reference
(https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.8085.xml)
but with a one-line change:
OLD: <reference anchor="RFC8085" target="https://www.rfc-editor.org/info/rfc8085">
NEW: <reference anchor="BCP145" target="https://www.rfc-editor.org/info/bcp145">
(We assume using <displayreference> is not an option bc of the change to the target.)

Rationale: Render a reference that matches the style guide
(https://datatracker.ietf.org/doc/html/draft-flanagan-7322bis-07#section-4.8.6.2).

If (A) is right, then should it do the right thing for a the section-specific xref?
 e.g. <xref section="5.2" sectionFormat="of" target="BCP145"/>
would yield "Section 5.2 of [BCP145]" where it links to the section in RFC 8085
(desired output https://www.rfc-editor.org/rfc/rfc8085#section-5.2).
I.e., it's the same effect as <xref section="5.2" sectionFormat="of" target="RFC8085"/>.
(Related ticket: https://trac.ietf.org/trac/xml2rfc/ticket/639)

Thanks,
Alice