Module sectioning

Functions for the formatting of titles, subtitles and other sectioning.

Functions

box(file=None, text=None, char=None)
Format and write out a box surrounding the text.

section(file=None, text=None, prespace=2, postspace=1)
Format and write out a section to the given file.

subsection(file=None, text=None, prespace=1, postspace=1)
Format and write out a subsection to the given file.

subsubsection(file=None, text=None, prespace=1, postspace=1)
Format and write out a subsubsection to the given file.

subsubtitle(file=None, text=None, prespace=1, postspace=1)
Format and write out a subsubtitle to the given file.

subtitle(file=None, text=None, prespace=1, postspace=1)
Format and write out a subtitle to the given file.

title(file=None, text=None, prespace=2, postspace=1)
Format and write out a title to the given file.

underline(file=None, text=None, char=None)
Format and write out the text underlined by the given character.

Variables

__package__ = None
hash(x)

Function Details

box(file=None, text=None, char=None)

Format and write out a box surrounding the text.

Parameters:

• file (file object) - The file object to write to.
• text (str) - The text to box.
• char (str) - The single character to use for the box.

section(file=None, text=None, prespace=2, postspace=1)

Format and write out a section to the given file.

Parameters:

• file (file object) - The file object to write to.
• text (str) - The section text.
• prespace (int) - The number of empty lines prior to the text printout.
• postspace (int) - The number of empty lines after the text printout.

subsection(file=None, text=None, prespace=1, postspace=1)

Format and write out a subsection to the given file.

Parameters:

• file (file object) - The file object to write to.
• text (str) - The subsection text.
• prespace (int) - The number of empty lines prior to the text printout.
• postspace (int) - The number of empty lines after the text printout.

subsubsection(file=None, text=None, prespace=1, postspace=1)

Format and write out a subsubsection to the given file.

Parameters:

• file (file object) - The file object to write to.
• text (str) - The subsubsection text.
• prespace (int) - The number of empty lines prior to the text printout.
• postspace (int) - The number of empty lines after the text printout.

subsubtitle(file=None, text=None, prespace=1, postspace=1)

Format and write out a subsubtitle to the given file.

Parameters:

• file (file object) - The file object to write to.
• text (str) - The subsubtitle text.
• prespace (int) - The number of empty lines prior to the text printout.
• postspace (int) - The number of empty lines after the text printout.

subtitle(file=None, text=None, prespace=1, postspace=1)

Format and write out a subtitle to the given file.

Parameters:

• file (file object) - The file object to write to.
• text (str) - The subtitle text.
• prespace (int) - The number of empty lines prior to the text printout.
• postspace (int) - The number of empty lines after the text printout.

title(file=None, text=None, prespace=2, postspace=1)

Format and write out a title to the given file.

Parameters:

• file (file object) - The file object to write to.
• text (str) - The title text.
• prespace (int) - The number of empty lines prior to the text printout.
• postspace (int) - The number of empty lines after the text printout.

underline(file=None, text=None, char=None)

Format and write out the text underlined by the given character.

Parameters:

• file (file object) - The file object to write to.
• text (str) - The text to underline.
• char (str) - The single character to use for the underline.