diff options
| -rw-r--r-- | README.md | 38 | ||||
| -rw-r--r-- | debian/changelog | 22 | ||||
| -rw-r--r-- | debian/control | 22 | ||||
| -rw-r--r-- | debian/tests/control | 2 | ||||
| -rw-r--r-- | pandoc-citeproc-preamble.1.pod | 31 | ||||
| -rw-r--r-- | pandoc-citeproc-preamble.cabal | 6 | ||||
| -rw-r--r-- | src/pandoc-citeproc-preamble.hs | 5 | ||||
| -rwxr-xr-x | test/test | 2 |
8 files changed, 67 insertions, 61 deletions
@@ -2,16 +2,13 @@ ## Synopsis -pandoc-citeproc-preamble is a JSON filter for [Pandoc][] which -inserts a preamble before the output that the [pandoc-citeproc][] -filter appends to the document. This preamble might include a heading -(e.g. "Bibliography") and raw markup to format the bibliography for -the output format. +pandoc-citeproc-preamble is a JSON filter for [Pandoc][] which inserts a +preamble before the output that Pandoc's citeproc filter appends to the +document. This preamble might include a heading (e.g. "Bibliography") and raw +markup to format the bibliography for the output format. [Pandoc]: http://pandoc.org/ "Pandoc home page" -[pandoc-citeproc]: http://hackage.haskell.org/package/pandoc-citeproc - ## Installation Users of Debian 10 or later or Ubuntu 17.04 or later: `apt-get install @@ -34,10 +31,9 @@ If you are not a Haskell programmer, you might find it easier to ## Usage -Add `--filter pandoc-citeproc-preamble` somewhere after `--filter -pandoc-citeproc`, e.g. +Add `--filter pandoc-citeproc-preamble` somewhere after `--citeproc`, e.g. - $ pandoc -s --filter pandoc-citeproc --bibliography=~/doc/mine.bib --filter pandoc-citeproc-preamble ~/doc/my_essay.mdwn -o ~/my_essay.pdf + $ pandoc -s --citeproc --bibliography=~/doc/mine.bib --filter pandoc-citeproc-preamble ~/doc/my_essay.mdwn -o ~/my_essay.pdf In this case, since the output format is LaTeX, pandoc-citeproc-preamble will look for the preamble in the file @@ -67,18 +63,16 @@ agnostic with regard to the output format they will eventually be compiled to: it should not be necessary to include in one's input file, for example, LaTeX code to format the bibliography. -When compiling to PDF (which is probably the most common case for -users of pandoc-citeproc), formatting code is usually required to have -the entries of pandoc-citeproc's bibliography line up with each other; -by default, all entries except the first will be indented. Another -common customisation is to set up a [hanging indent][] for bibliography -entries. - -Since pandoc-citeproc doesn't provide any facility to add formatting -control code to its output, pandoc-citeproc-preamble is necessary to -avoid the user being forced to add their control code to the end of -their input files, thereby losing the input file's agnosticity with -regard to output format. +When compiling to PDF (which is probably the most common case for users of +Pandoc's citeproc filter), formatting code is usually required to have the +entries of Pandoc's bibliography line up with each other; by default, all +entries except the first will be indented. Another common customisation is to +set up a [hanging indent][] for bibliography entries. + +Since Pandoc's citeproc filter doesn't provide any facility to add formatting +control code to its output, pandoc-citeproc-preamble is necessary to avoid the +user being forced to add their control code to the end of their input files, +thereby losing the input file's agnosticity with regard to output format. [hanging indent]: http://www.computerhope.com/jargon/h/hanginde.htm "description of hanging indent" diff --git a/debian/changelog b/debian/changelog index 69377f8..ae4dd8a 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,10 +1,28 @@ -pandoc-citeproc-preamble (1.6-1) UNRELEASED; urgency=medium +pandoc-citeproc-preamble (1.7-2) unstable; urgency=medium + + * Rebuild against newer Pandoc. + + -- Sean Whitton <spwhitton@spwhitton.name> Thu, 21 Mar 2024 19:13:55 +0800 + +pandoc-citeproc-preamble (1.7-1) unstable; urgency=medium + + * Replace references to pandoc-citeproc. + We now say "Pandoc's citeproc filter", "Pandoc's bibliography", etc.. + * Replace '--filter pandoc-citeproc' -> '--citeproc' (Closes: #1017256). + * Drop build-dep and autopkgtest dep on pandoc-citeproc. + + * Update homepage in pandoc-citeproc-preamble.cabal. + * Fix a manpage typo. + + -- Sean Whitton <spwhitton@spwhitton.name> Sun, 21 Aug 2022 14:36:30 -0700 + +pandoc-citeproc-preamble (1.6-1) unstable; urgency=medium * Drop mistaken Tests: field from d/tests/control. * Fix test/test to use /usr/bin/pandoc-citeproc-preamble when AUTOPKGTEST_TMP is set. - -- Sean Whitton <spwhitton@spwhitton.name> Sun, 26 Jul 2020 14:41:21 -0700 + -- Sean Whitton <spwhitton@spwhitton.name> Sun, 26 Jul 2020 14:50:55 -0700 pandoc-citeproc-preamble (1.5-1) unstable; urgency=medium diff --git a/debian/control b/debian/control index fdae29e..aa9e60e 100644 --- a/debian/control +++ b/debian/control @@ -8,7 +8,6 @@ Build-Depends: debhelper (>= 10), libghc-text-conversions-dev, libghc-pandoc-types-dev (>= 1.20), pandoc <!nocheck>, - pandoc-citeproc <!nocheck>, Standards-Version: 4.4.1 Homepage: https://spwhitton.name/tech/code/pandoc-citeproc-preamble/ Vcs-Git: https://git.spwhitton.name/pandoc-citeproc-preamble @@ -20,15 +19,14 @@ Depends: ${shlibs:Depends}, ${misc:Depends}, ${haskell:Depends}, Recommends: pandoc-citeproc -Description: insert a preamble before pandoc-citeproc's bibliography - pandoc-citeproc-preamble is a JSON filter for Pandoc which inserts a - preamble before the output that the pandoc-citeproc filter appends to - the document. This preamble might include a heading - (e.g. "Bibliography") and raw markup to format the bibliography for - the output format. +Description: insert a preamble before Pandoc's bibliography + pandoc-citeproc-preamble is a JSON filter for Pandoc which inserts a preamble + before the output that Pandoc's citeproc filter appends to the document. This + preamble might include a heading (e.g. "Bibliography") and raw markup to + format the bibliography for the output format. . - Since pandoc-citeproc doesn't provide any facility to add formatting - control code to its output, pandoc-citeproc-preamble is necessary to - avoid the user being forced to add their control code to the end of - their input files, thereby losing the input file's agnosticity with - regard to output format. + Since Pandoc's citeproc filter doesn't provide any facility to add formatting + control code to its output, pandoc-citeproc-preamble is necessary to avoid + the user being forced to add their control code to the end of their input + files, thereby losing the input file's agnosticity with regard to output + format. diff --git a/debian/tests/control b/debian/tests/control index c8f286d..be59a79 100644 --- a/debian/tests/control +++ b/debian/tests/control @@ -1,4 +1,4 @@ Test-Command: test/test Restrictions: rw-build-tree # ^ produces test/output.tex -Depends: @, pandoc, pandoc-citeproc +Depends: @, pandoc diff --git a/pandoc-citeproc-preamble.1.pod b/pandoc-citeproc-preamble.1.pod index 521988e..3b42d2c 100644 --- a/pandoc-citeproc-preamble.1.pod +++ b/pandoc-citeproc-preamble.1.pod @@ -1,6 +1,6 @@ =head1 NAME -pandoc-citeproc-preamble - insert a preamble before pandoc-citeproc's bibliography +pandoc-citeproc-preamble - insert a preamble before Pandoc's bibliography =head1 SYNOPSIS @@ -8,20 +8,18 @@ B<pandoc-citeproc-preamble> =head1 DESCRIPTION -B<pandoc-citeproc-preamble> is a JSON filter for pandoc(1) which -inserts a preamble before the output that the pandoc-citeproc(1) -filter appends to the document. This preamble might include a heading -(e.g. "Bibliography") and/or raw markup to format the bibliography for -the output format. +B<pandoc-citeproc-preamble> is a JSON filter for pandoc(1) which inserts a +preamble before the output that Pandoc's citeproc filter appends to the +document. This preamble might include a heading (e.g. "Bibliography") and/or +raw markup to format the bibliography for the output format. =head1 USAGE -Add B<--filter pandoc-citeproc-preamble> somewhere after B<--filter -pandoc-citeproc>, e.g. +Add B<--filter pandoc-citeproc-preamble> somewhere after B<--citeproc>, e.g. =over 4 - % pandoc -s --filter pandoc-citeproc --bibliography=~/doc/mine.bib \ + % pandoc -s --citeproc --bibliography=~/doc/mine.bib \ --filter pandoc-citeproc-preamble \ ~/doc/my_essay.mdwn -o ~/my_essay.pdf @@ -42,7 +40,7 @@ To override this, you can set document metadata like this: =over 4 - % pandoc ... --filter pandoc-citeprocpreamble \ + % pandoc ... --filter pandoc-citeproc-preamble \ -M citeproc-preamble=~/mypreamble.tex ... =back @@ -55,13 +53,12 @@ eventually be compiled. For example, it should not be necessary to include LaTeX code in one's input file in order to format the bibliography. The input file might also be compiled to HTML. -However, when compiling to PDF, formatting code is usually required in -order to have the entries of pandoc-citeproc's bibliography line up -with each other; by default, all entries except the first will be -indented. Another common customisation is to set up a hanging indent -for bibliography entries. +However, when compiling to PDF, formatting code is usually required in order +to have the entries of Pandoc's bibliography line up with each other; by +default, all entries except the first will be indented. Another common +customisation is to set up a hanging indent for bibliography entries. -Since pandoc-citeproc(1) doesn't provide any facility to add +Since Pandoc's citeproc filter doesn't provide any facility to add formatting control code to its output, B<pandoc-citeproc-preamble> is necessary to avoid the user being forced to add their control code to the end of their input files, thereby losing the input file's @@ -73,4 +70,4 @@ Sean Whitton <spwhitton@spwhitton.name> =head1 SEE ALSO -pandoc(1), pandoc-citeproc(1) +pandoc(1) diff --git a/pandoc-citeproc-preamble.cabal b/pandoc-citeproc-preamble.cabal index e3f2344..37224ca 100644 --- a/pandoc-citeproc-preamble.cabal +++ b/pandoc-citeproc-preamble.cabal @@ -1,8 +1,8 @@ name: pandoc-citeproc-preamble -version: 1.5 -synopsis: Insert a preamble before pandoc-citeproc's bibliography +version: 1.7 +synopsis: Insert a preamble before Pandoc's bibliography description: Please see README.md -homepage: https://github.com/spwhitton/pandoc-citeproc-preamble +homepage: https://spwhitton.name/tech/code/pandoc-citeproc-preamble/ license: GPL-3 license-file: LICENSE author: Sean Whitton diff --git a/src/pandoc-citeproc-preamble.hs b/src/pandoc-citeproc-preamble.hs index 4716e4a..94c68af 100644 --- a/src/pandoc-citeproc-preamble.hs +++ b/src/pandoc-citeproc-preamble.hs @@ -1,6 +1,6 @@ {- - pandoc-citeproc-preamble --- Insert a preamble before pandoc-citeproc's bibliography + pandoc-citeproc-preamble --- Insert a preamble before Pandoc's bibliography Copyright (C) 2015-2016, 2019 Sean Whitton @@ -34,8 +34,7 @@ insertPreamble :: Block -> [Block] -> [Block] insertPreamble preamble = foldr step [] where step refsDiv@(Div ("refs", _, _) theRefs) xs = - -- check whether pandoc-citeproc actually inserted any - -- references + -- check whether Pandoc actually inserted any references if null theRefs then refsDiv : xs else preamble : refsDiv : xs @@ -35,7 +35,7 @@ die "need to build before testing\n" unless -x $pcp; unlink $output if -e $output; print "testing with " . (`pandoc --version`)[0]; -system "pandoc -s --filter pandoc-citeproc --bibliography=test.bib" +system "pandoc -s --citeproc --bibliography=test.bib" . " --filter $pcp -M citeproc-preamble=../examples/default.latex" . " test.mdwn -f markdown -o $output"; |