Skip to content

Commit

Permalink
Refine README.md to include all three options, readd paper.tex, add l…
Browse files Browse the repository at this point in the history
…ni-author-template.tex
  • Loading branch information
koppor committed Jan 23, 2017
1 parent 7624af8 commit 96ddcc0
Show file tree
Hide file tree
Showing 5 changed files with 469 additions and 47 deletions.
3 changes: 2 additions & 1 deletion .gitignore
@@ -1,6 +1,7 @@
#The output should not be versioned
paper.pdf

paper-bibtex.pdf
lni-author-template.pdf



Expand Down
115 changes: 69 additions & 46 deletions README.md
@@ -1,50 +1,87 @@
# Simplified LNI Template
# LaTeX Template for GI-Edition Lecture Notes in Informatics (LNI)

This repository aims to provide a quick start for modern LaTeXing with [LNI].
This README is best viewed in a markdown viewer or [on GitHub](https://github.com/latextemplates/LNI/blob/master/README.md).

This version does not require biblatex, but still suffers from a broken `lni.bst`.
This is a known issue (https://github.com/latextemplates/LNI/issues/1).
The current fix is to switch to biber and to use [biblatex-lni].
In case, your LaTeX installation is uptodate, it is recommended to switch to https://github.com/latextemplates/LNI.
## Three starting options

## Quick start
* **Option A**: Use biblatex and a template with examples. This is the most modern.
* [biblatex](https://github.com/plk/biblatex#overview) (at least 3.5),
* [biber](https://github.com/plk/biber#overview) (at least 2.6), and
* [biblatex-lni](https://github.com/latextemplates/biblatex-lni/blob/master/README.md#biblatex-lni) for the bibliography
* **Option B**: Use bibtex and a template with examples.
This is recommended in case you cannot update to the latest version of bibtex (instruction are given below).
Be aware that lni.bst is broken (https://github.com/latextemplates/LNI/issues/1), but still produces a correct bibliography.
* **Option C**: Use bibtex and a template without content.
This is the default distributed with the LNI style.

All three options produce valid results to be submitted to conferences and workshops requring LNI.
It is proven with the proceedings of [BTW 2017](http://btw2017.informatik.uni-stuttgart.de/).

* Click on `Download ZIP` or [here](https://github.com/latextemplates/LNI/archive/lni-bibtex.zip).
* Extract lni-bibtex.zip in the folder where you want to write your paper.
* Edit [paper.tex](paper.tex).
* Run `pdflatex -synctex=1 paper`.
* Run `bibtex paper`.
* Run `pdflatex -synctex=1 paper`.
## Quick start

[latexmk] currently does not work, because of https://github.com/latextemplates/LNI/issues/1.
* Click on `Download ZIP` or [here](https://github.com/latextemplates/LNI/archive/master.zip).
* Extract master.zip in the folder where you want to write your paper.
* Edit the paper
* Option A: Edit [paper.tex](paper.tex).
* Option B: Edit [paper-bibtex.tex](paper-bibtex.tex).
* Option C: Edit [lni-author-template.tex](lni-author-template.tex).
* Make the paper. You can use your usual build system.
* Option A: `latexmk paper`. See [latexmk] for more information.
If you want to have continuous preview, execute `latexmk -pvc paper`.
* Option B: `pdflatex paper-bibtex`, `bibtex paper-bibtex`, ignore the errors, `pdflatex paper-bibtex`, `pdflatex paper-bibtex`
* Option B: `pdflatex lni-author-template`, `bibtex lni-author-template`, ignore the errors, `pdflatex lni-author-template`, `pdflatex lni-author-template`.

## Trouble shooting

* `! pdfTeX error (font expansion): auto expansion is only possible with scalable fonts.` -> Install the `cm-super` package using the MiKTeX package manager. Then, run `initexmf --mkmaps` on the command line. (Long description: http://tex.stackexchange.com/a/324972/9075)
* `! pdfTeX error (font expansion): auto expansion is only possible with scalable fonts.` -> Install the [cm-super] package using the MiKTeX package manager. Then, run `initexmf --mkmaps` on the command line. (Long description: http://tex.stackexchange.com/a/324972/9075)
* `! LaTeX Error: Command \openbox already defined.`: Insert `\let\openbox\relax` beore `\usepackage{amsthm}`
* `! Undefined control sequence. l.84 \ulp@afterend`. Remove `paper.aux` and recompile.
* `! Package xkeyval Error: `family_i' undefined in families `blx@opt@namepart'.`: You switched from bibtex to biblatex. Remove `paper.bbl` and rempile.
* Option A: biber/biblatex too old -> see installation hints of how to update them at different systems

## Installation hints for Windows

### Installing MiKTeX
* Download the [MiKTeX] basic installer from http://miktex.org/download
* Start it
* First screen: Read the license condiditions and be sure that you really agree.
* Second screen: "Shared Installation": Install MiKTeX for: "Only for: `username`"
* Third screen: "Installation Directory": Install MiKTeX to: `C:\MiKTeX`. This enabled browsing for documentation at `C:\MiKTeX29\doc\latex`
* Fourth screen: "Settings": Preferred paper: A4 and Install missing packages on the fly: `Yes`
* Fifth screen: Press "Start"
* After the installation:
1. Open `cmd.exe`
2. Execute `mpm --update-db`
3. Execute `mpm --update`
4. Execute `mpm --install=cm-super`
5. Execute `initexmf --update-fndb`

### Further hints

## Benefits in comparison to GI e.V.'s version
* The default installation of MiKTeX ships with incompatible biblatex and biber packages. You have to keep your MiKTeX up to date. In case you followed the linked installation steps, you only have to run "Update MiKTeX". If you installed MiKTeX other ways, you have to run "Update MiKTeX (Admin)" and "Update MiKTeX" and check in both tools for updates (see http://tex.stackexchange.com/a/108490/9075)
* Install the [cm-super] package.
* Install other tools using [Chocolatey]: `choco install texstudio sumatrapdf.install latexmk strawberryperl jabref jre8`. This allows you to run `choco upgrade all` to keep the software updated.
* Option A: Ensure that in the "MiKTeX Package Manager" "biber" and "biblatex-lni" are installed

The [official LNI template] is updated at <https://github.com/sieversMartin/LNI/>, which is approved by GI and offers following benefits:
## Installation hints for Ubuntu

* Enables most recent hyphenation patterns for German text
* Clean copy and paste of ligatures (e.g., "workflow" stays "workflow" after copying from the PDF).
* [microtypographic extensions](https://www.ctan.org/pkg/microtype) for a better look of the paper.
* Support of `\powerset`.
* Support of hyperlinked references without extra color thanx to [hyperref].
* Better breaking of URLs.
* Removed `sty` files: These are provided by all modern LaTeX distributions.
* Adds modern packages such as [hypcap].
* Provides a skeletal [lni-author-template.tex](https://github.com/sieversMartin/LNI/blob/master/lni-author-template.tex) file demonstrating the template.
Option A: Ubuntu currently [ships biber 2.4](https://bugs.launchpad.net/ubuntu/+source/biber/+bug/1589644), so you have to upgrade your texlive distribution.
The easiest way is to uninstall the ubuntu package and use [install-tl-ubuntu](https://github.com/scottkosty/install-tl-ubuntu).
Then, you can follow the instructions given at http://tex.stackexchange.com/a/55459/9075 to update your tex live distribution.
If you do not want to have an updated installation, but fiddle around with dirty patching your installation, please follow http://tex.stackexchange.com/questions/84624/how-to-upgrade-biblatex-properly.

In addition, this template offers following benefits:
## Benefits of Option B in comparison to Option C

* Automatic setting of "Fig." and "Section"/"Sect." according to the LNI style. Just use `\Cref{sec:xy}` at the beginning of a sentence and `\cref{sec:xy}` in the middle of a sentence. Thanx to [cleveref].
* Adds modern packages such as [csquotes] and [booktabs].
* Provides a skeletal [paper.tex](paper.tex) file demonstrating cleveref and booktabs.

## Benefits of Option A in comparison to Option B:

* No compilation erros when running `bibtex` (because biblatex is used).
* Support of [biblatex].

## Tool hints

Grammar and spell checking is available at [TeXstudio].
Expand All @@ -63,42 +100,28 @@ If TeXstudio doesn't fit your needs, check [the list of all available LaTeX Edit

## Updating

Just execute `git pull -Xtheirs template lni-bibtex`

## Space saving techniques

**These are not officially approved!**

```
\newlength{\bibitemsep}\setlength{\bibitemsep}{.2\baselineskip plus .05\baselineskip minus .05\baselineskip}
\newlength{\bibparskip}\setlength{\bibparskip}{0pt}
\let\oldthebibliography\thebibliography
\renewcommand\thebibliography[1]{%
\oldthebibliography{#1}
\setlength{\parskip}{\bibitemsep}%
\setlength{\itemsep}{\bibparskip}%
}
```

Just execute `git pull -Xtheirs template master`

## Links

* Other templates: http://latextemplates.github.io/
* German: Hinweise zu Ausarbeitungen: http://wiki.flupp.de/studium/ausarbeitungen

[LNI]: https://www.gi.de/service/publikationen/lni/autorenrichtlinien.html
[official LNI template]: https://www.gi.de/fileadmin/redaktion/Autorenrichtlinien/LNI-LaTeX-Vorlage.zip

[biblatex-lni]: https://github.com/latextemplates/biblatex-lni
[biblatex]: https://www.ctan.org/pkg/biblatex?lang=de
[booktabs]: https://www.ctan.org/pkg/booktabs
[cleveref]: https://ctan.org/pkg/cleveref
[cm-super]: https://www.ctan.org/pkg/cm-super
[csquotes]: https://www.ctan.org/pkg/csquotes
[hypcap]: https://www.ctan.org/pkg/hypcap
[hyperref]: https://ctan.org/pkg/hyperref
[microtype]: https://ctan.org/pkg/microtype

[latexmk]: https://www.ctan.org/pkg/latexmk/

[JabRef]: http://www.jabref.org
[Chocolatey]: https://chocolatey.org/
[JabRef]: https://www.jabref.org
[LanguageTool]: https://languagetool.org/
[MiKTeX]: http://miktex.org/
[TeXstudio]: http://texstudio.sourceforge.net/
42 changes: 42 additions & 0 deletions lni-author-template.tex
@@ -0,0 +1,42 @@
%% !TeX encoding = UTF-8
%% !TeX program = pdflatex
%% !BIB program = bibtex
%%
%%% Um einen Artikel auf deutsch zu schreiben, genügt es die Klasse ohne
%%% Parameter zu laden.
\documentclass[]{lni}
%%% To write an article in English, please use the option ``english'' in order
%%% to get the correct hyphenation patterns and terms.
%%% \documentclass[english]{class}
%%
\begin{document}
%%% Mehrere Autoren werden durch \and voneinander getrennt.
%%% Die Fußnote enthält die Adresse sowie eine E-Mail-Adresse.
%%% Das optionale Argument (sofern angegeben) wird für die Kopfzeile verwendet.
\author[Vorname1 Name1\and Vorname2 Name 2]{Vorname1
Nachname1\footnote{Einrichtung/Universität, Abteilung, Anschrift, Postleitzahl
Ort, \email{emailadresse@author1}}\and Vorname2
Nachname2\footnote{Einrichtung/Universität, Abteilung, Anschrift, Postleitzahl
Ort, \email{emailadresse@author2}} und weitere Autorinnen und Autoren in der
gleichen Notation}
\title[Kurztitel (falls nötig)]{Titel}
\startpage{11}% Beginn der Seitenzählung für diesen Beitrag
\editor{Ich selbst}
\booktitle{Ein Test}
\year{2017}
\maketitle

\begin{abstract}
Hier kommt die Zusammenfassung hin
Add your abstract here
\end{abstract}
\begin{keywords}
Hier kommen die Keywords hin
Add your keywords here
\end{keywords}
%%% Beginn des Artikeltexts
\section{Überschrift}

%%% Angabe der .bib-Datei (ohne Endung)
\bibliography{mybibfile}
\end{document}
91 changes: 91 additions & 0 deletions paper.bib
@@ -0,0 +1,91 @@
% Encoding: UTF-8
@InProceedings{ABC01,
author = {N. Abraham and U. Bibel and P. Corleone},
title = {Formatting Contributions for Proceedings},
pages = {46-53},
crossref = {Gl01},
}

@InBook{Az09,
pages = {135-162},
title = {Die Fußnote in LNI-Bänden},
author = {Azubi, L. and others},
crossref = {Gl09},
}

@Book{AB00,
title = {Formatierungsrichtlinien für Tagungsbände},
publisher = {Format-Verlag},
year = {2000},
author = {K. Abel and U. Bibel},
address = {Bonn},
}

@Book{Ez10,
title = {The Magic Format -- Your Way to Pretty Books},
publisher = {Noah \& Sons},
year = {2010},
author = {O. Ezgarani},
}

@Article{Gl06,
author = {H. I. Glück},
title = {Formatierung leicht gemacht},
journal = {Formatierungsjournal},
volume = {11},
number = {09},
year = {2009},
pages = {23-27},
}

@Book{Wa14,
title = {Essenzen der Informatik},
publisher = {Verlag Formvoll},
year = {2014},
author = {K. Wasser and H. Feuer and R. Erde and H. Licht},
}

@Book{Wa14b,
title = {Ganz neue Essenzen der Informatik im selben Jahr},
publisher = {Format-Verlag},
year = {2014},
author = {K. Wasser and H. Feuer and R. Erde and H. Licht},
}

@Proceedings{Gl01,
title = {Proc. 7th Int. Conf. on Formatting of Workshop-Proceedings},
year = {2001},
editor = {Glück, H. I.},
address = {San Francisco},
publisher = {Noah \& Sons},
booktitle = {Proc. 7th Int. Conf. on Formatting of Workshop-Proceedings},
}

@Book{Gl09,
title = {Formatierung 2009},
publisher = {Format-Verlag},
year = {2009},
editor = {H. I. Glück},
number = {999},
series = {LNI},
address = {Bonn},
booktitle = {Formatierung 2009},
}

@Misc{XX14,
title = {Anteil an Frauen in der Informatik},
label = {An},
howpublished = {Statistics Worldwide},
year = {2014},
}

@Online{GI14,
author = {{Gesellschaft für Informatik e.\,V.}},
label = {GI},
year = {2014},
url = {http://www.gi-ev.de},
urldate = {2014-12-24}
}

@Comment{jabref-meta: databaseType:biblatex;}

0 comments on commit 96ddcc0

Please sign in to comment.