summaryrefslogtreecommitdiff
path: root/biblio/citation-style-language/citation-style-language-doc.tex
blob: b93678a0515c43c4eea20c045ecb4748943a8a3b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
%
% Copyright (c) 2021-2024 Zeping Lee
% Released under the MIT License.
% Repository: https://github.com/zepinglee/citeproc-lua
%

\documentclass{l3doc}

\usepackage{mathpazo}
\usepackage{helvet}
\usepackage{listings}

\NewDocumentCommand\opt{m}{\texttt{#1}}

\lstnewenvironment{LaTeXdemo}{
  \lstset{
    basicstyle = \ttfamily\small,
    basewidth  = 0.51em,
    frame      = single,
    gobble     = 2,
    language   = [LaTeX]TeX,
  }
}{}

\lstnewenvironment{bash}{
  \lstset{
    basicstyle = \ttfamily\small,
    basewidth  = 0.51em,
    % gobble     = 2,
    language   = bash,
  }
}{}

% \hypersetup{hidelinks}
% \urlstyle{same}

\begin{document}

\title{%
  Bibliography formatting with \pkg{citation-style-language}
}

\author{%
  Zeping Lee%
  \thanks{%
    E-mail:
    \href{mailto:zepinglee@gmail.com}
      {zepinglee@gmail.com}%
  }%
}

\date{2024-04-21 v0.4.9}

\maketitle

% \begin{abstract}
%   Foo
% \end{abstract}

\begin{documentation}

\section{Introduction}

The Citation Style Language\footnote{\url{https://citationstyles.org/}} (CSL)
is an XML-based language that defines the formats of citations and bibliography.
There are currently thousands of styles in CSL including the most widely used
APA, Chicago, Vancouver, etc.
The \pkg{citation-style-language} package is aimed to provide another reference formatting method
for LaTeX that utilizes the CSL styles.
It contains a citation processor implemented in pure Lua (\pkg{citeproc-lua})
which reads bibliographic metadata and performs sorting and formatting on both
citations and bibliography according to the selected CSL style.
A LaTeX package (\file{citation-style-language.sty}) is provided to communicate with the processor.

Note that this project is in early development stage and some features of CSL
are not implemented yet.
Comments, suggestions, and bug reports are welcome.


\section{Installation}

This package is available from TeX Live 2022 or later versions.
For most users, the easiest way is to install it via |tlmgr|.
If you want to install the GitHub develop version of this package,
you may follow the steps below.

The \pkg{citation-style-language} requires the following packages:
\pkg{filehook}, \pkg{l3kernel}, \pkg{l3packages}, \pkg{lua-uca}, \pkg{lualibs},
\pkg{luatex}, \pkg{luaxml}, and \pkg{url}.
\pkg{l3build} is also required for actually performing the installation.
Make sure they are already installed in the TeX distribution.

\begin{bash}
  git clone https://github.com/zepinglee/citeproc-lua  # Clone the repository
  cd citeproc-lua
  git submodule update --init --remote                 # Fetch submodules
  l3build install
\end{bash}

These commands install the package files to |TEXMFHOME| which is usually
|~/texmf| on Linux or |~/Library/texmf| on macOS.
Besides, the |citeproc-lua| executable needs to be copied to some directory in
the |PATH| environmental variable so that it can be called directly in the shell.
For example provided |~/bin| is in |PATH|:

\begin{bash}
  cp citeproc/citeproc-lua.lua "~/bin/citeproc-lua"
\end{bash}

To uninstall the package from |TEXMFHOME|, just run |l3build uninstall|.

\section{Getting started}

An example of using \pkg{citation-style-language} package is as follows.

\begin{LaTeXdemo}
  \documentclass{...}
  \usepackage{citation-style-language}
  \cslsetup{
    style = ...,
    ...
  }
  \addbibresource{bibfile.json}
  \begin{document}
  \cite{...}
  ...
  \printbibliography
  \end{document}
\end{LaTeXdemo}

The procedure to compile the document is different across engines.

\paragraph{LuaTeX}

The CSL processor is written in Lua and it can be run directly in LuaTeX
without the need of running external programs.
For LuaTeX, the compiling procedure is simply running \file{latex} twice,
which is the same as documents with cross references.

\paragraph{Other engines}

For engines other than LuaTeX, the \file{citeproc-lua} executable is required
to run on the \file{.aux} file to generate the citations and bibliography.
The general procedure is similar to the traditional BibTeX workflow.
\begin{enumerate}
  \item Run \file{latex} on \file{example.tex}.
  \item Run \file{citeproc-lua} on \file{example.aux}.
    The engine reads the \file{.csl} style, CSL locale files, and
    \file{.bib} database and then writes the processed citations and
      bibliography to \file{example.bbl}.
  \item Run \file{latex} on \file{example.tex}.
    The \file{.bbl} file is loaded and all the citations and bibliography
    are printed.
\end{enumerate}



\section{Package commands}

\begin{function}{\cslsetup}
  \begin{syntax}
    \cs{cslsetup}\marg{options}
  \end{syntax}
\end{function}

Package options may be set when the package is loaded or at any later stage
with the \cs{cslsetup} command.
These two methods are equivalent.
\begin{LaTeXdemo}
  \usepackage[style = apa]{citation-style-langugage}
  % OR
  \usepackage{citation-style-langugage}
  \cslsetup{style = apa}
\end{LaTeXdemo}

\DescribeOption{style}
The \opt{style=}\meta{style-id} option selects the style file
\meta{style-id}\file{.csl} for both citations and bibliography.
The implemented CSL style files are available in the official GitHub
repository\footnote{\url{https://github.com/citation-style-language/styles}}
as well as the Zotero style
repository\footnote{\url{https://www.zotero.org/styles}}.
The user may search and download the \file{.csl} file to the working directory.
The following styles are distributed within the package and
each of them can be directly loaded without downloading.

\begin{description}
  \item[\opt{american-chemical-society}] American Chemical Society
  \item[\opt{american-medical-association}] American Medical Association 11th edition
  \item[\opt{american-political-science-association}] American Political Science Association
  \item[\opt{american-sociological-association}] American Sociological Association 6th edition
  \item[\opt{apa}] American Psychological Association 7th edition
  \item[\opt{chicago-author-date}] Chicago Manual of Style 17th edition (author-date)
  \item[\opt{chicago-fullnote-bibliography}] Chicago Manual of Style 17th edition (full note)
  \item[\opt{chicago-note-bibliography}] Chicago Manual of Style 17th edition (note)
  \item[\opt{elsevier-harvard}] Elsevier - Harvard (with titles)
  \item[\opt{harvard-cite-them-right}] Cite Them Right 11th edition - Harvard
  \item[\opt{ieee}] IEEE
  \item[\opt{modern-humanities-research-association}] Modern Humanities Research Association 3rd edition (note with bibliography)
  \item[\opt{modern-language-association}] Modern Language Association 9th edition
  \item[\opt{nature}] Nature
  \item[\opt{vancouver}] Vancouver
\end{description}

\DescribeOption{locale}
The \opt{locale} option receives an ISO 639-1 two-letter language code
(e.g.,  ``\opt{en}'', ``\opt{zh}''), optionally with a two-letter locale code
(e.g., ``\opt{de-DE}'', ``\opt{de-AT}'').
This option affects sorting of the entries and the output of dates, numbers,
and terms (e.g., ``et al.'').
It may also be set \opt{auto} (default) and the \opt{default-locale} attribute in
the CSL style file will be used.
The locale falls back to ``\opt{en}'' (English) if the attribute is not set.
When \pkg{babel} package is loaded, the selected main language is implicitly set
as the \opt{locale} for \pkg{citation-style-language}.

\DescribeOption{bib-font}
Usually, the list of references is printed in the same font style and size as
the main text.
The \opt{bib-font} option is used to set different formats in the
\env{thebibliography} environment.
It may override the \opt{line-spacing} attribute configured in the CSL style.
For example, to force double-spacing in the bibliography:
\begin{LaTeXdemo}
  \cslsetup{bib-font = \linespread{2}\selectfont}
\end{LaTeXdemo}

\DescribeOption{bib-item-sep}
The vertical space between entries in the bibliography is configured in the
CSL style.
It can be overridden by this \opt{bib-item-sep} option.
It is recommended to set \opt{bib-item-sep} to a stretchable glue rather than
a fixed length to help reducing page breaks in the middle of an entry.
\begin{LaTeXdemo}
  \cslsetup{bib-item-sep = 8 pt plus 4 pt minus 2 pt}
\end{LaTeXdemo}

\DescribeOption{bib-hang}
The \opt{bib-hang} option sets the hanging indentation length which is
usually used for author-date style references.
By default, it is 1 em (with respect to the \opt{bib-font} size if set).

\DescribeOption{bib-par-indent}
The paragraph indentation of references if they are in normal paragraph style
rather than labelled or hanging indented.
By default, it is the \cs{parindent} at when printed out.


\begin{function}{\addbibresource}
  \begin{syntax}
    \cs{addbibresource}\marg{resource}
  \end{syntax}
\end{function}

The \cs{addbibresource} command loads bibliographic data from \meta{resource}
file. CSL-JSON is the preferred format especially when the data is exported
from a reference manager like Zotero.  Other formats like CSL-YAML and
Bib(La)TeX (for compatibility) are also supported but they need to be converted
to CSL-JSON for internal processing. Note that the files must be specified with
their extension names and the content should be encoded in UTF-8.
\begin{LaTeXdemo}
  \addbibresource{file1.json}
  \addbibresource{file2.yaml, file3.bib}
\end{LaTeXdemo}


\begin{function}{\cite}
  \begin{syntax}
    \cs{cite}\oarg{options}\marg{keys}
  \end{syntax}
\end{function}

The citation command is similar to the one in standard LaTeX except that the
\meta{options} is in key-value style.
\DescribeOption{prefix}
\DescribeOption{suffix}
\DescribeOption{page}
\DescribeOption{figure}
The \meta{options} can be \opt{prefix}, \opt{suffix} or one of locators like
\opt{page} or \opt{figure}.
The full list of supported locators is detailed in Table~\ref{tab:locators}.
An example is as follows.
\begin{LaTeXdemo}
  \cite[prefix = {See }, page = 42]{ITEM-1}
\end{LaTeXdemo}

\begin{table}
  \centering
  \caption{The locators supported in CSL v1.0.2.}
  \label{tab:locators}
  \begin{tabular}{lll}
    \toprule
    \opt{act}       & \opt{folio}     & \opt{section}    \\
    \opt{appendix}  & \opt{issue}     & \opt{sub-verbo}  \\
    \opt{article}   & \opt{line}      & \opt{supplement} \\
    \opt{book}      & \opt{note}      & \opt{table}      \\
    \opt{canon}     & \opt{opus}      & \opt{timestamp}  \\
    \opt{chapter}   & \opt{page}      & \opt{title}      \\
    \opt{column}    & \opt{paragraph} & \opt{verse}      \\
    \opt{elocation} & \opt{part}      & \opt{version}    \\
    \opt{equation}  & \opt{rule}      & \opt{volume}     \\
    \opt{figure}    & \opt{scene}     &                  \\
    \bottomrule
  \end{tabular}
\end{table}

The traditional form \cs{cite}\oarg{prenote}\oarg{postnote}\marg{keys}
introduced in \pkg{natbib} and \pkg{biblatex} is also supported but not
recommended.
If only one optional argument is provided, it is treated as \meta{postnote}.
The \meta{postnote} is used as a page locator if it consists of only digits.

\begin{function}{\parencite,\citep}
  \begin{syntax}
    \cs{parencite}\oarg{options}\marg{keys}
  \end{syntax}
\end{function}

The \cs{parencite} and \cs{citep} command are aliases of \cs{cite}.
They are added for compatibility with \pkg{biblatex} and \pkg{natbib} packages.
If the citation format defined in the CSL style does not have affixes,
these commands in \pkg{citation-style-language} do not enclose the output with
brackets, which is different from other packages.

\begin{function}{\textcite,\citet}
  \begin{syntax}
    \cs{textcite}\oarg{options}\marg{keys}
  \end{syntax}
\end{function}

\DescribeOption{infix}
These commands proceduce narrative in-text citation where the author name is
part of the running text followed by the year in parentheses.
These commands only work with author-date styles.
An extra option \opt{infix} can be given to specify the text inserted between
then author and year parts. For example, “Kesey’s early work (1962)” can be
produced by |\textcite[infix={'s early work}]{ITEM-1}|.
By default the infix is a space.

\begin{function}{\cites}
  \begin{syntax}
    \cs{cites}\oarg{options}\marg{key}...[options]\marg{key}
  \end{syntax}
\end{function}

The \cs{cites} accepts multiple cite items in a single citation.
This command scans greedily for arguments and a following bracket may be
mistakenly recognized as a delimiter.
To prevent this, an explicit \cs{relax} command is required to terminate the
scanning process. The following example illustrates its usage.

\begin{LaTeXdemo}
  \cites[prefix = {See }, page = 6]{key1}[section = 2.3]{key2}\relax [Text]
\end{LaTeXdemo}

\begin{function}{\citeauthor}
  \begin{syntax}
    \cs{citeauthor}\marg{key}
  \end{syntax}
\end{function}

This command prints the author name.
If the orginal citation does not contain the author name (e.g., a numeric
style), an optional |<intext>| element can be suppplied as a sibling to the
|<citation>| and |<bibliography>| elements in the CSL style (see
\href{https://citeproc-js.readthedocs.io/en/latest/running.html#citation-flags-with-processcitationcluster}{citeproc-js's documentation} for details).

\begin{function}{\nocite}
  \begin{syntax}
    \cs{nocite}\marg{keys}
  \end{syntax}
\end{function}

This command produces no output but makes the entries included in the
bibliography, which is the same in standard \LaTeX.
If the special key |*| is given (\cs{notecite\{*\}}), all the entries in the
database are included.



\begin{function}{\printbibliography}
  \begin{syntax}
    \cs{printbibliography}\oarg{options}
  \end{syntax}
\end{function}

This command prints the reference list.
Currently no options are available.


% \begin{function}{\cites}
%   \begin{syntax}
%     \cs{cite}\oarg{options}\marg{keys}
%   \end{syntax}
% \end{function}




% \markdownInput{bib-csl-mapping.md}


\section{Compatibility with other packages}

\paragraph{\pkg{babel}}

The main language set by \pkg{babel} is used as the locale for \pkg{citation-style-language}.
In general, \pkg{babel} is supposed to be loaded before \pkg{citation-style-language}.

\paragraph{\pkg{beamer}}

Most of this package's features work fine with \pkg{beamer} except the
\opt{backref} option. At the moment this can be addressed with \pkg{hyperref}'s
\opt{backref} option.


\paragraph{\pkg{hyperref}}

When \pkg{hyperref} is loaded, the DOIs, PMIDs, and PMCIDs are correctly
rendered as hyperlinks.

\paragraph{Incompatible packages}

The following packages are not compatible with \pkg{citation-style-language}.
An error will be triggered if any of them is loaded together with \pkg{citation-style-language}.
\begin{itemize}
  \item \pkg{babelbib}
  \item \pkg{backref}
  \item \pkg{biblatex}
  \item \pkg{bibtopic}
  \item \pkg{bibunits}
  \item \pkg{chapterbib}
  \item \pkg{cite}
  \item \pkg{citeref}
  \item \pkg{inlinebib}
  \item \pkg{jurabib}
  \item \pkg{mcite}
  \item \pkg{mciteplus}
  \item \pkg{multibib}
  \item \pkg{natbib}
  \item \pkg{splitbib}
\end{itemize}



\section{To-do list}

The \pkg{citation-style-language} package is in early development stage and
some features may not work as expected.
Bug report are welcome at the GitHub issue tracker
\footnote{\url{https://github.com/zepinglee/citeproc-lua/issues}}.
The following is a list of features to be implemented.
If you need any of them or new features, please post a issue to let me know
so that I can give it a priority.

\begin{itemize}
  \item The \pkg{citeproc-lua} engine has not passed all the fixures from the
    CSL standard test-suite. The skipped fixtures are lists in
    \href{https://github.com/zepinglee/citeproc-lua/blob/main/tests/citeproc-test-skip.txt}{citeproc-test-skip.txt}
    and they need to be handled (though less than 6\% of test-suite).

  \item The Unicode sorting method is provided by \pkg{lua-uca} package and
    CJK scripts are not supported so far.

  \item Citation commands that capitalize the first letter (\cs{Cite},
    \cs{Textcite}, etc.).

  \item Back references: page numbers of the citations appears after the entry
    item in bibliography (even without the hyperref).

  \item \cs{footcite} command.

  \item \cs{cite} in a footnote should work as in-text citations (similar to
    \cs{smartcite}).

  \item CSL-YAML support.

  \item Multiple bibliographies in a document like \pkg{chapterbib} package or
    \texttt{refsection} and \texttt{refsegment} options in \pkg{biblatex}.

  \item Journal abbreviation.

  \item Sentences case conversion: the title and booktitle fields in BibTeX
    database are converted to sentences case if they are in title case.

  \item Distinguish dropping and non-dropping particles in names.
\end{itemize}


\end{documentation}

\end{document}