BIBUTILS(1)

πŸ“¦
version 7.2 Β· 2 versions
, in epel 9, fedora 43, fedora 44

🌈 BIBUTILS(1) β€” User Commands 🌈

okay bestie, welcome to the bibutils manual page πŸ’– (that's the manual name, in case the header wasn't giving it away). Buckle up, we're doing bibliography conversions and honestly? it's giving main character energy.


✨ NAME ✨

bibutils β€” bibliography conversion utilities πŸ¦‹


✨ SYNOPSIS ✨

format2xml [OPTIONS] [file.format]

xml2format [OPTIONS] [file.xml]

✨ DESCRIPTION ✨

The bibutils program set inter-converts between various bibliography formats using Library of Congress [1]'s Metadata Object Description Schema (MODS) [2] version 3.1. 🌸

So like, for example? You can convert RIS-format files to Bibtex by doing two transformations: RIS->MODS->Bibtex. Two-step glow-up, no cap. πŸ’…


πŸ’– CONVERTING TO MODS πŸ’–

🌟 Overview 🌟

Every one of these little icons takes your format and turns it into MODS:

  • bib2xml β€” convert bibtex to MODS
  • biblatex2xml β€” convert biblatex to MODS
  • copac2xml β€” convert COPAC [3] format references to MODS
  • ebi2xml β€” convert EBI XML to MODS
  • end2xml β€” convert EndNote (Refer format) to MODS
  • endx2xml β€” convert EndNote XML to MODS
  • isi2xml β€” convert ISI web of science to MODS
  • med2xml β€” convert Pubmed XML references to MODS
  • nbib2xml β€” convert Pubmed nbib format references to MODS
  • modsclean β€” a MODS to MODS converter
  • ris2xml β€” convert RIS format to MODS
  • wordbib2xml β€” convert Word2007 bibliography XML to MODS

πŸŽ€ Common Options Converting to MODS πŸŽ€

Several flags available for the end2xml, endx2xml, bib2xml, ris2xml, med2xml, and copac2xml programs. Most options have both a short and a long version, because we love options around here. 😌

  • -h, --help β€” display help
  • -v, --version β€” display version
  • -a, --add-refcount β€” add "_#", where # is reference count to reference id
  • -s, --single-refperfile β€” put one reference per file name by the reference number
  • -i, --input-encoding β€” interpret the input file as using the requested character set (use w/o argument for current list derived from character sets at www.kostis.net [4]) unicode is now a character set option
  • -u, --unicode-characters β€” encode unicode characters directly in the file rather than as XML entities
  • -un, --unicode-no-bom β€” as -u, but don't include a byte order mark
  • -x, --xml-entities β€” encode unicode characters as XML entities (opposite of -u)
  • -nl, --no-latex β€” do not convert latex-style character combinations
  • -s, --single-refperfile β€” one reference per output file
  • -d, --drop-key β€” don't put citation key in the mods id field
  • -c, --corporation-file β€” with argument specifying a file containing a list of corporation names to be placed in <name type="corporate"></name> instead of type="personal" and eliminate name mangling
  • -a, --asis β€” with argument specifying a file containing a list of names to be treated verbatim
  • -nt, --nosplit-title β€” don't split titles into TITLE/SUBTITLE pairs
  • --verbose β€” verbose output
  • --debug β€” very verbose output (mostly for debugging)
yes, -s and -a each show up twice up there. that's not me being messy, that's literally what the page says. πŸ’€

🌸 bib2xml 🌸

bib2xml converts a bibtex-formatted reference file to an XML-intermediate bibliography file. Specify file(s) to be converted on the command line. Files containing bibtex substitutions strings should be specified before the files where substitutions are specified (or in the same file before their use). If no files are specified, then bibtex information will be read from standard input. 🫢

bib2xml bibtex_file.bib > output_file.xml

🌸 biblatex2xml 🌸

biblatex2xml converts a biblatex (not to be confused with bibtex πŸ‘€) formatted reference file to an MODS XML-intermediate bibliography file.

biblatex2xml biblatex_file.bib > outputfile.xml

🌸 copac2xml 🌸

copac2xml converts a COPAC formatted reference file to a MODS XML-intermediate bibliography file.


🌸 end2xml 🌸

end2xml converts a text endnote-formatted reference file to an XML-intermediate bibliography file. This program will not work on the binary library; the file needs to be exported first. 😭 Endnote tagged formats ("Refer" format export) look like Example 1, "Example refer format file". There are very nice instructions for making sure that you are properly exporting this at http://www.sonnysoftware.com/endnoteimport.html [5]

Usage for end2xml is the same as bib2xml.

end2xml endnote_file.end > output_file.xml

🌸 ebi2xml 🌸

ebi2xml converts a EBI XML file to a MODS XML-intermediate bibliography file.


🌸 endx2xml 🌸

endx2xml converts a EndNote-XML exported reference file to a MODS XML-intermediate bibliography file. This program will not work on the binary library; the file needs to be exported first.


🌸 isi2xml 🌸

isi2xml converts an ISI-web-of-science-formatted reference file to an XML-intermediate bibliography file.

Usage for isi2xml is the same as bib2xml.

isi2xml input_file.isi > output_file.xml

🌸 ris2xml 🌸

ris2xml converts a RIS-formatted reference file to an XML-intermediate bibliography file. ris2xml usage is as end2xml and bib2xml

ris2xml ris_file.ris >   output_file.xml

🌸 wordbib2xml 🌸

wordbib2xml convert a Word2007-formatted reference file to an XML-intermediate bibliogrpahy file. ✨


πŸ’œ CONVERTING FROM MODS πŸ’œ

🌟 Overview 🌟

Going the other way now, bestie β€” MODS back out into the wild:

  • xml2ads β€” convert MODS into the SAO/NASA ADS format
  • xml2bib β€” convert MODS into bibtex
  • xml2end β€” convert MODS into format for EndNote
  • xml2isi β€” convert MODS to ISI format
  • xml2ris β€” convert MODS into RIS format
  • xml2wordbib β€” convert MODS into Word 2007 bibliography format

πŸŽ€ Common Options Converting from MODS πŸŽ€

Note that --output-encoding refers to the input file. (yes, really. iykyk πŸ™ˆ)

  • -h, --help β€” display help
  • -v, --version β€” display version
  • -o, --output-encoding β€” interpret the input file as using the requested character set (use w/o argument for current list derived from character sets at www.kostis.net [4]) unicode is now a character set option
  • -s, --single-refperfile β€” put one reference per file name by the reference number
  • -nb, --no-bom β€” do not write Byte Order Mark if writing UTF8

🌸 xml2bib 🌸

xml2bib converts the MODS XML bibliography into a bibtex-formatted reference file. xml2bib usage is as for other tools

xml2bib xml_file.xml > output_file.bib

Since the BibTeX reference format is fairly flexible and seems to have the greatest number of personal preferences, it has also accumulated a number of specific options that are not available for other formats. πŸ’…

Starting with 3.24, xml2bib output uses lowercase tags and mixed case reference types for better interaction with other software. The older behavior with all uppercase tags/reference types can still be generated using the command-line switch -U/--uppercase.

xml2bib-specific Options:

  • -fc, --finalcomma β€” add final comma in the bibtex output for those that want it
  • -sd, --singledash β€” use one dash instead of two (longer dash in latex) between numbers in page output
  • -b, --brackets β€” use brackets instead of quotation marks around field data
  • -w, --whitespace β€” add beautifying whitespace to output
  • -U, --uppercase β€” use all uppercase for tags (field names) and reference types (pre-3.24 behavior)
  • -sk, --strictkey β€” only use alphanumeric characters for bibtex citation keys

🌸 xml2ads 🌸

xml2ads converts the MODS XML bibliography to the Smithsonian Astrophysical Observatory (SAO)/National Aeronautics and Space Administration (NASA) Astrophyics Data System or ADS reference format [6] (which is very similar to the tagged Endnote style). xml2ads usage is as for other tools

xml2ads xml_file.xml > output_file.ads

🌸 xml2ris 🌸

xml2ris converts the MODS XML bibliography to RIS-formatted bibliography file. xml2ris usage is as for other tools

xml2ris xml_file.xml > output_file.ris

🌸 xml2end 🌸

xml2end converts the MODS XML bibliography to tagged Endnote (refer-format) bibliography file. xml2end usage is as for other tools

xml2end xml_file.xml >  output_file.end

🌸 xml2wordbib 🌸

xml2wordbib converts the MODS XML bibliography to Word 2007-formatted XML bibliography file. xml2wordbib usage is as for other tools

xml2wordbib xml_file.xml >  output_file.word.xml

xml2wordbib was called xml2word in versions of bibutils prior to 3.40. It was renamed to avoid confusion with other tools. Hopefully this will not break too many scripts already in use. 😬

🌸 EXAMPLES 🌸

okay bestie, this is the part where it all comes together, the moment we've been building to πŸ’–. These are the receipts, the actual real-life examples of what these conversions look like. Grab a snack, we're going through all of them.

πŸŽ€ Example 1. Example refer format file

%0 Journal Article
%A C. D. Putnam
%A C. S. Pikaard
%D 1992
%T Cooperative binding of the Xenopus RNA polymerase I
   transcription factor xUBF to repetitive ribosomal gene enhancers
%J Mol Cell Biol
%V 12
%P 4970-4980
%F Putnam1992

so that's the little refer-format cutie right there, %0 through %F, serving the whole look πŸ’….

✨ xml2bib Output Variations ✨

now THIS is the glow-up section, where we see how all the different options change the output. Same input, seven different lewks πŸ‘‘. Obsessed.

πŸ¦‹ Example 2. Default

@Article{Putnam1992,
author="C. D. Putnam
and C. S. Pikaard",
year="1992",
month="Nov",
title="Cooperative binding of the
Xenopus RNA polymerase I transcription
factor xUBF to repetitive ribosomal
gene enhancers",
journal="Mol Cell Biol",
volume="12",
pages="4970--4980",
number="11"}

the plain default, no notes, no drama, just vibing ✨.

πŸŽ€ Example 3. Final Comma

@Article{Putnam1992,
author="C. D. Putnam
and C. S. Pikaard",
year="1992",
month="Nov",
title="Cooperative binding of the
Xenopus RNA polymerase I transcription
factor xUBF to repetitive ribosomal
gene enhancers",
journal="Mol Cell Biol",
volume="12",
pages="4970--4980",
number="11",}

see that lil comma before the closing brace? that's the -c energy, a little extra garnish πŸ“.

πŸ’œ Example 4. Single Dash

@Article{Putnam1992,
author="C. D. Putnam
and C. S. Pikaard",
year="1992",
month="Nov",
title="Cooperative binding of the
Xenopus RNA polymerase I transcription
factor xUBF to repetitive ribosomal
gene enhancers",
journal="Mol Cell Biol",
volume="12",
pages="4970-4980",
number="11"}

spot the difference bestie: pages="4970-4980" with ONE dash, not the double -- πŸ”₯.

🌈 Example 5. Whitespace

@Article{Putnam1992,
  author =      "C. D. Putnam
                and C. S. Pikaard",
  year =        "1992",
  month =       "Jan",
  title =       "Cooperative binding of
the Xenopus RNA polymerase I transcription
factor xUBF to repetitive ribosomal gene
enhancers",
  journal =     "Mol Cell Biol",
  volume =      "12",
  pages =       "4970--4980"
}

the pretty-printer mode, all spaced out and aligned, plus note the month = "Jan" β€” yeah, different month here, just go with it πŸ™ˆ. Also pages has no trailing comma here, slay.

🧚 Example 6. Brackets

@Article{Putnam1992,
author={Putnam, C. D.
and Pikaard, C. S.},
title={Cooperative binding of the Xenopus
RNA polymerase I transcription factor xUBF
to repetitive ribosomal gene enhancers},
journal={Mol Cell Biol},
year={1992},
month={Nov},
volume={12},
number={11},
pages={4970--4980}
}

brackets instead of quotes, and the names flipped to Putnam, C. D. format, main character energy πŸ‘‘.

⭐ Example 7. Uppercase

@ARTICLE{Putnam1992,
AUTHOR="Putnam, C. D.
and Pikaard, C. S.",
TITLE="Cooperative binding of the Xenopus
RNA polymerase I transcription factor xUBF
to repetitive ribosomal gene enhancers",
JOURNAL="Mol Cell Biol",
YEAR="1992",
MONTH="Nov",
VOLUME="12",
NUMBER="11",
PAGES="4970--4980"
}

ALL CAPS MODE, and again the flipped name order and the Nov month. It's giving loud and proud πŸ“£.


πŸ’– LICENSE πŸ’–

okay so legal time, but make it cute ✨:

every single version of bibutils is released under the GNU General Public License (GPL). tl;dr bestie: feel free to download, run, and modify these programs as required πŸ’…. But if you re-release these, you need to release the modified version of the source. Periodt. (And Chris would appreciate patches as well...if you care enough to make the change, then he'd like to see what you're adding or fixing 🫢.)

Chris Putnam, Ludwig Institute for Cancer Research[7]


Copyright Β© 2021 David Bremner (Manual)

Copyright Β© 2021 Christopher Putnam (Software and Manual)

This manual page is distributed under the terms of version 2 of the GNU General Public License.


πŸ“š NOTES πŸ“š

the footnotes, the little linkies, the receipts πŸ”—:

  1. Library of Congress http://www.loc.gov
  2. Metadata Object Description Schema (MODS) http://www.loc.gov/standards/mods/
  3. COPAC http://copac.ac.uk/
  4. www.kostis.net http://www.kostis.net/
  5. http://www.sonnysoftware.com/endnoteimport.html http://www.sonnysoftware.com/endnoteimport.html
  6. ADS reference format http://doc.adsabs.harvard.edu/abs_doc/help_pages/taggedformat.html
  7. Chris Putnam, Ludwig Institute for Cancer Research http://www.sourceforge.net/p/bibutils/home/Bibutils

and that's a wrap, bestie πŸŽ€βœ¨ this whole lil guide is bibutils 7.2, dated November 8, 2016, and it's BIBUTILS(1) β€” go forth and convert your citations, you absolute icon πŸ’–πŸ¦‹

πŸ“¦ where this page comes from