summaryrefslogtreecommitdiff
path: root/biblio/citation-style-language/citation-style-language-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'biblio/citation-style-language/citation-style-language-doc.tex')
-rw-r--r--biblio/citation-style-language/citation-style-language-doc.tex48
1 files changed, 26 insertions, 22 deletions
diff --git a/biblio/citation-style-language/citation-style-language-doc.tex b/biblio/citation-style-language/citation-style-language-doc.tex
index 538aaae00a..1dda26c5fa 100644
--- a/biblio/citation-style-language/citation-style-language-doc.tex
+++ b/biblio/citation-style-language/citation-style-language-doc.tex
@@ -49,7 +49,7 @@
}%
}
-\date{2022-03-21 v0.1.1}
+\date{2022-08-18 v0.2.0}
\maketitle
@@ -73,7 +73,7 @@ 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 (especially collapsing and disambiguation).
+are not implemented yet.
Comments, suggestions, and bug reports are welcome.
@@ -131,14 +131,14 @@ The general procedure is similar to the traditional BibTeX workflow.
\end{syntax}
\end{function}
-The behavior of the \pkg{citation-style-language} package is controlled by several key-value
-options which can be set with the \cs{cslsetup} command.
-For example,
+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}
- \cslsetup{
- style = apa,
- locale = zh-CN,
- }
+ \usepackage[style = apa]{citation-style-langugage}
+ % OR
+ \usepackage{citation-style-langugage}
+ \cslsetup{style = apa}
\end{LaTeXdemo}
\DescribeOption{style}
@@ -278,13 +278,11 @@ 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.
-In other packages, several commands are provided for producing citations in
-different styles such as \cs{citet}, \cs{citep}, \cs{parencite}, and
-\cs{footnotecite}.
-In \pkg{citation-style-language} package, however, the format of citations is
-fixed as defined in CSL style and it is impossible to select another format
-without modifying the \file{.csl} style file.
-Note that narrative citation (like ``Doe (2018)'') will be supported in CSL 1.1.
+For author-date styles, there are also narrative in-text citations where the
+author names appear in running text and only dates are enclosed in parentheses
+(\cs{citet} in \pkg{natbib} pacakge or \cs{textcite} in \pkg{biblatex}).
+However such cite command in this pakcage is not available at the momment and
+it will be implemented in the next release.
\begin{function}{\cites}
\begin{syntax}
@@ -302,6 +300,17 @@ scanning process. The following example illustrates its usage.
\cites[prefix = {See }, page = 6]{key1}[section = 2.3]{key2}\relax [Text]
\end{LaTeXdemo}
+\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}
@@ -368,16 +377,11 @@ An error will be triggered if any of them is loaded together with \pkg{citation-
The \pkg{citation-style-language} package is in early development stage and there are some issues with it.
\begin{itemize}
- \item The \pkg{citeproc-lua} has not implemented all the features of CSL,
- especially disambiguation and collapsing.
+ \item The \pkg{citeproc-lua} has not implemented all the features of CSL.
For detailed information of the coverage on the CSL standard test
suite\footnote{\url{https://github.com/citation-style-language/test-suite}},
see \href{https://github.com/zepinglee/citeproc-lua/blob/main/test/citeproc-test.log}{citeproc-test.log}
in the GitHub repository.
- \item The processor is much slower than expected compared to other
- reference engines.
- This is because little care has been taken in the development so far.
- Optimization is needed in the future.
\item When used with \pkg{hyperref}, the citations are not correctly rendered
as hyperlinks.
\item The Unicode sorting method is provided by \pkg{lua-uca} package and