Softwareentwicklungspraktikum: LaTeXBuddy

Zielbestimmung

In diesem Projekt soll ein modulares, kollaborationsfähiges Tool zum automatischen Prüfen von LaTeX-Dokumenten entwickelt werden. Es gibt diverse Tools wie languagetool, chktex, etc., die es erlauben Rechtschreibefehler, Grammatikfehler und problematische LaTeX-Nutzung (veraltete Packages, etc.) und weiteres zu erkennen. Wir wollen diese ganzen Tools bündeln und den Nutzern einen einheitlichen Report mit allen Meldungen geben. Ein vergleichbares Projekt ist textidote, das in Java geschrieben ist. Wir wollen aber einen anderen Ansatz als textidote nehmen:

• Es gibt sehr viele False Positives. Das zu entwickelnde Tool soll eine einheitliche Whitelist ermöglichen, die auch über Git geteilt werden kann, damit nicht jeder dem Spellchecker erstmal beibringen muss, dass 'Fekete' kein Rechtschreibefehler ist.
• Das Tool soll modular sein und einfach die Einbindung weiterer Tools erlauben. Hier ist ein grosser Vorteil von Python, dass man Plugins schreiben kann, ohne neu kompilieren zu müssen.

Im Idealfall werdet Ihr die zweite Hälfte Eurer SEP-Dokumente bereits mit Eurem Tool analysieren und korrigieren.

Eine etwas ältere Variante ohne grafische Ausgabe könnt Ihr auch hier sehen. Insbesondere, dass die Tools wirklich schon fast alles für euch übernehmen. Primär geht es also um die Entwicklung eines intuitiven Interfaces mit ein paar Goodies. Dies lässt sich im Team auch gut aufteilen: Eine Person kann etwa für die Anbindung von LanguageTool zuständig sein, eine andere kann sich um chktex kümmern, eine andere kann den HTML Bericht aller Fehlermeldungen machen (hierfür muss sich natürlich auf ein einheitliches Format geeinigt werden).

Rahmenbedingungen

Das Projekt soll von einem Team von 8+/-2 Studenten bearbeitet werden.

Programmiersprachen

• Es soll in Python mit Fokus auf Unix-Systeme entwickelt werden.

Es ist sehr vorteilhaft, wenn Ihr vorher schon Erfahrung mit LaTex und der Command Line gemacht habt. Einige Dinge können auch während des Projekts noch gelernt werden, aber es wird schwierig wenn Ihr in keinem der genannten Bereichen Erfahrung habt.

Organisatorisches

Die zentrale Organisation erfolgt durch das ISF. Die Teilnahme, insbesondere am Kickoff-Meeting und den ersten regelmäßigen Treffen, ist für alle Teilnehmer verpflichtend. Im Krankheitsfall erwarten wir ein ärztliches Attest.

Die Kommunikation erfolgt ausschließlich durch unsere Mailingliste. In diese werdet Ihr von uns automatisch nach der Gruppeneinteilung eingetragen. Wir nutzen hierfür Eure offizielle *@tu-bs.de Addresse (diese stimmt nicht mit StudIP überein! Ihr braucht hierfür ein normalen E-Mail-Clienten wie Thunderbird.). Stellt bitte sicher, dass Ihr Mail über diese Addresse auch tatsächlich erhaltet. Andernfalls kann es passieren, dass Ihr Pflichttermine verpasst. Später könnt Ihr auch Eure private (uns aber bei Anmeldung nicht bekannte) E-Mail-Adresse verwenden.