Document BibTeX to JSON conversion

[larsga]

Thank you for making this tool! It's made dealing with citations in LaTeX far easier.

The hardest part about using it, however, is figuring out what the BibTeX input turns into in the CSL model. Documentation of that would be great, but, failing that, the BibTeX to JSON conversion is a very useful substitute. But I had to read the source code to figure out that the option was there.

How about adding a flag to citeproc-lua so that citeproc-lua --help shows the option? Or even just documenting it on Github?

[zepinglee]

The mapping between BibTeX database to CSL-JSON is described in bib-csl-mapping.md. I thought it was too long to be put in the PDF manual.

How about adding a flag to citeproc-lua so that citeproc-lua --help shows the option? Or even just documenting it on Github?

What kind of "option" are you referring to? An option like --show-mapping that prints the contents of bib-csl-mapping.md?

[larsga]

I see. I never found that file, but that's very good to have. Maybe you should link to it from the top page?

What kind of "option" are you referring to?

In the command-line tool you have this option to convert the BibTeX to JSON. I found that very useful for seeing how my BibTeX was interpreted, but it's quite tricky for the user to discover that it exists. So maybe document it more clearly?