Platforms to show: All Mac Windows Linux Cross-Platform
Back to TidyDocumentMBS class.
TidyDocumentMBS.OptionIndent 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 if Tidy should indent block-level tags.
If set to auto Tidy will decide whether or not to indent the content of tags such as <title>, <h1>-<h6>, <li>, <td>, or <p> based on the content including a block-level element.
Setting indent to yes can expose layout bugs in some browsers.
Use the option indent-spaces to control the number of spaces or tabs output per level of indent, and indent-with-tabs to specify whether spaces or tabs are used.
(Read and Write property)
TidyDocumentMBS.OptionIndentAttributes 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 begin each attribute on a new line.
(Read and Write property)
TidyDocumentMBS.OptionIndentCdata 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 indent <![CDATA[]]> sections.
(Read and Write property)
TidyDocumentMBS.OptionIndentContent 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.OptionIndentSpaces 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 number of spaces or tabs that Tidy uses to indent content when indent is enabled.
Note that the default value for this option is dependent upon the value of indent-with-tabs (see also).
(Read and Write property)
TidyDocumentMBS.OptionIndentWithTabs 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 indent with tabs instead of spaces, assuming indent is yes.
Set it to yes to indent using tabs instead of the default spaces.
Use the option indent-spaces to control the number of tabs output per level of indent. Note that when indent-with-tabs is enabled the default value of indent-spaces is reset to 1.
Note tab-size controls converting input tabs to spaces. Set it to zero to retain input tabs.
(Read and Write property)
TidyDocumentMBS.OptionInlineTags as String Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Unless you declare new tags, Tidy will refuse to generate a tidied file if the input includes previously unknown tags. This option is ignored in XML mode.
(Read and Write property)
TidyDocumentMBS.OptionInputEncoding 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 the input. See char-encoding for more info.
(Read and Write property)
TidyDocumentMBS.OptionInputXml 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 use the XML parser rather than the error correcting HTML parser.
(Read and Write property)
TidyDocumentMBS.OptionJoinClasses 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 combine class names to generate a single, new class name if multiple class assignments are detected on an element.
(Read and Write property)
TidyDocumentMBS.OptionJoinStyles 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 combine styles to generate a single, new style if multiple style values are detected on an element.
(Read and Write property)
TidyDocumentMBS.OptionKeepFileTimes 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 no. Setting the option to yes allows you to tidy files without causing these files to be uploaded to a web server when using a tool such as SiteCopy. Note this feature is not supported on some platforms.
(Read and Write property)
TidyDocumentMBS.OptionKeepTime 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 keep the original modification time of files that Tidy modifies in place.
Setting the option to yes allows you to tidy files without changing the file modification date, which may be useful with certain tools that use the modification date for things such as automatic server deployment.
Note this feature is not supported on some platforms.
(Read and Write property)
TidyDocumentMBS.OptionLanguage as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Currently not used, but this option specifies the language Tidy would use if it were properly localized. For example: en.
(Read and Write property)
TidyDocumentMBS.OptionLiteralAttribs 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.OptionLiteralAttributes 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 how Tidy deals with whitespace characters within attribute values.
If the value is no Tidy normalizes attribute values by replacing any newline or tab with a single space, and further by replacing any contiguous whitespace with a single space.
To force Tidy to preserve the original, literal values of all attributes and ensure that whitespace within attribute values is passed through unchanged, set this option to yes.
(Read and Write property)
TidyDocumentMBS.OptionLogicalEmphasis 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 any occurrence of <i> with <em> and any occurrence of <b> with <strong>. Any attributes are preserved unchanged.
This option can be set independently of the clean option.
(Read and Write property)
TidyDocumentMBS.OptionLowerLiterals 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 the value of an attribute that takes a list of predefined values to lower case.
This is required for XHTML documents.
(Read and Write property)
TidyDocumentMBS.OptionMakeBare 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.OptionMakeClean as Boolean Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
It works well on the HTML saved by Microsoft Office products.
(Read and Write property)
TidyDocumentMBS.OptionMark as Boolean Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Tidy won't add a meta element if one is already present.
(Read and Write property)
TidyDocumentMBS.OptionMarkup 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 generate a pretty printed version of the markup. Note that Tidy won't generate a pretty printed version if it finds significant errors (see force-output).
(Read and Write property)
TidyDocumentMBS.OptionMergeDivs 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 can be used to modify the behavior of clean when set to yes.
This option specifies if Tidy should merge nested <div> such as <div><div>...</div></div>.
If set to auto the attributes of the inner <div> are moved to the outer one. Nested <div> with id attributes are not merged.
If set to yes the attributes of the inner <div> are discarded with the exception of class and style.
(Read and Write property)
TidyDocumentMBS.OptionMergeEmphasis 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 merge nested <b> and <i> elements; for example, for the case
<b class="rtop-2">foo <b class="r2-2">bar</b> baz</b>,
Tidy will output <b class="rtop-2">foo bar baz</b>.
(Read and Write property)
TidyDocumentMBS.OptionMergeSpans 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 can be used to modify the behavior of clean when set to yes.
This option specifies if Tidy should merge nested <span> such as <span><span>...</span></span>.
The algorithm is identical to the one used by merge-divs.
(Read and Write property)
TidyDocumentMBS.OptionNcr 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 allow numeric character references.
(Read and Write property)
TidyDocumentMBS.OptionNewBlocklevelTags 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 new block-level tags. 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.OptionNewEmptyTags 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 new empty inline tags. 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.OptionNewInlineTags 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 new non-empty inline tags. 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.
This option is ignored in XML mode.
(Read and Write property)
TidyDocumentMBS.OptionNewline as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The default is appropriate to the current platform.
Genrally CRLF on PC-DOS, Windows and OS/2; CR on Classic Mac OS; and LF everywhere else (Linux, Mac OS X, and Unix).
(Read and Write property)
TidyDocumentMBS.OptionNewPreTags 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 new tags that are to be processed in exactly the same way as HTML's <pre> element. 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 cannot as yet add new CDATA elements.
This option is ignored in XML mode.
(Read and Write property)
TidyDocumentMBS.OptionNumEntities as Boolean Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Tidy | MBS Tools Plugin | 10.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Only entities compatible with the DOCTYPE declaration generated are used. Entities that can be represented in the output encoding are translated correspondingly.
(Read and Write property)
TidyDocumentMBS.OptionNumericEntities 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 entities other than the built-in HTML entities (&amp;, &lt;, &gt;, and &quot;) in the numeric rather than the named entity form.
Only entities compatible with the DOCTYPE declaration generated are used.
Entities that can be represented in the output encoding are translated correspondingly.
(Read and Write property)
TidyDocumentMBS.OptionOmitOptionalTags 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 omit optional start tags and end tags when generating output.
Setting this option causes all tags for the <html>, <head>, and <body> elements to be omitted from output, as well as such end tags as </p>, </li>, </dt>, </dd>, </option>, </tr>, </td>, and </th>.
This option is ignored for XML output.
(Read and Write property)
TidyDocumentMBS.OptionOutCharEncoding 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. May only be different from input-encoding for Latin encodings (ascii, latin0, latin1, mac, win1252, ibm858).
(Read and Write property)
TidyDocumentMBS.OptionOutFile 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 markup is written to "stdout".
(Read and Write property)
TidyDocumentMBS.OptionOutputBom 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 if Tidy should write a Unicode Byte Order Mark character (BOM; also known as Zero Width No-Break Space; has value of U+FEFF) to the beginning of the output, and only applies to UTF-8 and UTF-16 output encodings.
If set to auto this option causes Tidy to write a BOM to the output only if a BOM was present at the beginning of the input.
A BOM is always written for XML/XHTML output using UTF-16 output encodings.
(Read and Write property)
TidyDocumentMBS.OptionOutputEncoding 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 the output.
Note that this may only be different from input-encoding for Latin encodings (ascii, latin0, latin1, mac, win1252, ibm858).
See char-encoding for more information
(Read and Write property)
TidyDocumentMBS.OptionOutputFile 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 output file Tidy uses for markup. Normally markup is written to stdout.
(Read and Write property)
TidyDocumentMBS.OptionOutputHtml 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 generate pretty printed output, writing it as HTML.
(Read and Write property)
TidyDocumentMBS.OptionOutputXhtml 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 generate pretty printed output, writing it as extensible HTML.
This option causes Tidy to set the DOCTYPE and default namespace as appropriate to XHTML, and will use the corrected value in output regardless of other sources.
For XHTML, entities can be written as named or numeric entities according to the setting of numeric-entities.
The original case of tags and attributes will be preserved, regardless of other options.
(Read and Write property)
TidyDocumentMBS.OptionOutputXml 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 pretty print output, writing it as well-formed XML.
Any entities not defined in XML 1.0 will be written as numeric entities to allow them to be parsed by an XML parser.
The original case of tags and attributes will be preserved, regardless of other options.
(Read and Write property)
TidyDocumentMBS.OptionPreserveEntities 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 preserve well-formed entities as found in the input.
(Read and Write property)
TidyDocumentMBS.OptionPreTags 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 not as yet add new CDATA elements (similar to <SCRIPT>). This option is ignored in XML mode.
(Read and Write property)
TidyDocumentMBS.OptionPunctuationWrap 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 line wrap after some Unicode or Chinese punctuation characters.
(Read and Write property)
TidyDocumentMBS.OptionQuiet 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 the summary of the numbers of errors and warnings, or the welcome or informational messages.
(Read and Write property)
Some examples using this property:
TidyDocumentMBS.OptionQuoteAmpersand 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 unadorned & characters as &amp;.
(Read and Write property)
Some examples using this property:
TidyDocumentMBS.OptionQuoteMarks 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 " characters as &quot; as is preferred by some editing environments.
The apostrophe character ' is written out as &#39; since many web browsers don't yet support &apos;.
(Read and Write property)
Some examples using this property:
TidyDocumentMBS.OptionQuoteNbsp 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 non-breaking space characters as entities, rather than as the Unicode character value 160 (decimal).
(Read and Write property)
TidyDocumentMBS.OptionRepeatedAttributes 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 if Tidy should keep the first or last attribute, if an attribute is repeated, e.g. has two align attributes.
(Read and Write property)
The items on this page are in the following plugins: MBS Tools Plugin.