Platforms to show: All Mac Windows Linux Cross-Platform
Back to TidyDocumentMBS class.
TidyDocumentMBS.ErrorOutput as TidyOutputMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read and Write property)
Some examples using this property:
TidyDocumentMBS.Handle as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
TidyDocumentMBS.OptionAccessibilityCheck as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies what level of accessibility checking, if any, that Tidy should perform.
Level 0 (Tidy Classic) is equivalent to Tidy Classic's accessibility checking.
For more information on Tidy's accessibility checking, visit Tidy's Accessibility Page (http://www.html-tidy.org/accessibility/).
(Read and Write property)
TidyDocumentMBS.OptionAccessibilityCheckLevel as Integer Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Level 0 is equivalent to Tidy Classic's accessibility checking. For more information on Tidy's accessibility checking, visit the Adaptive Technology Resource Centre at the University of Toronto. :
http://www.aprompt.ca/Tidy/accessibilitychecks.html
(Read and Write property)
TidyDocumentMBS.OptionAddXmlDecl as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should add the XML declaration when outputting XML or XHTML.
Note that if the input already includes an <?xml ... ?> declaration then this option will be ignored.
If the encoding for the output is different from ascii, one of the utf* encodings, or raw, then the declaration is always added as required by the XML standard.
(Read and Write property)
TidyDocumentMBS.OptionAddXmlSpace as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should add xml:space="preserve" to elements such as <pre>, <style> and <script> when generating XML.
This is needed if the whitespace in such elements is to be parsed appropriately without having access to the DTD.
(Read and Write property)
TidyDocumentMBS.OptionAltText as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies the default alt= text Tidy uses for <img> attributes when the alt= attribute is missing.
Use with care, as it is your responsibility to make your documents accessible to people who cannot see the images.
(Read and Write property)
TidyDocumentMBS.OptionAnchorAsName as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option controls the deletion or addition of the name attribute in elements where it can serve as anchor.
If set to yes a name attribute, if not already existing, is added along an existing id attribute if the DTD allows it.
If set to no any existing name attribute is removed if an id attribute exists or has been added.
(Read and Write property)
TidyDocumentMBS.OptionAsciiChars as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Can be used to modify behavior of the clean option when set to yes.
If set to yes when using clean, &emdash;, &rdquo;, and other named character entities are downgraded to their closest ASCII equivalents.
(Read and Write property)
TidyDocumentMBS.OptionAssumeXmlProcins as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should change the parsing of processing instructions to require ?> as the terminator rather than >.
This option is automatically set if the input is in XML.
(Read and Write property)
TidyDocumentMBS.OptionBare as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should strip Microsoft specific HTML from Word 2000 documents, and output spaces rather than non-breaking spaces where they exist in the input.
(Read and Write property)
TidyDocumentMBS.OptionBlockTags as String Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option takes a space or comma separated list of tag names. Unless you declare new tags, Tidy will refuse to generate a tidied file if the input includes previously unknown tags. Note you can't change the content model for elements such as <TABLE>, <UL>, <OL> and <DL>. This option is ignored in XML mode.
(Read and Write property)
TidyDocumentMBS.OptionBodyOnly as Integer Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If set to "auto", this is performed only if the body tag has been inferred. Useful for incorporating existing whole pages as a portion of another page. This option has no effect if XML output is requested.
Value is 0 for no, 1 for yes and 2 for auto.
(Read and Write property)
TidyDocumentMBS.OptionBreakBeforeBr as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should output a line break before each <br> element.
(Read and Write property)
TidyDocumentMBS.OptionCharEncoding as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies the character encoding Tidy uses for both the input and output.
For ascii Tidy will accept Latin-1 (ISO-8859-1) character values, but will use entities for all characters whose value >127.
For raw, Tidy will output values above 127 without translating them into entities.
For latin1, characters above 255 will be written as entities.
For utf8, Tidy assumes that both input and output are encoded as UTF-8.
You can use iso2022 for files encoded using the ISO-2022 family of encodings e.g. ISO-2022-JP.
For mac and win1252, Tidy will accept vendor specific character values, but will use entities for all characters whose value >127.
For unsupported encodings, use an external utility to convert to and from UTF-8.
(Read and Write property)
TidyDocumentMBS.OptionClean as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should perform cleaning of some legacy presentational tags (currently <i>, <b>, <center> when enclosed within appropriate inline tags, and <font>). If set to yes then legacy tags will be replaced with CSS <style> tags and structural markup as appropriate.
(Read and Write property)
TidyDocumentMBS.OptionCoerceEndtags as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should coerce a start tag into an end tag in cases where it looks like an end tag was probably intended; for example, given
<span>foo <b>bar<b> baz</span>
Tidy will output
<span>foo <b>bar</b> baz</span>
(Read and Write property)
TidyDocumentMBS.OptionCssPrefix as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies the prefix that Tidy uses for styles rules.
By default, c will be used.
(Read and Write property)
TidyDocumentMBS.OptionDecorateInferredUl as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should decorate inferred <ul> elements with some CSS markup to avoid indentation to the right.
(Read and Write property)
TidyDocumentMBS.OptionDoctype as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies the DOCTYPE declaration generated by Tidy.
If set to omit the output won't contain a DOCTYPE declaration. Note this this also implies numeric-entities is set to yes.
If set to html5 the DOCTYPE is set to <!DOCTYPE html>.
If set to auto (the default) Tidy will use an educated guess based upon the contents of the document.
If set to strict, Tidy will set the DOCTYPE to the HTML4 or XHTML1 strict DTD.
If set to loose, the DOCTYPE is set to the HTML4 or XHTML1 loose (transitional) DTD.
Alternatively, you can supply a string for the formal public identifier (FPI).
For example:
doctype: "-//ACME//DTD HTML 3.14159//EN"
If you specify the FPI for an XHTML document, Tidy will set the system identifier to an empty string. For an HTML document, Tidy adds a system identifier only if one was already present in order to preserve the processing mode of some browsers. Tidy leaves the DOCTYPE for generic XML documents unchanged.
This option does not offer a validation of document conformance.
(Read and Write property)
TidyDocumentMBS.OptionDoctypeMode as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
TidyDocumentMBS.OptionDropEmptyElements as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should discard empty elements.
(Read and Write property)
TidyDocumentMBS.OptionDropEmptyParas as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should discard empty paragraphs.
(Read and Write property)
TidyDocumentMBS.OptionDropFontTags as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Deprecated; do not use. This option is destructive to <font> tags, and it will be removed from future versions of Tidy. Use the clean option instead.
If you do set this option despite the warning it will perform as clean except styles will be inline instead of put into a CSS class. <font> tags will be dropped completely and their styles will not be preserved.
If both clean and this option are enabled, <font> tags will still be dropped completely, and other styles will be preserved in a CSS class instead of inline.
See clean for more information.
(Read and Write property)
TidyDocumentMBS.OptionDropPropAttrs as Boolean Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read and Write property)
TidyDocumentMBS.OptionDropProprietaryAttributes as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should strip out proprietary attributes, such as Microsoft data binding attributes. Additionally attributes that aren't permitted in the output version of HTML will be dropped if used with strict-tags-attributes.
(Read and Write property)
TidyDocumentMBS.OptionDuplicateAttrs as Integer Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read and Write property)
TidyDocumentMBS.OptionEmacs as Boolean Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read and Write property)
TidyDocumentMBS.OptionEmacsFile as String Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read and Write property)
TidyDocumentMBS.OptionEmptyTags as String Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option takes a space or comma separated list of tag names. Unless you declare new tags, Tidy will refuse to generate a tidied file if the input includes previously unknown tags. Remember to also declare empty tags as either inline or blocklevel. This option is ignored in XML mode.
(Read and Write property)
TidyDocumentMBS.OptionEncloseBlockText as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should insert a <p> element to enclose any text it finds in any element that allows mixed content for HTML transitional but not HTML strict.
(Read and Write property)
TidyDocumentMBS.OptionEncloseBodyText as Boolean Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This is useful when you want to take existing HTML and use it with a style sheet.
(Read and Write property)
TidyDocumentMBS.OptionEncloseText as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should enclose any text it finds in the body element within a <p> element.
This is useful when you want to take existing HTML and use it with a style sheet.
(Read and Write property)
TidyDocumentMBS.OptionErrFile as String Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Normally errors and warnings are output to "stderr".
(Read and Write property)
TidyDocumentMBS.OptionErrorFile as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies the error file Tidy uses for errors and warnings. Normally errors and warnings are output to stderr.
(Read and Write property)
TidyDocumentMBS.OptionEscapeCdata as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should convert <![CDATA[]]> sections to normal text.
(Read and Write property)
TidyDocumentMBS.OptionEscapeScripts as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option causes items that look like closing tags, like </g to be escaped to <\/g. Set this option to 'no' if you do not want this.
(Read and Write property)
TidyDocumentMBS.OptionFixBackslash as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should replace backslash characters \ in URLs with forward slashes /.
(Read and Write property)
TidyDocumentMBS.OptionFixBadComments as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should replace unexpected hyphens with = characters when it comes across adjacent hyphens.
The default is yes.
This option is provided for users of Cold Fusion which uses the comment syntax: <!--- --->.
(Read and Write property)
TidyDocumentMBS.OptionFixComments as Boolean Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The default is yes. This option is provided for users of Cold Fusion which uses the comment syntax: <!--- --->
(Read and Write property)
TidyDocumentMBS.OptionFixUri as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should check attribute values that carry URIs for illegal characters and if such are found, escape them as HTML4 recommends.
(Read and Write property)
TidyDocumentMBS.OptionForceOutput as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should produce output even if errors are encountered.
Use this option with care; if Tidy reports an error, this means Tidy was not able to (or is not sure how to) fix the error, so the resulting output may not reflect your intention.
(Read and Write property)
Some examples using this property:
TidyDocumentMBS.OptionGdoc as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should enable specific behavior for cleaning up HTML exported from Google Docs.
(Read and Write property)
TidyDocumentMBS.OptionGnuEmacs as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should change the format for reporting errors and warnings to a format that is more easily parsed by GNU Emacs.
(Read and Write property)
TidyDocumentMBS.OptionGnuEmacsFile as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Used internally.
(Read and Write property)
TidyDocumentMBS.OptionHideComments as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option specifies if Tidy should print out comments.
(Read and Write property)
TidyDocumentMBS.OptionHideEndtags as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This option is an alias for omit-optional-tags.
(Read and Write property)
TidyDocumentMBS.OptionHtmlOut as Boolean Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read and Write property)
TidyDocumentMBS.OptionInCharEncoding as Integer Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See char-encoding for more info.
(Read and Write property)
The items on this page are in the following plugins: MBS Tools Plugin.