/dhge-pi20-sem6

Mitschriften des Matrikel 2020, aus dem sechsten Semester des Studiengangs "Praktische Informatik", an der DHGE

Primary LanguageTeX

DHGE - Praktische Informatik - Matrikel 20 - Semester 6

Dieses Repository ist ein Projekt von Studierenden des Studiengangs "Praktische Informatik" der Dualen Hochschule Gera-Eisenach. Hier werden alle Mitschriften der einzelnen Modulen gesammelt. Die Skripte liegen im markdown-Format vor. Zur besseren Handhabung (und weil Github nur begrenzte markdown-Features bereitstellt) werden diese zusätzlich automatisch in PDFs umgewandelt und zur Verfügung gestellt.

Dieses Repo wurde von PI19 erstellt und gepflegt, PI20 führt hier diese Aufzeichnungen weiter.

Contributing (andere Jahrgänge)

Studierende anderer Jahrgänge sind dazu eingeladen, dieses Projekt als Grundlage für ihr eigenes, matrikelspezifsiches Repository zu nutzen. Du kannst folgendermaßen vorgehen:

  • Lerne in jedem Fall Git und Github kennen, frage deine Kommilitonen, frage das Internet, frage uns diesbezüglich.
  • Lerne außerdem hilfreiche Software kennen: Github Desktop, Visual Studio Code / andere Editoren, Git Bash, git-fork, GitKraken etc.
  • Beantrage ggf. Github Student Developer Pack (optional, aber nice to have)
  • Such dir engagierte Leute und
  • Informiere dich bei deinen Kommilitonen, ob schon jemand ein Repo / eine Orga angelegt hat. Falls wir (PI19) das mitkriegen folgt hier ein Link:
  • Es gibt schon ein Repo? Dort weiterlesen.
  • Es gibt noch kein Repo? Übernimm Verantwortung:
  1. Lege eine Organisation mit passendem Namen und Einstellungen an. (Wie wäre es mit importPI20fromDHGE?)
  2. Forke dieses Repository mit der Organisation als Besitzer, ändere ggf. den Namen.
  3. Nimm alle Sicherheitseinstellungen vor, stell das Repo auf Public, lade deine Kommilitonen zur Organsiation ein, verwalte Rechte.
  4. Klone (git clone) das neue Repo lokal auf deinem Computer.
  5. Passe ggf. das Top-Level README.md an.

Und dann kann es losgehen!

Contributing (PI 20)

Alle Kommilitonen PI19 sind dazu eingeladen, ihre eigenen Beiträge zu diesem Projekt zu leisten und ihre Ideen einzubringen. Wenn du einen Beitrag leisten willst, kannst du wie folgt vorgehen:

  1. Wenn du hier neu bist, erstelle auf jeden Fall ersteinmal ein Issue. Dann können wir uns gerne über deine Idee austauschen.
  2. git clone diese Repo und erstelle mit git checkout -b <branchname> eine neue Branch
  3. Implementiere deine Idee. Bei Fragen kannst du dich gerne über das Issue an uns wenden.
  4. Erstelle eine Pull Request, markiere dabei via @mention die Personen aus dem Issue und warte auf Feedback.

Module

Markdown-Erweiterungen

Alle Skripte in diesem Repository sind im markdown-Format verfasst. Für dieses existieren viele verschiedene Standards. Auf Github selbst ist der Funktionsumfang von markdown im Vergleich zu anderen Standards deutlich eingeschränkt. Es ist beispielsweise nicht möglich die Größe von Bilder zu definieren, Metadaten für Dokumente anzugeben oder Mathematische Formel darzustellen. Aus diesem Grund wird pandoc verwendet, um markdown-Dateien mit vielen Funktionserweiterungen in PDFs umzuwandeln. [Siehe unten](### list-Dateien) Damit eine Kompatibilität zum Github-markdown haben wir eigene Erweiterungen definiert, die im Folgenden beschrieben werden:

Markdown-Linter

In unseren Github Repositories kommt ein sogenannter Linter zum Einsatz. Dieser sorgt dafür, dass bei allen Markdown Dokumenten eine einheitliche Formatierung eingehalten wird. Damit bereits bei der lokalen Bearbeitung etwaige Fehler festgestellt werden können, empfehlen wir die Verwendung der VSCode-Extension markdownlint von David Anson. Dieses Repository enthält für die Extension bereits eine vorgefertigte Konfiguration, die automatisch verwendet wird.

Bildgröße

![Bildbeschreibung](assets/a.png)<!--width=200px-->
![Bildbeschreibung](assets/b.png)<!--height=200px-->

Pagebreaks usw

<!--pagebreak-->
<!--newpage-->
<!--clearpage-->

Mathematische Formel

Github unterstützt keine mathematischen Formeln. Als Workaround gibt es eine Erweiterung für Chrome. Ansonsten können Formeln in ihrer vollen Pracht nur in den PDFs betrachtet werden.

Dateilisten für Anki-Decks und PDFs

Zusätzlich zu den PDFs können aus Markdown-Dokumenten Anki-Decks generiert werden. Damit diese möglichst problemlos generiert werden können, sollten auch die Markdown Extensions hier beachtet werden. Durch einen Eintrag in den Dateien anki.list und pdf.list wird festgelegt, welche Dokumente als Anki-Deck bzw. PDF erstellt werden. Dabei muss folgende Syntax streng eingehalten werden:

  • pro Zeile wird genau ein Dokument angegeben
  • Eine Zeile besteht aus dem relativen Pfad (vom Repo-Stammverzeichnis aus) zur gewünschten Markdown-Datei, gefolgt von einem Semikolon als Trennzeichen, gefolgt vom Dateinamen ohne Pfad
  • es befinden sich keine Leerzeichen in einer Zeile
  • die Datei muss mit einer Leerzeile enden

Beispiele

anki.list

./SCH-IT/appendix/LKF.md;SCHIT-LKF.apkg
./PRO-K/README.md;PRO.apkg

pdf.list

./ABC-MUELLER-IT/appendix/LKF.md;MUELLER-ABC-LKF.pdf
./ML-FELDMANN/README.md;ML.pdf