Interface Options

interface Options {
    applyCrossRef?: boolean;
    caseProtection?: boolean | "as-needed" | "strict";
    english?: boolean | string[];
    fieldMode?: Record<string, ParseMode>;
    languageAsLangid?: boolean;
    raw?: boolean;
    removeOuterBraces?: string[];
    sentenceCase?: false | {
        guess?: boolean;
        preserveQuoted?: boolean;
        subSentence?: boolean;
    };
    strings?: string | Record<string, string>;
    unsupported?: unsupportedHandler | "ignore";
    verbatimFields?: (string | RegExp)[];
}

Properties

applyCrossRef? caseProtection? english? fieldMode? languageAsLangid? raw? removeOuterBraces? sentenceCase? strings? unsupported? verbatimFields?

Properties

OptionalapplyCrossRef

applyCrossRef?: boolean

Apply crossref inheritance

OptionalcaseProtection

caseProtection?: boolean | "as-needed" | "strict"

translate braced parts of English-entry titles into a case-protected counterpart; Default == true == as-needed. In as-needed mode the parser will assume that words that have capitals in them imply "nocase" behavior in the consuming application. If you don't want this, turn this option on, and you'll get case protection exactly as the input has it

Optionalenglish

english?: boolean | string[]

Bib(La)TeX handles entries that are in English differently from emtries in other languages. For English-like entries, it expects titles in title-case. Words within braces are recognized as "case-protected" and their original casing is preserved during rendering. For non-English entries, the casing as entered in the entries is rendered as entered. Other reference managers, such as Zotero, expect all titles to be in sentence-case. In this parser you can specify which langid values mark an entry to be English so that it can convert those titles to sentence-case, and to carry over case-protection. If no langid is present an entry is assumed to be English by bib(la)tex, and the parser follows that convention. Note that sentence-casing uses heuristics and does not employ any kind of natural language processing, so you should always inspect the results. If you offer your own list of english-langids here, do not forget to include the empty string, stands for "langid absent". Default languages to sentenceCase are the empty string, plus:

  • american
  • british
  • canadian
  • english
  • australian
  • newzealand
  • usenglish
  • ukenglish
  • en
  • eng
  • en-au
  • en-bz
  • en-ca
  • en-cb
  • en-gb
  • en-ie
  • en-jm
  • en-nz
  • en-ph
  • en-tt
  • en-us
  • en-za
  • en-zw

If you pass an empty array, or false, no sentence casing will be applied (even when there's no language field).

OptionalfieldMode

fieldMode?: Record<string, ParseMode>

Specify parsing mode for specific fields

OptionallanguageAsLangid

languageAsLangid?: boolean

By default, langid and hyphenation are used to determine whether an entry is English, but some sources (ab)use the language field for this. If you turn on this option, this field will also be taken into account as a source for langid.

Optionalraw

raw?: boolean

If this flag is set entries will be returned without conversion of LaTeX to unicode equivalents.

OptionalremoveOuterBraces

removeOuterBraces?: string[]

In the past many bibtex entries would just always wrap a field in double braces, likely because whomever was writing them couldn't figure out the case meddling rules (and who could blame them). Fields listed here will either have one outer layer of braces treated as case-preserve, or have the outer braced be ignored completely, if this is detected.

OptionalsentenceCase

sentenceCase?: false | {
    guess?: boolean;
    preserveQuoted?: boolean;
    subSentence?: boolean;
}

Type declaration

  • Optionalguess?: boolean

    Some bibtex files will have English titles in sentence case, or all-uppercase. If this is on, and there is a field that would normally have sentence-casing applied in which there are all-lowercase words that are not prepositions (where X is either lower or upper) than mixed-case, it is assumed that you want them this way, and no sentence-casing will be applied to that field

  • OptionalpreserveQuoted?: boolean

    If you have sentence-casing on, you can independently choose whether quoted titles within a title are preserved as-is (true) or also sentence-cased (false).

  • OptionalsubSentence?: boolean

    Retain Capitalised words in sub-sentences after colons. Given the input title "Structured Interviewing For OCB: Construct Validity, Faking, And The Effects Of Question Type":

    • when true, sentence-cases to "Structured interviewing for OCB: Construct validity, faking, and the effects of question type"
    • when false, sentence-cases to "Structured interviewing for OCB: construct validity, faking, and the effects of question type"

Optionalstrings

strings?: string | Record<string, string>

You can pass in an existing @string dictionary

Optionalunsupported

unsupported?: unsupportedHandler | "ignore"

By default, when a TeX command is encountered which the parser does not know about, the parser will throw an error. You can pass a function here to return the appropriate text output for the command.

OptionalverbatimFields

verbatimFields?: (string | RegExp)[]

Some fields such as url are parsed in what is called "verbatim mode" where pretty much everything except braces is treated as regular text, not TeX commands. You can change the default list here if you want, for example to help parse Mendeley file fields, which against spec are not in verbatim mode.

Settings

Member Visibility

On This Page

Properties