Skip to content

Add CITATION.cff file#4109

Merged
laurmaedje merged 2 commits intotypst:mainfrom
drupol:add-citation-cff
May 13, 2024
Merged

Add CITATION.cff file#4109
laurmaedje merged 2 commits intotypst:mainfrom
drupol:add-citation-cff

Conversation

@drupol
Copy link
Copy Markdown
Contributor

@drupol drupol commented May 10, 2024 •
edited
Loading

Hello,

I frequently need to cite Typst in the documents I write, and noticed that GitHub supports a specific citation file format (CITATION.cff). Having this file would enhance the visibility and proper citation of Typst directly from the GitHub repository page.

GitHub's support for the CITATION.cff files enables easy access to citation information, which can be automatically parsed and displayed on the project page. More details can be found in the GitHub documentation on citation files.

Would you be interested in adding such a file to the project?

When Github detect such a file in a repo, a new link is displayed on the right side:

image

Clicking on the link open a box:

image

Screenshots from https://github.com/citation-file-format/citation-file-format

Related to #4108

@drupol drupol marked this pull request as ready for review May 10, 2024 10:31
@drupol
Copy link
Copy Markdown
Contributor Author

drupol commented May 10, 2024

See it lively at https://github.com/drupol/typst/tree/add-citation-cff

xkevio
xkevio reviewed May 10, 2024
View reviewed changes
@xkevio
Copy link
Copy Markdown
Contributor

xkevio commented May 10, 2024

Would it also maybe make sense to add the date-released field? As like the year the repository went public? It's not ideal, especially once Typst is out of beta but citing something without some form of year can look off in most citation styles.

@drupol
Copy link
Copy Markdown
Contributor Author

drupol commented May 10, 2024

Would it also maybe make sense to add the date-released field? As like the year the repository went public? It's not ideal, especially once Typst is out of beta but citing something without some form of year can look off in most citation styles.

Yes ! The more field we have, the better ! feel free to suggest them !!!

@xkevio
Copy link
Copy Markdown
Contributor

xkevio commented May 10, 2024

Would it also maybe make sense to add the date-released field? As like the year the repository went public? It's not ideal, especially once Typst is out of beta but citing something without some form of year can look off in most citation styles.

Yes ! The more field we have, the better ! feel free to suggest them !!!

On that note, the version field could be nice but would have to be updated alongside releases.

@drupol
Copy link
Copy Markdown
Contributor Author

drupol commented May 10, 2024

The date-released field is usually used when we add the versions inside that file. TBH, I don't believe we should add the versions, therefore, I don't think this field is really needed.

@laurmaedje laurmaedje changed the title chore: add CITATION.cff file Add CITATION.cff file May 13, 2024
laurmaedje
laurmaedje reviewed May 13, 2024
View reviewed changes
@drupol
Copy link
Copy Markdown
Contributor Author

drupol commented May 13, 2024

I applied your suggestions, and also added a new CI file to check the validity of the CITATION.cff file.

laurmaedje
laurmaedje reviewed May 13, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@laurmaedje laurmaedje left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think CI for a citation file is overkill, so I'd rather not have that. 🙂

@drupol
Copy link
Copy Markdown
Contributor Author

drupol commented May 13, 2024

Removed

@laurmaedje laurmaedje enabled auto-merge May 13, 2024 09:10
@laurmaedje
Copy link
Copy Markdown
Member

laurmaedje commented May 13, 2024

Thanks!

@laurmaedje laurmaedje added this pull request to the merge queue May 13, 2024
Merged via the queue into typst:main with commit 32a84e5 May 13, 2024
@drupol drupol deleted the add-citation-cff branch May 13, 2024 09:17
@drupol drupol mentioned this pull request May 20, 2024
Merged
@drupol drupol mentioned this pull request May 28, 2024
Merged
@drupol drupol mentioned this pull request Jul 16, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@laurmaedje laurmaedje laurmaedje left review comments

+1 more reviewer

@xkevio xkevio xkevio left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@drupol @xkevio @laurmaedje