summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2022-09-18 19:43:14 +0000
committerKarl Berry <karl@freefriends.org>2022-09-18 19:43:14 +0000
commite1c8dfe96e04abdaaa9715bd0035ee0cd1b89c3f (patch)
tree91e6aadae65eb8a73144f623ea35e9f7516f1b5d /Master/texmf-dist/doc/latex
parentf363d563b7b3a861e98f2667feb590123944d67b (diff)
citation-style-language (18sep22)
git-svn-id: svn://tug.org/texlive/trunk@64429 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r--Master/texmf-dist/doc/latex/citation-style-language/CHANGELOG.md13
-rw-r--r--Master/texmf-dist/doc/latex/citation-style-language/DEPENDS.txt13
-rw-r--r--Master/texmf-dist/doc/latex/citation-style-language/citation-style-language-doc.pdfbin220489 -> 227617 bytes
-rw-r--r--Master/texmf-dist/doc/latex/citation-style-language/citation-style-language-doc.tex40
4 files changed, 55 insertions, 11 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 e351714b3a9..6dd051a601f 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,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
+## [v0.2.1] - 2022-09-18
+
+### Changed
+
+- Rewrite BibTeX parser with `lpeg`. The accent letters are now converted to unicode.
+
+### Fixed
+
+- Fix redundant warning `entry "*" not found`.
+
## [v0.2.0] - 2022-08-18
### Added
@@ -46,7 +56,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.2.0...HEAD
+[Unreleased]: https://github.com/zepinglee/citeproc-lua/compare/v0.2.1...HEAD
+[v0.2.1]: https://github.com/zepinglee/citeproc-lua/compare/v0.2.0...0.2.1
[v0.2.0]: https://github.com/zepinglee/citeproc-lua/compare/v0.1.1...0.2.0
[v0.1.1]: https://github.com/zepinglee/citeproc-lua/compare/v0.1.0...v0.1.1
[v0.1.0]: https://github.com/zepinglee/citeproc-lua/releases/tag/v0.1.0
diff --git a/Master/texmf-dist/doc/latex/citation-style-language/DEPENDS.txt b/Master/texmf-dist/doc/latex/citation-style-language/DEPENDS.txt
index 3d0edb73de8..8e08eb5388a 100644
--- a/Master/texmf-dist/doc/latex/citation-style-language/DEPENDS.txt
+++ b/Master/texmf-dist/doc/latex/citation-style-language/DEPENDS.txt
@@ -1,10 +1,11 @@
# The format of this file is described in https://www.tug.org/texlive/pkgcontrib.html#deps.
-hard luatex
-hard l3kernel
-hard l3packages
hard filehook
-hard url
-hard luaxml
+hard l3kernel
+hard l3packages # xparse
+hard lpeg
hard lua-uca
-hard lualibs
+hard lualibs # JSON parser
+hard luatex
+hard luaxml
+hard url
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 af42980a811..6a7dd5f03fc 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 1dda26c5fa9..e4f9ea43761 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
@@ -26,7 +26,7 @@
\lstset{
basicstyle = \ttfamily\small,
basewidth = 0.51em,
- gobble = 2,
+ % gobble = 2,
language = bash,
}
}{}
@@ -49,7 +49,7 @@
}%
}
-\date{2022-08-18 v0.2.0}
+\date{2022-09-18 v0.2.1}
\maketitle
@@ -77,6 +77,38 @@ 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.
@@ -107,12 +139,12 @@ which is the same as documents with cross references.
\paragraph{Other engines}
-For engines other than LuaTeX, the \file{citeproc} executable is required
+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} on \file{example.aux}.
+ \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}.