Skip to content

Package citations #3797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 10, 2025
Merged

Package citations #3797

merged 4 commits into from
May 10, 2025

Conversation

mahrud
Copy link
Member

@mahrud mahrud commented May 9, 2025

This is my attempt at #3715.

  • added Citation key for documentation and SimpleDoc
  • Add syntax highlighting for BibTeX to documentation
  • upgraded cite method to look at package documentation
  • added example citation for TerraciniLoci

Here's the default, if no citation is provided:
image

On the other hand, given a section like:

doc ///
  Key
    TerraciniLoci
  Headline
    package for computing Terracini loci
  Description
...
  Citation
    @article{Galuppi_2025,
      title={Geometry of First Nonempty Terracini Loci},
      ISSN={1793-6683},
      url={http://dx.doi.org/10.1142/S0219199725500531},
      DOI={10.1142/s0219199725500531},
      journal={Communications in Contemporary Mathematics},
      publisher={World Scientific Pub Co Pte Ltd},
      author={Galuppi, Francesco and Santarsiero, Pierpaola and Torrance, Douglas A. and Turatti, Ettore Teixeira},
      year={2025},
      month=apr }
///

You get:
image

Moreover, cite returns that string.

I think this is good enough for this release, if we want, but there are several features that I think would be nice:

  • reorder Author and Version and Citation and Certificate, or even combine them in some way that makes sense
  • allow authors to add more than just the bibtex reference, e.g. provide two references and explain in which situation which one should be cited.

@mahrud
Copy link
Member Author

mahrud commented May 9, 2025

Also, note that I didn't change the citation of M2 itself, which should still be decided I think.

@mahrud mahrud requested a review from d-torrance May 9, 2025 16:42
@mahrud
Copy link
Member Author

mahrud commented May 9, 2025

Probably some packages shouldn't have citation info, right? e.g. Style, but I'm not sure where to draw the line.

@d-torrance
Copy link
Member

Although no one will likely cite Style, I don't see any harm in having citation info show up on its documentation page.

@mahrud
Copy link
Member Author

mahrud commented May 10, 2025

Just feels unnecessary and crowding. I also think perhaps having citation box in too many places might make people gloss over it, whereas if only packages which the authors think may be cited include citation, then people may notice it.

@d-torrance d-torrance merged commit 9a938ec into Macaulay2:development May 10, 2025
5 checks passed
@d-torrance d-torrance mentioned this pull request May 10, 2025
@mahrud mahrud deleted the feature/cite branch May 10, 2025 14:02
@mahrud mahrud mentioned this pull request May 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants