diff --git a/talks-public/2020-05-05-biblatex-software/2020-05-05-biblatex-software.org b/talks-public/2020-05-05-biblatex-software/2020-05-05-biblatex-software.org new file mode 100644 index 0000000..daf4f7e --- /dev/null +++ b/talks-public/2020-05-05-biblatex-software/2020-05-05-biblatex-software.org @@ -0,0 +1,151 @@ +#+COLUMNS: %40ITEM %10BEAMER_env(Env) %9BEAMER_envargs(Env Args) %10BEAMER_act(Act) %4BEAMER_col(Col) %10BEAMER_extra(Extra) %8BEAMER_opt(Opt) +#+TITLE: Software in bibliographies with the biblatex-software package +#+SUBTITLE: +#+AUTHOR: Roberto Di Cosmo +#+EMAIL: roberto@dicosmo.org @rdicosmo @swheritage +#+BEAMER_HEADER: \date{May 5th, 2020} +#+BEAMER_HEADER: \title[The \texttt{biblatex-software} package]{Software in bibliographies with the \texttt{biblatex-software} package} +#+BEAMER_HEADER: \author[Roberto Di Cosmo \hspace{5em} www.dicosmo.org]{Roberto Di Cosmo\\[2em]} +# #+BEAMER_HEADER: \setbeameroption{show notes on second screen} +#+BEAMER_HEADER: \setbeameroption{hide notes} +#+KEYWORDS: software heritage legacy preservation knowledge mankind technology +#+LATEX_HEADER: \usepackage{tcolorbox} +#+LATEX_HEADER: \definecolor{links}{HTML}{2A1B81} +#+LATEX_HEADER: \hypersetup{colorlinks,linkcolor=,urlcolor=links} +# +# prelude.org contains all the information needed to export the main beamer latex source +# use prelude-toc.org to get the table of contents +# + +#+INCLUDE: "../../common/modules/prelude-toc.org" :minlevel 1 + + +#+INCLUDE: "../../common/modules/169.org" + +# +LaTeX_CLASS_OPTIONS: [aspectratio=169,handout,xcolor=table] + +#+LATEX_HEADER: \usepackage{bbding} +#+LATEX_HEADER: \DeclareUnicodeCharacter{66D}{\FiveStar} +#+LATEX_HEADER: \usepackage[anythingbreaks]{breakurl} + +# +# If you want to change the title logo it's here +# +# +BEAMER_HEADER: \titlegraphic{\includegraphics[width=0.7\textwidth]{SWH-logo}} + +# aspect ratio can be changed, but the slides need to be adapted +# - compute a "resizing factor" for the images (macro for picblocks?) +# +# set the background image +# +# https://pacoup.com/2011/06/12/list-of-true-169-resolutions/ +# +#+BEAMER_HEADER: \pgfdeclareimage[height=90mm,width=160mm]{bgd}{swh-world-169.png} +#+BEAMER_HEADER: \setbeamertemplate{background}{\pgfuseimage{bgd}} +#+LATEX: \addtocounter{framenumber}{-1} + +* Introduction +** Software at Inria +*** Inria (https://www.inria.fr) + - French national research institution for digital sciences (CS, applied Maths, ...) + - some 2000 researchers in 200 teams + - over 1000 open source software developed and distributed over 50 years +#+BEAMER: \pause +*** The software citation working group + - Contributors :: Pierre Alliez, Roberto Di Cosmo, Benjamin Guedj, Alain Girault, Mohand-Said Hacid, Arnaud Legrand, Xavier Leroy, Nicolas Rougier, Manuel Serrano + - Outputs :: + + P. Alliez, R. Di Cosmo, B. Guedj, A. Girault, M. Hacid, A. Legrand, N. Rougier, [[https://dx.doi.org/10.1109/MCSE.2019.2949413][\emph{Attributing and Referencing (Research) Software: Best Practices and Outlook From Inria}]], Computing in Science and Engineering, 22 (1), 2020. DOI: 10.1109/MCSE.2019.2949413 + + ~biblatex-software~ : software bibitems for BibLaTeX +** BibTeX/BibLaTeX reminder +*** BibTeX + Bibliographic format widely used in the scholarly world by LaTeX users to + store and exchange bibliographic information. + + At Inria it is used to generate bibliographies for the activity reports of 200 teams +*** BibLaTeX + Modern LaTeX package (and tool set) that produces rich bibliographies from BibTeX entries +*** State of software: + No support for software in BibTeX/BibLaTeX up to now: + - BibLaTeX has a ~@software~ bibitem, that is treated like ~@misc~ + +** biblatex-software: new entries +*** Four new bibliographic entries + - @software :: Computer software. + + /Required fields:/ ~author~ / ~editor~, ~title~, ~url~, ~year~ +#+BEAMER: \pause + - @softwareversion :: A specific version of a software. + + /Required fields:/ ~author~ / ~editor~, ~title~, ~url~, ~version~, ~year~ +#+BEAMER: \pause + + - @softwaremodule :: A specific module of a larger software project. + + /Required fields:/ ~author~, ~subtitle~, ~url~, ~year~ + +#+BEAMER: \pause + - @codefragment :: A code fragment (e.g. a specific algorithm in a program or library). + + /Required fields:/ ~url~ +#+BEAMER: \pause + +*** Inheritance + *softwareversion*, *softwaremodule* and *codefragment* entries can inherit + missing fields from entries designated via the /crossref/ field + +** biblatex-software: new fields +*** Four new software-specific fields + - license :: list (literal). The license/s of the title in SPDX format. + - introducedin :: field (literal). If this is a software module or fragment, + the version of the containing project where it has been first introduced. + - repository :: field (uri). The url of the code repository (e.g on GitHub, GitLab). + - swhid :: field (verbatim). The identifier of the digital + object (a.k.a the software artifact itself). The intrinsic identifier + of the item is an swh-id (swh:cnt for a content, swh:dir for a directory, swh:rev for + a revision, swh:rel for a release, etc.). See [[https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html][the SWH-ID specification]]. +#+BEAMER: \pause +*** Two more new software-specific fields for HAL + - ~hal_id~ :: field (verbatim). A digital identifier for the + software record including its description and metadata on HAL. + - ~hal_version~ :: field (verbatim). The version of the HAL software record. + + + + +** biblatex-software: new options +*** Five new options to control typesetting of software related entries + - swlabels=true|false :: add a special label for software entries + - license=true|false :: show license information + - halid=true|false :: show the HAL identifier + - swhid=true|false :: show the SWHID identifier + - vcs=true|false :: show the repository URL + +** Examples are worth a thousand words +#+LATEX: \tiny +#+BEGIN_SRC bibtex + @software {cgal, + title = {The Computational Geometry Algorithms Library}, + author = {{The CGAL Project}}, + editor = {{CGAL Editorial Board}}, + year = 1996, + url = {https://cgal.org/} + } + + @softwareversion{cgal:5-0-2, + crossref = {cgal}, + version = {{5.0.2}}, + url = {https://docs.cgal.org/5.02}, + year = 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}, + } +#+END_SRC