<style> .reveal h3 {font-size: 1.1em} </style> # Spielregeln * Eigenes Mikrofon: <span style="color: red">**AUS**</span> * Eigenes Video: <span style="color: green">**AN**</span> oder <span style="color: red">**AUS**</span> * Buttons: <!-- .element style="width: 80%"--> * Fragen nur im Chat --- # Texte schreiben in Markdown Adrian Pachzelt --- ## Das bin ich - Full-Stack-Entwickler/Data Engineer an der UB Frankfurt - Entwicklung einer semantischen Suche im [BIOfid](https://www.biofid.de)-Projekt - Automatisierung von Routineaufgaben - Streiter für Maschinenlesbarkeit - Tabletop-Rollenspiel-Nerd :sparkling_heart: `@GrazingScientist` --- ## Es war einmal in einem Text-Editor... ``` Das ist eine Überschrift Hier steht dann ein paar Worte Es folgt eine Unterüberschrift Vielleicht auch eine Aufzählung Links können auch eingefügt werden (https://www.website.de) ``` --- ## Es war einmal in einem Text-Editor... ``` # Das ist eine Überschrift Hier steht dann ein paar Worte ## Es folgt eine Unterüberschrift * Vielleicht * auch * eine * Aufzählung [Links können auch eingefügt werden](https://www.website.de) ``` --- ## Wozu Markdown? :arrow_right: **Beispiel**: `docx-Dokument` ---- <!-- .slide: style="font-size: 0.8em;" --> ### Ein Beispiel aus dem "echten" Word <w:body><w:p><w:pPr><w:pStyle w:val="Title"/><w:bidi w:val="0"/><w:spacing w:before="240" w:after="120"/><w:jc w:val="center"/><w:rPr></w:rPr></w:pPr><w:r><w:rPr></w:rPr><w:t><span><!-- .element: class="fragment highlight-current-red" data-fragment-index="1" -->Mein großartiges Paper, das in Nature oder wenigstens in PNAS veröffentlicht wird</span></w:t></w:r></w:p><w:p><w:pPr><w:pStyle w:val="<span><!-- .element: class="fragment highlight-red" data-fragment-index="2" -->Heading2</span>"/><w:bidi w:val="0"/><w:jc w:val="left"/><w:rPr></w:rPr></w:pPr><w:r><w:rPr></w:rPr><w:t><span><!-- .element: class="fragment highlight-current-red" data-fragment-index="1" -->Zusammenfassung</span></w:t></w:r></w:p><w:p><w:pPr><w:pStyle w:val="TextBody"/><w:bidi w:val="0"/><w:jc w:val="left"/><w:rPr></w:rPr></w:pPr><w:r><w:rPr></w:rPr><w:t><span><!-- .element: class="fragment highlight-current-red" data-fragment-index="1" -->Lorem ipsum dolor sit amet, consetetur sadipscing...</span> ---- ### Das gleiche in Markdown (nur Text) ``` # Zusammenfassung Lorem ipsum dolor sit amet, consetetur .... # Einleitung Lorem ipsum dolor sit amet, ... ``` ---- ### Das gleiche in Markdown (mit Metadaten) ``` --- title: Mein großartiges Paper, das in Nature oder wenigstens in PNAS veröffentlicht wird author: Adrian Pachzelt --- # Zusammenfassung Lorem ipsum dolor sit amet, consetetur .... # Einleitung Lorem ipsum dolor sit amet, ... ``` ---- ### Vorteile des Markdown-Formats * Einsteigerfreundlicher Kompromiss zwischen Style und Komfort * Teilen einer großen Datei in viele kleine * Versionierbarkeit * Archivierbarkeit * Maschinenlesbarkeit ---- ### Einsteigerfreundlichkeit ``` Das ist eine Überschrift Hier steht dann ein paar Worte Es folgt eine Unterüberschrift Vielleicht auch eine Aufzählung Links können auch eingefügt werden (https://www.website.de) ``` ---- ### Einsteigerfreundlichkeit ```mediawiki # Das ist eine Überschrift Hier steht dann ein paar Worte ## Es folgt eine Unterüberschrift * Vielleicht * auch * eine * Aufzählung [Links können auch eingefügt werden](https://www.website.de) ``` **Markdown** ---- ### Einsteigerfreundlichkeit ``` \section{Das ist eine Überschrift} \label{sec:ueberschrift} Hier steht dann ein paar Worte \subsection{Es folgt eine Unterüberschrift} \label{subsec:ueberschrift} \begin{itemize} \item Vielleicht \item auch \item eine \item Aufzählung \end{itemize} \href{https://www.website.de}{Links können auch eingefügt werden} ``` **LateX** ---- ### Versionierbarkeit **1. Version** `Kant beschrieb 1900 den kategorischen Imperativ, der davon ausgeht, dass...` <span><!-- .element class="fragment fade-in-then-out" --> **Änderung** `Kant hat ab 1900 'ne Menge Zeug geschrieben, unter anderem...` </span> --- ### Archivierbarkeit Texte lassen sich auch in 20 Jahren noch mit einem Texteditor lesen. ---- ### Machinenlesbarkeit Wiss. Veröffentlichungen werden heutzutage in Massen von Wissenschaftler\*innen mittels Skripten eingelesen und analysiert. ---- > Markdown?! Hab davon noch nie gehört! Wer benutzt denn sowas? > --- Anonyme\*r Student\*in ---- ## Markdown wird von vielen Anwendungen benutzt * Facebook Messenger * Discord * Skype * Slack * WhatsApp * Wikipedia ---- ## Online Markdown-Editoren * [StackEdit](https://stackedit.io) * [HackMD](https://hackmd.io/) Erlauben kollaboratives Schreiben ---- ## Desktop-Markdown Editoren * [Zettler](https://www.zettlr.com/) * [Atom IDE](https://ide.atom.io/) + Plugin [Mardown-Preview-Enhanced](https://atom.io/packages/markdown-preview-enhanced) --- ## Was passiert im Hintergrund? Umwandlung von Markdown in HTML ```mediawiki # Von den grünen Auen vor Frankfurt Als ich mich dem bezaubernden Tore ... ``` <!-- .element style="text-align: center" --> :arrow_down_small: ```htmlembedded <h1>Von den grünen Auen vor Frankfurt</h1> <p>Als ich mich dem bezaubernden Tore ...</p> ``` <!-- .element style="text-align: center" --> --- ## Tabellen in Markdown | Überschrift 1 | Überschrift 2| Anmerkungen | | ------------ | ------------ | ----------- | | Das ist eine Zelle | Das ist noch eine | Bemerkung | | Hier steht noch mehr | Hier nicht|| <!-- .element style="font-size: 0.8em" --> ---- ## Tabellen in Markdown ``` | Überschrift 1 | Überschrift 2| Anmerkungen | | ------------ | ------------ | ----------- | | Das ist eine Zelle | Das ist noch eine | Bemerkung | | Hier steht noch mehr | Hier nicht|| ``` --- ## Bilder in Markdown  ```  ``` --- ## Cheat Sheets * [Emoji-Cheat-Sheet](https://www.webfx.com/tools/emoji-cheat-sheet/) * [HackMD Features](https://hackmd.io/features?both) * [HackMD Syntax](https://www.markdownguide.org/tools/hackmd/) --- ## Präsentationen in Markdown Präsentation: https://hackmd.io/@apachzelt/SyU2eW3N8 Markdown-Skript: https://hackmd.io/@apachzelt/SyU2eW3N8/edit --- # Hands-on --- # Backup --- <!-- .slide: style="font-size: 0.8em;" --> ### Machinenlesbarkeit - Ein Beispiel #### Leseransicht > [...] reports of three species, the <span><!-- .element class="fragment highlight-red" data-fragment-index="1" -->widespread M. cantiana (Montagu, 1803)</span> and the endemic M. orsini (Villa & Villa, 1841) and M. ruffoi Giusti, 1973, and a number of taxa with uncertain taxonomic status (Alzona 1971; Manganelli et al. 1995). > --- <cite>[Pieńkowska et al. (2020)](https://zookeys.pensoft.net/article/56397/)</cite> ---- <!-- .slide: style="font-size: 0.8em;" --> ### Machinenlesbarkeit - Ein Beispiel #### Computeransicht `"widespread M. cantiana (Montagu, 1803)"` > [...] widespread <italic><span><!-- .element class="fragment highlight-current-red" data-fragment-index="1" -->\<tp:taxon-name></span><tp:taxon-name-part taxon-name-part-type="<span><!-- .element class="fragment highlight-blue" data-fragment-index="3" -->genus</span>" reg="<span><!-- .element class="fragment highlight-blue" data-fragment-index="3" -->Monacha</span>"><span><!-- .element class="fragment highlight-red" data-fragment-index="2" -->M.</span></tp:taxon-name-part><tp:taxon-name-part taxon-name-part-type="<span><!-- .element class="fragment highlight-current-blue" data-fragment-index="5" -->species</span>" reg="<span><!-- .element class="fragment highlight-blue" data-fragment-index="5" -->cantiana</span>"><span><!-- .element class="fragment highlight-red" data-fragment-index="4" -->cantiana</span></tp:taxon-name-part><span><!-- .element class="fragment highlight-current-red" data-fragment-index="1" --></tp:taxon-name></span></italic><span><!-- .element class="fragment highlight-red" data-fragment-index="6" -->(Montagu, 1803)</span> and [...]