`preferred-citation` for `conference-paper`

[tgamblin]

Hi! Thank for CITATION.cff. I'm attempting to get GitHub to display this citation properly in BibTeX and APA format:

preferred-citation:
  type: conference-paper
  authors:
  - family-names: "Gamblin"
    given-names: "Todd"
  - family-names: "LeGendre"
    given-names: "Matthew"
  - family-names: "Collette"
    given-names: "Michael R."
  - family-names: "Lee"
    given-names: "Gregory L."
  - family-names: "Moody"
    given-names: "Adam"
  - family-names: "de Supinski"
    given-names: "Bronis R."
  - family-names: "Futral"
    given-names: "Scott"
  title: "The Spack Package Manager: Bringing Order to HPC Software Chaos"
  conference:
    name: "Supercomputing 2015 (SC’15)"
    date-start: 2015-11-15
    date-end: 2015-11-20
    city: "Austin"
    region: "Texas"
    country: "USA"

I would expect that to come out something like this (abbreviated initials would be fine):

Todd Gamblin, Matthew P. LeGendre, Michael R. Collette, Gregory L. Lee, Adam Moody, Bronis R. de Supinski, and W. Scott Futral. The Spack Package Manager: Bringing Order to HPC Software Chaos. In Supercomputing 2015 (SC’15), Austin, Texas, November 15-20 2015.

and, in BibTeX:

@inproceedings{SomeKindOfKey,
	address = {Austin, Texas},
	author = {Todd Gamblin and Matthew P. LeGendre and Michael R. Collette and Gregory L. Lee and Adam Moody and Bronis R. de Supinski and W. Scott Futral},
	booktitle = {Supercomputing 2015 (SC'15)},
	month = {November 15-20},
	title = {{The Spack Package Manager: Bringing order to HPC software chaos}},
	year = {2015}}

But it seems like the only parts I get are:

Gamblin, T., LeGendre, M., Collette, M. R., Lee, G. L., Moody, A., de Supinski, B. R., & Futral, S. The Spack Package Manager: Bringing Order to HPC Software Chaos

and:

@inproceedings{Gamblin_The_Spack_Package,
author = {Gamblin, Todd and LeGendre, Matthew and Collette, Michael R. and Lee, Gregory L. and Moody, Adam and de Supinski, Bronis R. and Futral, Scott},
title = {{The Spack Package Manager: Bringing Order to HPC Software Chaos}}
}

Am I missing something or is this just not supported yet?

[hainesr]

Hi @tgamblin, I think this is similar to #75?

The short answer is "we're working on it" 😄 The longer answer is that I think being able to cover all the different reference types that can be specified by a preferred-citation is going to need something like #67 to folded in.

[tgamblin]

Oh I didn’t see #75 — yep — same issue! Feel free to close this as a duplicate.

It’ll definitely be nice to have support for inproceedings (especially for us CS people).

[hainesr]

I'll leave this issue open so I can track against the different publication types as I try to tick them off 😄

[monperrus]

Hi! In Github, the "Cite this repository" widget doesn't show the year if there is only the year metadat. Has this fix landed on Github's side already?

Thanks.

[hainesr]

In Github, the "Cite this repository" widget doesn't show the year if there is only the year metadat. Has this fix landed on Github's side already?

This has been fixed in ruby-cff but I'm not sure when it'll percolate through to the GitHub UI. There are some other updates coming so it might happen when they are finished - hopefully soon.

[hainesr]

ruby-cff now supports @inproceedings and has improved support for conference papers in APA format. Please raise any other issues if there are any other adjustments/cases needed. Thanks!

[arfon]

...and this is now live on GitHub. Any issues, let me know!

[tgamblin]

Does it appear on mobile? (Should it?) I looked at https://github.con/tgamblin/spack, where I’ve been experimenting with this, and it doesn’t show up there. I used to be able to ask for the desktop site but that doesn’t seem to be an option in the GitHub UI anymore. I assume that means they should have the same UI elements, right?

I’ll check this out on desktop later today.

[arfon]

I assume that means they should have the same UI elements, right?

Not sure sorry. This looks to be working for me (on the desktop view):

[tgamblin]

Yep! I checked. It's definitely improved in the desktop view. Nice!

It looks like it is still not respecting the date-start and date-end fields in the conference: part of the CFF, and it doesn't seem to translate notes on the reference. I'm looking at the markdown and json schema descriptions to try to figure out what to write. Neither the APA format nor the BibTeX seem to get these fields.

I would expect this CFF yaml:

preferred-citation:
  type: conference-paper
  authors:
  - family-names: "Gamblin"
    given-names: "Todd"
  - family-names: "LeGendre"
    given-names: "Matthew"
  - family-names: "Collette"
    given-names: "Michael R."
  - family-names: "Lee"
    given-names: "Gregory L."
  - family-names: "Moody"
    given-names: "Adam"
  - family-names: "de Supinski"
    given-names: "Bronis R."
  - family-names: "Futral"
    given-names: "W. Scott"
  title: "The Spack Package Manager: Bringing Order to HPC Software Chaos"
  conference:
    name: "Supercomputing 2015 (SC’15)"
    city: "Austin"
    region: "Texas"
    country: "USA"
    date-start: 2015-11-15
    date-end: 2015-11-20
notes: LLNL-CONF-669890

@inproceedings{gamblin+:sc15,
        address = {Austin, Texas},
        author = {Todd Gamblin and Matthew P. LeGendre and Michael R. Collette and Gregory L. Lee and Adam Moody and Bronis R. de Supinski and W. Scott Futral},
        booktitle = {Supercomputing 2015 (SC'15)},
        month = {November 15-20},
        note = {LLNL-CONF-669890},
        title = {{The Spack Package Manager: Bringing order to HPC software chaos}},
        year = {2015}}

But GitHub only shows partial information:

@inproceedings{Gamblin_The_Spack_Package,
address = {Austin, Texas, USA},
author = {Gamblin, Todd and LeGendre, Matthew and Collette, Michael R. and Lee, Gregory L. and Moody, Adam and de Supinski, Bronis R. and Futral, Scott},
series = {Supercomputing 2015 (SC’15)},
title = {{The Spack Package Manager: Bringing Order to HPC Software Chaos}}
}