Inheritance diagram for formatter.Formatter:

Public Member Functions
def	__init__ (self, processor)

def	add_identifier (self, name, block)

def	toc_enter (self)

def	toc_chapter_enter (self, chapter)

def	toc_section_enter (self, section)

def	toc_section_exit (self, section)

def	toc_chapter_exit (self, chapter)

def	toc_index (self, index_filename)

def	toc_exit (self)

def	toc_dump (self, toc_filename=None, index_filename=None)

def	index_enter (self)

def	index_name_enter (self, name)

def	index_name_exit (self, name)

def	index_exit (self)

def	index_dump (self, index_filename=None)

def	section_enter (self, section)

def	block_enter (self, block)

def	markup_enter (self, markup, block=None)

def	field_enter (self, field, markup=None, block=None)

def	field_exit (self, field, markup=None, block=None)

def	markup_exit (self, markup, block=None)

def	block_exit (self, block)

def	section_exit (self, section)

def	section_dump (self, section, section_filename=None)

def	section_dump_all (self)

Public Attributes
	processor

	identifiers

	chapters

	sections

	block_index

	blocks

Detailed Description

Definition at line 17 of file formatter.py.

Constructor & Destructor Documentation

◆ init()

def formatter.Formatter.__init__	(	self,
		processor
	)

Definition at line 19 of file formatter.py.

Member Function Documentation

◆ add_identifier()

def formatter.Formatter.add_identifier	(	self,
		name,
		block
	)

Definition at line 41 of file formatter.py.

References formatter.Formatter.identifiers.

◆ block_enter()

def formatter.Formatter.block_enter	(	self,
		block
	)

Definition at line 136 of file formatter.py.

◆ block_exit()

def formatter.Formatter.block_exit	(	self,
		block
	)

Definition at line 151 of file formatter.py.

◆ field_enter()

def formatter.Formatter.field_enter	(	self,
		field,
		markup = `None`,
		block = `None`
	)

Definition at line 142 of file formatter.py.

◆ field_exit()

def formatter.Formatter.field_exit	(	self,
		field,
		markup = `None`,
		block = `None`
	)

Definition at line 145 of file formatter.py.

◆ index_dump()

def formatter.Formatter.index_dump	(	self,
		index_filename = `None`
	)

Definition at line 114 of file formatter.py.

◆ index_enter()

def formatter.Formatter.index_enter ( self )

Definition at line 102 of file formatter.py.

◆ index_exit()

def formatter.Formatter.index_exit ( self )

Definition at line 111 of file formatter.py.

◆ index_name_enter()

def formatter.Formatter.index_name_enter	(	self,
		name
	)

Definition at line 105 of file formatter.py.

◆ index_name_exit()

def formatter.Formatter.index_name_exit	(	self,
		name
	)

Definition at line 108 of file formatter.py.

◆ markup_enter()

def formatter.Formatter.markup_enter	(	self,
		markup,
		block = `None`
	)

Definition at line 139 of file formatter.py.

◆ markup_exit()

def formatter.Formatter.markup_exit	(	self,
		markup,
		block = `None`
	)

Definition at line 148 of file formatter.py.

◆ section_dump()

def formatter.Formatter.section_dump	(	self,
		section,
		section_filename = `None`
	)

Definition at line 157 of file formatter.py.

Referenced by formatter.Formatter.section_dump_all(), and tohtml.HtmlFormatter.section_dump_all().

◆ section_dump_all()

def formatter.Formatter.section_dump_all ( self )

Definition at line 184 of file formatter.py.

References formatter.Formatter.section_dump(), formatter.Formatter.sections, content.DocChapter.sections, and content.ContentProcessor.sections.

◆ section_enter()

def formatter.Formatter.section_enter	(	self,
		section
	)

Definition at line 133 of file formatter.py.

◆ section_exit()

def formatter.Formatter.section_exit	(	self,
		section
	)

Definition at line 154 of file formatter.py.

◆ toc_chapter_enter()

def formatter.Formatter.toc_chapter_enter	(	self,
		chapter
	)

Definition at line 57 of file formatter.py.

◆ toc_chapter_exit()

def formatter.Formatter.toc_chapter_exit	(	self,
		chapter
	)

Definition at line 66 of file formatter.py.

◆ toc_dump()

def formatter.Formatter.toc_dump	(	self,
		toc_filename = `None`,
		index_filename = `None`
	)

Definition at line 75 of file formatter.py.

◆ toc_enter()

def formatter.Formatter.toc_enter ( self )

Definition at line 54 of file formatter.py.

◆ toc_exit()

def formatter.Formatter.toc_exit ( self )

Definition at line 72 of file formatter.py.

◆ toc_index()

def formatter.Formatter.toc_index	(	self,
		index_filename
	)

Definition at line 69 of file formatter.py.

◆ toc_section_enter()

def formatter.Formatter.toc_section_enter	(	self,
		section
	)

Definition at line 60 of file formatter.py.

◆ toc_section_exit()

def formatter.Formatter.toc_section_exit	(	self,
		section
	)

Definition at line 63 of file formatter.py.

Member Data Documentation

◆ block_index

formatter.Formatter.block_index

Definition at line 24 of file formatter.py.

Referenced by tohtml.HtmlFormatter.index_exit().

◆ blocks

formatter.Formatter.blocks

Definition at line 27 of file formatter.py.

Referenced by sources.SourceProcessor.add_block_lines(), sources.SourceProcessor.dump(), and sources.SourceProcessor.reset().

◆ chapters

formatter.Formatter.chapters

Definition at line 22 of file formatter.py.

◆ identifiers

formatter.Formatter.identifiers

Definition at line 21 of file formatter.py.

Referenced by formatter.Formatter.add_identifier(), tohtml.HtmlFormatter.html_source_quote(), tohtml.HtmlFormatter.index_name_enter(), and tohtml.HtmlFormatter.make_html_word().

◆ processor

formatter.Formatter.processor

Definition at line 20 of file formatter.py.

◆ sections

formatter.Formatter.sections

Definition at line 23 of file formatter.py.