summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2024-06-10 20:25:03 +0000
committerKarl Berry <karl@freefriends.org>2024-06-10 20:25:03 +0000
commit3ddc8c76f799d899022ca939dcee53d7469d11f4 (patch)
treeb86fc22e75be0a8a8c7795ca87f1d236b4d59864 /Master/texmf-dist/doc
parent48b3dac6579bd4c1d68f1aee50c2f08cab5c8024 (diff)
citation-style-language (9jun24)
git-svn-id: svn://tug.org/texlive/trunk@71468 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/latex/citation-style-language/CHANGELOG.md14
-rw-r--r--Master/texmf-dist/doc/latex/citation-style-language/citation-style-language-doc.pdfbin229210 -> 235845 bytes
-rw-r--r--Master/texmf-dist/doc/latex/citation-style-language/citation-style-language-doc.tex229
-rw-r--r--Master/texmf-dist/doc/man/man1/citeproc-lua.12
-rw-r--r--Master/texmf-dist/doc/man/man1/citeproc-lua.man1.pdfbin14934 -> 14880 bytes
5 files changed, 183 insertions, 62 deletions
diff --git a/Master/texmf-dist/doc/latex/citation-style-language/CHANGELOG.md b/Master/texmf-dist/doc/latex/citation-style-language/CHANGELOG.md
index 76bcc5c067e..60c4ae9e823 100644
--- a/Master/texmf-dist/doc/latex/citation-style-language/CHANGELOG.md
+++ b/Master/texmf-dist/doc/latex/citation-style-language/CHANGELOG.md
@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
+## [0.5.0] - 2024-06-09
+
+### Added
+
+- Add `\fullcite` command ([#64](https://github.com/zepinglee/citeproc-lua/issues/64)).
+- Add support for annotated bibliography ([#64](https://github.com/zepinglee/citeproc-lua/issues/64)).
+
+## Changed
+
+- Check if the `\cite` command is in a footnote.
+
## [0.4.9] - 2024-04-21
## Added
@@ -186,7 +197,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Initial CTAN release.
-[Unreleased]: https://github.com/zepinglee/citeproc-lua/compare/v0.4.9...HEAD
+[Unreleased]: https://github.com/zepinglee/citeproc-lua/compare/v0.5.0...HEAD
+[0.5.0]: https://github.com/zepinglee/citeproc-lua/compare/v0.4.9...v0.5.0
[0.4.9]: https://github.com/zepinglee/citeproc-lua/compare/v0.4.8...v0.4.9
[0.4.8]: https://github.com/zepinglee/citeproc-lua/compare/v0.4.7...v0.4.8
[0.4.7]: https://github.com/zepinglee/citeproc-lua/compare/v0.4.6...v0.4.7
diff --git a/Master/texmf-dist/doc/latex/citation-style-language/citation-style-language-doc.pdf b/Master/texmf-dist/doc/latex/citation-style-language/citation-style-language-doc.pdf
index 0794c8fcdb3..83d520bd1bd 100644
--- a/Master/texmf-dist/doc/latex/citation-style-language/citation-style-language-doc.pdf
+++ b/Master/texmf-dist/doc/latex/citation-style-language/citation-style-language-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/citation-style-language/citation-style-language-doc.tex b/Master/texmf-dist/doc/latex/citation-style-language/citation-style-language-doc.tex
index b93678a0515..c8af8574e16 100644
--- a/Master/texmf-dist/doc/latex/citation-style-language/citation-style-language-doc.tex
+++ b/Master/texmf-dist/doc/latex/citation-style-language/citation-style-language-doc.tex
@@ -11,6 +11,8 @@
\usepackage{listings}
\NewDocumentCommand\opt{m}{\texttt{#1}}
+\NewDocumentCommand\field{m}{\texttt{#1}}
+\NewDocumentCommand\entrytype{m}{\texttt{#1}}
\lstnewenvironment{LaTeXdemo}{
\lstset{
@@ -49,7 +51,7 @@
}%
}
-\date{2024-04-21 v0.4.9}
+\date{2024-06-09 v0.5.0}
\maketitle
@@ -115,11 +117,7 @@ An example of using \pkg{citation-style-language} package is as follows.
\begin{LaTeXdemo}
\documentclass{...}
- \usepackage{citation-style-language}
- \cslsetup{
- style = ...,
- ...
- }
+ \usepackage[style = apa]{citation-style-language}
\addbibresource{bibfile.json}
\begin{document}
\cite{...}
@@ -155,7 +153,7 @@ The general procedure is similar to the traditional BibTeX workflow.
-\section{Package commands}
+\section{Package setup}
\begin{function}{\cslsetup}
\begin{syntax}
@@ -264,6 +262,8 @@ their extension names and the content should be encoded in UTF-8.
\end{LaTeXdemo}
+\section{Citation commands}
+
\begin{function}{\cite}
\begin{syntax}
\cs{cite}\oarg{options}\marg{keys}
@@ -328,15 +328,25 @@ brackets, which is different from other packages.
\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.
+
+\DescribeOption{infix}
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}{\footcite}
+ \begin{syntax}
+ \cs{footcite}\oarg{options}\marg{keys}
+ \end{syntax}
+\end{function}
+
+This command is similar to \cs{cite}. It is for compatibility with
+\pkg{biblatex}.
+
\begin{function}{\cites}
\begin{syntax}
\cs{cites}\oarg{options}\marg{key}...[options]\marg{key}
@@ -365,6 +375,25 @@ 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}{\citeyearpar}
+ \begin{syntax}
+ \cs{citeyearpar}\oarg{options}\marg{keys}
+ \end{syntax}
+\end{function}
+
+This command suppresses the author names in the citation.
+It is equivalent to \cs{cite} with \opt{suppress-author} option enabled.
+
+\begin{function}{\fullcite}
+ \begin{syntax}
+ \cs{fullcite}\oarg{options}\marg{keys}
+ \end{syntax}
+\end{function}
+
+This command prints a full citation similar to the bibliographic entry.
+The contents are genreated from the |<bibliography>| element in the CSL style
+rather than the |<citation>| element.
+
\begin{function}{\nocite}
\begin{syntax}
\cs{nocite}\marg{keys}
@@ -377,23 +406,149 @@ If the special key |*| is given (\cs{notecite\{*\}}), all the entries in the
database are included.
+\section{Bibliography commands}
\begin{function}{\printbibliography}
\begin{syntax}
+ \cs{printbibliography}
\cs{printbibliography}\oarg{options}
\end{syntax}
\end{function}
This command prints the reference list.
-Currently no options are available.
+It also accepts an optional argument in square brackets which is a list of
+key-value options. The following options are available.
+
+\begin{variable}{heading}
+ \begin{syntax}
+ heading = \meta{name}
+ \end{syntax}
+\end{variable}
+This option selects the section heading style defined with \cs{defbibheading}.
+The default heading for \cs{printbibliography} is \opt{bibliography}.
-% \begin{function}{\cites}
-% \begin{syntax}
-% \cs{cite}\oarg{options}\marg{keys}
-% \end{syntax}
-% \end{function}
+\begin{variable}{title}
+ \begin{syntax}
+ title = \meta{text}
+ \end{syntax}
+\end{variable}
+
+This option sets the title in the heading.
+
+\begin{variable}{label}
+ \begin{syntax}
+ label = \meta{label}
+ \end{syntax}
+\end{variable}
+This option is equivalent to \cs{label}\marg{label} after the heading so that
+it can be \cs{ref}ed from other parts in the document.
+
+\begin{variable}{prenote, postnote}
+ \begin{syntax}
+ prenote = \meta{name}
+ postnote = \meta{name}
+ \end{syntax}
+\end{variable}
+
+\begin{variable}{type}
+ \begin{syntax}
+ type = \meta{entrytype}
+ \end{syntax}
+\end{variable}
+
+Print only the entries of the given \meta{entrytype}.
+Note that the \meta{entrytype} should be the name of a CSL entry type rather
+than BibTeX entry type (e.g., use |article-journal| rather than |article|).
+
+\begin{variable}{nottype}
+ \begin{syntax}
+ nottype = \meta{entrytype}
+ \end{syntax}
+\end{variable}
+
+Print only the entries that are not \meta{entrycategory}.
+This option may be used multiple times.
+
+\begin{variable}{keyword}
+ \begin{syntax}
+ keyword = \meta{keyword}
+ \end{syntax}
+\end{variable}
+
+Print only the entries whose \field{keyword} field includes the given
+\meta{keyword}. This option may be used multiple times.
+
+\begin{variable}{notkeyword}
+ \begin{syntax}
+ notkeyword = \meta{keyword}
+ \end{syntax}
+\end{variable}
+
+Print only the entries whose \field{keyword} field does not include the given
+\meta{keyword}. This option may be used multiple times.
+
+\begin{variable}{category}
+ \begin{syntax}
+ category = \meta{category}
+ \end{syntax}
+\end{variable}
+
+Print only the entries assigned to the given category.
+This option may be used multiple times.
+
+
+\begin{variable}{notcategory}
+ \begin{syntax}
+ notcategory = \meta{category}
+ \end{syntax}
+\end{variable}
+
+Print only the entries assigned to the given category.
+This option may be used multiple times.
+
+
+\subsection{Bibliography Headings}
+
+\begin{function}{\defbibheading}
+ \begin{syntax}
+ \cs{defbibheading}\marg{name}\oarg{title}\marg{code}
+ \end{syntax}
+\end{function}
+
+This command defines a bibliographic heading which can be used with the
+\opt{bibheading} option of \cs{printbibliography}. The \meta{name} is an
+identifier assigned to the defined style.
+If a \opt{title} option is given in the \cs{printbibliography}, it is passed
+to the \opt{code} as |#1|. Otherwise the value \meta{title} in the optional
+argument is used by default. The following is the definition of the default
+heading when used in a \cls{book} class.
+
+\begin{LaTeXdemo}
+ \defbibheading{bibliography}[\bibname]{%
+ \chapter*{#1}%
+ \markboth{\MakeUppercase{#1}}{\MakeUppercase{#1}}%
+ }
+\end{LaTeXdemo}
+
+
+The following are predefined headings which can be used directly.
+
+\begin{description}
+ \item[\opt{bibliography}] The default heading used by \cs{printbibliography}.
+ \item[\opt{subbibliography}] Similar to \opt{bibliography} but one sectioning level lower.
+ \item[\opt{bibintoc}] Similar to \opt{bibliography} but adds an entry to the table of contents.
+ \item[\opt{subbibintoc}] Similar to \opt{subbibliography} but adds an entry to the table of contents.
+ \item[\opt{bibnumbered}] Similar to \opt{bibliography} but uses \cs{chapter}
+ or \cs{section} to create a numbered heading which is also added to the table of contents.
+ \item[\opt{subbibnumbered}] Similar to \opt{subbibliography} but uses \cs{chapter}
+ or \cs{section} to create a numbered heading which is also added to the table of contents.
+ \item[\opt{none}] An empty heading.
+ % \item[\opt{biblist}]
+ % \item[\opt{biblistintoc}]
+ % \item[\opt{biblistnumbered}]
+\end{description}
@@ -441,52 +596,6 @@ An error will be triggered if any of them is loaded together with \pkg{citation-
\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}
diff --git a/Master/texmf-dist/doc/man/man1/citeproc-lua.1 b/Master/texmf-dist/doc/man/man1/citeproc-lua.1
index 1186f832eab..2f51415907c 100644
--- a/Master/texmf-dist/doc/man/man1/citeproc-lua.1
+++ b/Master/texmf-dist/doc/man/man1/citeproc-lua.1
@@ -1,4 +1,4 @@
-.TH citeproc-lua 1 "0.4.9"
+.TH citeproc-lua 1 "0.5.0"
.SH NAME
citeproc-lua \- make CSL citations and bibliography for LaTeX
.SH SYNOPSIS
diff --git a/Master/texmf-dist/doc/man/man1/citeproc-lua.man1.pdf b/Master/texmf-dist/doc/man/man1/citeproc-lua.man1.pdf
index c06597f06e1..353bc49d1fc 100644
--- a/Master/texmf-dist/doc/man/man1/citeproc-lua.man1.pdf
+++ b/Master/texmf-dist/doc/man/man1/citeproc-lua.man1.pdf
Binary files differ