Skip to content

Latest commit

 

History

History
144 lines (101 loc) · 4.9 KB

README.md

File metadata and controls

144 lines (101 loc) · 4.9 KB
Raw

pandoc-zotxt.lua

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

Requirements

pandoc-zotxt.lua requires

It should work under every operating system supported by Pandoc; but it has not been tested under Windows.

Your version of Pandoc must also support Lua ≥ v5.3. Pandoc ≥ v2 does so by default. However, the Pandoc package provided by your operating system vendor may use an older version. Notably, the version of Pandoc available in the package repository of Debian v10 ("Buster") only supports Lua v5.1.

Installation

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

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

If you are running a POSIX-compliant operating system (e.g., *BSD, Linux, or macOS) and have curl or wget, then you can install pandoc-zotxt.lua by copy-pasting the following commands into a Bourne-compatible shell:

( set -eu
  : "${HOME:?}" "${XDG_DATA_HOME:="$HOME/.local/share"}"
  name=pandoc-zotxt.lua vers=1.2.0
  url="https://github.com/odkr/$name/releases/download/v$vers/$name-$vers.tgz"
  for data_dir in "$HOME/.pandoc" "$XDG_DATA_HOME/pandoc"; do
    [ -d "$data_dir" ] && break
  done
  filters_dir="$data_dir/filters"
  mkdir -p "$filters_dir" && cd -P "$filters_dir" || exit 69
  { curl --silent --show-error --location "$url" || err=$?
    [ "${err-0}" -eq 127 ] && wget --output-document=- "$url"
  } | tar -xz && ln -fs "$name" "$name-$vers/$name" .; )

If you want to use the manual page that ships with this release, add <Pandoc data directory>/filters/pandoc-zotxt.lua-1.2.0/man to your MANPATH.

Documentation

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

Contact

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

Testing

Requirements

  1. A POSIX-compliant operating system.
  2. Pandoc ≥ v2.
  3. GNU Make.

The test suite has been tested with Pandoc v2.9 to v2.17.1.1.

Running the tests

Simply say:

    make

Note, some tests report errors even if they succeed. Not every error message indicates that pandoc-zotxt.lua failed a test. If it does fail a test, make will exit with a non-zero status.

The real-world test suite

By default, the test suite neither connects to the Zotero desktop client nor to the Zotero Web API, but but uses canned responses. You can force the test suite to connect to the Zotero desktop client and the Web API respectively by:

    make test -e FILTER=./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). You will also need to adapt the Zotero item IDs used in test cases to your Zotero library.

License

Copyright 2018–2022 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