Table of contents Index

class _LaTeX_

Declared in module PyLaTeX.LaTeX

Synopsis

class _LaTeX_:
    def X__init__(self)
    def X_writesection(self, type, full, short=None, label=None)
    def chapter(self, full, short=None, label=None)
    def close(self)
    def compile(self)
    def doc_class(self, name, option=None)
    def dvips(self)
    def equation(self, content, label=None)
    def file(self)
    def image(self, file, options=None, caption=None, shortcap=None, label=None)
    def lof(self)
    def lot(self)
    def open(self, file=None)
    def package(self, name, option=None)
    def preamble(self, data='')
    def ref(self, label)
    def toc(self)
    def write(self, data='')

tuple Chaps = ('part', 'section', 'subsection', 'subsubsection', 'paragraph', 'subparagraph')

Description

This class uses some internal classes which represent the different elementes of a LaTeX file:

_INTERNAL
Abstract base class for the element containing classes.
Class
Represents the document class.
Package
This is used for additional packages.
Chaps
Class insterted for chapter like commands.
Equation
This generates equations.
Figure
This adds a figure environment.
Line
This holds all informations added by write.

X__init__(self)

None

Crete a new LaTeX file instance.

X_writesection(self, type, full, short=None, label=None)

None

This method is used for the part, section, ... commands.

chapter(self, full, short=None, label=None)

None

This can't be handeled by _writesection because article like document classes can't handle chapters.

close(self)

None

Close (after actually writing it) the LaTeX file.

compile(self)

None

run LaTeX.

doc_class(self, name, option=None)

None

Declare the documentclass.

dvips(self)

None

Run dvips.

equation(self, content, label=None)

None

Add an euation

file(self)

None

To which file are the LaTeX commands written?

image(self, file, options=None, caption=None, shortcap=None, label=None)

None

Add an eps image using the graphicx package.

lof(self)

None

Add the list of figures.

lot(self)

None

Add the list of tables.

open(self, file=None)

None

Open the file to write the LaTeX commands to. If file is not given, generate a temporary filename.

package(self, name, option=None)

None

Add a \usepackage command.

preamble(self, data='')

None

Add a preamble command.

ref(self, label)

None

Generate a crossreference.

toc(self)

None

Add the table of contents.

write(self, data='')

None

Add a set of LaTeX commands.
Author: Berthold H\366llmann
Version: 1.11