Package adams.doc.latex

Class LatexHelper

java.lang.Object

adams.doc.latex.LatexHelper

public class LatexHelper
extends Object

Helper class for LaTeX setup.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field	Description
static String	BIBTEX	the bibtex executable.
static String	BINARIES_DIR	the binaries dir.
static String	EXECUTABLE	the executable.
static String	EXECUTABLE_OPTIONS	the executable options.
static String	FILENAME	the name of the props file.
protected static adams.core.Properties	m_Properties	the properties.

Constructor Summary

Constructors

Constructor	Description
LatexHelper()

Method Summary

Modifier and Type	Method	Description
static String	getBibtex()	Returns the bibtex executable.
static adams.core.io.PlaceholderDirectory	getBinariesDir()	Returns the binaries dir.
static String	getExecutable()	Returns the executable, eg pdflatex.
static String	getExecutableOptions()	Returns the executable options, eg "-halt-on-error".
static adams.core.Properties	getProperties()	Returns the underlying properties.
static boolean	writeProperties()	Writes the specified properties to disk.
static boolean	writeProperties(adams.core.Properties props)	Writes the specified properties to disk.

Methods inherited from class java.lang.Object

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

Field Detail

FILENAME

public static final String FILENAME

the name of the props file.

See Also:

Constant Field Values

BINARIES_DIR

public static final String BINARIES_DIR

the binaries dir.

See Also:

Constant Field Values

EXECUTABLE

public static final String EXECUTABLE

the executable.

See Also:

Constant Field Values

EXECUTABLE_OPTIONS

public static final String EXECUTABLE_OPTIONS

the executable options.

See Also:

Constant Field Values

BIBTEX

public static final String BIBTEX

the bibtex executable.

See Also:

Constant Field Values

m_Properties

protected static adams.core.Properties m_Properties

the properties.

Constructor Detail

LatexHelper

public LatexHelper()

Method Detail

getProperties

public static adams.core.Properties getProperties()

Returns the underlying properties.

Returns:

the properties

writeProperties

public static boolean writeProperties()

Writes the specified properties to disk.

Returns:

true if successfully stored

writeProperties

public static boolean writeProperties(adams.core.Properties props)

Writes the specified properties to disk.

Parameters:

props - the properties to write to disk

Returns:

true if successfully stored

getBinariesDir

public static adams.core.io.PlaceholderDirectory getBinariesDir()

Returns the binaries dir.

Returns:

the binaries dir

getExecutable

public static String getExecutable()

Returns the executable, eg pdflatex.

Returns:

the executable (no path)

getExecutableOptions

public static String getExecutableOptions()

Returns the executable options, eg "-halt-on-error".

Returns:

the executable options

getBibtex

public static String getBibtex()

Returns the bibtex executable.

Returns:

the bibtex executable (no path)