[Tex/LaTex] Add field “tome” to biblatex entries

biblatex

I need to add a new field in the @book or @InProceedings entries:
this field is "tome", for I have for instance the following title:

Francesco Bertolini, Società di trasmissione orale: mito e folclore, in Lo spazio letterario della Grecia antica, a cura di G. Cambiano, L. Canfora e D. Lanza, vol. I, tomo I, Salerno, Roma 1992, pp. 47--75.

So the following code is not enough:

@InProceedings{ bertolini:1992,
  author                   = "Francesco Bertolini",
  title                    = "Società di trasmissione orale: mito e folclore",
  booktitle                = "Lo spazio letterario della Grecia antica",
  editor                   = "G. Cambiano and L. Canfora and D. Lanza",
  publisher                = "Salerno",
  location                 = "Roma",
  year                     = "1992",
  volume                   = "1,
  pages                    = "47--75",
}

Using othes codes, I was able only to produce the "tome" field, but with a general trouble about the other fields:

\DeclareSourcemap{
  \maps[datatype=bibtex]{
    \map{
      \step[fieldsource=tome,fieldtarget=usera]
    }
  }
}
\DeclareFieldFormat{usera}{tomo\space{#1}}


\DeclareBibliographyDriver{book}{%
  \usebibmacro{author/editor}%
  \setunit{\labelnamepunct}\newblock
  \usebibmacro{title}%
  \newunit\newblock
  \usebibmacro{journal+issuetitle}%
  \setunit{\bibpagespunct}%
  \printfield{pages}%
  \newunit\newblock
  \printfield{usera}%
  \usebibmacro{finentry}}
\renewcommand*{\finentrypunct}{}

(useful for articles, but not for my case). By real, I'm not able to understand which bibmascros I have to invocate…

I tried to write a biblatex-tome.dbx:

\ProvidesFile{biblatex-tome.dbx} 

\DeclareDatamodelFields[type=field,datatype=literal,skipout=false]{tome} 

\DeclareDatamodelEntryfields{tome}

Inside the main .tex file I put just this code:

\DeclareFieldFormat{tome}{\mkbibacro{tome}\addcolon\space #1}
\newcommand*{\patchmoretome}[1]{
  \xpatchbibdriver{#1}%
    {\printfield{tome}}
    {\printfield{tome}%
          \newunit\newblock
     \printfield{tome}}%
    {\typeout{patching #1 to include more tome succeded}}%
    {\typeout{patching #1 to include more tome failed}}%
}
% patch all drivers
\patchmoretome{article}
\patchmoretome{book}
\patchmoretome{collection}
\patchmoretome{inbook}
\patchmoretome{incollection}
\patchmoretome{inproceedings}
\patchmoretome{manual}
\patchmoretome{periodical}
\patchmoretome{proceedings}
\patchmoretome{report}
\patchmoretome{thesis}

but it doesn't print the field in bibliographic entry. So I'm very confused about a (re)writing of driver

Best Answer

Use an existing field (`part`)

If you use the part field for tome information¹, there is not a lot to be done in the standard styles. If you have a non-standard/custom style that moves around the part information though, you would need to tell us more about it.

These four lines should do what you want. They redefine the string part to be "tomo" and print ", tomo #" after the volume.

\DefineBibliographyStrings{italian}{%
  part = {tomo},
}
\DeclareFieldFormat{part}{\addcomma\space\bibstring{part}\space #1}

All the standard styles use the sequence

\printfield{volume}%
\printfield{part}%

to print part information, so we should be fine.

(Normally, putting \addcomma and the like in \DeclareFieldFormat is frowned upon, but the part field seems to be special insofar that the default format is {.#1} and that there is no other punctuation inserted between volume and part by any of the standard styles.)

Your bib entry would be

@InProceedings{bertolini:1992,
  author         = "Francesco Bertolini",
  title          = "Società di trasmissione orale: mito e folclore",
  booktitle      = "Lo spazio letterario della Grecia antica",
  editor         = "G. Cambiano and L. Canfora and D. Lanza",
  publisher      = "Salerno",
  location       = "Roma",
  year           = "1992",
  volume         = "1",
  part           = "2",
  pages          = "47--75",
}

Full MWE

\documentclass[italian]{article}
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
\usepackage{babel}
\usepackage[]{biblatex}
\usepackage{filecontents}

%\DeclareFieldFormat{part}{.#1}% physical part of a logical volume
\DefineBibliographyStrings{italian}{%
  part = {tomo},
}
\DeclareFieldFormat{part}{\addcomma\space\bibstring{part}\space #1}

\begin{filecontents*}{\jobname.bib}
@InProceedings{bertolini:1992,
  author         = "Francesco Bertolini",
  title          = "Società di trasmissione orale: mito e folclore",
  booktitle      = "Lo spazio letterario della Grecia antica",
  editor         = "G. Cambiano and L. Canfora and D. Lanza",
  publisher      = "Salerno",
  location       = "Roma",
  year           = "1992",
  volume         = "1",
  part           = "2",
  pages          = "47--75",
}
\end{filecontents*}
\addbibresource{\jobname.bib}

\begin{document}
\cite{bertolini:1992}
\printbibliography
\end{document}

enter image description here

¹ The biblatex documentation states on page 21, §2.2.2 Data Fields,

part (field (literal)) The number of a partial volume. This field applies to books only, not to journals. It may be used when a logical volume consists of two or more physical ones. In this case the number of the logical volume goes in the volume field and the number of the part of that volume in the part field.

Map the field to an existing field (`part`)

You could also map the field tome to part thus creating an alias for input purposes

\DeclareSourcemap{
  \maps[datatype=bibtex]{
    \map{
      \step[fieldsource=tome]
      \step[fieldset=part, origfieldval]
    }
  }
}

The sample entry might look like this then

@InProceedings{bertolini:1992,
  author         = "Francesco Bertolini",
  title          = "Società di trasmissione orale: mito e folclore",
  booktitle      = "Lo spazio letterario della Grecia antica",
  editor         = "G. Cambiano and L. Canfora and D. Lanza",
  publisher      = "Salerno",
  location       = "Roma",
  year           = "1992",
  volume         = "1",
  tome           = "3",
  pages          = "47--75",
}

For more general purposes, biblatex defines the five generic fields usera to userf (as well as lista to listf for lists fields and namea to namec for names). While it might be awkward to use these fields in the input .bib file, where more useful names are expected, they are useful for internal remapping.

Declare a new field

If you absolutely insist on creating a new data field tome, create a new datamodel file, tome.dbx, with the following content and put it somewhere LaTeX can find it (this is necessary since version 2.9, before that it was possible to use datamodel commands directly in the document, but this is not guaranteed to work and therefore strongly discouraged, see Data model macro cannot be used in preamble; LaTeX will be able to find the .dbx file if you place it in the same folder as your main .tex document, other options to make the file globally available are discussed in https://texfaq.org/FAQ-inst-wlcf).

\ProvidesFile{tome.dbx}[2019/20/02 add tome field to biblatex data model]

\DeclareDatamodelFields[type=field,datatype=literal]{tome}
\DeclareDatamodelEntryfields{tome}

(In the MWE below this file is created automatically using the filecontents package.)

We then have to load biblatex with the option datamodel=tome in order to get load the correct datamodel where tome is defined. Alternatively, you can put the above lines into biblatex-dm.cfg (see How to include price in bibliography?).

Again we use localisation strings

\NewBibliographyString{tome}
\DefineBibliographyStrings{italian}{%
  tome = {tomo},
}

\DeclareFieldFormat{tome}{\bibstring{tome}\space #1}

We will then have to patch all the drivers/macros to include tome information, that is quite a task...

We renew some macros

\renewbibmacro*{maintitle+title}{%
  \iffieldsequal{maintitle}{title}
    {\clearfield{maintitle}%
     \clearfield{mainsubtitle}%
     \clearfield{maintitleaddon}}
    {\iffieldundef{maintitle}
       {}
       {\usebibmacro{maintitle}%
    \newunit\newblock
    \iffieldundef{volume}
      {}
      {\printfield{volume}%
     \setunit{addcomma\space}%
     \printfield{tome}
           \printfield{part}%
           \setunit{\addcolon\space}}}}%
  \usebibmacro{title}%
  \newunit}

\renewbibmacro*{maintitle+booktitle}{%
  \iffieldundef{maintitle}
    {}
    {\usebibmacro{maintitle}%
     \newunit\newblock
     \iffieldundef{volume}
       {}
       {\printfield{volume}%
     \setunit{addcomma\space}%
     \printfield{tome}
        \printfield{part}%
        \setunit{\addcolon\space}}}%
  \usebibmacro{booktitle}%
  \newunit}

And add tome to the drivers

\newcommand*{\addtometo}[1]{%
  \xpatchbibdriver{#1}
    {\printfield{volume}}
    {\printfield{volume}%
     \setunit{\addcomma\space}%
     \printfield{tome}}
    {}
    {\typeout{failed to add tome to #1 driver}}
}
\addtometo{inproceedings}
\addtometo{book}

MWE

\documentclass[italian]{article}
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
\usepackage{babel}


\usepackage{filecontents}
\begin{filecontents*}{tome.dbx}
\ProvidesFile{tome.dbx}[2019/20/02 add tome field to biblatex data model]

\DeclareDatamodelFields[type=field,datatype=literal]{tome}
\DeclareDatamodelEntryfields{tome}
\end{filecontents*}

\usepackage[backend=biber,datamodel=tome]{biblatex}


%\DeclareFieldFormat{part}{.#1}% physical part of a logical volume
\NewBibliographyString{tome}
\DefineBibliographyStrings{italian}{%
  tome = {tomo},
}


\DeclareFieldFormat{tome}{\bibstring{tome}\space #1}

\usepackage{xpatch}

\newcommand*{\addtometo}[1]{%
  \xpatchbibdriver{#1}
    {\printfield{volume}}
    {\printfield{volume}%
     \setunit{\addcomma\space}%
     \printfield{tome}}
    {}
    {\typeout{failed to add tome to #1 driver}}
}
\addtometo{proceedings}
\addtometo{inproceedings}
\addtometo{book}
\addtometo{inbook}

\renewbibmacro*{maintitle+title}{%
  \iffieldsequal{maintitle}{title}
    {\clearfield{maintitle}%
     \clearfield{mainsubtitle}%
     \clearfield{maintitleaddon}}
    {\iffieldundef{maintitle}
       {}
       {\usebibmacro{maintitle}%
    \newunit\newblock
    \iffieldundef{volume}
      {}
      {\printfield{volume}%
     \setunit{addcomma\space}%
     \printfield{tome}
           \printfield{part}%
           \setunit{\addcolon\space}}}}%
  \usebibmacro{title}%
  \newunit}

\renewbibmacro*{maintitle+booktitle}{%
  \iffieldundef{maintitle}
    {}
    {\usebibmacro{maintitle}%
     \newunit\newblock
     \iffieldundef{volume}
       {}
       {\printfield{volume}%
     \setunit{addcomma\space}%
     \printfield{tome}
        \printfield{part}%
        \setunit{\addcolon\space}}}%
  \usebibmacro{booktitle}%
  \newunit}

\begin{filecontents*}{\jobname.bib}
@InProceedings{bertolini:1992,
  author         = "Francesco Bertolini",
  title          = "Società di trasmissione orale: mito e folclore",
  booktitle      = "Lo spazio letterario della Grecia antica",
  editor         = "G. Cambiano and L. Canfora and D. Lanza",
  publisher      = "Salerno",
  location       = "Roma",
  year           = "1992",
  volume         = "1",
  tome           = "3",
  pages          = "47--75",
}
\end{filecontents*}
\addbibresource{\jobname.bib}

\begin{document}
\cite{bertolini:1992}
\printbibliography
\end{document}

That much hassle probably is not worth it as we have part that seems to do what you want rather well.

Related Solutions

[Tex/LaTex] biblatex month field

The MONTH thing is special. Biblatex supports the old bibtex month strings like 'jan' 'feb' etc. as these are bibtex @STRINGS which expand to the right string for your language. It's the same in biblatex/biber.

To be more precise, biblatex only wants numbers for the months so it can replace them with language-specific strings in a general way (without relying on English @STRING macro names like 'jan'). Biber supporte these macros by turning them into numbers for biblatex in the .bbl.

[Tex/LaTex] Biblatex: collaborator(s) field

I think that the most appropriate way to enable you to have "collaborator" in the database and still use the standard styles without fiddling with any drivers is to add a sourcemap (you will need Biber 1.0+ and biblatex 2.0+).

The "magic" here is in the \DeclareSourcemap section, which basically works as follows:

Identify entries with a collaborator field: if the entry doesn't have such a field process it no further: \step[fieldsource=collaborator, final=true]
Copy the collaborator field to the editora field: \step[fieldtarget=editora, origfieldval]
Set the editoratype field to "collaborator": \step[fieldset=editoratype, fieldvalue=collaborator

If you were happy with the "standard" formatting ("In collab[oration] with") that would be all you needed. A bit of extra complexity creeps in because you want a different format, "With collaborator(s)". The trouble here is that in the "bytype" string, the standard biblatex styles don't attempt to distinguish between single and multiple names. At that point you have three options:

If you want to keep things simple, roll with the punches and accept a format which can work for one or many collaborators, such as the default. This is simplest, and unless you are wedded to the "with collaborators" formula probably best. If so, you could delete the whole of the second map step, the \newbibliographystring and the definition of a bycollaborators string.
If you want to be "correct", rewrite internal macros to identify multiple names and print appropriately different introductory strings. This would be quite a bit of work, and probably more than is really justifiable.
Distinguish in the .bib file itself between one and multiple collaborators, by using "collaborator" for one and "collaborators" for two. As far as biblatex is concerned it is then dealing with quite different "types" ("collaborators" might as well be "turnipwranglers" as far as it's concerned), but by defining a suitable bibstring to handle the plural form the problem is solved. That's not perfect, but it seems acceptable, and so that's what I've done here.

The end result, given your input fractionally changed so that "collaborator" becomes "collaborators" (for reasons explained above) is as follows: