de.dokutransdata.antlatex
Class LaTeX

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          de.dokutransdata.antlatex.SimpleExternalTask
              de.dokutransdata.antlatex.LaTeX

All Implemented Interfaces:

java.lang.Cloneable

public class LaTeX
extends SimpleExternalTask

Complex Task to generate DVI/PDF Files with (PDF)LaTeX.

Field Summary

static java.lang.String

RCS_ID

Fields inherited from class de.dokutransdata.antlatex.SimpleExternalTask

antTask, If, run, theCommand, thePath, verbose, workingDir

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

LaTeX()
Initialisierung (verbose = false, pdftex = false, clean = false)

Method Summary

void	add(FileSet f) Callback-Methode um eingeschachtelte <fileset>-Elemente einfügen zu können.
BibTeXTask	createBibtex()
java.lang.Object	createDeleteTempFiles() Callback-Methode fuer Ant
java.lang.Object	createGlosstex() Callback-Methode fuer Ant
java.lang.Object	createJxGlosstex() Callback-Methode fuer Ant
MakeindexTask	createMakeindex()
void	execute()
java.lang.String	getFileExtensions()
java.lang.String	getPassThruLaTeXParameters()
java.lang.String	getReRunPattern()
void	init()
boolean	isFigbib()
boolean	isGlossbib()
boolean	isMikTeX()
void	run() Eigentliche Verarbeitung der TeX/LaTeX-Datei.
void	setAuxDir(java.io.File s) Setzt das Arbeitsverzeichnis für TeX, darin befinden sich alle *.aux, *.log etc.
void	setClean(boolean flag) Schaltet das Löschen der temporären Dateien ein oder aus.
void	setFigbib(boolean figbib)
void	setFileExtensions(java.lang.String fileExtensionPattern)
void	setGlossbib(boolean glossbib)
void	setJobname(java.lang.String s) Die Ausgabedatei erhält jetzt den Wert von jobname, dabei werden jetzt intern mainFile und logfile gesetzt.
void	setLatexfile(java.lang.String s) Hauptdokument zur Verarbeitung.
void	setMikTeX(boolean isMikTeX)
void	setMultibib(boolean flag) Schaltet die Ausführung von MultiBibTeX-Verarbeitung ein oder aus.
void	setOutputDir(java.io.File s) Setzt das Ausgabeverzeichnis.
void	setPassThruLaTeXParameters(java.lang.String passThruLaTeXParameters)
void	setPdftex(boolean flag) Schaltet die Verarbeitung durch PDFLaTeX ein.
void	setReRunPattern(java.lang.String reRunPattern)

Methods inherited from class de.dokutransdata.antlatex.SimpleExternalTask

getCommand, getIf, getPath, getRun, invoke, setCommand, setIf, setPath, setRun, setVerbose, setWorkingDir

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RCS_ID

public static final java.lang.String RCS_ID

See Also:

Constant Field Values

Constructor Detail

LaTeX

public LaTeX()

Initialisierung (verbose = false, pdftex = false, clean = false)

Method Detail

createBibtex

public BibTeXTask createBibtex()

Returns:

Neuer BibTeX-Task

createMakeindex

public MakeindexTask createMakeindex()

Returns:

neuer MakeIndex-Task

createDeleteTempFiles

public java.lang.Object createDeleteTempFiles()

Callback-Methode fuer Ant

Returns:

Delete-Task

add

public void add(FileSet f)

Callback-Methode um eingeschachtelte <fileset>-Elemente einfügen zu können.

Parameters:

f - from build.xml

createGlosstex

public java.lang.Object createGlosstex()

Callback-Methode fuer Ant

Returns:

GlossTeX-Task

createJxGlosstex

public java.lang.Object createJxGlosstex()

Callback-Methode fuer Ant

Returns:

jxGlossTeX-Task

execute

public final void execute()
                   throws BuildException

Overrides:

execute in class Task

Throws:

BuildException

run

public void run()
         throws BuildException,
                java.io.IOException

Eigentliche Verarbeitung der TeX/LaTeX-Datei. Aufruf von LaTeX, BibTeX, MakeIndex und GlossTeX (je nach Bedarf).

Throws:

BuildException

java.io.IOException

init

public void init()

Overrides:

init in class Task

getReRunPattern

public final java.lang.String getReRunPattern()

Returns:

Returns the reRunPattern.

setReRunPattern

public final void setReRunPattern(java.lang.String reRunPattern)
                           throws BuildException

Parameters:

reRunPattern - The reRunPattern to set.

Throws:

BuildException

setMultibib

public void setMultibib(boolean flag)

Schaltet die Ausführung von MultiBibTeX-Verarbeitung ein oder aus. Hier wird mit einem Filterset die *.aux verarbeitet.

Parameters:

flag -

setClean

public void setClean(boolean flag)

Schaltet das Löschen der temporären Dateien ein oder aus.

Parameters:

flag -

getFileExtensions

public final java.lang.String getFileExtensions()

Returns:

Returns the fileExtensions.

setFileExtensions

public final void setFileExtensions(java.lang.String fileExtensionPattern)

Parameters:

fileExtensionPattern - The fileExtensionsPattern to set.

setLatexfile

public void setLatexfile(java.lang.String s)
                  throws BuildException

Hauptdokument zur Verarbeitung. Es können *.tex, *.ltx, *.dtx oder *.ins Dateien verarbeitet werden. Die Prüfung der Endung erfolgt nur, wenn der jobname nicht gesetzt ist!

Parameters:

s - Dateiname

Throws:

BuildException - Wenn die Endung nicht *.ltx, *.tex, *.dtx, *.ins ist oder nicht in fileExtensions gefunden wurde.

setJobname

public void setJobname(java.lang.String s)
                throws BuildException

Die Ausgabedatei erhält jetzt den Wert von jobname, dabei werden jetzt intern mainFile und logfile gesetzt.

Parameters:

s - Dateiname der Ausgabedatei

Throws:

BuildException - Wenn die Variablenauswertung nicht durchgeführt wurde.

setOutputDir

public void setOutputDir(java.io.File s)

Setzt das Ausgabeverzeichnis.

Parameters:

s -

setAuxDir

public void setAuxDir(java.io.File s)

Setzt das Arbeitsverzeichnis für TeX, darin befinden sich alle *.aux, *.log etc. Dateien.

Parameters:

s -

setPdftex

public void setPdftex(boolean flag)

Schaltet die Verarbeitung durch PDFLaTeX ein.

Parameters:

flag -

getPassThruLaTeXParameters

public final java.lang.String getPassThruLaTeXParameters()

Returns:

Returns the passThruLaTeXParameters.

setPassThruLaTeXParameters

public final void setPassThruLaTeXParameters(java.lang.String passThruLaTeXParameters)
                                      throws BuildException

Parameters:

passThruLaTeXParameters - The passThruLaTeXParameters to set.

Throws:

BuildException

isFigbib

public final boolean isFigbib()

Returns:

Returns the figbib.

setFigbib

public final void setFigbib(boolean figbib)

Parameters:

figbib - The figbib to set.

isGlossbib

public final boolean isGlossbib()

Returns:

Returns the glossbib.

setGlossbib

public final void setGlossbib(boolean glossbib)

Parameters:

glossbib - The glossbib to set.

isMikTeX

public final boolean isMikTeX()

Returns:

Returns the isMikTeX.

setMikTeX

public final void setMikTeX(boolean isMikTeX)

Parameters:

isMikTeX - The isMikTeX to set.