.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "PANDOC-CITEPROC-PREAMBLE.1 1"
.TH PANDOC-CITEPROC-PREAMBLE.1 1 "2019-01-28" "perl v5.28.1" "User Commands"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
pandoc\-citeproc\-preamble \- insert a preamble before pandoc\-citeproc's bibliography
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBpandoc-citeproc-preamble\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBpandoc-citeproc-preamble\fR is a \s-1JSON\s0 filter for \fBpandoc\fR\|(1) which
inserts a preamble before the output that the \fBpandoc\-citeproc\fR\|(1)
filter appends to the document.  This preamble might include a heading
(e.g. \*(L"Bibliography\*(R") and/or raw markup to format the bibliography for
the output format.
.SH "USAGE"
.IX Header "USAGE"
Add \fB\-\-filter pandoc-citeproc-preamble\fR somewhere after \fB\-\-filter
pandoc-citeproc\fR, e.g.
.Sp
.Vb 3
\&    % pandoc \-s \-\-filter pandoc\-citeproc \-\-bibliography=~/doc/mine.bib \e
\&        \-\-filter pandoc\-citeproc\-preamble \e
\&        ~/doc/my_essay.mdwn \-o ~/my_essay.pdf
.Ve
.SH "FILES"
.IX Header "FILES"
.IP "~/.pandoc/citeproc\-preamble/default.\fI\s-1FORMAT\s0\fR" 4
.IX Item "~/.pandoc/citeproc-preamble/default.FORMAT"
Default citeproc preamble for Pandoc output format \fI\s-1FORMAT\s0\fR
(e.g. \*(L"latex\*(R").
.PP
To override this, you can set document metadata like this:
.Sp
.Vb 2
\&    % pandoc ... \-\-filter pandoc\-citeprocpreamble \e
\&        \-M citeproc\-preamble=~/mypreamble.tex ...
.Ve
.SH "RATIONALE"
.IX Header "RATIONALE"
One motivation for authoring with Pandoc is that one's input files are
agnostic with regard to the output format to which they will
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 \s-1HTML.\s0
.PP
However, when compiling to \s-1PDF,\s0 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.
.PP
Since \fBpandoc\-citeproc\fR\|(1) doesn't provide any facility to add
formatting control code to its output, \fBpandoc-citeproc-preamble\fR 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.
.SH "AUTHOR"
.IX Header "AUTHOR"
Sean Whitton <spwhitton@spwhitton.name>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBpandoc\fR\|(1), \fBpandoc\-citeproc\fR\|(1)