▼External Public API | The Public API is the API that LibTidy programmers must access in order to harness HTML Tidy as a library |
Basic Operations | For an excellent example of how to invoke LibTidy, please consult console/tidy.c:main() for in-depth implementation details |
Configuration Options | Functions for getting and setting Tidy configuration options |
Diagnostics and Repair | After parsing the document, you can use these functions to attempt cleanup, repair, get additional diagnostics, and determine the document type |
Document Parse | Functions for parsing markup from a given input source, as well as string and filename functions for added convenience |
Document Save Functions | Save currently parsed document to the given output sink |
Document Tree | A parsed (and optionally repaired) document is represented by Tidy as a tree, much like a W3C DOM |
I/O and Messages | Tidy provides flexible I/O |
Localization Support | These functions help manage localization in Tidy |
Memory Allocation | Tidy can use a user-provided allocator for all memory allocations |
Message Key Management | These functions serve to manage message codes, i.e., codes that are used Tidy and communicated via its callback filters to represent reports and dialogue that Tidy emits |
Opaque Types | Instances of these types are returned by LibTidy API functions, however they are opaque; you cannot see into them, and must use accessor functions to access the contents |
Public Enumerations | Separated public enumerations header providing important indentifiers for LibTidy and internal users, as well as code-generator macros used to generate many of them. |
▼Internal API | The Internal API is used exclusively within LibTidy |
Configuration Options | This module organizes all of Tidy's configuration options, including picklist management, option setting and retrieval, option file utilities, and so on |
HTML Tags | This module organizes all of Tidy's HTML tag operations, such as parsing tags, defining tags, and user-defined tags |
HTML and XML Parsing | These functions and structures form the internal API for document parsing |
Key Discovery | LibTidy users may want to use TidyReportCallback to enable their own localization lookup features |
Message Creation and Releasing | |
Message Muting | Message types included in the mute option will be be printed in messageOut() |
Report Arguments Interrogation API | |
Report and Dialogue API | |
Report and Dialogue Writing Functions | These simple functions perform the vast majority of Tidy's output, and one these should be your first choice when adding your own output |
Tidy Release Information | These functions return information about the current release version date and version number |
Tidy Strings Generation Macros | Tidy aims to provide a consistent API for library users, and so we go to some lengths to provide a tidyStrings enum that consists of the message code for every string that Tidy can emit (used internally), and the array tidyStringsKeys[] containing string representations of each message code |
▼Tidy Console Application | HTML TidyLib command line driver. |
CLI Options Utilities | These structures, arrays, declarations, and definitions are used throughout this console application |
Configuration Options Utilities | Provide utilities to manipulate configuration options for output |
Experimental Stuff | From time to time the developers might leave stuff here that you can use to experiment on their own, or that they're using to experiment with |
Main | Let's do something here! |
Miscellaneous Utilities | This group contains general utilities used in the console application |
Output Helping Functions | This group functions that aid the formatting of output |
Provide the -export-config Services | |
Provide the -help Service | |
Provide the -help-config Service | |
Provide the -help-env Service | |
Provide the -help-option Service | |
Provide the -lang help Service | |
Provide the -show-config Service | |
Provide the -version Service | |
Provide the -xml-config Service | |
Provide the -xml-error-strings Service | |
Provide the -xml-help Service | |
Provide the -xml-options-strings Service | |
Provide the -xml-strings Service | |