pandoc-zotxt.lua

pandoc-zotxt.lua looks up sources of citations in Zotero and adds them either to a document's references metadata field or to a bibliography file, where Pandoc can pick them up. See the manual for more details.

Requirements

pandoc-zotxt.lua requires Pandoc v2.0 or later, Zotero, and zotxt. It should work under any POSIX-compliant operating system (e.g., Linux, macOS, FreeBSD, OpenBSD, NetBSD) as well as under Windows. It has not been tested under Windows, however.

Installation

You use pandoc-zotxt.lua at your own risk.

1. Download the latest release.
2. Unpack the repository.
3. Move it to the filters sub-directory of your Pandoc data directory
   (pandoc --version tells you where that is).
4. Move the file pandoc-zotxt.lua from the repository directory up into the filters directory.

If you are using a POSIX-compliant system and have curl or wget, you can install pandoc-zotxt.lua by copy-pasting the following commands into a bourne shell:

( set -Cefu
  NAME=pandoc-zotxt.lua VERS=1.0.0
  URL="https://github.com/odkr/${NAME:?}/archive/v${VERS:?}.tar.gz"
  FILTERS="${HOME:?}/.pandoc/filters"
  mkdir -p "${FILTERS:?}"
  cd -P "$FILTERS" || exit
  { curl -L "$URL" || ERR=$?
    [ "${ERR-0}" -eq 127 ] && wget -O - "$URL"; } | tar xz
  mv "$NAME-$VERS/pandoc-zotxt.lua" .; )

You may also want to copy the manual page from the man directory in the repository to wherever your operating system searches for manual pages (e.g., /usr/local/share/man/man1, /usr/share/man/man1).

Documentation

See the manual, the source code documentation, and the source code itself for details.

Testing

Requirements

1. A POSIX-compliant operating system.
2. Pandoc v2.7.2.
3. pandoc-citeproc v0.16.1.3 (for Pandoc prior to v2.11).

The test suite may or may not work with other versions of Pandoc and pandoc-citeproc.

Assumptions

You are using the default Citation Style Language stylesheet that ships with Pandoc (or pandoc-citeproc respectivey), namely, chicago-author-date.csl.

Running the tests

Simply say:

    make test

The real-world test suite

By default, the test suite doesn't connect to a Zotero instance, but uses canned responses. You can force the test suite to connect to a local Zotero database by:

    make test -e SCRIPT=./pandoc-zotxt.lua

Note, you will have to adapt the test suite to your database (or vice versa; you can import the references used in the test suite from tests/items.rdf).

Moreover, you will need:

• Zotero (v5 or newer)
• zotxt (v5 or newer)
• Better BibTex for Zotero

Contact

If there's something wrong with pandoc-zotxt.lua, open an issue.

License

Copyright 2018, 2019, 2020 Odin Kroeger

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Further Information

GitHub: https://github.com/odkr/pandoc-zotxt.lua