Re: RFC and I-D Citation Tool

Steven Bellovin <smb@cs.columbia.edu> Tue, 31 July 2012 21:35 UTC

Return-Path: <smb@cs.columbia.edu>
X-Original-To: ietf@ietfa.amsl.com
Delivered-To: ietf@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 2C96521F888D; Tue, 31 Jul 2012 14:35:29 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -6.599
X-Spam-Level:
X-Spam-Status: No, score=-6.599 tagged_above=-999 required=5 tests=[AWL=0.000, BAYES_00=-2.599, RCVD_IN_DNSWL_MED=-4]
Received: from mail.ietf.org ([12.22.58.30]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id RvrnCS97LT98; Tue, 31 Jul 2012 14:35:28 -0700 (PDT)
Received: from tarap.cc.columbia.edu (tarap.cc.columbia.edu [128.59.29.7]) by ietfa.amsl.com (Postfix) with ESMTP id F083221F8857; Tue, 31 Jul 2012 14:35:27 -0700 (PDT)
Received: from [10.9.0.226] (fireball.cs.columbia.edu [128.59.13.10]) (user=smb2132 mech=PLAIN bits=0) by tarap.cc.columbia.edu (8.14.4/8.14.3) with ESMTP id q6VLZLqk016938 (version=TLSv1/SSLv3 cipher=AES128-SHA bits=128 verify=NOT); Tue, 31 Jul 2012 17:35:22 -0400 (EDT)
Subject: Re: RFC and I-D Citation Tool
Mime-Version: 1.0 (Apple Message framework v1278)
Content-Type: text/plain; charset="us-ascii"
From: Steven Bellovin <smb@cs.columbia.edu>
In-Reply-To: <alpine.OSX.2.01.1207311421270.87763@173-11-110-132-sfba.hfc.comcastbusiness.net>
Date: Tue, 31 Jul 2012 14:35:21 -0700
Content-Transfer-Encoding: quoted-printable
Message-Id: <C18E588A-541E-43C7-AF41-F301E3A6AE5B@cs.columbia.edu>
References: <alpine.OSX.2.01.1207311102470.86865@173-11-110-132-sfba.hfc.comcastbusiness.net> <80A0822C5E9A4440A5117C2F4CD36A6404136619@DEMUEXC006.nsn-intra.net> <alpine.OSX.2.01.1207311421270.87763@173-11-110-132-sfba.hfc.comcastbusiness.net>
To: Ole Jacobsen <ole@cisco.com>
X-Mailer: Apple Mail (2.1278)
X-No-Spam-Score: Local
X-Scanned-By: MIMEDefang 2.68 on 128.59.29.7
Cc: The IETF <ietf@ietf.org>, Henrik Levkowetz <henrik@levkowetz.com>, RSOC <rsoc@iab.org>, Heather Flanagan <hlflanagan@gmail.com>, rsag@rfc-editor.org
X-BeenThere: ietf@ietf.org
X-Mailman-Version: 2.1.12
Precedence: list
List-Id: IETF-Discussion <ietf.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/ietf>, <mailto:ietf-request@ietf.org?subject=unsubscribe>
List-Archive: <http://www.ietf.org/mail-archive/web/ietf>
List-Post: <mailto:ietf@ietf.org>
List-Help: <mailto:ietf-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/ietf>, <mailto:ietf-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 31 Jul 2012 21:35:29 -0000

There are a number of very weird entries that require special handling.  I (also) wrote a Python script to convert the XML file to bibtex and had to deal with a number of these special cases.  For example, RFC 4534 lists the authors as "A Colegrove, H Harney" instead of "A. Colegrove, H. Harney".  Other names like "The Internet Society" require special handling.  And I completely punted on proper capitalization of the titles; I just accept what's there.

On Jul 31, 2012, at 2:23 PM, Ole Jacobsen wrote:

> 
> Mehmet,
> 
> The tool is not INTENDED to change the author order. A somewhat 
> incomplete database can indeed lead to unexpected results, use with 
> caution.
> 
> Ole
> 
> Ole J. Jacobsen
> Editor and Publisher,  The Internet Protocol Journal
> Cisco Systems
> Tel: +1 408-527-8972   Mobile: +1 415-370-4628
> E-mail: ole@cisco.com  URL: http://www.cisco.com/ipj
> Skype: organdemo
> 
> 
> On Tue, 31 Jul 2012, Ersue, Mehmet (NSN - DE/Munich) wrote:
> 
>> Nice tool. 
>> 
>> However, I am wondering why the tool changes the order of the names.
>> There is actually a reason why documents list names in a specific order.
>> 
>> Some of the citations appear to be incomplete, see RFC3410.
>> 
>> Cheers, 
>> Mehmet 
>> 
>> 
>>> -----Original Message-----
>>> From: ietf-bounces@ietf.org [mailto:ietf-bounces@ietf.org] On Behalf
>> Of ext Ole
>>> Jacobsen
>>> Sent: Tuesday, July 31, 2012 11:17 AM
>>> To: The IETF
>>> Cc: RSOC; Heather Flanagan; rsag@rfc-editor.org
>>> Subject: RFC and I-D Citation Tool
>>> 
>>> 
>>> In The Internet Protocol Journal I have been using the following
>>> citation format, best illustrated by an example:
>>> 
>>> Julien Meuric, Diego Caviglia, Don Fedyk, Attila Takacs, and Lou
>>> Berger, "GMPLS Asymmetric Bandwidth Bidirectional Label Switched
>>> Paths (LSPs)," RFC 6387, September 2011.
>>> 
>>> So, that's full author names "and" before the last author name, title,
>>> document number and date, using the American "quotation outside
>>> punctuation rule."
>>> 
>>> I got tired of doing this "by hand" so I asked Henrik if he could
>>> write me a tool. He did (THANKS!), and the result is here:
>>> 
>>> http://tools.ietf.org/tools/citation/
>>> 
>>> This will take either the draft name or the RFC number as input and
>>> produce a citation similar to the one above. You can of course play
>>> with the elements and generate a format that suits your own taste, for
>>> example, for I-Ds, in print it might be good to have the FILE NAME as
>>> the last entry:
>>> 
>>> Adam Langley, "Serializing DNS Records with DNSSEC Authentication,"
>>> Internet Draft, work in progress, July 2011,
>>> draft-agl-dane-serializechain-01
>>> 
>>> ...since I like having filenames or URLs on one line (not wrapping)
>>> as much as possible.
>>> 
>>> Many thanks again to Henrik, and I hope you will find it useful too!
>>> 
>>> Ole
>>> 
>>> 
>>> 
>>> Ole J. Jacobsen
>>> Editor and Publisher,  The Internet Protocol Journal
>>> Cisco Systems
>>> Tel: +1 408-527-8972   Mobile: +1 415-370-4628
>>> E-mail: ole@cisco.com  URL: http://www.cisco.com/ipj
>>> Skype: organdemo
>> 
>> 
> 


		--Steve Bellovin, https://www.cs.columbia.edu/~smb