Rename filter to "multibib"

Author: tarleb

Makefile

@@ -1,13 +1,18 @@
-DIFF ?= diff
+# Name of the filter file, *with* `.lua` file extension.
+FILTER_FILE := $(wildcard *.lua)
+
+# Allow to use a different pandoc binary, e.g. when testing.
 PANDOC ?= pandoc
+# Allow to adjust the diff command if necessary
+DIFF = diff
 
 # Use special expected output file if it exists.
 expected_output = test/expected.$(PANDOC_VERSION).txt
 ifeq ($(wildcard $(expected_output)),)
 expected_output = test/expected.txt
 endif
 
-test: test/input.md multiple-bibliographies.lua
+test: test/input.md $(FILTER_FILE)
 	@$(PANDOC) -d test/test.yaml \
 	    | $(DIFF) $(expected_output) -
 

README.md

@@ -1,11 +1,14 @@
-# multiple-bibliographies
+# multibib
+
+[![GitHub build status][CI badge]][CI workflow]
 
 This filter allows to create multiple bibliographies using
 `citeproc`. The content of each bibliography is controlled via
 YAML values and the file in which a bibliographic entry is
 specified.
 
-## Usage
+[CI badge]: https://img.shields.io/github/workflow/status/pandoc-ext/multibib/CI?logo=github
+[CI workflow]: https://github.com/pandoc-ext/multibib/actions/workflows/ci.yaml
 
 The bibliographies must be defined in a map below the
 `bibliography` key in the document's metadata. E.g.
@@ -35,3 +38,53 @@ The placement of bibliographies is controlled via special divs.
 Each refs-*x* div should have a matching entry *x* in the
 metadata. These divs are filled with citations from the respective
 bib-file.
+
+
+Usage
+------------------------------------------------------------------
+
+The filter modifies the internal document representation; it can
+be used with many publishing systems that are based on pandoc.
+
+### Plain pandoc
+
+Pass the filter to pandoc via the `--lua-filter` (or `-L`) command
+line option.
+
+    pandoc --lua-filter multibib.lua ...
+
+### Quarto
+
+Users of Quarto can install this filter as an extension with
+
+    quarto install extension pandoc-ext/multibib
+
+and use it by adding `multibib` to the `filters` entry
+in their YAML header.
+
+``` yaml
+---
+filters:
+  - multibib
+---
+```
+
+### R Markdown
+
+Use `pandoc_args` to invoke the filter. See the [R Markdown
+Cookbook](https://bookdown.org/yihui/rmarkdown-cookbook/lua-filters.html)
+for details.
+
+``` yaml
+---
+output:
+  word_document:
+    pandoc_args: ['--lua-filter=multibib.lua']
+---
+```
+
+License
+------------------------------------------------------------------
+
+This pandoc Lua filter is published under the MIT license, see
+file `LICENSE` for details.

multiple-bibliographies.lua renamed to multibib.lua

@@ -1,5 +1,5 @@
 --[[
-multiple-bibliographies – create multiple bibliographies
+multibib – create multiple bibliographies
 
 Copyright © 2018-2022 Albert Krewinkel
 

test/test.yaml

@@ -2,4 +2,4 @@ input-files: ['test/input.md']
 to: plain
 standalone: true
 filters:
-  - multiple-bibliographies.lua
+  - multibib.lua