Inheritance diagram for tohtml.HtmlFormatter:

Public Member Functions
def	__init__ (self, processor, project_title, file_prefix)

def	make_section_url (self, section)

def	make_block_url (self, block)

def	make_html_words (self, words)

def	make_html_word (self, word)

def	make_html_para (self, words)

def	make_html_code (self, lines)

def	make_html_items (self, items)

def	print_html_items (self, items)

def	print_html_field (self, field)

def	html_source_quote (self, line, block_name=None)

def	print_html_field_list (self, fields)

def	print_html_markup (self, markup)

def	index_enter (self)

def	index_name_enter (self, name)

def	index_exit (self)

def	index_dump (self, index_filename=None)

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	section_enter (self, section)

def	block_enter (self, block)

def	markup_enter (self, markup, block)

def	markup_exit (self, markup, block)

def	block_exit (self, block)

def	section_exit (self, section)

def	section_dump_all (self)

Public Member Functions inherited from formatter.Formatter
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
	headers

	project_title

	file_prefix

	html_header

	html_index_header

	html_toc_header

	html_footer

	columns

	index_items

Public Attributes inherited from formatter.Formatter
	processor

	identifiers

	chapters

	sections

	block_index

	blocks

Detailed Description

Definition at line 198 of file tohtml.py.

Constructor & Destructor Documentation

◆ init()

def tohtml.HtmlFormatter.__init__	(	self,
		processor,
		project_title,
		file_prefix
	)

Definition at line 200 of file tohtml.py.

Member Function Documentation

◆ block_enter()

def tohtml.HtmlFormatter.block_enter	(	self,
		block
	)

Definition at line 538 of file tohtml.py.

References tohtml.HtmlFormatter.headers, content.ContentProcessor.headers, and tohtml.HtmlFormatter.html_source_quote().

◆ block_exit()

def tohtml.HtmlFormatter.block_exit	(	self,
		block
	)

Definition at line 581 of file tohtml.py.

References tohtml.HtmlFormatter.file_prefix.

◆ html_source_quote()

def tohtml.HtmlFormatter.html_source_quote	(	self,
		line,
		block_name = `None`
	)

Definition at line 334 of file tohtml.py.

References tohtml.html_quote(), formatter.Formatter.identifiers, and tohtml.HtmlFormatter.make_block_url().

Referenced by tohtml.HtmlFormatter.block_enter().

◆ index_dump()

def tohtml.HtmlFormatter.index_dump	(	self,
		index_filename = `None`
	)

Definition at line 438 of file tohtml.py.

References tohtml.HtmlFormatter.file_prefix.

◆ index_enter()

def tohtml.HtmlFormatter.index_enter ( self )

Definition at line 400 of file tohtml.py.

References tohtml.HtmlFormatter.html_index_header.

◆ index_exit()

def tohtml.HtmlFormatter.index_exit ( self )

Definition at line 409 of file tohtml.py.

References formatter.Formatter.block_index, tohtml.HtmlFormatter.columns, tohtml.HtmlFormatter.file_prefix, tohtml.HtmlFormatter.html_footer, and tohtml.HtmlFormatter.index_items.

◆ index_name_enter()

def tohtml.HtmlFormatter.index_name_enter	(	self,
		name
	)

Definition at line 404 of file tohtml.py.

References formatter.Formatter.identifiers, tohtml.HtmlFormatter.index_items, and tohtml.HtmlFormatter.make_block_url().

◆ make_block_url()

def tohtml.HtmlFormatter.make_block_url	(	self,
		block
	)

Definition at line 242 of file tohtml.py.

References tohtml.HtmlFormatter.make_section_url().

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

◆ make_html_code()

def tohtml.HtmlFormatter.make_html_code	(	self,
		lines
	)

convert a code sequence to HTML

Definition at line 303 of file tohtml.py.

References tohtml.html_quote().

Referenced by tohtml.HtmlFormatter.make_html_items().

◆ make_html_items()

def tohtml.HtmlFormatter.make_html_items	(	self,
		items
	)

convert a field's content into some valid HTML

Definition at line 311 of file tohtml.py.

References tohtml.HtmlFormatter.make_html_code(), and tohtml.HtmlFormatter.make_html_para().

Referenced by tohtml.HtmlFormatter.print_html_field(), tohtml.HtmlFormatter.print_html_items(), and tohtml.HtmlFormatter.section_enter().

◆ make_html_para()

def tohtml.HtmlFormatter.make_html_para	(	self,
		words
	)

convert words of a paragraph into tagged HTML text, handle xrefs

Definition at line 287 of file tohtml.py.

References tohtml.HtmlFormatter.make_html_word().

Referenced by tohtml.HtmlFormatter.make_html_items(), and tohtml.HtmlFormatter.toc_section_enter().

◆ make_html_word()

def tohtml.HtmlFormatter.make_html_word	(	self,
		word
	)

analyze a simple word to detect cross-references and styling

Definition at line 255 of file tohtml.py.

References tohtml.html_quote(), formatter.Formatter.identifiers, and tohtml.HtmlFormatter.make_block_url().

Referenced by tohtml.HtmlFormatter.make_html_para().

◆ make_html_words()

def tohtml.HtmlFormatter.make_html_words	(	self,
		words
	)

convert a series of simple words into some HTML text

Definition at line 245 of file tohtml.py.

References tohtml.html_quote().

◆ make_section_url()

def tohtml.HtmlFormatter.make_section_url	(	self,
		section
	)

Definition at line 239 of file tohtml.py.

References tohtml.HtmlFormatter.file_prefix.

Referenced by tohtml.HtmlFormatter.make_block_url(), and tohtml.HtmlFormatter.toc_section_enter().

◆ markup_enter()

def tohtml.HtmlFormatter.markup_enter	(	self,
		markup,
		block
	)

Definition at line 567 of file tohtml.py.

References tohtml.HtmlFormatter.print_html_markup().

◆ markup_exit()

def tohtml.HtmlFormatter.markup_exit	(	self,
		markup,
		block
	)

Definition at line 575 of file tohtml.py.

◆ print_html_field()

def tohtml.HtmlFormatter.print_html_field	(	self,
		field
	)

Definition at line 325 of file tohtml.py.

References tohtml.HtmlFormatter.make_html_items().

◆ print_html_field_list()

def tohtml.HtmlFormatter.print_html_field_list	(	self,
		fields
	)

Definition at line 364 of file tohtml.py.

References tohtml.HtmlFormatter.print_html_items().

Referenced by tohtml.HtmlFormatter.print_html_markup().

◆ print_html_items()

def tohtml.HtmlFormatter.print_html_items	(	self,
		items
	)

Definition at line 322 of file tohtml.py.

References tohtml.HtmlFormatter.make_html_items().

Referenced by tohtml.HtmlFormatter.print_html_field_list(), and tohtml.HtmlFormatter.print_html_markup().

◆ print_html_markup()

def tohtml.HtmlFormatter.print_html_markup	(	self,
		markup
	)

Definition at line 378 of file tohtml.py.

References tohtml.HtmlFormatter.print_html_field_list(), and tohtml.HtmlFormatter.print_html_items().

Referenced by tohtml.HtmlFormatter.markup_enter().

◆ section_dump_all()

def tohtml.HtmlFormatter.section_dump_all ( self )

Definition at line 589 of file tohtml.py.

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

◆ section_enter()

def tohtml.HtmlFormatter.section_enter	(	self,
		section
	)

Definition at line 493 of file tohtml.py.

References tohtml.HtmlFormatter.html_header, and tohtml.HtmlFormatter.make_html_items().

◆ section_exit()

def tohtml.HtmlFormatter.section_exit	(	self,
		section
	)

Definition at line 586 of file tohtml.py.

◆ toc_chapter_enter()

def tohtml.HtmlFormatter.toc_chapter_enter	(	self,
		chapter
	)

Definition at line 451 of file tohtml.py.

◆ toc_chapter_exit()

def tohtml.HtmlFormatter.toc_chapter_exit	(	self,
		chapter
	)

Definition at line 465 of file tohtml.py.

◆ toc_dump()

def tohtml.HtmlFormatter.toc_dump	(	self,
		toc_filename = `None`,
		index_filename = `None`
	)

Definition at line 481 of file tohtml.py.

References tohtml.HtmlFormatter.file_prefix.

◆ toc_enter()

def tohtml.HtmlFormatter.toc_enter ( self )

Definition at line 447 of file tohtml.py.

References tohtml.HtmlFormatter.html_toc_header.

◆ toc_exit()

def tohtml.HtmlFormatter.toc_exit ( self )

Definition at line 474 of file tohtml.py.

References tohtml.HtmlFormatter.file_prefix, and tohtml.HtmlFormatter.html_footer.

◆ toc_index()

def tohtml.HtmlFormatter.toc_index	(	self,
		index_filename
	)

Definition at line 469 of file tohtml.py.

◆ toc_section_enter()

def tohtml.HtmlFormatter.toc_section_enter	(	self,
		section
	)

Definition at line 455 of file tohtml.py.

References tohtml.HtmlFormatter.make_html_para(), and tohtml.HtmlFormatter.make_section_url().

◆ toc_section_exit()

def tohtml.HtmlFormatter.toc_section_exit	(	self,
		section
	)

Definition at line 462 of file tohtml.py.

Member Data Documentation

◆ columns

tohtml.HtmlFormatter.columns

Definition at line 237 of file tohtml.py.

Referenced by tohtml.HtmlFormatter.index_exit().

◆ file_prefix

tohtml.HtmlFormatter.file_prefix

Definition at line 213 of file tohtml.py.

Referenced by tohtml.HtmlFormatter.block_exit(), tohtml.HtmlFormatter.index_dump(), tohtml.HtmlFormatter.index_exit(), tohtml.HtmlFormatter.make_section_url(), tohtml.HtmlFormatter.section_dump_all(), tohtml.HtmlFormatter.toc_dump(), and tohtml.HtmlFormatter.toc_exit().

◆ headers

tohtml.HtmlFormatter.headers

Definition at line 211 of file tohtml.py.

Referenced by tohtml.HtmlFormatter.block_enter().

◆ html_footer

tohtml.HtmlFormatter.html_footer

Definition at line 233 of file tohtml.py.

Referenced by tohtml.HtmlFormatter.index_exit(), and tohtml.HtmlFormatter.toc_exit().

◆ html_header

tohtml.HtmlFormatter.html_header

Definition at line 214 of file tohtml.py.

Referenced by tohtml.HtmlFormatter.section_enter().

◆ html_index_header

tohtml.HtmlFormatter.html_index_header

Definition at line 221 of file tohtml.py.

Referenced by tohtml.HtmlFormatter.index_enter().

◆ html_toc_header

tohtml.HtmlFormatter.html_toc_header

Definition at line 227 of file tohtml.py.

Referenced by tohtml.HtmlFormatter.toc_enter().

◆ index_items

tohtml.HtmlFormatter.index_items

Definition at line 402 of file tohtml.py.

Referenced by tohtml.HtmlFormatter.index_exit(), and tohtml.HtmlFormatter.index_name_enter().

◆ project_title

tohtml.HtmlFormatter.project_title

Definition at line 212 of file tohtml.py.

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

C:/git/VL/src/external/freetype/src/tools/docmaker/tohtml.py

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ block_enter()

◆ block_exit()

◆ html_source_quote()

◆ index_dump()

◆ index_enter()

◆ index_exit()

◆ index_name_enter()

◆ make_block_url()

◆ make_html_code()

◆ make_html_items()

◆ make_html_para()

◆ make_html_word()

◆ make_html_words()

◆ make_section_url()

◆ markup_enter()

◆ markup_exit()

◆ print_html_field()

◆ print_html_field_list()

◆ print_html_items()

◆ print_html_markup()

◆ section_dump_all()

◆ section_enter()

◆ section_exit()

◆ toc_chapter_enter()

◆ toc_chapter_exit()

◆ toc_dump()

◆ toc_enter()

◆ toc_exit()

◆ toc_index()

◆ toc_section_enter()

◆ toc_section_exit()

Member Data Documentation

◆ columns

◆ file_prefix

◆ headers

◆ html_footer

◆ html_header

◆ html_index_header

◆ html_toc_header

◆ index_items

◆ project_title

◆ init()