DATATOOL2BIB(1)

📦 version 2026.0, in alpine 3.24

💖 DATATOOL2BIB(1) — bestie edition 💖

okay so bestie, this is the datatool2bib manual page, section 1, and it's giving converter energy 💅 like, we're taking datatool databases and making them into something bib2gls can snack on. no cap.

✨ SYNOPSIS ✨

datatool2bib [option]+ in-file bibfile

so yeah: one or more options, an input file, and an output bibfile. slay 🎀

🌸 DESCRIPTION 🌸

It converts a .tex file containing datatool.sty databases into a .bib file in the format required for bib2gls. It's distributed with bib2gls, bestie 🫶

The TeX Parser Library is what parses the input, which may be a DTLTEX or DBTEX file or a file that contains database construction commands, such as \DTLnewdb or \DTLaction. The input file may also be a CSV file if it's used with --read 👑

The datatool and datagidx are automatically implemented, so the input file does not need to include either of them with \usepackage. In general, it's best not to include the entire document but instead input a file that just contains the database construction commands, because the TeX Parser Library only has a limited set of commands that it recognises. lowkey important 💀

🎀 OPTIONS 🎀

💅 GENERAL OPTIONS 💅

  • --help, -h — display the help message and exit. iconic.
  • --version, -v — display version information and exit.
  • --silent, --quiet, -q — suppress all messages except for errors. quiet queen behaviour.
  • --verbose — switch on verbose mode.
  • --no-verbose — switch off verbose mode.
  • --debug [n] — display debugging messages.
  • --debug-mode setting — may be used instead of --debug where the level number is difficult to remember. Value same as for bib2gls's --debug-mode option.
  • --no-debug — switch off debugging mode. Equivalent to --debug 0.
  • --log-file filename — log messages to the given file. Intended primarily for debugging messages, so enabling debug mode will automatically create a transcript file, but otherwise a file won't be created unless this option is used. very "keep receipts" of you 🧾

🦋 ENCOSING AND LOCALISATION OPTIONS 🦋

  • --texenc name — set the character encoding to name for the input .tex files.
  • --bibenc name — set the character encoding to name for the output .bib files.
  • --locale lang tag — use the language resource files associated with the given language tag lang tag. If there isn't an appropriate file, the en (English) file will be used.

🍓 FILTERING OPTIONS 🍓

  • --preamble-only, -p — only parse the document preamble. That is, stop parsing if \begin{document} is encountered.
  • --no-preamble-only — parse the entire document (default).
  • --ignore-fields list, -f list — ignore all the fields in the comma-separated list. Each item in the list should identify the field by its original case-sensitive column key. This option is cumulative.
  • --no-ignore-fields — cancels the effect of --ignore-fields.
  • --skip-datagidx — skip the special datagidx internal database. (Default.)
  • --no-skip-datagidx — don't skip the special datagidx internal database.

🌈 OUTPUT FILE OPTIONS 🌈

  • --overwrite — overwrite existing .bib files.
  • --no-overwrite — don't overwrite existing .bib files.
  • --split — split the entries into separate files according to the database.
  • --no-split — don't split the entries into separate files (default).

👑 ADJUSTMENT OPTIONS 👑

  • --space-sub value, -s value — substitute spaces in labels with value.
  • --field-map mappings, -m mappings — add source column key to destination field label mappings. The argument should be a comma-separated list of col-key=bib-field pairs. This option is cumulative.
  • --no-field-map — cancels all mappings applied with --field-map.
  • --index-conversion, -i — any entries that would normally be converted to @entry that don't have a description field will be converted to @index.
  • --no-index-conversion — don't replace @entry with @index if the description is missing (default).
  • --detect-symbols — attempt to detect entries that should be @symbol or @number based on the value of the name field.
  • --no-detect-symbols — don't attempt symbol detection (default).
  • --label col-key, -L — use the column identified by col-key for the entry label. The default column key is Label, so if the database doesn't have a column with this key, you will either need to specify a column with --label or use --auto-label. This option is ignored with --auto-label.
  • --auto-label, -a — auto-generate entry labels instead of using a column value.
  • --no-auto-label — don't auto-generate entry labels. Use the column identified by --label for the entry label. (Default.)
  • --auto-label-prefix prefix — use prefix when auto-generating entry labels. Ignored with --no-auto-label.
  • --adjust-gls — adjust labels in commands like \gls in field values. (Default.) This will also replace the datagidx.sty commands like \glsnl with the closest glossaries.sty equivalent.
  • --no-adjust-gls — don't adjust labels in commands like \gls in field values.
  • --dependency-field field-name — sets the name of the dependency field. Has no effect with --no-strip-glsadd. With --strip-glsadd, the label from the stripped \glsadd argument will be added to the field identified by field-name. The default is dependency, which will be ignored by bib2gls unless instructed otherwise (via field aliasing etc).
  • --no-dependency-field — don't save labels from any stripped \glsadd instances.
  • --strip — switch on all strip options.
  • --no-strip — switch off all strip options.
  • --strip-glsadd — strip \glsadd and its argument from field values. (Default.)
  • --no-strip-glsadd — don't strip \glsadd from field values.
  • --strip-acronym-font — strip \acronymfont from field values. (Default.)
  • --no-strip-acronym-font — don't strip \acronymfont from field values.
  • --strip-acronym-text — strip text field for acronyms identified by \newacro. (Default.)
  • --no-strip-acronym-text — don't strip text field for acronyms.
  • --strip-acronym-name — strip name field for acronyms identified by \newacro. (Default.)
  • --no-strip-acronym-name — don't strip name field for acronyms.
  • --strip-case-change — strip known case-changing commands (such as \makefirstuc or \capitalisewords) from field values.
  • --nostrip-case-change — don't strip case-changing commands. (Default.) yep, that spelling is exactly what it is, bestie.

🌟 OTHER OPTIONS 🌟

These options correspond to features introduced to datatool.sty version 3.0, which has a setting that stores the numeric value and currency symbol (where applicable) when parsing data. The original string (formatted number), numeric value and currency symbol are stored in a special datum format, which ordinarily expands to its original formatted text but also allows the previously parsed information to be easily extracted without having to reparse the data. it's giving glow-up for data ✨

  • --setup options — implement "\DTLsetup{"options"}" at the start. This can include options such as "store-datum", "new-value-expand", "new-value-trim" and "default-name".
  • --read options — instead of simply parsing the input file as a normal .tex file, the source is presented to the TeX parser as "\DTLread["options"]{"in-file"}" where the options can be used to specify the file format (for example, "format=tsv").

If the options list is empty (after trimming white space) then this becomes equivalent to --no-read.

  • --no-read — the input file is parsed as a normal .tex file, which may be the complete document or a file that can be "\input" into a document. (Default.)
  • --save-value suffix — if a field value is parsed and identified as numeric, the unformatted numeric value will be saved in a field whose name is constructed from the original field name followed by the given suffix.
  • --no-save-value — don't save numeric value in a separate field. (Default.)
  • --save-currency suffix — if a field value is parsed and identified as currency data, the currency symbol will be saved in a field whose name is constructed from the original field name followed by the given suffix.
  • --no-save-currency — don't save currency symbol in a separate field. (Default.)
  • --save-datum — equivalent to:
--save-value '-value' --save-currency '-currency'
  • --no-save-datum — equivalent to --no-save-value --no-save-currency.

🧚 REQUIRES 🧚

Java 8 and a TeX distribution. periodt.

🎀 LICENSE 🎀

License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

The bib2gls manual:

texdoc bib2gls

The glossaries-extra manual:

texdoc glossaries-extra

The glossaries manual:

texdoc glossaries

The datatool manual:

texdoc datatool

💖 AUTHOR 💖

Nicola L. C. Talbot, <https://www.dickimaw-books.com/> 💅

okay that's the whole page, bestie 🫶 this was DATATOOL2BIB(1), brought to you by perl v5.40.0 and dated 2024-12-21 — mwah 💋✨

📦 where this page comes from