From 4a82dd73974178d3b6ca1b8affbd02756849674c Mon Sep 17 00:00:00 2001 From: Reproog <64138508+Reproog@users.noreply.github.com> Date: Sun, 12 Jun 2022 21:24:43 +0200 Subject: [PATCH 1/4] Adding Simple Pandoc Introduction (TODO in README) --- Vorstellung/README.md | 164 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 164 insertions(+) create mode 100644 Vorstellung/README.md diff --git a/Vorstellung/README.md b/Vorstellung/README.md new file mode 100644 index 0000000..ccf07e1 --- /dev/null +++ b/Vorstellung/README.md @@ -0,0 +1,164 @@ +# Ein einfacher Pandoc/Markdown-Spickzettel + +pandoc ist ein Toolpaket zur Konvertierung zwischen Textformaten. Als +Schriftsteller (und nicht als Techniker) finde ich es nützlich, um +etwas, das in einfachem Text geschrieben wurde, in eine RTF-Datei zu +konvertieren, die ich in einem Textverarbeitungsprogramm - bis hin zum +gefürchteten Word - problemlos mit einigen Formatierungen lesen kann. +Was ich hier beschreibe, ist nur ein winziger Bruchteil dessen, was man +damit machen kann. + +Es ist so einfach wie: + +`$ pandoc -s datei.txt -o datei.rtf` + +(Ersetzen Sie \"rtf\" durch html usw., um etwas anderes zu erhalten). + +Es kann eine Datei konvertieren, die nur aus Tippen besteht, aber wenn +Sie ein wenig einfache Formatierung verwenden, ziemlich genau eine +Version der Markdown-Syntax, können Sie ein schönes RTF mit einigen +nützlichen Zusatzfunktionen (zum Beispiel Kursivschrift) erhalten. Für +eine Überschrift unterstreichen Sie mit Gleichheitszeichen oder +Bindestrichen in der nächsten Zeile; + + Überschrift hier + ------------ + +oder + + Überschrift hier + ============ + +wenn sie verarbeitet werden, ergibt das eine Überschrift. (Für richtige +H1 H2 usw. siehe unten). + +Die Absatzbildung wird durch Leerzeilen bestimmt, so dass dieser Text in +der RTF-Datei einen Absatz ergibt und\... + +Dieser Text\ +enthält auch\ +einen Absatz\ +in der RTF-Datei. + +Wenn ich einen Return erzwingen will, beende ich eine Zeile mit einem +Backslash. + +Dies funktioniert nicht innerhalb von Backtics (siehe unten), die die +wortwörtliche Umgebung darstellen. Wenn ich also zum Beispiel einen +Haufen Zeug wortwörtlich, ohne Zwischenabstände, haben möchte, beende +ich jede Zeile mit einem Backslash *außerhalb der* Backtics: + +`Zeile 1''`\ +`Zeile 2''`\ +`` `Zeile 3` `` + +wird geben + +`Zeile 1`\ +`Zeile 2`\ +`Zeile 3` + +## Schriftarten formatieren + +Das Wort ist das Zeichen, das zur Abgrenzung des geänderten Textes +verwendet wird. Der Code wird ebenfalls wörtlich angegeben. + +*Unterstrich* `_Unterstrich_` + +*Dollar* (mathematisch, was sich nicht in RTF übersetzen lässt) +`$dollar$` + +^caret^ (hochgestellt) \^caret\^ + +~tilde~ (tiefgestellt) `~tilde~` + +~~2 tildes~~ `~~tilde~~` + +**2 Unterstriche** `__2 Unterstriche__` + +**2 Sternchen** `**2 Sternchen**` + +***3 Sternchen*** `***3 Sternchen***` + +`zurück ticken ``` `zurück ticken` `` + +Beachten Sie, dass bei der Verwendung von Back Ticks (wortwörtlich) die +Verschachtelung der Anweisungen von Bedeutung ist + +`***Rückwärtshaken außerhalb von 3 Sternchen***` + +`3 Sternchen außerhalb des hinteren Häkchens` + +`2 Sternchen außerhalb des hinteren Häkchens` + +`1 Sternchen außerhalb des hinteren Häkchens` + +## Andere Dinge + +(Anmerkung: Die obige Zeile (\"Sonstiges\") wurde in der unmittelbar +folgenden Zeile mit Bindestrichen unterstrichen). + +Nonbreaking Space - einem Leerzeichen wird ein Backslash vorangestellt: +\'\\⌴\' (ich verwende ⌴ für ein Leerzeichen) + +> Anführungszeichen: \> (größer als leitet ein um 1 Tabulator +> eingerücktes Anführungszeichen ein) +> +> Blockzitat, wieder: \>\> gleich, größerer Einzug + +So zum Beispiel + + >Dieser Text würde als Blockzitat erscheinen, das um 1 Tabulator eingerückt ist. + +# H1 (1 Raute, #) + +Also schreiben: + + # Hier ist meine Überschrift 1 + +## H2 (2 Hashes, ##) + + ## Hier ist meine Überschrift 2 + +### H3 (3 Hashes, ###) + + ### Hier ist meine Überschrift 3 + +- Aufzählungspunkt (+ am Anfang der Zeile, dann Leerzeichen) +- Aufzählungspunkt (- (Bindestrich) am Anfang der Zeile, dann + Leerzeichen) +- Aufzählungspunkt (\* am Anfang der Zeile, dann Leerzeichen) + +1. Nummerierte Liste +2. Nummerierte Liste noch +3. Erneut nummerierte Liste + +(einfach eine Zeile mit einer Nummer und einem Stopp beginnen) + +\- 2 Bindestriche für en-Regel + +\- 3 Bindestriche für em-Regel + +## Metadaten + +Bei einigen Formaten (z. B. HTML) müssen Metadaten angegeben werden. Am +einfachsten ist es, wenn man + +`% Titel`\ +`% Autor(en)`\ +`% Datum` + +ganz oben in der Datei (ersetzen Sie \"Titel\", \"Autor\" und \"Datum\" +durch Ihren eigenen Text). + + +--- + +TODO: + + ++ [ ] Fußnoten und Bilder Verlinkung erklären ++ [ ] Pandoc Templates erklären ++ [ ] PDF-Engines Installerprobleme erklären + + From e2724926c6bc7e1bf98467bb1497a57fff4feb81 Mon Sep 17 00:00:00 2001 From: Reproog <64138508+Reproog@users.noreply.github.com> Date: Sun, 12 Jun 2022 21:26:11 +0200 Subject: [PATCH 2/4] Deleting Not necessary Lines in Introduction --- Vorstellung/README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/Vorstellung/README.md b/Vorstellung/README.md index ccf07e1..e7f6d73 100644 --- a/Vorstellung/README.md +++ b/Vorstellung/README.md @@ -1,10 +1,6 @@ # Ein einfacher Pandoc/Markdown-Spickzettel -pandoc ist ein Toolpaket zur Konvertierung zwischen Textformaten. Als -Schriftsteller (und nicht als Techniker) finde ich es nützlich, um -etwas, das in einfachem Text geschrieben wurde, in eine RTF-Datei zu -konvertieren, die ich in einem Textverarbeitungsprogramm - bis hin zum -gefürchteten Word - problemlos mit einigen Formatierungen lesen kann. +pandoc ist ein Toolpaket zur Konvertierung zwischen Textformaten. Was ich hier beschreibe, ist nur ein winziger Bruchteil dessen, was man damit machen kann. From d60b4a096ffc2f15f5b149cbc0cfe2e62bf45efa Mon Sep 17 00:00:00 2001 From: Reproog <64138508+Reproog@users.noreply.github.com> Date: Wed, 6 Jul 2022 10:35:47 +0200 Subject: [PATCH 3/4] Changing Header in Markdown Vorstellung --- Vorstellung/README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/Vorstellung/README.md b/Vorstellung/README.md index e7f6d73..cb341d7 100644 --- a/Vorstellung/README.md +++ b/Vorstellung/README.md @@ -14,19 +14,16 @@ Es kann eine Datei konvertieren, die nur aus Tippen besteht, aber wenn Sie ein wenig einfache Formatierung verwenden, ziemlich genau eine Version der Markdown-Syntax, können Sie ein schönes RTF mit einigen nützlichen Zusatzfunktionen (zum Beispiel Kursivschrift) erhalten. Für -eine Überschrift unterstreichen Sie mit Gleichheitszeichen oder -Bindestrichen in der nächsten Zeile; +eine Überschrift benutzen Sie '#'. 1 # steht für Ebene 1 (Titel). +2 # steht für Ebene 2, usw. Es gibt insgesamt 6 Ebenen. - Überschrift hier - ------------ -oder +# Überschrift 1 +## Überschrift 2 +... +###### Überschrift 6 - Überschrift hier - ============ - -wenn sie verarbeitet werden, ergibt das eine Überschrift. (Für richtige -H1 H2 usw. siehe unten). +--- Die Absatzbildung wird durch Leerzeilen bestimmt, so dass dieser Text in der RTF-Datei einen Absatz ergibt und\... @@ -39,10 +36,10 @@ in der RTF-Datei. Wenn ich einen Return erzwingen will, beende ich eine Zeile mit einem Backslash. -Dies funktioniert nicht innerhalb von Backtics (siehe unten), die die +Dies funktioniert nicht innerhalb von einfachen Anführungszeichen (siehe unten), die die wortwörtliche Umgebung darstellen. Wenn ich also zum Beispiel einen Haufen Zeug wortwörtlich, ohne Zwischenabstände, haben möchte, beende -ich jede Zeile mit einem Backslash *außerhalb der* Backtics: +ich jede Zeile mit einem Backslash *außerhalb der* Anführungszeichen: `Zeile 1''`\ `Zeile 2''`\ From a5788450aeff427f9e8835fae458c322ab74d732 Mon Sep 17 00:00:00 2001 From: Reproog <64138508+Reproog@users.noreply.github.com> Date: Wed, 6 Jul 2022 10:46:07 +0200 Subject: [PATCH 4/4] Changing Path to Latex Template from Gitlab to Github --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a3770d..ebe10e2 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## Pandoc Template -Das Template [seminarfach.latex](https://gitlab.com/october32551/tgsw_semi/-/blob/main/templates/seminarfach.latex) ist eine Modifikation des [default Pandoc Templates](https://github.com/jgm/pandoc/blob/master/data/templates/default.latex). +Das Template [seminarfach.latex](https://github.com/Tuesday8127/tgsw_seminarfach/blob/main/templates/seminarfach.latex) ist eine Modifikation des [default Pandoc Templates](https://github.com/jgm/pandoc/blob/master/data/templates/default.latex). ### Variablen @@ -64,6 +64,12 @@ Damit Es überhaupt etwas zu Zitieren gibt, wird eine Bib-Latex Datei benötigt. Ich zitiere: „Sein oder Nichtsein, das ist hier die Frage“[@citationkey]. ``` +Um die Seitenzahl oder einen Vergleich anzugeben kann so geschreiben werden: + +```md +Ich zitiere: „Sein oder Nichtsein, das ist hier die Frage“[vgl. @citationkey, S. 30]. +``` + Und im Header muss der Pfad zu `.bib` Datei angegeben werden z.B.: ```yaml