Digraphs icon indicating copy to clipboard operation
Digraphs copied to clipboard

Come up with a new bit of BibTeX for the "How to cite Digraphs" part of the Digraphs homepage

Open wilfwilson opened this issue 6 months ago • 2 comments

This is how it currently is:

@misc{DeBeule2025aa,
      Author = { Jan De Beule and
                 Julius Jonu{\v s}as and
                 James D. Mitchell and
                 Michael Torpey and
                 Maria Tsalakou and
                 Wilf A. Wilson },
      Title  = { Digraphs - {GAP} package, Version 1.11.0 },
      Month  = { Aug },
      Year   = { 2025 },
      Url    = { https://digraphs.github.io/Digraphs }
}

Namely six authors. But the Digraphs PackageInfo.g file now lists 47 people, all of whom are described as authors. In the source code of the PackageInfo file (i.e. in PackageInfo.g), there are five authors who appear first (with a comment # The 5 main authors come first), and these authors are Jan, Julius, James, Wilf, and Michael. Maria's not included in this.

So the list of six authors given in the BibTeX citation on the webpage no longer matches any group of six authors that we have. So it seems inconsistent for these to be the list of authors that we ask people to use when they cite us.

I see four options:

  1. Consider all authors equal, and list all 47 names in the citation. That's probably too unwieldy, but there's no technical reason that we can't.
  2. Remove Maria from the BibTeX command so that just the five "main" authors are listed here (with a possible "et al"). If we do that though, we should clarify somewhere what we mean by "main" authors, and what makes them special, perhaps in the documentation.
  3. Add Maria to the list "main" authors in the PackageInfo.g file, and as before, clarify somewhere what makes these six authors special.
  4. Consider all authors equal and list none of them here. Just have Author = { The Digraphs team }, or something like that.

Note that further up the Digraphs package homepage, we do have a section called "Authors" that contains all 47 names, automatically generated from the PackageInfo.g file. If we still want to consider the package as having 5 or 6 "main" authors, then perhaps we should rename this section to "Contributors". If we don't want to rename this section, perhaps that's a good reason for abandoning the idea of "main" authors.

wilfwilson avatar Sep 01 '25 17:09 wilfwilson

Maybe we also want to include the Zenodo DOI in this citation? https://zenodo.org/records/16989980

wilfwilson avatar Sep 01 '25 17:09 wilfwilson

I'm curious what your thoughts are on this issue @james-d-mitchell

wilfwilson avatar Sep 01 '25 21:09 wilfwilson