Skip to content
Citations from bibtex for Sublime Text 3
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bibtexparser
messages
.gitignore
.gitmodules
.no-sublime-package
COPYING
Citer.sublime-settings
Default.sublime-commands
Main.sublime-menu
README.md
citer.py
messages.json
package-metadata.json

README.md

Citations from BibTeX for Sublime Text

This Sublime Text 3 plugin provides citation search and Tab-completion for citations stored in a BibTeX file. Configure the file path and you are good to go!

The default set up is optimized to work with AcademicMarkdown.

Uses the bibtexparser library from sciunto.

Configuration

You must specify the location of your BibTeX file or files in the Citer-sublime-settings preferences file. Multiple files can be added as a list.

Optionally you can define

  • search_fields the BibTeX fields to search in when using Citer: Search
  • citation_format the citation format
  • completions_scopes the list of scopes to limit the operation of the plugin (by default, Citer will only suggest citations within plain text scopes and is disabled in source code)
  • enable_completions enable/disable citation completions (when you hit @)
  • quickview_format customise the format when listing library entries in the quickview panel (e.g. with the Citer: Show All command). Place variables between {} braces. Available variables are citekey, title, author, year.
  • auto_merge_citations Whether to automatically merge citations that are inserted next to each other. [@Fred2000][@Mary2001] becomes [@Fred2000; @Mary2001]. Equivalent to running Citer: Combine adjacent citations on every insert

See below for example (default) configuration

{
    //REQUIRED:

    "bibtex_file_path": "example/path/to/file.bib",
    // You can also specify a list
    //"bibtex_file_path": ["example/path/to/file.bib", "example/path/to/fileTwo.bib"],

    //OPTIONAL:

    //By default Citer Search looks for your keyword in the 
    //author, title, year, and Citekey (id) fields
    "search_fields": ["author", "title", "year", "id"] ,
    //Default format is @Citekey
    "citation_format": "@%s",
    //list of scopes. Could be top level "text" or "source", or limit to
    // e.g "text.html.markdown"
    "completions_scopes": ["text"],
    "enable_completions": true,
    //Customise the quickview of you library, using python format syntax
    "quickview_format": "{citekey} - {title}",
    "auto_merge_citations": false
}

Commands

Citer: Search - enter a search term. All results where the term is found in the author, title, citekey, or year fields will be shown (the searched fields are configurable)

Citer: Show All - show all the entries in your BibTeX in a quick view (you can then search in the title)

Citer: Insert Title - show all the entries in your BibTeX in a searchable quick view, inserts the title

Citer: Combine adjacent citations - Combines neighbouring citations i.e. [@Fred2000][@Mary2001] becomes [@Fred2000; @Mary2001]

Completions

Citer provides autocompletions for your citekeys, these are enabled by default and can be disabled in the config.

Compatibility

Citer has been tested with BibTeX generated by Mendeley, Jabref, and Zotero. It should work with any well-formed BibTeX file.

TODO

  • Look into providing snippets for pandoc citation format in markdown files.

Licence

LGPLv3. See COPYING for details.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.