Re: [TOOLS-DEVELOPMENT] Preview release of Text Submission Converter, id2xml

Henrik Levkowetz <henrik@levkowetz.com> Fri, 26 May 2017 20:08 UTC

Return-Path: <henrik@levkowetz.com>
X-Original-To: tools-development@ietfa.amsl.com
Delivered-To: tools-development@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id C1B7112940D for <tools-development@ietfa.amsl.com>; Fri, 26 May 2017 13:08:21 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Level:
X-Spam-Status: No, score=-1.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, 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 K98N553CnUuw for <tools-development@ietfa.amsl.com>; Fri, 26 May 2017 13:08:20 -0700 (PDT)
Received: from durif.tools.ietf.org (durif.tools.ietf.org [IPv6:2001:1900:3001:11::3d]) (using TLSv1.2 with cipher DHE-RSA-AES128-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id EEAFA124281 for <tools-development@ietf.org>; Fri, 26 May 2017 13:08:19 -0700 (PDT)
Received: from h-43-30.a357.priv.bahnhof.se ([79.136.43.30]:50314 helo=[192.168.1.120]) by durif.tools.ietf.org with esmtpsa (TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128) (Exim 4.80) (envelope-from <henrik@levkowetz.com>) id 1dELWz-0005Y1-LC; Fri, 26 May 2017 13:08:19 -0700
To: Sandy Ginoza <sginoza@amsl.com>, Megan Ferguson <mferguson@amsl.com>
References: <591F6199.60801@levkowetz.com> <E5A96E3B-8D3A-4046-8D14-FCD260B66CA6@amsl.com> <EE7FE0BC-1B58-4E1E-AE2F-7889B38B3B69@amsl.com>
Cc: tools-development@ietf.org
From: Henrik Levkowetz <henrik@levkowetz.com>
Message-ID: <59288B29.7040906@levkowetz.com>
Date: Fri, 26 May 2017 22:08:09 +0200
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.11; rv:38.0) Gecko/20100101 Thunderbird/38.4.0
MIME-Version: 1.0
In-Reply-To: <EE7FE0BC-1B58-4E1E-AE2F-7889B38B3B69@amsl.com>
Content-Type: multipart/signed; micalg="pgp-sha256"; protocol="application/pgp-signature"; boundary="GThBIDrfk9saQTCukhGrvhwFQGPqUkdFx"
X-SA-Exim-Connect-IP: 79.136.43.30
X-SA-Exim-Rcpt-To: tools-development@ietf.org, mferguson@amsl.com, sginoza@amsl.com
X-SA-Exim-Mail-From: henrik@levkowetz.com
X-SA-Exim-Version: 4.2.1 (built Mon, 26 Dec 2011 16:24:06 +0000)
X-SA-Exim-Scanned: Yes (on durif.tools.ietf.org)
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-development/c8HvS0YJC-37TS3b5Ui2ZW_JSWE>
Subject: Re: [TOOLS-DEVELOPMENT] Preview release of Text Submission Converter, id2xml
X-BeenThere: tools-development@ietf.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: Tools Development list server <tools-development.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/tools-development>, <mailto:tools-development-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/tools-development/>
List-Post: <mailto:tools-development@ietf.org>
List-Help: <mailto:tools-development-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/tools-development>, <mailto:tools-development-request@ietf.org?subject=subscribe>
X-List-Received-Date: Fri, 26 May 2017 20:08:22 -0000

On 2017-05-26 21:18, Sandy Ginoza wrote:
> Hi All,
> 
> xml v2 does not handle the formatting for these types of reference
> entries, and I believe the goal for id2xml is to convert .txt to .xml
> v2 (so this will not be addressed via id2xml) — though, please
> correct me if I’m mistaken. If not, we will continue to manually
> update these entries post xml2rfc.

For version 1.x of id2xml this is right.  The intention is to produce a
version 2.x of id2xml which will produce vocabulary v3 xml as part of the
current work.  At that time, entries like the one below should be
correctly parsed into xml (v3) by id2xml.

> However, I am curious about where the reference information to create
> the XML entry is being pulled from. Does it XMLize the text entry or
> does it pull info from somewhere else?

That would be interesting to know, yes.

	Henrik

> Thanks,
> Sandy
> 
>> On May 26, 2017, at 11:49 AM, Megan Ferguson <mferguson@amsl.com> wrote:
>> 
>> 2) I was curious about how a reference to a BCP that included more than one RFC would be handled (for example, BCP 9 below).  
>> 
>> 
>> In text, it would appear as:
>> 
>>   [BCP9]     Bradner, S., "The Internet Standards Process -- Revision
>>              3", BCP 9, RFC 2026, October 1996.
>> 
>>              Kolkman, O., Bradner, S., and S. Turner, "Characterization
>>              of Proposed Standards", BCP 9, RFC 7127, January 2014.
>> 
>>              Dusseault, L. and R. Sparks, "Guidance on Interoperation
>>              and Implementation Reports for Advancement to Draft
>>              Standard", BCP 9, RFC 5657, September 2009.
>> 
>>              Housley, R., Crocker, D., and E. Burger, "Reducing the
>>              Standards Track to Two Maturity Levels", BCP 9, RFC 6410,
>>              October 2011.
>> 
>>              Resnick, P., "Retirement of the "Internet Official
>>              Protocol Standards" Summary Document", BCP 9, RFC 7100,
>>              December 2013.
>> 
>>              Dawkins, S., "Increasing the Number of Area Directors in
>>              an IETF Area", BCP 9, RFC 7475, March 2015.
>> 
>>              <http://www.rfc-editor.org/info/bcp9 <http://www.rfc-editor.org/info/bcp9>>
>> 
>> 
>> I don’t have a draft in queue to test this on, so I just manually added a reference to BCP 9 and corresponding citation 
>> to draft-ietf-rtgwg-yang-key-chain-24.txt. Below is the resulting XML from id2xml:
>> 
>> <reference anchor="BCP9"><front><title>The Internet Standards Process -- Revision 3</title>
>> 	<author fullname="S. Bradner" initials="S." surname="Bradner"/>
>> 	<date month="October" year="1996"/>
>> 	</front>
>> 	<seriesInfo name="BCP" value="9"/>
>> 	<seriesInfo name="RFC" value="2026"/>
>> 	</reference>
>> 	<reference><front/>
>> 	</reference>
>> 	<reference><front/>
>> 	</reference>
>> 	<reference><front/>
>> 	</reference>
>> 	<reference><front/>
>> 	</reference>
>> 	<reference><front/>
>> 	</reference>
>> 	<reference><front/>
>> 	</reference>
>> 
>> *Note - references to multi-RFC BCPs and STDs are rare and require manual post-xml2rfcv2 updates with our current tools. 
>> The current possible workaround in xml is to include an <annotation> element.  However, I *believe* only one such element is allowed.
> 
> 
> 
> 
> _______________________________________________
> TOOLS-DEVELOPMENT mailing list
> TOOLS-DEVELOPMENT@ietf.org
> https://www.ietf.org/mailman/listinfo/tools-development
>