diff --git a/README.md b/README.md index b4dd697..9cf9453 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,15 @@ Pandoc ist ein Programm mit dem man Markdown (und andere formate) in viele versc Hier findest du die Vorlage zur generierung einer PDF oder eines Latex-Files für B-Prüfungen an der WBH. Es integriert die Vorlage für B-Prüfungen in den Arbeitsablauf für Pandoc. -# HowTo +## Installation -Kopiere die Vorlage in das Verzeichnis `/user/share/pandoc/data/templates`. Den Bilderordner benötigst du in deinem Projekt. +Kopiere die Vorlage in das Verzeichnis `/user/share/pandoc/data/templates`. In deinem Projekt fügst du an den anfang folgende Zeilen ein und füllst sie aus: + +## Verwendung + ``` --- title: Projektmanagemant für Anfänger @@ -23,4 +26,16 @@ lang: de --- ``` -nun kannst du dein Dokument mit hilfe des folgenden Befehls generieren: +### Variablen + +| Variable | Beschreibung | Optional | +| -------- | ------------ | -------- | +| title | Titel der Arbeit/B-Prüfung | nein | +| author | Der Uhrheber der Arbeit, in der Regel dein Name | nein | +| matrikelnr | Deine Matrikelnummer | nein | +| studiengang | Dein Studiengang | nein | +| fach | In welchem Fach wird die Prüfung bearbeitet | nein | +| aufgabencode | Der Code befindet sich auf deiner B-Prüfung ganz oben | nein | +| date | Datum der Abgabe | nein | +| lang | Sprache (Standard ist en = Englisch) | ja | +| logo | Der Pfad zum Logo (Standard ./Bilder/logo.png) | ja | diff --git a/b-pruefung.tex b/b-pruefung.tex index f2f99da..4701cc6 100644 --- a/b-pruefung.tex +++ b/b-pruefung.tex @@ -57,6 +57,10 @@ \pdfinfo{/CreationDate (D:20170605133321)} \renewcommand{\familydefault}{\sfdefault} +% Pandoc tightlisting +\providecommand{\tightlist}{% + \setlength{\itemsep}{0pt}\setlength{\parskip}{0pt}} + \begin{document} \titlespacing{\section}{0pt}{12pt plus 4pt minus 2pt}{-6pt plus 2pt minus 2pt} @@ -88,7 +92,7 @@ % ---------------------------------------------------------------------------------------------------------- \thispagestyle{empty} \begin{center} - \includegraphics[scale=0.2]{$if(logo)$ $logo$ $else$ Bilder/logo.png $endif$}\\ + \includegraphics[scale=0.2]{$if(logo)$$logo$$else$Bilder/logo.png$endif$}\\ \vspace*{2cm} \Large \textbf{Studiengang:}\\ diff --git a/beispiel/beispiel.pdf b/beispiel/beispiel.pdf new file mode 100644 index 0000000..0c3a274 Binary files /dev/null and b/beispiel/beispiel.pdf differ diff --git a/beispiel/pruefung.md b/beispiel/pruefung.md new file mode 100644 index 0000000..05cd228 --- /dev/null +++ b/beispiel/pruefung.md @@ -0,0 +1,43 @@ +--- +titel: Beispiel und Dokumentation zu Pandoc +author: Sebastian Preisner +matrikelnr: 900266 +studiengang: Technische Informatike +fach: Freizeitgestaltung +aufgabencode: Freiwillige Arbeit +date: 08.06.2017 +logo: ../Bilder/logo.png +lang: de +toc: true +--- + +# Was ist Pandoc? +[Pandoc](http://pandoc.org/) ist ein Übersetzer der eine Datei von einem Markup in ein anderes übersetzt. Markup ist das englische Wort für Auszeichnung und steht für +eine maschinenlesbare Sprache für die Gliederung und Formatierung von Texten und Daten. Der bekannteste Vertreter ist die die Hypertext Markup Language (HTML), die Kernsprache des World Wide Webs. +Pandoc bassiert hierbei auf einer erweiterten Variante der Auszeichnungssprache Markdown. + +Im folgenden findest du einige input Formate die von Pandoc unterstützt werden. Eine volle liste findest du auf der Webseite von Pandoc. + +- Markdown +- CommonMark +- LaTeX +- textil +- HTML +- EPUB +- LibreOffice/OpenOffice (odt) +- Microsoft Word DOCX (OOXML) +- Mediawiki +- DocBook + +All diese Formate unterstützt Pandoc auch für den Export und zusätzlich: + +- PDF via LaTeX +- Dokumentationsformate: DocBook, GNU TexInfo, Groff manpages +- HTML5, XHTML +- AsciiDoc + +## Wieso sollte ich Pandoc einsetzen? +Hierfür gibt es viele gute Argumente. Zum einen kannst du deine geschriebene Arbeit + +# Markdown für akademische Arbeiten +