grunt-tex-bibtex
v0.2.0
Published
Grunt bibtex task
Downloads
1
Readme
grunt-tex-bibtex
Part of the grunt-tex suite of LaTeX-orientated Grunt tasks.
This plugin can be used to generate bibliography files using the application bibtex
.
Getting Started
This plugin requires Grunt ~0.4.5
and bibtex to be available.
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-tex-bibtex --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-tex-bibtex');
The "bibtex" task
Overview
In your project's Gruntfile, add a section named bibtex
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
bibtex: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
}
}
});
Options
options.executable
Type: String
Default value: bibtex
If bibtex is not available on the command line as bibtex
, put it's location in this option.
options.args
Type: Object
Default value: { -terse: null }
An object of arguments to pass through to bibtex as command line options. Check the bibtex man page for all options. A few rules are applied to these arguments:
- If the value of a key is
null
, it will be treated a flag, i.e. it will be compiled as--option
rather than--option=null
- If the key starts with
-
and has a value, - If the key starts with
--
and has a value,=
will be used to separate the key and value
Without changing any arguments, bibtex will be executed like so:
bibtex -terse <document-name>
Usage Examples
Basic
This is the most basic usage of bibtex:
grunt.initConfig({
bibtex: "document.aux"
});
Multitask
In this example, bibtex is used as a multitask, with a custom path to bibtex specified.
grunt.initConfig({
bibtex: {
options: {
executable: "/usr/bin/bibtex"
},
documentone: "documentone.aux",
documenttwo: "documenttwo.aux"
}
});
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
Release History
- 2015-01-08 v0.1.0 Initial release
- 2015-01-09 v0.2.0 Change argument handling