\AtBeginDvi

Aus goLaTeX

\AtBeginDvi ist eine LaTeX-Kern-Anweisung, um aus der Dokumentpräambel heraus noch vor Ausgabe der ersten Seite etwas in die Ausgabedatei zu schreiben.

Verwendung

Syntax

\AtBeginDvi{Code}

Parameter

{Code}
Der Code, der vor Ausgabe der ersten Seite in die Ausgabedatei geschrieben werden soll.

Beschreibung

In einigen Fällen ist es notwendig, dass Klassen oder Pakete in die Ausgabedatei etwas schreiben können, bevor die erste Seite ausgegeben wird. Dazu fügt LaTeX Code einer internen vertikalen Box hinzu, die vor der Ausgabe der ersten Seite ausgegeben wird. Wird die Anweisung in der Dokumentpräambel verwendet, so ist die Initialisierung von LaTeX noch nicht vollständig abgeschlossen. Schon deshalb ist in „LaTeX2ε for class and package writers” und den LaTeX-Quellen explizit dokumentiert, dass Code keine satztechnischen Ausgaben tätigen darf. Darüber hinaus ist nicht spezifiziert, welche Einflüsse diese auf die Ausgabe der ersten Seite hätten.

Beispielsweise verwenden die Pakete geometry und typearea diese Möglichkeit bei Ausgabe einer DVI-Datei, eine \special-Anweisung für die Seitengröße zu schreiben. Das graphics-Paket sorgt auf diesem Weg dafür, dass eine bestimmte header-Datei für dvips geladen wird. Der Name der Anweisung leitet sich von dieser ursprünglichen Verwendung ab. Der Inhalt der erwähnten Box wird jedoch auch bei der PDF-Ausgabe ausgegeben.

Da Code einer vertikalen Box hinzugefügt wird, findet eine Expansion im Gegensatz beispielsweise zu \AtBeginDocument unmittelbar bei Verwendung von \AtBeginDvi und nicht erst bei der Ausgabe der Box selbst statt.

Beispiele

Da die Anweisung nur für wenige Spezialfälle in Klassen oder Paketen sinnvoll eingesetzt werden kann, wird hier auf ein Beispiel verzichtet.

Verwandte Befehle

\AtBeginDocument, \AtEndDocument, \AtEndOfPackage, \BeforeClosingMainAux (KOMA-Script), \AfterReadingMainAux (KOMA-Script), \AfterPreamble (etoolbox), \AtEndPreamble (etoolbox), \AfterEndPreamble (etoolbox), \AfterEndDocument (etoolbox)

Verweise

Die Anweisung ist in den LaTeX-Quellen in Datei ltoutput.dtx definiert und zusätzlich zu source2e.pdf in „LaTeX2ε for class and package writers” dokumentiert.

Links