Bachelor-Seminar WIF 640 (BUJ): Reports publizieren mit Markup-Sprachen

Zur gleichzeitigen Codierung von Text, Programmen und Daten haben sich seit einigen Jahren textbasierte Markup-Sprachen wie reStructuredText, Wiki-Markup und Markdown auf breiter Front durchgesetzt:

  • In der Data Science werden mit Jupyter-Notebooks Programm und sein Dokumentation engestens miteinander verwoben und mit Pandoc Cross-Media publiziert.
  • Mathematiker, Physiker und viele andere technische Autoren benutzen seit gut 40 Jahren sowieso nichts anderes als LaTeX;
  • Um menschenlesbar komfortabel Daten notieren und austauschen zu können bietet sich json und yaml an.
  • Im Semantic Web Umfeld werden mit textbasierte RDF-Serialisierungen wie Turtle komplexe Knowledge Graphs notiert.

Im Seminar stellen wir die verschiedenen Formate und Technologie-Stacks vor, mit denen sich Wirtschafts- und Unternehmensdaten publiszieren lassen.

Wir untersuchen vergleichend, worin ihre Stärken und Schwächen liegen, und welche Teilmengen an Ausdrucksmitteln sich verlustfrei ineinander überführen lassen.

Insgesamt geht es darum im Detail zu verstehen, wie eine integrierte Datenhaltung von Text, Code und Daten für Cross-Media-Publishing verwendet werden kann.

Themen

Jeder Seminarteilnehmer muss sich die Grundlagen aneignen von Markdown, LaTeX, Pandoc und json.

Einzelne Themen:

Block Thema
praktisches Dokumenten-Management mit Git Git Basics
Distributed Git - Distributed Workflows
Klassiker LaTeX
html5
DocBook
Markup Markdown
Dokuwiki und Media-Wiki
Transclusion in Dokuwiki
reStructuredText
Pandoc
Bibliographie Citeproc
BibTeX
Zotero
Citavi
Daten Json
Yaml
Turtle
HAW LA Typo 3

Präsentation

Aspekte

  • das Format selbst
  • Geschichte: Wer, wozu? Rezeption, aktuelle Entwickungen?
  • typischer Einsatz-Kontext
  • Editor-Unterstützung (z.B. notepad++, emacs, andere?)
  • Zusammenarbeit mit der Literaturverwaltung
  • Roundtrip mit Pandoc zu und von Markdown
  • Publizieren als html und pdf
  • Demo-Dokument: möglichst fancy: ausreizen und zeigen, was geht!
  • Demo am laufenden System

Medien

  • Im mündlichen Vortrag ist einen live-Demonstration enthalten, wie in dem jeweiligen Umfeld ein Dokument als Web- und/oder pdf-Dokument publiziert werden kann.
  • Sujet-typisch bietet es sich an, in diesem Demo-Dokument den Inhalt des Vortrags selbst zu spiegeln, d.h. das Dokument als ein erweitertes schriftliches Handout zum Vortrag zu konzipieren.
  • Als Texttyp für dieses Handout bietet sich ein wissenschaftlichen Short-Paper im Umfang von ca 2000 Zeichen an, incl. Abbildungen, wiss. Zitaten und einem ordentlichen Literaturverzeichnis.
  • Wir verwenden das Seminar insbesondere auch dazu, an einem kleinen, vergleichsweise einfachen Thema das wissenschaftliche Präsentieren (Vortrag plus wissenschaftliches Handout) auszuprobieren.
  • Abgabe der Präsentationsfolien und des überarbeiteten Handouts: ca 15.2.2020 (muss noch genauer spezifiziert werden).