Re: RFC and I-D Citation Tool

2012-08-09 Thread Henrik Levkowetz
Hi,

On 2012-08-01 01:17 Ole Jacobsen said:
 
 One feature request that I discussed with Henrik was to either
 auto-detect I-D file names and handle them slightly differently
 from RFC numbers (by putting the file name as the final entry)
 OR just having two tools. With the kind of feedback Henrik is
 getting I am sure the tool will be improved/enhanced over time.

I've now set up the tool to use different templates, depending on
whether the document is an RFC or a draft (actually, it's decided
on whether or not I find an RFC number in the metadata I have for
a document).

Let me know if this works for you, or if further tweaks are needed
to provide what is desired.


Best regards,

Henrik



signature.asc
Description: OpenPGP digital signature


Re: RFC and I-D Citation Tool

2012-08-09 Thread Eggert, Lars
Hi,

one suggestion: I-Ds must be cited as Work in Progress only. From the 
boilerplate text:

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
  ^^^
   material or to cite them other than as work in progress.
   ^^

I typically do it like this. Instead of:

Alia Atlas, Cisco Systems, Dave Ward, Juniper Networks, and Thomas Nadeau, 
Interface to the Routing System Framework, July 2012, 
draft-ward-irs-framework-00.

I use:

Alia Atlas, Cisco Systems, Dave Ward, Juniper Networks, and Thomas Nadeau, 
Interface to the Routing System Framework, Internet-Draft 
draft-ward-irs-framework-00, Work in Progress, July 2012.

Lars

smime.p7s
Description: S/MIME cryptographic signature


Re: RFC and I-D Citation Tool

2012-08-01 Thread t . p .
- Original Message -
From: Noel Chiappa j...@mercury.lcs.mit.edu
To: ietf@ietf.org
Cc: r...@iab.org; j...@mercury.lcs.mit.edu; r...@rfc-editor.org
Sent: Tuesday, July 31, 2012 10:47 PM
  From: Ole Jacobsen o...@cisco.com

  using the American quotation outside punctuation rule.

 Ugh. There may be uglier typographic conventions, but off the top of
my head,
 I can't come up with one.

Ugh indeed, but I find the space before every comma rule even uggier.

Tom Petch


 Noel





RFC and I-D Citation Tool

2012-07-31 Thread Ole Jacobsen

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: o...@cisco.com  URL: http://www.cisco.com/ipj
Skype: organdemo



Re: RFC and I-D Citation Tool

2012-07-31 Thread Marc Blanchet
cool!!!  I will also be using this! thanks!

Marc.

Le 2012-07-31 à 11:16, Ole Jacobsen a écrit :

 
 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: o...@cisco.com  URL: http://www.cisco.com/ipj
 Skype: organdemo



Re: RFC and I-D Citation Tool

2012-07-31 Thread Eggert, Lars
And for those of us who write academic papers, there is of course Roland's and 
Miguel's BibTex collections:

http://tm.uka.de/~bless/bibrfcindex.html
https://sites.google.com/site/ea1dof/bibtex

Lars

On Jul 31, 2012, at 11:16, Ole Jacobsen o...@cisco.com wrote:

 
 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: o...@cisco.com  URL: http://www.cisco.com/ipj
 Skype: organdemo
 



smime.p7s
Description: S/MIME cryptographic signature


RE: RFC and I-D Citation Tool

2012-07-31 Thread Ersue, Mehmet (NSN - DE/Munich)
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-boun...@ietf.org [mailto:ietf-boun...@ietf.org] On Behalf
Of ext Ole
 Jacobsen
 Sent: Tuesday, July 31, 2012 11:17 AM
 To: The IETF
 Cc: RSOC; Heather Flanagan; r...@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: o...@cisco.com  URL: http://www.cisco.com/ipj
 Skype: organdemo



RE: RFC and I-D Citation Tool

2012-07-31 Thread Ole Jacobsen

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: o...@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-boun...@ietf.org [mailto:ietf-boun...@ietf.org] On Behalf
 Of ext Ole
  Jacobsen
  Sent: Tuesday, July 31, 2012 11:17 AM
  To: The IETF
  Cc: RSOC; Heather Flanagan; r...@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: o...@cisco.com  URL: http://www.cisco.com/ipj
  Skype: organdemo
 
 


Re: RFC and I-D Citation Tool

2012-07-31 Thread Steven Bellovin
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: o...@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-boun...@ietf.org [mailto:ietf-boun...@ietf.org] On Behalf
 Of ext Ole
 Jacobsen
 Sent: Tuesday, July 31, 2012 11:17 AM
 To: The IETF
 Cc: RSOC; Heather Flanagan; r...@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: o...@cisco.com  URL: http://www.cisco.com/ipj
 Skype: organdemo
 
 
 


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







Re: RFC and I-D Citation Tool

2012-07-31 Thread Noel Chiappa
 From: Ole Jacobsen o...@cisco.com

 using the American quotation outside punctuation rule.

Ugh. There may be uglier typographic conventions, but off the top of my head,
I can't come up with one.

Noel


Re: RFC and I-D Citation Tool

2012-07-31 Thread Carsten Bormann
Not yet quite optimal for e.g. RFC 3095:

http://tools.ietf.org/tools/citation/?doc=3095template=%7Bauthors.andlist%7D%2C+%22%7Bdoctitle%7D%2C%22+%7Bdocname%7D%2C+%7Bdate%3A%25B+%25Y.%7Dsubmit=Generate+citation

Grüße, Carsten



Re: RFC and I-D Citation Tool

2012-07-31 Thread Henrik Levkowetz
Hi Ersue,

On 2012-07-31 13:27 Ersue, Mehmet (NSN - DE/Munich) said the following:
 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.

There is no intentional name re-ordering.  I'll look into why that happens.

 Some of the citations appear to be incomplete, see RFC3410.

Ok, will check that too.

Thanks for the feedback!


Best regards,

Henrik

 Cheers, 
 Mehmet 
 
 
 -Original Message-
 From: ietf-boun...@ietf.org [mailto:ietf-boun...@ietf.org] On Behalf
 Of ext Ole
 Jacobsen
 Sent: Tuesday, July 31, 2012 11:17 AM
 To: The IETF
 Cc: RSOC; Heather Flanagan; r...@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: o...@cisco.com  URL: http://www.cisco.com/ipj
 Skype: organdemo
 
 


Re: RFC and I-D Citation Tool

2012-07-31 Thread Henrik Levkowetz

On 2012-07-31 14:35 Steven Bellovin said the following:
 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.

Ah.  I'll have to look at fixing cases like the ones you mention, then.

Thanks!

Henrik

 
 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: o...@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-boun...@ietf.org [mailto:ietf-boun...@ietf.org] On Behalf
 Of ext Ole
 Jacobsen
 Sent: Tuesday, July 31, 2012 11:17 AM
 To: The IETF
 Cc: RSOC; Heather Flanagan; r...@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: o...@cisco.com  URL: http://www.cisco.com/ipj
 Skype: organdemo
 
 
 
 
 
   --Steve Bellovin, https://www.cs.columbia.edu/~smb
 
 
 
 
 
 



signature.asc
Description: OpenPGP digital signature


Re: RFC and I-D Citation Tool

2012-07-31 Thread Ole Jacobsen

One feature request that I discussed with Henrik was to either
auto-detect I-D file names and handle them slightly differently
from RFC numbers (by putting the file name as the final entry)
OR just having two tools. With the kind of feedback Henrik is
getting I am sure the tool will be improved/enhanced over time.

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: o...@cisco.com  URL: http://www.cisco.com/ipj
Skype: organdemo




Re: RFC and I-D Citation Tool

2012-07-31 Thread Henrik Levkowetz
Hi Ole,

On 2012-07-31 16:17 Ole Jacobsen said the following:
 
 One feature request that I discussed with Henrik was to either
 auto-detect I-D file names and handle them slightly differently
 from RFC numbers (by putting the file name as the final entry)
 OR just having two tools. With the kind of feedback Henrik is
 getting I am sure the tool will be improved/enhanced over time.

I'm thinking about how to do this best now.  One option I'm considering
is to provide two template fields in the tool, one to be used for
references to RFCs, the other to references to drafts.


Best regards,

Henrik



signature.asc
Description: OpenPGP digital signature