GladTeX: LaTeX-Formeln automatisch erstellen und verlinken

Aus ELVIS-Wiki
Zur Navigation springenZur Suche springen

Gladtex

Beschreibung und Zweck

Traditionell werden Formeln in der AG SBS als Bilder eingebunden, in deren Alternativtext (alt-Attribut) dann das entsprechende LaTeX-Äquivalent steht. Dies ist aufwendig, da man:

  • die Bildreferenz selbst erzeugen muss
  • das Bild selbst erzeugen muss
  • das Alt-Attribut im Falle eines kopierten Bildes selbst schreiben muss
  • die Ausrichtung der Grafik relativ zur Zeile korrekt bestimmen muss

Es gibt aber seit längerer Zeit ein Programm genannt GladTeX, welches dies automatisch vornimmt. Für die AG SBS wurde in dieses Program die Neuerung eingeführt, dass neben den Bildreferenzen auch der Alternativtext eingefügt wird und das zu lange Alternativtexte ausgelagert werden.

Download

Die jeweils neueste Version gibt es auf http://sourceforge.net/projects/gladtex/files/.

Installation

Die Installation wird in der Datei README beschrieben. Für Windows ist die Installation relativ schwierig, es werden aber in der genannten Datei Hinweise gegeben. Ansonsten sollte man unter Windows GladTeX zusammen mit dem AGSBS-Plugin nutzen.

Benutzung

Schreiben der HTML-Datei

Bei der Erstellung der HTML-Datei sind lediglich zwei Dinge zu beachten:

  • die Datei muss auf .htex enden
  • alle Formeln müssen in <EQ></EQ> eingebettet werden.

Wenn man bestimmte Anforderungen an die LaTeX-spezifischen Umgebungen der Formeln hat, kann man zusätzlich die Art der Umgebung angeben. Angenommen, man würde gern die Umgebung flalign* nutzen, schreibt man <EQ ENV="flalign*">Formel</EQ>.

Optionen

Auch GladTeX ist ein Kommandozeilenprogramm. Es bietet einige Optionen, um sein Verhalten zu steuern. Die Wichtigsten seien hier aufgeführt, gladtex -h gibt eine ausführlichere Übersicht.

-a
Diese Option lagert automatisch zu lange Formeln aus, damit sie leichter lesbar sind. Hintergrund ist, dass alle Zeilenumbrüche in dem alt-Attribut verloren gehen. Daher werden die Formel gekürzt dargestellt und sind ein Link, bei dessen Verfolgung die Formel dann in <pre/> dargestellt wird.
-d
Gibt das Verzeichnis für die Bilder, für die Datei gladtex.cache und die Datei desc.html an.
-p
Nutzt man in den Formeln Besonderheiten, die nicht in den Paketen amsmath und amssymb vorhanden sind, z.B. \kilo\meer, muss man das passende Paket angeben. Übergeben wird zum Beispiel dann folgendes:
-p '\usepackage[squaren]{SIunits}'

GladTeX speichert im Bildpfad auch eine Datei gladtex.cache. Die sollte man ruhig aufheben: hier werden die Formeln gespeichert, die bereits verwendet wurden. Falls man nun das Dokument erweitert, ändert oder schlicht Formeln doppelt vorkommen, werden diese doppelt genutzt.

Ein typischer Aufruf sieht dann so aus:

gladtex -a -d bilder kxx.htex

Anbindung an Pandoc

Pandoc ist ebenfalls in der Lage ein Dokument für GladTeX vorzubereiten, dazu dient die Option --gladtex. Ein Aufruf könnte so aussehen:

pandoc -s -f markdown -t html --gladtex kxx.htex
gladtex -a -d bilder kxx.htex

In Zukunft sollte diese Funktionalität aber durch das AGSBS-Plugin automatisiert werden.