TitlePage Class Reference

Inheritance diagram for TitlePage:

Collaboration diagram for TitlePage:

Public Member Functions
def	__init__ (self, title, authors, abstract, add_table_of_contents=True, clearpage=True)
def	__str__ (self)
def	add (self)
def	finish (self)
def	save (self, filename, compile=False)

Public Attributes
	output
	Stores the outputted latex-code.

Detailed Description

Creates a latex title-page and optionally abstract and table-of-contents.
You should include only one of these objects in your latex code.

Definition at line 427 of file b2latex.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			title,
			authors,
			abstract,
			add_table_of_contents = True,
			clearpage = True
	)

Sets author, date, title property, calls maketitle, optionalla adds abstract and table-of-contents.
    @param title of the latex file.
    @param authors of the latex file, so the person who write the corresponding python-code with this framework :-)
    @param abstract optional abstract placed on the title-page.
    @param add_table_of_contents bool indicating of table-of-contents should be included.

Definition at line 433 of file b2latex.py.

Member Function Documentation

__str__()

def __str__ (   self )

inherited

Transform object to string, in this case, just returns .the generated latex-code

Definition at line 26 of file b2latex.py.

add()

def add (   self )

inherited

Add latex-code to the output string.
This method is usually overriden in the subclasses

Definition at line 32 of file b2latex.py.

finish()

def finish (   self )

inherited

Finishes the generation of latex-code.
E.g. adds end latex-commands
This method is usually overriden in the subclasses

Reimplemented in Itemize, and Graphics.

Definition at line 39 of file b2latex.py.

save()

def save (   self,   filename,   compile = False  )

inherited

Saves the latex-code into a file, adds preamble and end of document,
and compiles the code if requested.
    @param filename latex-code is stored in this file, should end on .tex
    @param compile compile the .tex file using pdflatex into a .pdf file

Definition at line 47 of file b2latex.py.

---

The documentation for this class was generated from the following file:

• framework/scripts/B2Tools/b2latex.py