Skip to content

Latest commit

 

History

History
115 lines (76 loc) · 4.57 KB

introduction.md

File metadata and controls

115 lines (76 loc) · 4.57 KB
Raw

Einleitung

Markdown und -Erweiterungen durch Pandoc

Für eine Einführung in (Pandoc-) Markdown vgl. pandoc.org/MANUAL.html.

Da als Backend \LaTeX{} zum Einsatz kommt, können alle entsprechenden Befehle und Umgebungen ebenfalls genutzt werden (ggf. muss noch das jeweilige Paket importiert werden).

Tipp: Für eine schnelle Übersicht einfach den Quelltext ansehen (./md/introduction.md).

Zitieren

Einfach den Bibtex-Key mit einem @ davor in eckigen Klammern schreiben: Aus [@Dietz2018] wird [@Dietz2018] ... Mit Seiten- oder Kapitelangabe: Aus [@Dietz2018, Seite 111] oder [@Dietz2018, Kapitel 111] wird [@Dietz2018, Seite 111] oder [@Dietz2018, Kapitel 111] ...

Pandoc (bzw. pandoc-citeproc) nutzt per Default den Chicago Manual of Style-Stil^[vgl. pandoc.org/MANUAL.html#citations]. Für andere Zitierstile (etwa numerisch oder als Fußnote) sind auf zotero.org/styles die passenden CSL-Dateien zum Download zu finden. Die Aktivierung erfolgt über die Option --csl=XXX.csl in der Datei Makefile.

Tipp: Unter editor.citationstyles.org/searchByName/ können Sie sich die Wirkung der jeweiligen Zitierstile/CSL-Definitionen anschauen.

Abbildungen

Hier steht die Bildunterschrift, Quelle: [@Dietz2018] \label{fig:foo}{width=80%}

Source-Code

def foo():
  """ Wuppie! """
  pass

Mathe

Display-Math geht wie in \LaTeX{} mit einem doppelten Dollarzeichen (entspricht der equation-Umgebung):

$$ \label{eq:wuppie} \nabla E(\mathbf{w}) = \left( \frac{\partial E}{\partial w_{0}}, \frac{\partial E}{\partial w_{1}}, \ldots, \frac{\partial E}{\partial w_{n}} \right)^T $$

Inline-Math geht mit einem einfachen Dollar-Zeichen: $\mathbf{w} \gets \mathbf{w} + \Delta\mathbf{w}$ ...

Tabellen

Rechtsbündig Linksbündig Default Zentriert
foo foo foo foo
123 123 123 123
bar bar bar bar

: Tabelle als Markdown-Pipe-Table, vgl. [@Dietz2018] \label{tab:ugh}

Leider gibt es derzeit einen Bug (siehe github.com/Wandmalfarbe/pandoc-latex-template/issues/29 bzw. github.com/jgm/pandoc/issues/3929), wodurch die Breite beim Einfärben der Tabellenzeilen etwas zu breit wird. Wenn das stört, kann man immer noch normale \LaTeX{}-Tabellen nutzen (siehe Tabelle \ref{tab:ieks}).

\begin{longtable}[]{rllc} \caption{Tabelle als \LaTeX{}-Table \label{tab:ieks}} \ \toprule Rechtsbündig & Linksbündig & Default & Zentriert \tabularnewline \midrule \endhead foo & foo & foo & foo \tabularnewline 123 & 123 & 123 & 123 \tabularnewline bar & bar & bar & bar \tabularnewline \bottomrule \end{longtable}

Querverweise

Querverweise funktionieren in Markdown leider nicht so richtig wie von \LaTeX{} gewohnt.

Hier kann aber einfach auf die ensprechenden \LaTeX{}-Pendants ausgewichen werden:

  • Definieren einer Referenz mit \label{<id>}{.latex} (beispielsweise in den jeweiligen Unterschriften unter einer Abbildung/Tabelle/Code-Schnipsel), und
  • Bezugnahme auf eine Referenz im Text mit \ref{<id>}{.latex}.

Vgl. Abbildung \ref{fig:foo} oder Tabelle \ref{tab:ugh} oder Listing \ref{lst:huh} ...

Wer mehr braucht, kann sogenannte Filter^[vgl. pandoc.org/filters.html bzw. pandoc.org/lua-filters.html] einsetzen, beispielsweise github.com/lierdakil/pandoc-crossref.

Hinweise zum generierten PDF

Das generierte PDF ist für den doppelseitigen Ausdruck gedacht. Wie bei einem Buch fangen neue Kapitel immer auf einer neuen rechten Seite an, d.h. es kann passieren, dass am Ende eines Kapitels ggf. eine leere Seite erzeugt wird. Dies ist durchaus beabsichtigt.