The Internal API is used exclusively within LibTidy.
If you are an HTML Tidy developer, then the internals API will be of especial importance to you.
- Note
- Always check first to determine whether or not an internal API representation exists for a public API function before invoking a public API function internally. In most cases, the public API functions simply call an internal function.
-
This documentation is not a substitute for browsing the source code. Although the public API is fairly well documented, the internal API is a very long, very slow, work-in-progress.
|
| 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.
|
|