Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

Сведения о файлах CITATION

Можно добавить в репозиторий файл CITATION, чтобы помочь пользователям правильно цитировать программное обеспечение.

Сведения о файлах 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"

Запрос на ссылку 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},
  version = {2.0.4},
  year = {2017}
}

В приведенном выше примере создается ссылка на программное обеспечение (т. е. тип @software в BibTeX, а не @article).

Дополнительные сведения см. на веб-сайте Формат файла ссылки.

При добавлении файла CITATION.cff в ветвь репозитория по умолчанию она автоматически связывается с целевой страницей репозитория. Это позволяет другим пользователям легко ссылаться на проект программного обеспечения, используя предоставленные сведения.

Гиперссылка на ссылку на целевой странице репозитория

Ссылка на что-то, кроме программного обеспечения

Если вы предпочитаете ссылку на GitHub, чтобы указать на другой ресурс, например научную статью, можно использовать переопределение preferred-citation в CFF со следующими типами.

РесурсТип CFFТип BibTeXАннотация APA
Статья/доклад в научном журналеarticle@article
Bookbook@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"
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 будет ссылаться на эти файлы в запросе Сослаться на этот репозиторий, но не будет пытаться проанализировать их в других форматах ссылок.

# 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 или внести свой вклад.