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.tex40
1 files changed, 36 insertions, 4 deletions
diff --git a/biblio/citation-style-language/citation-style-language-doc.tex b/biblio/citation-style-language/citation-style-language-doc.tex
index 1dda26c5fa..e4f9ea4376 100644
--- a/biblio/citation-style-language/citation-style-language-doc.tex
+++ b/biblio/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}.