summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/biblatex-contrib/biblatex-lni/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/biblatex-contrib/biblatex-lni/README.md')
-rw-r--r--macros/latex/contrib/biblatex-contrib/biblatex-lni/README.md46
1 files changed, 33 insertions, 13 deletions
diff --git a/macros/latex/contrib/biblatex-contrib/biblatex-lni/README.md b/macros/latex/contrib/biblatex-contrib/biblatex-lni/README.md
index 16f91d70a5..e1a19dee70 100644
--- a/macros/latex/contrib/biblatex-contrib/biblatex-lni/README.md
+++ b/macros/latex/contrib/biblatex-contrib/biblatex-lni/README.md
@@ -1,13 +1,35 @@
-# biblatex-lni [![Build Status](https://circleci.com/gh/gi-ev/biblatex-lni/tree/master.svg?style=shield)](https://circleci.com/gh/gi-ev/biblatex-lni/) [![CTAN](https://img.shields.io/badge/CTAN-biblatex--lni-blue.svg?style=flat-square)](https://ctan.org/pkg/biblatex-lni)
+# biblatex-lni
-This is a [biblatex] style for [LNI], the Lecture Notes in Informatics of the [Gesellschaft für Informatik e.V.].
+This is a [biblatex] style for the [Lecture Notes in Informatics (LNI)](https://gi.de/service/publikationen/lni) of the [Gesellschaft für Informatik e.V.]
It requires at least [biblatex 3.5] and [biber] 2.6.
-## Usage
+> This style is available on CTAN at <https://ctan.org/pkg/biblatex-lni> and should directly be usable in your LaTeX distribution.
-This style has no specific requirements, thus you can just pass `style=LNI` as parameter to biblatex.
+## Usage in the context of the LNI class
-If you include the template in an existing document, following lines are recommended
+Typically, this class is used in the context of LNI publications, which are typeset using the [lni package](https://ctan.org/pkg/lni).
+
+```latex
+\documentclass[biblatex,english]{lni}
+\bibliography{LNI-examples.bib}
+\begin{document}
+\title{Title}
+\author{Firstname Lastname}
+\maketitle
+\begin{abstract}
+Text
+\end{abstract}
+\section{Introduction}
+Text~\cite{jabref}.
+\printbibliography
+\end{document}
+```
+
+## Usage outside LNI class
+
+This style has no specific requirements, thus you can just pass `style=LNI` as parameter to [biblatex].
+
+If you include the template in an existing document, following lines are recommended:
```latex
\usepackage[english]{babel}
@@ -25,22 +47,20 @@ Use `biber` instead of `bibtex` to generate the bibliography entries.
## Source and Feedback
The source of this package is maintained at <https://github.com/gi-ev/biblatex-lni>.
-This site also allows for filing issues in case something strange is encontered.
+This site also allows for filing issues in case something strange is encountered.
## License
-Copyright (c) 2016 Lukas C. Bossert, Georg Duffner, Oliver Kopp
+Copyright (c) 2016-2023 Lukas C. Bossert, Georg Duffner, Oliver Kopp
This work has the LPPL maintenance status _maintained_.
The current maintainer of this work is Oliver Kopp.
-
This package may be distributed under the terms of the LaTeX Project
Public License, as described in lppl.txt in the base LaTeX distribution.
Either version 1.3 or, at your option, any later version.
- [biber]: https://github.com/plk/biber#overview
- [biblatex]: https://github.com/plk/biblatex#overview
- [biblatex 3.5]: https://github.com/plk/biblatex/blob/dev/doc/latex/biblatex/CHANGES.org#release-notes-for-version-35
- [Gesellschaft für Informatik e.V.]: https://www.gi.de
- [LNI]: https://www.gi.de/service/publikationen/lni/autorenrichtlinien.html
+[biber]: https://github.com/plk/biber#overview
+[biblatex]: https://github.com/plk/biblatex#overview
+[biblatex 3.5]: https://github.com/plk/biblatex/blob/dev/doc/latex/biblatex/CHANGES.org#release-notes-for-version-35
+[Gesellschaft für Informatik e.V.]: https://gi.de