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)

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.

Reimplemented from LatexObject.

Definition at line 433 of file b2latex.py.

    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.
        """
        super().__init__()
        self.output += r"\author{"
        for author in authors:
            self.output += author + r"\\"
        self.output += r"}" + '\n'
        self.output += r"\date{\today}" + '\n'
        self.output += r"\title{" + title + r"}" + '\n'
        self.output += r"\maketitle" + '\n'
        if abstract:
            self.output += r"\begin{abstract}" + '\n'
            self.output += abstract
            self.output += '\n' + r'\end{abstract}' + '\n'
 
        if clearpage:
            self.output += r"\clearpage" + '\n'
        if add_table_of_contents:
            self.output += r"\tableofcontents" + '\n'
            self.output += r"\FloatBarrier" + '\n'
            if clearpage:
                self.output += r"\clearpage" + '\n'
 
 

---

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

• framework/scripts/B2Tools/b2latex.py