manuelmitasch / gitbook-plugin-bibtex-citation

Bibtex Citations Gitbook Plugin

This plugins requires gitbook >=2.0.0.

Install

Add this to your book.json, then run gitbook install:

{
    "plugins": ["bibtex-citation"]
}

Usage

The plugin expects a literature.bib file in your books root folder. You can use the bibtex keys defined within the file to reference the literature.

{{ "some-key" | cite }}

You can also add a table of references through:

{% references %} {% endreferences %}

Only used literature is included in the table of references. They are ordered by the usage within the text.

Limitations

The plugin currently only supports IEEE referencing style. Feel free to submit pull requests to add additional styles.

gitbook-plugin-bibtex-citation's Issues

Question: how to configure the path to literature.bib

I trided several contribution but always ended with this error
Any hint ?

GitBook Community in Google+

Hi manuelmitasch,

I am Aleen (https://github.com/aleen42) , and the founder of GitBook Community in Google+: https://plus.google.com/communities/110696788983472771007, which aims to sharing books or plugins of GitBook, talking anything about it as well. Here I am sincerely inviting you to join us. 👊

Bibliography in a separated file

Since pages are parsed alphabetically, citation numbers are attached to bibliography items page by page. As a consequence, if the bibliography file is the first file to be processed (e.g. if it is called bibliography.md), the table of references will be empty (only used items are shown). As a workaround bibliography.md could be renamed zbibliography.md, but it would be nice to avoid this dirty hack.

Can't get it working

I'm on gitbook 2.6.7 and can't get bibtex plugin working:

bibtex.md:

# BibTeX

See here: {{ "test" | cite }}

References:

{% references %} {% endreferences %}

literature.bib:

@article{test,
    title = {Test title},
    volume = {82},
    url = {http://my.url},
    doi = {10.1103/doi},
    number = {5},
    urldate = {2012-01-13},
    journal = {My journal},
    author = {Me and You},
    month = nov,
    year = {2010},
    pages = {05901},
}

$ gitbook build ./ --log=debug --debug
Template render error: (/home/boris/gitb/bibtex.md)
  TypeError: Cannot read property 'toUpperCase' of undefined (In file 'bibtex.md')
Template render error: (/home/boris/gitb/bibtex.md)
  TypeError: Cannot read property 'toUpperCase' of undefined
    at Object.exports.prettifyError (/home/boris/.gitbook/versions/2.6.7/node_modules/nunjucks/src/lib.js:34:15)
    at /home/boris/.gitbook/versions/2.6.7/node_modules/nunjucks/src/environment.js:485:31
    at eval (eval at <anonymous> (/home/boris/.gitbook/versions/2.6.7/node_modules/nunjucks/src/environment.js:564:24), <anonymous>:10:11)
    at /home/boris/.gitbook/versions/2.6.7/node_modules/q/q.js:1891:17
    at flush (/home/boris/.gitbook/versions/2.6.7/node_modules/q/q.js:108:17)
    at _combinedTickCallback (node.js:370:9)
    at process._tickCallback (node.js:401:11)

?

Only works when keys are cited in top level pages

If I have a something like

chap_1.md
  - chap_1_part2.md

The references in chap_1_part2.md are not printed