Currently, references appear in the text as the key used in the bibtex file. It would be nice to have citation styles like [1] or Author [et al] 2023.

Not sure if using handlebars templates here too is the best, or to just provide a few hard-coded common styles.

Would it be an option to provide a default reference formatting style like the one we currently have, and in addition allow for a custom .hbs file in the configuration?

This way, there is no need to focus on a one-fits-all style. Default to something familiar and convenient (like the current style), and possibly provide .hbs files of common stlyes for download.

When citing in a file that is in a sub-directory of the book sources, the same sub-directory is assumed for the linked bibliography.html file, while the file is actually not in that directory.

Example project struture:

root
  |-- src
  |     |-- chapter-1
  |     |     `-- section-1-1.md
  |     |-- bibliography.bib
  |     `-- SUMMARY.md
  `-- book.toml

When citing in section-1-1.md, citations link to chapter-1/bibliography.bib, but should link to bibliography.bib only.

Currently, the entire bibliography is listed on the Refs page. The expected behaviour (as compared to most reference management software) would be to show only what was actually cited.

The behaviour could be configurable, e.g. with render-bib=[all,cited], with the latter as default.

The current rendering of the references does not allow C&P of the citation key due to popup on hover.
Personally, I find the popup behaviour with motion in the following references a bit distracting.

Maybe it could be a solution to not show the citation key, but to provide a small link that copies it to the clipboard? Or to include the key in the details tags so it opens only on click?

An optional config argument to use an alternative title for the bib chapter, e.g. References.

Do it only if the url exists

See https://github.com/mlange-42/yarner-bib

e.g. alphabetical, numbered, etc...

Hi @francisco-perez-sorrosal,

while thinking about a bibtex reference preprocessor for mdBook as a next hobby project, I stumbled upon your brand new repository. Instead of starting a competing project, I would like to ask whether you welcome contributions?

A few ideas for features/possible contributions:

• Render only the cited items in the bibliography. I.e. when using your all-in-one bib file with a four-digit number of entries, only show what was actually used in the text. I would probably start with a PR on that.
• An option for per-chapter bibliographies, e.g. for edited books with multiple authors/essays
• Bibliography and in-line citation styles (syntax like/close to/subset of LaTeX EDIT: or through a custom .hbs file)
  • Incl. sorting of the bibliography, e.g. by first author or by citation order

I have only a few months of (however, fairly intensive) Rust experience. You may want to assess by a look into my Rust repositories.

Thanks for starting this very useful project!
Regards!

Prevent README.md grow too much. Leave only essential basic stuff in README.md and move everything else to a new markdown file or github pages.

Then pass it to the functions that require it.

Not sure if this was intentional, but the latest release has tag master. So this will not be published to crates.io.

Can we have a release v0.0.5 (incl. the resp. entry in Cargo.toml)? Or meybe even go for v0.1.0?

It would be nice to have a list of citations only for the specific page, and have them all listed say at the bottom of the page.

Can we release binaries for the 0.3.0 version, so they can be downloaded by CI scripts to save the effort of building them using Cargo?

We could change the trigger in release.yaml to release creation:

on:
  release:
    types: [ created ]

I want to adjust reference style for my mdbook, But I'm having a little trouble with author names. I tried the default approach by downloading references.hbs, adding it to my src folder and then adding hb-tpl = "references.hbs" to the TOML file as per the manual's instructions. Compilation is fine, but the resulting bibliography is missing the list of authors.

In the HTML I get:

<summary class=citation>
<a id="Knuth1974">[Knuth1974]</a> -  - <a href="http://portal.acm.org/citation.cfm?doid&#x3D;361604.361612" target="_blank"><cite>Computer programming as an art</cite></a>. - 1974. -
<button onclick="copyToClipboard('\{\{ #cite Knuth1974 \}\}')">Copy citation_key</button>
</summary>

instead of the expected (and default behavior if no hb-tpl is set in the TOML):

<summary class=citation>
<a id="Knuth1974">[Knuth1974]</a> - Knuth, Donald E. - <a href="http://portal.acm.org/citation.cfm?doid&#x3D;361604.361612" target="_blank"><cite>Computer programming as an art</cite></a>. - 1974. -
<button onclick="copyToClipboard('\{\{ #cite Knuth1974 \}\}')">Copy citation_key</button>
</summary>

Up to now the two options added zotero_user_id and render-bib do not follow a common pattern for the word separators. We should consolidate this, either using _ or -.

https://github.com/francisco-perez-sorrosal/mdbook-bib/blob/34f3588e51da45f8a4f528f4095b1c28858440d4/src/lib.rs#L319C25-L319C25

I have an author with "and" in their name, notably, Christopher Alexander, but I imagine anyone with an and in their name will suffer the same split personality fate.

Describe the main features there, as for example, the Zotero feature is not there.

after installation of mdbook-bib, I have encountered fatal runtime error: stack overflow when trying to build mdbook.

bib file is an example as show below
@book{DUMMY:1,
AUTHOR = "John Doe",
TITLE = "The Book without Title",
PUBLISHER = "Dummy Publisher",
YEAR = "2100",
}

in the markdown.md file, I just include the @@dummy:1 string but a fatal error is shown, please kindly help.

➜ docs git:(main) ✗ cargo install mdbook-bib

Updating crates.io index
 Ignored package `mdbook-bib v0.0.4` is already installed, use --force to override

➜ docs git:(main) ✗ mdbook build
2022-07-21 19:19:16 [INFO] (mdbook::book): Book building has started
Warning: The bib plugin was built against version 0.4.20 of mdbook, but we're being called from version 0.4.18
2022-07-21 19:19:16 [INFO] (mdbook_bib): Processor Name: bib
2022-07-21 19:19:16 [INFO] (mdbook_bib::config): Using default HB template...
2022-07-21 19:19:16 [INFO] (mdbook_bib::config): Using default CSS template...
2022-07-21 19:19:16 [INFO] (mdbook_bib::config): Using default JS template...
2022-07-21 19:19:16 [INFO] (mdbook_bib): Bibliography file: biblio.bib
2022-07-21 19:19:16 [INFO] (mdbook_bib): Bibliography path: /Users/mac/Repo/waxctech.github.io/docs/src/biblio.bib
2022-07-21 19:19:16 [INFO] (mdbook_bib): Loading bibliography from "/Users/mac/Repo/waxctech.github.io/docs/src/biblio.bib"...
2022-07-21 19:19:16 [INFO] (mdbook_bib): Building bibliography...

thread 'main' has overflowed its stack
fatal runtime error: stack overflow
2022-07-21 19:19:16 [ERROR] (mdbook::utils): Error: The "bib" preprocessor exited unsuccessfully with signal: 6 status
➜ docs git:(main) ✗

Currently, only the date field of bibliography entries is considered. If the field is missing, year and month should also be parsed.

Add javascript code to allow copying to the clipboard the {{#cite <citation_key>}} from the Bibliography entries to quickly add it into the book contents. This is useful when writing the markdown of a book while rendering and seeing the output in a browser.

Explore these:

https://github.com/github-changelog-generator/github-changelog-generator
and its corresponding github action https://github.com/marketplace/actions/generate-changelog

https://github.com/typst/biblatex

Problem

When you cite a publication in a file that is not in the root src directory but rather in a subdirectory, the generated link to the Bibliography page contains the path to the subdirectory and thus does not work.

Possible Solutions

• Get current path and generate the relative path to the Bibliography page correctly (probably the best solution)
• Add a Bibliography page to each subdirectory with citations (probably not desired)

If you can't work on this issue, but are willing to accept a PR, I will do my best to provide one when I find the time.

Thanks for the plugin!

Provide downloadable binaries for Linux, Windows and MacOS, for those not using cargo.