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.tex49
1 files changed, 37 insertions, 12 deletions
diff --git a/biblio/citation-style-language/citation-style-language-doc.tex b/biblio/citation-style-language/citation-style-language-doc.tex
index 83557185c4..628e30f781 100644
--- a/biblio/citation-style-language/citation-style-language-doc.tex
+++ b/biblio/citation-style-language/citation-style-language-doc.tex
@@ -1,5 +1,5 @@
%
-% Copyright (c) 2021-2022 Zeping Lee
+% Copyright (c) 2021-2023 Zeping Lee
% Released under the MIT License.
% Repository: https://github.com/zepinglee/citeproc-lua
%
@@ -49,7 +49,7 @@
}%
}
-\date{2022-12-25 v0.3.0}
+\date{2023-04-02 v0.4.0}
\maketitle
@@ -437,23 +437,48 @@ An error will be triggered if any of them is loaded together with \pkg{citation-
-\section{Known issues}
+\section{To-do list}
-The \pkg{citation-style-language} package is in early development stage and there are some issues with it.
+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} 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 When used with \pkg{hyperref}, the citations are not correctly rendered
- as hyperlinks.
+ \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.
-\end{itemize}
+ \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}