-
-
Notifications
You must be signed in to change notification settings - Fork 295
Configuration
<!-- DO NOT EDIT THIS FILE ON THE GITHUB WIKI
This page is generated automatically from comments in
https://github.com/retorquere/zotero-better-bibtex/blob/master/chrome/content/zotero-better-bibtex/preferences/preferences.xul.
Any edits made directly in this file will be overwritten the next time it is generated.
-->
The Better BibTeX Configuration can be found under the regular Zotero preferences pane, tab 'Better Bib(La)TeX'.
The configuration of Better BibTeX is a little baroque compared to the standard Zotero Bib(La)TeX exporters (which only have hidden preferences). The defaults should just work, but here's an attempt to describe what they do.
Making any change here will drop your entire export cache. This is usually not a problem unless you have a really large library, but you can read about what is involved here.
Used for drag-and-drop/quick copy citations. In the Zotero "Export" pane, choose, "Better BibTeX
Quick Copy" as the default export format for quick copy, then set the desired LaTeX citation
command here. If you set this to citep, drag-and-drop citations will yield
\citep{key1,key2,...}
Set the pattern used to generate citation keys. The format of the keys is documented here.
If you have deviated from the default citation key format pattern by specifycing your own, you may
wind up with non-ASCII characters in your citation keys. You can prevent that using the fold function at the
appropriate place in your pattern, but checking this checkbox will just apply fold to all your keys.
This determines what happens if you pin a key to a value that is already in use in a different reference but not pinned there. Neither are ideal, you just get to pick your poison. The options are:
- postfixed (causes key changes): Change the non-pinned key by adding a postfix character. This means the citation key changes which could be problematic for existing papers.
- kept (causes key duplicates): Keep the non-pinned key as-is. This means your library now has duplicate keys.
By default, Better BibTeX assigns dynamic keys to your references; if your reference changes, your citation key will
also likely change (depending on which fields you changed). If you don't want this, you can "pin" the citation key; if
you have bibtex: <something> in the extra field of your reference, <something> will be used as the citation key
regardless of what your reference says.
You can have Better BibTeX do this pinning for you automatically. This behavior is off by default, but you can have it automatically pin the key after the first change to the reference (this generally means at reference creation), or at export (and auto-exports count as exports). This is mainly useful to do if you share your library, to make sure you and your co-authors have the same keys, or if you work from multiple workstations. Please note that "on change" does not mean that the reference will be re-pinned on change. Once pinned, no more changes are made to your keys by Better BibTeX itself.
Note: This option requires webdav/zotero sync to be off, or automatic. If you don't sync your references/attachments, it's considered off. If you have syncing set up but not on automatic, this option will be greyed out. Each pinned key change (or clearing of a pinned key) means a change to the reference, and that means the item will be synced if you have that set up. Bulk key changes causing bulk reference changes (which can easily happen if you have on-export and you export your full library) could overwhelm the Zotero sync service if presented all at once; automatic syncing ameliorates that problem. Not doing this would risk sync being permanently impossible, as the Zotero server will kick you out if a sync takes too long.
If you enable this, the extra column in the Zotero reference list (if you have selected it to be
shown) will display the citation key instead of the extra field.
Used for drag-and-drop/quick copy citations. You can select the output format here: LaTeX (in combination with the Citation command preference), Pandoc, or Org-mode
Does what it says on the tin, really. If a reference has both a DOI and an URL, you can choose to have them both exported, or either one of them.
BibLaTeX actually has really good Unicode support, so you generally want this off. But for some geezers such as me it is simply more pleasing to have things like accented characters translated to their equivalent LaTeX constructs on export.
BibTeX has really spotty Unicode support, so you generally want this on. It will translate things like accented characters to their equivalent LaTeX constructs on export.
By default, Better BibTeX will export attachments including a title and their mimetype, in a format supported by JabRef. Many but not all BibTeX managers support this format, but if yours (like emacs ebib) doesn't, enable this to export only the filename.
Assume single-word strings to be externally-defined @string vars, and thus not surrounded by braces (default: false)
When enabled, single-word strings will be assumed to be externally-defined @string vars, and thus not surrounded by braces. If you don't know what this means, leave it off.
Name handling is a lot more complex than I had ever thought it to be. A lot more complex. This setting
determines how two-part names (that is, names specified in separate last name and first name fields) are handled.
When enabled, Gogh, Rembrandt van will be exported (roughly) to author = {van Gogh, Rembrandt}. This is not
always desirable, so you can disable this, in which case you will get (roughly) author = {Gogh, Rembrandt van}
If there are some fields you don't want in your bibtex files (such as note for example), add a
list of them here, separated by comma's.
BibLaTeX supports urls in your references natively; BibTeX does not. For this reason, URLs are
omitted from BibTeX exports by default. Using this setting you can have them added to your exports either in a note
field (not as clean, but compatible with BibTeX out of the box), or in an url field (requires extra packages to be loaded,
or bibtex will error out).
If set, generates journal abbreviations on export using the Zotero journal abbreviator, according to the abbreviation style selected in the list below the checkbox.
Determines when automatic exports are kicked off:
- Disabled: disable automatic exports (but still marks them when changes occur)
- On Change: export whenever a reference in the export changes/is added/is removed.
- When Idle: export marked collections when your computer is idle. You mostly want this if your computer is performance-constrained (aka slow)
Better BibTeX extended debug logging. Restart Firefox/Zotero to activate, persists over reboots. Affects performance, so turn off when done. (default: false)
This will generate more verbose logs. This really does affect performance, so only enable this if you're trying to diagnose a problem in Better BibTeX.
Enables hardcore mode. You like Zotero in some ways, but really just want it to be a BibTeX manager. If you enable this, any BibTeX files you import will retain all the LaTeX commands they have, and marks the entry to be exported without any translation.
Adds a '%b' formatter to Zotfile which retrieves the BibTeX citation key. This is going to be depreated soon, as it's much safare to have this done on the ZotFile side
There have been occasions where Better BibTeX seemed to ignore keys you have specified manually by having
bibtex: <whatever> in the extra field of your reference. I haven't seen this in ages, but enabling this and then restarting
Zotero will force a re-scan to find them. This slows down startup tremendously if you have a big library. The checkbox
will automatically clear after restart.
Show reference ID instead of 'call number' field in reference list (requires restart) (default: false)
If you enable this, the call number column in the Zotero reference list (if you have selected it to be
shown) will display the internal reference ID instead of the call number field. Only useful for debugging.
For those who are curious about what the "Clear/Generate BibTeX key" right-click options do, this will warn you if you are doing this on more than 10 (default) at the same time, to prevent your curiosity from changing all your citation keys at once.
Snippet of javascript to run after each BibTeX generation.
Switches between babel and polyglossia, except I haven't gotten around to polyglossia yet.
Select the style for auto-abbreviation.
Number of seconds to wait after your system goes idle before kicking off auto-exports.
How often the Better BibTeX database should be saved to disk. Defaults to once every 5 seconds. Note that your database is always saved when your computer goes idle, or when you exit Zotero.
On upgrading to a new version, Better BibTeX drops your cache to make sure you get the latest export implementation. For large libraries, this may be undesirable because Better BibTeX updates frequently, and export on an empty cache is really slow. If you have more than N entries in your cache, you will be asked if you want to keep the cache (and forego the benefits of the upgrade until the relevant entries change to change their cache).
You really want this on. Better BibTeX has a very involved process of generating BibTeX output, and the caching mechanism makes sure it doesn't happen any more frequently than necessary.
Enables csquotes support.
list of words to skip in title when generating citation keys
Unit tests to run
Export JabRef groups for collections.
The Better BibTeX date parser uses locale hints when provided with ambiguous dates such as 1/2/2008 (which is
either 1st of February, or 2nd of Januari). Better BibTeX will first look at the language specified in your reference and
fall back to your system locale otherwise, but if you add a language code here, this will be used as a fallback. I use
en-GB here myself as I generally prefer the en-US locale for my systems, but not the wacky idea of date formatting
that comes with it.
List of words to keep lowercase when applying title casing.
When language alternates are present in Juris-M, this is the language BBT will pick.
Generate quality reports for exported references.