Package lib :: Package text :: Module sectioning
[hide private]
[frames] | no frames]

Module sectioning

source code

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

Functions [hide private]
 
box(file=None, text=None, char=None)
Format and write out a box surrounding the text.
source code
 
section(file=None, text=None, prespace=2, postspace=1)
Format and write out a section to the given file.
source code
 
subsection(file=None, text=None, prespace=1, postspace=1)
Format and write out a subsection to the given file.
source code
 
subsubsection(file=None, text=None, prespace=1, postspace=1)
Format and write out a subsubsection to the given file.
source code
 
subsubtitle(file=None, text=None, prespace=1, postspace=1)
Format and write out a subsubtitle to the given file.
source code
 
subtitle(file=None, text=None, prespace=1, postspace=1)
Format and write out a subtitle to the given file.
source code
 
title(file=None, text=None, prespace=2, postspace=1)
Format and write out a title to the given file.
source code
 
underline(file=None, text=None, char=None)
Format and write out the text underlined by the given character.
source code
Variables [hide private]
  __package__ = None
hash(x)
Function Details [hide private]

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

source code 

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)

source code 

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)

source code 

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)

source code 

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)

source code 

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)

source code 

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)

source code 

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)

source code 

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.