BibLaTeX. Ссылка на программный продукт

Обновлено 2024-10-06 5 мин. для прочтения Computer-Science

BibLaTeX. Ссылка на программный продукт.

Содержание

1 Общая информация

  • В BibLaTeX есть стандартное поле software.
  • Однако в стандартных стилях оно не реализовано (вернее, просто является заглушкой).

2 Пакет biblatex-software

  • CTAN: https://ctan.org/pkg/biblatex-software
  • Репозиторий: https://gitlab.inria.fr/gt-sw-citation/bibtex-sw-entry
  • Добавляет поддержку четырёх типов записей программного обеспечения к любому другому стилю BibLaTeX.
  • Состоит из следующих компонентов:
    • стиль ссылок (software.bbx);
    • расширение модели данных (software.dbx);
    • файлы локализации строк (<lang>-software.lbx).

2.1 Типы записей

  • Четыре типа записей:
    • @software;
    • @softwareversion;
    • @softwaremodule;
    • @codefragment.

2.1.1 @software

  • Применение : программное обеспечение.
  • Обязательные поля : author / editor, title, url, year.
  • Дополнительные поля : abstract, date, doi, eprint, eprintclass, eprinttype, file, hal_id, hal_version, institution, license, month, note, organization, publisher, related, relatedtype, relatedstring, repository, swhid, urldate, version.

2.1.2 @softwareversion

  • Применение : конкретная версия программного обеспечения.
  • Наследует значения отсутствующих полей из записи, упомянутой в поле crossref.
  • Обязательные поля : author / editor, title, url, version, year.
  • Дополнительные поля : abstract, crossref, date, doi, eprint, eprintclass, eprinttype, file, hal_id, hal_version, institution, introducedin, license, month, note, organization, publisher, related, relatedtype, relatedstring, repository, swhid, subtitle, urldate.

2.1.3 @softwaremodule

  • Применение : конкретный модуль более крупного программного проекта.
  • Наследует значения отсутствующих полей из записи, упомянутой в поле crossref.
  • Обязательные поля : author, subtitle, url, year.
  • Дополнительные поля : abstract, crossref, date, doi, eprint, eprintclass, eprinttype, editor, file, hal_id, hal_version, institution, introducedin, license, month, note, organization, publisher, related, relatedtype, relatedstring, repository, swhid, title, urldate, version.

2.1.4 @codefragment

  • Применение : фрагмент кода (например, конкретный алгоритм в программе или библиотеке).
  • Наследует значения отсутствующих полей из записи, упомянутой в поле crossref.
  • Обязательные поля : url.
  • Дополнительные поля : author, abstract, crossref, date, doi, eprint, eprintclass, eprinttype, file, hal_id, hal_version, institution, introducedin, license, month, note, organization, publisher, related, relatedtype, relatedstring, repository, swhid, subtitle, title, urldate, version, year.

2.2 Дополнительные поля

  • Пакет вводит новые поля, специфичные для пакета:
    • hal_id : цифровой идентификатор для запись программного обеспечения, включая его описание и метаданные в HAL;
    • hal_version : версия записи программного обеспечения HAL;
    • license : лицензия на право собственности в формате SPDX;
    • introducedin : если это программный модуль или фрагмент, версия содержащего проекта, в которой он был впервые представлен;
    • repository : URL-адрес репозитория кода (например, на GitHub, GitLab);
    • swhid : идентификатор цифрового объекта (https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html):
      • swh-id : внутренний идентификатор элемента;
      • swh:cnt : для содержимого;
      • swh:dir : для каталога;
      • swh:rev : для ревизия;
      • swh:rel : для выпуска.

2.3 Использование

  • Добавить модель данных к biblatex:
    \usepackage[datamodel=software]{biblatex}
  • Подключить стиль:
    \usepackage{software-biblatex}
  • Установите опции пакета:
    \ExecuteBibliographyOptions{
  halid=true,
  swhid=true,
  shortswhid=false,
  swlabels=true,
  vcs=true,
  license=true}
  • Опции пакета:
    • swlabels=true|false : программное обеспечение — это особый результат исследования, отличный от публикаций, поэтому записи о программном обеспечении в библиографии по умолчанию помечаются специальной меткой;
    • license=true|false : информация о лицензии (по умолчанию true);
    • halid=true|false : включением идентификатора в репозитории HAL (по умолчанию true);
    • swhid=true|false : включением идентификатора в архиве Software Heritage (SWHID) (по умолчанию true);
    • shortswhid=true|false : способ отображения SWHID; если true, в печатную версию будет включена только основная часть SWHID, а в гиперссылке будет сохранен полный SWHID со всей контекстной информацией (по умолчанию false);
    • vcs=true|false : URL-адрес платформы размещения кода, на которой разрабатывается программное обеспечение, описанное в записи (по умолчанию true).

2.4 Примеры

2.4.1 software, softwareversion

  • Пример описания выпуска программного обеспечения с использованием одной записи @softwareversion:

    @softwareversion {delebecque:hal-02090402-condensed,
  title = {Scilab},
  author = {Delebecque, Fran{\c c}ois and Gomez, Claude and Goursat, Maurice and Nikoukhah, Ramine and Steer, Serge and Chancelier, Jean-Philippe},
  url = {https://www.scilab.org/},
  date = {1994-01},
  file = {https://hal.inria.fr/hal-02090402/file/scilab-1.1.tar.gz},
  institution = {Inria},
  license = {Scilab license},
  hal_id = {hal-02090402},
  hal_version = {v1},
  swhid = {swh:1:dir:1ba0b67b5d0c8f10961d878d91ae9d6e499d746a;origin=https://hal.archives-ouvertes.fr/hal-02090402},
  version = {1.1},
  note = {First Scilab version. It was distributed by anonymous ftp.},
  repository= {https://github.com/scilab/scilab},
  abstract = {Software for Numerical Computation freely distributed.}
}

  • Эту же информацию можно также представить с помощью пары @software и @softwareversion; общая информация в @software, изменения в @softwareversion:

    @software {delebecque:hal-02090402,
  title = {Scilab},
  author = {Delebecque, Fran{\c c}ois and Gomez, Claude and Goursat, Maurice and Nikoukhah, Ramine and Steer, Serge and Chancelier, Jean-Philippe},
  date = {1994},
  institution = {Inria},
  license = {Scilab license},
  hal_id = {hal-02090402},
  hal_version = {v1},
  url = {https://www.scilab.org/},
  abstract = {Software for Numerical Computation freely distributed.},
  repository= {https://github.com/scilab/scilab},
}

@softwareversion {delebecque:hal-02090402v1,
  version = {1.1},
  date = {1994-01},
  file = {https://hal.inria.fr/hal-02090402/file/scilab-1.1.tar.gz},
  swhid = {swh:1:dir:1ba0b67b5d0c8f10961d878d91ae9d6e499d746a;origin=https://hal.archives-ouvertes.fr/hal-02090402},
  note = {First Scilab version. It was distributed by anonymous ftp.},
  crossref = {delebecque:hal-02090402}
}

2.4.2 softwaremodule

  • Если программный продукт содержит много модулей, то может потребоваться ссылаться конкретно на конкретный модуль, который отличает авторов, и, возможно, он будет включен в проект позднее:
    @software {cgal,
 title = {The Computational Geometry Algorithms Library},
 author = {The CGAL Project},
 editor = {CGAL Editorial Board},
 date = {1996},
 url = {https://cgal.org/}
}

@softwareversion{cgal:5-0-2,
 crossref = {cgal},
 version = {5.0.2},
 url = {https://docs.cgal.org/5.02},
 date = {2020},
 swhid = {swh:1:rel:636541bbf6c77863908eae744610a3d91fa58855;
          origin=https://github.com/CGAL/cgal/}
}

@softwaremodule{cgal:lp-gi-20a,
 crossref = {cgal:5-0-2},
 author = {Menelaos Karavelas},
 subtitle = {{2D} Voronoi Diagram Adaptor},
 license = {GPL},
 introducedin = {cgal:3-1},
 url = {https://doc.cgal.org/5.0.2/Manual/packages.html#PkgVoronoiDiagram2},
}
  • Можно использовать только одну запись, чтобы получить эквивалентный результат:
    @softwaremodule{cgal:lp-gi-20a-condensed,
 title = {The Computational Geometry Algorithms Library},
 subtitle = {{2D} Voronoi Diagram Adaptor},
 author = {Menelaos Karavelas},
 editor = {CGAL Editorial Board},
 license = {GPL},
 version = {5.0.2},
 introducedin = {cgal:3-1},
 date = {2020},
 swhid = {swh:1:rel:636541bbf6c77863908eae744610a3d91fa58855;
          origin=https://github.com/CGAL/cgal/},
 url = {https://doc.cgal.org/5.0.2/Manual/packages.html#PkgVoronoiDiagram2},
}

2.4.3 codefragment

  • Если необходимо, чтобы определённый фрагмент кода появился в библиографии:
    @software {parmap,
  title = {The Parmap library},
  author = {Di Cosmo, Roberto and Marco Danelutto},
  date = {2012},
  institution = {{Inria} and {University of Paris} and {University of Pisa}},
  license = {LGPL-2.0},
  url = {https://rdicosmo.github.io/parmap/},
  repository= {https://github.com/rdicosmo/parmap},
}

@softwareversion {parmap-1.1.1,
  crossref = {parmap},
  date = {2020},
  version = {1.1.1},
  swhid = {swh:1:rel:373e2604d96de4ab1d505190b654c5c4045db773;
     origin=https://github.com/rdicosmo/parmap;
     visit=swh:1:snp:2a6c348c53eb77d458f24c9cbcecaf92e3c45615},
}

@codefragment {simplemapper,
  subtitle = {Core mapping routine},
  swhid = {swh:1:cnt:43a6b232768017b03da934ba22d9cc3f2726a6c5;
     origin=https://github.com/rdicosmo/parmap;
     visit=swh:1:snp:2a6c348c53eb77d458f24c9cbcecaf92e3c45615;
     anchor=swh:1:rel:373e2604d96de4ab1d505190b654c5c4045db773;
     path=/src/parmap.ml;
     lines=192-228},
  crossref = {parmap-1.1.1}
}
  • Можно использовать только одну запись:
    @codefragment {simplemapper-condensed,
  title = {The Parmap library},
  author = {Di Cosmo, Roberto and Marco Danelutto},
  date = {2020},
  institution = {{Inria} and {University of Paris} and {University of Pisa}},
  license = {LGPL-2.0},
  url = {https://rdicosmo.github.io/parmap/},
  repository= {https://github.com/rdicosmo/parmap},
  version = {1.1.1},
  subtitle = {Core mapping routine},
  swhid = {swh:1:cnt:43a6b232768017b03da934ba22d9cc3f2726a6c5;
     origin=https://github.com/rdicosmo/parmap;
     visit=swh:1:snp:2a6c348c53eb77d458f24c9cbcecaf92e3c45615;
     anchor=swh:1:rel:373e2604d96de4ab1d505190b654c5c4045db773;
     path=/src/parmap.ml;
     lines=192-228}
}

Links to this note

Bib Tex
Дмитрий Сергеевич Кулябов
Дмитрий Сергеевич Кулябов
Профессор кафедры теории вероятностей и кибербезопасности

Мои научные интересы включают физику, администрирование Unix и сетей.

Похожие