Phoenix LaTeX für VS Code
Wissenschaftliche Arbeit (T1000, T2000, T3000, Bachelorarbeit …) nach der DHBW-Vorlage anlegen, schreiben,
das PDF direkt in VS Code sehen und vor der Abgabe alles prüfen. Gebraucht werden nur Phoenix LaTeX und
TeX Live – keine weitere Erweiterung.
Die Vorlage (Version 3.3) ist mitgeliefert.
Installieren
- TeX Live installieren (einmalig, vollständige Installation):
tug.org/texlive/windows.html (Windows),
MacTeX (macOS) oder
texlive-full (Linux).
- Phoenix LaTeX installieren:
phoenix-latex-<version>.vsix herunterladen. In VS Code links auf
Erweiterungen → oben rechts … → Aus VSIX installieren ….
- Links auf das Phoenix-Symbol (Flamme über dem Doktorhut) → Neue Arbeit anlegen, Angaben
ausfüllen, Arbeit anlegen. Das erste PDF wird sofort erstellt und rechts neben dem Text angezeigt.
Zwei Varianten beim Anlegen:
- Leer: Kapitelgerüst Einleitung bis Fazit, ohne Anleitung, Beispielkapitel, Beispielquellen und Beispiel-Glossar.
- Mit Anleitung und Beispielen: die komplette Vorlage zum Ausprobieren.
Eine vorhandene Arbeit öffnest du über Vorhandene Arbeit öffnen oder Datei → Ordner öffnen. Die Arbeit
wird auch erkannt, wenn du den Ordner darüber öffnest (z. B. Studium/ mit T1000/ und T2000/ darin);
bei mehreren Arbeiten fragt Phoenix, welche gemeint ist.
Umstieg von „DHBW LaTeX-Vorlage“ (1.x): die alte Erweiterung deinstallieren, Phoenix LaTeX installieren.
Vorhandene Arbeiten funktionieren weiter. Einmal Phoenix: Diese Arbeit einrichten (Befehlspalette, F1)
ergänzt die Projekteinstellungen – danach öffnet auch der Klick auf das PDF im Explorer die Vorschau.
Einstellungen dhbwLatex.… heißen jetzt phoenix.… und müssen neu gesetzt werden.
Schreiben
| Was |
Wie |
| PDF aktualisieren |
Speichern (Strg+S) oder Strg+Umschalt+B. Statusleiste unten links: „PDF aktuell · 42 S.“ oder „1 Fehler“ |
| Fehler finden |
Klick auf „Fehler“ in der Statusleiste oder Zur Stelle springen in der Meldung; Erklärung auf Deutsch |
| PDF ansehen |
PDF anzeigen – die Vorschau lädt nach jedem Erstellen neu und behält Zoom und Position |
| Text → PDF |
Stelle im PDF zeigen (Strg+Alt+J, Seitenleiste oder Rechtsklick): baut bei Bedarf neu und markiert die Stelle |
| PDF → Text |
Strg+Klick in die Vorschau (macOS: Cmd+Klick) springt zur Zeile im Text |
| Zitat einfügen |
Zitat einfügen …: Quelle suchen, indirekt/direkt, Seiten → \citeM{i}{Schluessel}{12}{14} |
| Quelle hinzufügen |
Quelle hinzufügen …: Formular für Buch, Artikel, Webseite, Sammelband, Sonstiges – oder DOI/ISBN eingeben und Daten holen |
| Abbildung einfügen |
Abbildung einfügen …: Bild wählen (wird bei Bedarf nach images/ kopiert), Bildunterschrift, Quelle |
| Glossarbegriff / Abkürzung |
Seitenleiste oder Rechtsklick; ein markiertes Wort wird als Vorschlag übernommen |
| Neues Kapitel |
Neues Kapitel … (wird automatisch eingebunden) |
| Beim Tippen |
Vorschläge nach \citeM{i}{, \cite{, \gls{, \ac{, \autoref{; Schnipsel citeM, tabelle, aufzaehlung |
| Gliederung |
Ansicht Gliederung im Explorer und die Pfadleiste über dem Text zeigen Kapitel und Abschnitte |
| Umfang |
Wörter zählen: Fließtext je Kapitel; die Seitenzahl steht in der Statusleiste |
| Anleitung der Vorlage |
Anleitung ausblenden (Seitenleiste → Prüfen & Abgabe) – lässt sich wieder einblenden; fehlen ihr dann Beispiele (Arbeit „leer“ angelegt), ergänzt Phoenix sie |
| Vor der Abgabe |
Abgabe prüfen: Platzhalter auf Deckblatt und im Abstract, Anleitung/Beispielkapitel noch drin, Quellen und Verweise ins Leere, \todo, leere Kapitel … |
| Verzeichnisse sehen alt aus |
Aufräumen & neu erstellen |
Das PDF liegt als dokumentation.pdf im Ordner der Arbeit, die Hilfsdateien im (ausgeblendeten) Unterordner output/.
Die PDF-Vorschau
Leiste oben: − / + (auch Tasten - und +), Seitenbreite (Taste 0), Seitenzahl zum Springen,
Dunkel kehrt die Farben für dunkle Themes um. Strg+Mausrad zoomt um den Mauszeiger. Text lässt sich
markieren und kopieren.
In einer Arbeit öffnet ein Klick auf ein PDF im Explorer die Phoenix-Vorschau (Einstellung
workbench.editorAssociations in .vscode/settings.json der Arbeit). Überall sonst bleibt alles, wie es ist;
dort geht es über Rechtsklick → Mit Phoenix-Vorschau öffnen.
Einstellungen
| Einstellung |
Bedeutung |
phoenix.beimSpeichernBauen |
manuell (Standard: bei Strg+S, nicht bei automatischem Speichern), immer, nie |
phoenix.pdfAutomatischAnzeigen |
PDF nach dem ersten Erstellen neben dem Text öffnen |
phoenix.texPfad |
Ordner mit pdflatex, falls die automatische Suche nichts findet |
phoenix.vorlagenOrdner |
eigener Ordner mit einer neueren Vorlage für Neue Arbeit anlegen |
Probleme?
Seitenleiste → Umgebung prüfen zeigt, ob TeX Live, BibTeX, kpsewhich, synctex und alle Pakete der
Vorlage da sind, installiert fehlende Pakete per tlmgr und bietet einen Probelauf an. Die komplette
Ausgabe steht im Ausgabefenster Phoenix LaTeX (LaTeX-Protokoll).
- „Kein TeX Live gefunden“: Nach der Installation Erneut prüfen – ein Neustart ist nicht nötig. Liegt
TeX an einem ungewöhnlichen Ort, den Ordner mit
pdflatex unter Ordner angeben … wählen.
- „Stelle im PDF zeigen“ springt nicht:
synctex gehört zu TeX Live; Umgebung prüfen zeigt, ob es
gefunden wird. Zu Kommentaren und Leerzeilen gibt es keine Stelle im PDF.
- PDF in Adobe Reader geöffnet: Windows sperrt die Datei. Adobe schließen oder die Vorschau in VS Code nutzen.
- Arbeit in OneDrive o. Ä.: funktioniert; meldet LaTeX „I can't write on file“, kurz warten und erneut speichern.
- DOI/ISBN-Abfrage: braucht Internet (doi.org, openlibrary.org, googleapis.com).
- Nach „Neue Arbeit anlegen“ passiert nichts: VS Code fragt beim ersten Öffnen eines Ordners, ob du den
Autoren vertraust. Erst nach Ja, ich vertraue den Autoren darf Phoenix bauen – dann geht es von selbst weiter.
- Noch nicht enthalten: Suche im PDF und anklickbare Links im PDF (z. B. im Inhaltsverzeichnis). Dafür das
PDF im Browser oder PDF-Programm öffnen (PDF im Datei-Explorer zeigen).
LaTeX Workshop
LaTeX Workshop wird nicht mehr gebraucht. Ist es trotzdem installiert, vertragen sich beide:
- Phoenix bietet einmal an, die Arbeit einzurichten. Dabei kommen vier Einstellungen in
.vscode/settings.json:
LaTeX Workshop baut nicht mehr automatisch beim Speichern (sonst bauen beide gleichzeitig) und sein grüner
Knopf schreibt in dieselben Ordner (output/).
- Vervollständigung und Gliederung überlässt Phoenix dann LaTeX Workshop (sonst erscheinen Vorschläge doppelt);
Phoenix ergänzt nur
\ac{…}, das LaTeX Workshop bei dieser Vorlage nicht kennt.
- Strg+Alt+J ist in beiden belegt. Springt die Phoenix-Vorschau nicht, Stelle im PDF zeigen über die
Seitenleiste oder den Rechtsklick nehmen – oder LaTeX Workshop deinstallieren.
Rechtschreibung
VS Code prüft von sich aus keine Rechtschreibung. Empfehlung: die Erweiterungen Code Spell Checker und
German – Code Spell Checker installieren und mit dem Befehl Enable German Spell Checker Dictionary einschalten.
Entwicklung
npm ci
npm run typecheck
npm test # Kern, Build-Engine (echtes TeX Live) und Extension mit API-Attrappe
npm run test:vorschau # PDF-Vorschau und Formulare in Chromium (braucht Playwright)
npm run package # → dist-vsix/phoenix-latex-<version>.vsix
Aufbau: src/core und src/build kommen ohne VS Code aus und sind mit Node testbar. src/ui enthält die
Oberfläche, media/viewer die PDF-Vorschau (läuft in der Webview, nutzt pdf.js aus media/pdfjs).
test/vscode-mock.ts ist eine Attrappe der VS-Code-API: Sie prüft Abläufe und Ladefehler, ersetzt aber
keinen Test in einem echten VS Code.
Abhängigkeiten stehen mit exakter Version in package.json (.npmrc: save-exact=true). Neue Versionen
erst übernehmen, wenn sie mindestens 14 Tage alt sind.
Neue Vorlage: Inhalt von vorlage/ ersetzen (.gitignore → _gitignore, .vscode → _vscode, weil das
Paketwerkzeug Punktordner auslässt) und die Version in package.json erhöhen.
Icon: media/icon.svg ändern, dann node scripts/icon.mjs (rendert media/icon.png mit Chromium).
Lizenz
Apache-2.0, siehe LICENSE.txt und NOTICE.txt (enthält die Hinweise zu pdf.js und jsonc-parser).
