Report and Dialogue Writing Functions

Detailed Description

These simple functions perform the vast majority of Tidy's output, and one these should be your first choice when adding your own output.

A report is typically diagnostic output that is generated each time Tidy detects an issue in your document or makes a change. A dialogue is a piece of information such as a summary, a footnote, or other non-tabular data. Some of these functions emit multiple reports or dialogue in order to effect a summary.

General Report Writing
If one of the convenience reporting functions does not fit your required message signature, then this designated reporting function will fit the bill. Be sure to see if a message formatter exists that can handle the variable arguments.
void	TY_❪Report❫ (TidyDocImpl *doc, Node *element, Node *node, uint code,...)
	The designated report writing function. More...

Convenience Reporting Functions
These convenience reporting functions are able to handle the bulk of Tidy's necessary reporting, and avoid the danger of using a variadic if you are unfamiliar with Tidy.
void	TY_❪ReportAccessError❫ (TidyDocImpl *doc, Node *node, uint code)
void	TY_❪ReportAttrError❫ (TidyDocImpl *doc, Node *node, AttVal *av, uint code)
void	TY_❪ReportBadArgument❫ (TidyDocImpl *doc, ctmbstr option)
void	TY_❪ReportEntityError❫ (TidyDocImpl *doc, uint code, ctmbstr entity, int c)
void	TY_❪ReportFileError❫ (TidyDocImpl *doc, ctmbstr file, uint code)
void	TY_❪ReportEncodingError❫ (TidyDocImpl *doc, uint code, uint c, Bool discarded)
void	TY_❪ReportEncodingWarning❫ (TidyDocImpl *doc, uint code, uint encoding)
void	TY_❪ReportMissingAttr❫ (TidyDocImpl *doc, Node *node, ctmbstr name)
void	TY_❪ReportSurrogateError❫ (TidyDocImpl *doc, uint code, uint c1, uint c2)
void	TY_❪ReportUnknownOption❫ (TidyDocImpl *doc, ctmbstr option)

General Dialogue Writing
These functions produce dialogue output such as individual messages, or several messages in summary form.
void	TY_❪Dialogue❫ (TidyDocImpl *doc, uint code,...)
	Emits a single dialogue message, and is capable of accepting a variadic that is passed to the correct message formatter as needed. More...

Output Dialogue Information
void	TY_❪ErrorSummary❫ (TidyDocImpl *doc)
	Outputs the footnotes and other dialogue information after document cleanup is complete. More...
void	TY_❪ReportMarkupVersion❫ (TidyDocImpl *doc)
	Outputs document HTML version and version-related information as the final report(s) in the report table. More...
void	TY_❪ReportNumWarnings❫ (TidyDocImpl *doc)
	Reports the number of warnings and errors found in the document as dialogue inforation. More...

Function Documentation

void TY_❪Dialogue❫	(	TidyDocImpl *	doc,
		uint	code,
			...
	)

Emits a single dialogue message, and is capable of accepting a variadic that is passed to the correct message formatter as needed.

void TY_❪ErrorSummary❫

(

TidyDocImpl *

doc

)

Outputs the footnotes and other dialogue information after document cleanup is complete.

LibTidy users might consider capturing these individually in the message callback rather than capturing this entire buffer. Called by tidyErrorSummary(), in console.

Todo:

: This name is a bit misleading and should probably be renamed to indicate its focus on printing footnotes.

void TY_❪ReportAccessError❫	(	TidyDocImpl *	doc,
		Node *	node,
		uint	code
	)

void TY_❪ReportAttrError❫	(	TidyDocImpl *	doc,
		Node *	node,
		AttVal *	av,
		uint	code
	)

void TY_❪ReportBadArgument❫	(	TidyDocImpl *	doc,
		ctmbstr	option
	)

void TY_❪ReportEncodingError❫	(	TidyDocImpl *	doc,
		uint	code,
		uint	c,
		Bool	discarded
	)

void TY_❪ReportEncodingWarning❫	(	TidyDocImpl *	doc,
		uint	code,
		uint	encoding
	)

void TY_❪ReportEntityError❫	(	TidyDocImpl *	doc,
		uint	code,
		ctmbstr	entity,
		int	c
	)

void TY_❪ReportFileError❫	(	TidyDocImpl *	doc,
		ctmbstr	file,
		uint	code
	)

void TY_❪ReportMarkupVersion❫

(

TidyDocImpl *

doc

)

Outputs document HTML version and version-related information as the final report(s) in the report table.

Called by tidyRunDiagnostics(), from console. Called by tidyDocReportDoctype(), currently unused.

void TY_❪ReportMissingAttr❫	(	TidyDocImpl *	doc,
		Node *	node,
		ctmbstr	name
	)

void TY_❪ReportNumWarnings❫

(

TidyDocImpl *

doc

)

Reports the number of warnings and errors found in the document as dialogue inforation.

Called by tidyRunDiagnostics(), from console.

void TY_❪ReportSurrogateError❫	(	TidyDocImpl *	doc,
		uint	code,
		uint	c1,
		uint	c2
	)

void TY_❪ReportUnknownOption❫	(	TidyDocImpl *	doc,
		ctmbstr	option
	)

void TY_❪Report❫	(	TidyDocImpl *	doc,
		Node *	element,
		Node *	node,
		uint	code,
			...
	)

The designated report writing function.

When a proper formatter exists, this one function can hanle all report output.