Сведения о файлах CITATION
Вы можете добавить файл CITATION.cff
в корень репозитория, чтобы сообщить другим пользователям, как им следует ссылаться на вашу работу. Файл ссылки содержит обычный текст с данными ссылки, доступные для чтения человеком и компьютером.
Пример файла CITATION.cff
:
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Lisa"
given-names: "Mona"
orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "Bot"
given-names: "Hew"
orcid: "https://orcid.org/0000-0000-0000-0000"
title: "My Research Software"
version: 2.0.4
doi: 10.5281/zenodo.1234
date-released: 2017-12-18
url: "https://github.com/github-linguist/linguist"
Запрос на ссылку GitHub в репозитории будет отображать пример CITATION.cff
содержимого в следующих форматах:
APA
Lisa, M., & Bot, H. (2017). My Research Software (Version 2.0.4) [Computer software]. https://doi.org/10.5281/zenodo.1234
BibTeX
@software{Lisa_My_Research_Software_2017,
author = {Lisa, Mona and Bot, Hew},
doi = {10.5281/zenodo.1234},
month = {12},
title = {{My Research Software}},
url = {https://github.com/github-linguist/linguist},
version = {2.0.4},
year = {2017}
}
Обратите внимание, что приведенный выше пример создает ссылку на программное обеспечение (т @software
. е. введите BibTeX, а не @article
).
Дополнительные сведения см. на веб-сайте Формат файла ссылки.
При добавлении CITATION.cff
файла в ветвь по умолчанию репозитория ссылка автоматически добавляется на целевую страницу репозитория на правой боковой панели с меткой "Cite this репозиторий". Это позволяет другим пользователям легко ссылаться на проект программного обеспечения, используя предоставленные сведения.
Ссылка на что-то, кроме программного обеспечения
Если вы предпочитаете ссылку на GitHub, чтобы указать на другой ресурс, например научную статью, можно использовать переопределение preferred-citation
в CFF со следующими типами.
Ресурс | Тип CFF | Тип BibTeX | Аннотация APA |
---|---|---|---|
Статья/доклад в научном журнале | article | @article | Нет данных |
Резервировать | book | @book | Нет данных |
Брошюра (в переплете, но не опубликованная) | pamphlet | @booklet | Нет данных |
Статья/доклад на конференции | conference-paper | @inproceedings | [Доклад на конференция] |
Сборник докладов на конференции | conference , proceedings | @proceedings | Нет данных |
Набор данных | data , database | @misc | [Набор данных] |
Статья в журнале | magazine-article | @article | Нет данных |
Руководство | manual | @manual | Нет данных |
Разное/другое | generic , любой другой тип CFF | @misc | Нет данных |
Статья в газете | newspaper-article | @article | Нет данных |
Программное обеспечение. | software , , software-code``software-container , software-executable``software-virtual-machine | @software | [Компьютерное программное обеспечение] |
Отчет или технический отчет | report | @techreport | Нет данных |
Неопубликованное | unpublished | @unpublished | Нет данных |
Расширенный файл CITATION.cff, описывающий программное обеспечение, но ссылающийся на научную статью в качестве источника:
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Lisa"
given-names: "Mona"
orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "Bot"
given-names: "Hew"
orcid: "https://orcid.org/0000-0000-0000-0000"
title: "My Research Software"
version: 2.0.4
doi: 10.5281/zenodo.1234
date-released: 2017-12-18
url: "https://github.com/github-linguist/linguist"
preferred-citation:
type: article
authors:
- family-names: "Lisa"
given-names: "Mona"
orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "Bot"
given-names: "Hew"
orcid: "https://orcid.org/0000-0000-0000-0000"
doi: "10.0000/00000"
journal: "Journal Title"
month: 9
start: 1 # First page number
end: 10 # Last page number
title: "My awesome research software"
issue: 1
volume: 1
year: 2021
Приведенный выше пример CITATION.cff
файла создаст следующие выходные данные в запросе на ссылку GitHub:
APA
Lisa, M., & Bot, H. (2021). My awesome research software. Journal Title, 1(1), 1. https://doi.org/10.0000/00000
BibTeX
@article{Lisa_My_awesome_research_2021,
author = {Lisa, Mona and Bot, Hew},
doi = {10.0000/00000},
journal = {Journal Title},
month = {9},
number = {1},
pages = {1--10},
title = {{My awesome research software}},
volume = {1},
year = {2021}
}
Ссылка на набор данных
Если репозиторий содержит набор данных, можно задать type: dataset
на верхнем уровне файла CITATION.cff
, чтобы создать выходные данные строки ссылки на данные в запросе ссылки GitHub.
Другие файлы ссылки
Функция ссылки GitHub также обнаруживает небольшое количество дополнительных файлов, которые часто используются сообществами и проектами для описания того, как они хотели бы процитировать свою работу.
GitHub будет ссылаться на эти файлы в запросе на Cite этого репозитория , но не будет пытаться проанализировать их в других форматах ссылок.
# Note these are case-insensitive and must be in the root of the repository
CITATION
CITATIONS
CITATION.bib
CITATIONS.bib
CITATION.md
CITATIONS.md
# CITATION files for R packages are typically found at inst/CITATION
inst/CITATION
Форматы ссылок
В настоящее время мы поддерживаем форматы файлов APA и BibTeX.
Ищете дополнительные форматы ссылок? GitHub использует библиотеку Ruby для анализа CITATION.cff
файлов. Вы можете запросить дополнительные форматы в репозитории ruby-cff или внести свой вклад.