diff options
author | Norbert Preining <norbert@preining.info> | 2022-01-22 03:01:16 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2022-01-22 03:01:16 +0000 |
commit | 26bfc07f2b7829213356de43cf5b81c3ba99e338 (patch) | |
tree | efb3037df2c42c45c904ad131334e8fc626cea19 /biblio/citation-style-language/README.md | |
parent | 5d5f239204f5c0d1f7573c9ebc64b5ad1ae75b49 (diff) |
CTAN sync 202201220301
Diffstat (limited to 'biblio/citation-style-language/README.md')
-rw-r--r-- | biblio/citation-style-language/README.md | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/biblio/citation-style-language/README.md b/biblio/citation-style-language/README.md new file mode 100644 index 0000000000..74c27590c6 --- /dev/null +++ b/biblio/citation-style-language/README.md @@ -0,0 +1,59 @@ +# citation-style-language + +The [Citation Style Language](https://citationstyles.org/) (CSL) is an +XML-based language that defines the formats of citations and bibliography. +There are currently thousands of styles in CSL including the most widely used +APA, Chicago, Vancouver, etc. +The `citation-style-language` package is aimed to provide another reference +formatting method for LaTeX that utilizes the CSL styles. +It contains a citation processor implemented in pure Lua (`citeproc-lua`) +which reads bibliographic metadata and performs sorting and formatting on both +citations and bibliography according to the selected CSL style. +A LaTeX package (`citation-style-language.sty`) is provided to communicate +with the processor. + +This project is in early development stage and some features of CSL (especially +collapsing and disambiguation) are not implemented yet. Comments, suggestions +and bug reports are welcome. + +## LaTeX example + +A full LaTeX example is in the [`example/`](example) directory. + +- LaTeX document example.tex + +```latex +\documentclass{article} + +\usepackage{citation-style-language} +\cslsetup{style = apa} +\addbibresource{example.bib} + +\begin{document} + +\cite{ITEM-1} +\printbibliography + +\end{document} +``` + +- Compiling with LuaTeX + +```bash +lualatex example.tex +lualatex example.tex +``` + +- Compiling with other TeX engines + +```bash +pdflatex example.tex +citeproc example.aux +pdflatex example.tex +``` + + +## License + +The LaTeX package and Lua library are released under MIT license. +The CSL locale files and styles are redistributed under the [Creative Commons Attribution-ShareAlike 3.0 Unported license](https://creativecommons.org/licenses/by-sa/3.0/). |