MicrosyntaxDescriptions

2016-12-17T12:51:22Z

MikeSmith: update ping datatype

The purpose of this page is to enable collaborative creation of brief advisory text for each HTML microsyntax so that when the content of an attribute value or the text content of an element does not conform to a given microsyntax, a validator can display the advisory text about the syntax to guide the author to fix the content. Note that like the rest of this wiki, editing requires you to agree to release your contributions under the MIT license (see wiki footer). Please note that while copying text from the [https://html.spec.whatwg.org/ WHATWG version of HTML] is OK, copying text from RFCs or W3C specs is not OK.

Note that some formats pertain to Web Forms 2.0 (e.g. <code>datetime-local</code>).

Please keep descriptions short: one paragraph in length.

==a-rel==
A whitespace-separated list of link types, with no duplicate keywords in the list. Each link type must be listed as allowed on <code><a></code> and <code><area></code> in the [https://html.spec.whatwg.org/multipage/semantics.html#linkTypes HTML specification], or must be listed as allowed on <code><a></code> and <code><area></code> on the [http://microformats.org/wiki/existing-rel-values#HTML5_link_type_extensions Microformats wiki]. You can register link types on the [http://microformats.org/wiki/existing-rel-values#HTML5_link_type_extensions Microformats wiki] yourself.

==browsing-context==
A browsing context name is any string that does not start with an underscore (<code>_</code>).

==browsing-context-or-keyword==
A browsing context name or keyword is either any string that does not start with an underscore (<code>_</code>) or a string that case-insensitively matches one of: <code>_blank</code>, <code>_self</code>, <code>_parent</code>, or <code>_top</code>.

==cdo-cdc-pair==
Any text content that does not contain the character sequence "<code></code>".

==charset==
An preferred encoding name according to the [https://encoding.spec.whatwg.org/ Encoding Standard]. Example: <code>utf-8</code>

==charset-list==
A whitespace-separated list of preferred encoding names according to the [https://encoding.spec.whatwg.org/ Encoding Standard]. Example: <code>utf-8 windows-1252</code>

==circle==
A circle is specified as three comma-separated (no spaces allowed) integers the last one of which is non-negative. An integer consists of one or more digits (<code>0</code>–<code>9</code>), optionally preceded by a hyphen (<code>-</code>). Examples of circles: <code>5,5,10</code> and <code>-5,0,20</code>

==content-security-policy==
A valid [https://developer.mozilla.org/en-US/docs/Web/Security/CSP/Using_Content_Security_Policy#Writing_a_policy Content Security Policy].

==date==
A date in the form <code>YYYY-MM-DD</code>. Example: <code>2002-09-29</code>.

==date-or-time==
A [https://html.spec.whatwg.org/multipage/infrastructure.html#valid-date-or-time-string date or time string]; that is, one of the following:
a date, which must be in the form <code>YYYY-MM-DD</code> • or, a time, which must begin in the form <code>hh:mm</code>, and can optionally be followed by <code>:ss</code>, which in turn can optionally be followed by “<code>.</code>” and one or more digits • or, a date, followed by “<code>T</code>”, followed by a time, followed by time-zone information, which must be either “<code>Z</code>”, or in the form <code>+hh:mm</code> or the form <code>-hh:mm</code> • Examples: <code>1996-01-01</code>, <code>12:05:25</code>, <code>1996-01-01T12:05:25-02:00</code>, <code>1996-01-01T12:05:25.6</code> • Note: The validator currently allows some values that the HTML specification prohibits; for example, it allows <code>1996-01-01T12:05:25</code> (a date and time with no time-zone information) and <code>12:05:25Z</code> (a time with no date but with time-zone information).

==datetime==
An ISO 8601 date and time in the UTC time zone, i.e. <code>YYYY-MM-DDThh:mm</code> optionally followed by <code>:ss</code> for the seconds, optionally followed by <code>.</code> and one, two, or three digits for the fraction of a second, and finally followed by <code>Z</code>. Examples: <code>1996-01-01T12:05Z</code>, <code>1996-01-01T12:05:25.6Z</code>.

==datetime-local==
An ISO 8601 date and time with no time zone information, i.e. <code>YYYY-MM-DDThh:mm</code> optionally followed by <code>:ss</code> for the seconds, optionally followed by <code>.</code> and one or more digits for the fraction of a second. Examples: <code>1996-01-01T12:05</code>, <code>1996-01-01T12:05:25.6</code>.

==datetime-tz==
A [https://html.spec.whatwg.org/multipage/infrastructure.html#valid-global-date-and-time-string global date and time string]; that is, a date, followed by a “<code>T</code>” or a single space, followed by a time, followed by time-zone information, where: the date must be in the form <code>YYYY-MM-DD</code> • the time must begin in the form <code>hh:mm</code>, followed by <code>:ss</code>, optionally followed by “<code>.</code>” and one, two, or three or digits • the time-zone information must be either “<code>Z</code>” or in the form <code>+hh:mm</code> or the form <code>-hh:mm</code> • Examples: <code>1996-01-01T12:05:25-02:00</code>, <code>1996-01-01T12:05:25Z</code>



==email==
An e-mail address must match the <code>addr-spec</code> production defined in [https://tools.ietf.org/html/rfc2822#section-3.4.1 RFC 2822 section 3.4.1] excluding the <code>CFWS</code> production everywhere and excluding the <code>FWS</code> production everywhere except in the <code>quoted-string</code> production.

==float==
First, optionally, <code>-</code> (U+002D). Then, a series of one or more characters in the range <code>0</code>…<code>9</code>. Then, optionally, a single <code>.</code> (U+002E) followed by a series of one or more characters in the range <code>0</code>…<code>9</code>. Then, optionally, either <code>e</code> or <code>E</code>, optionally followed by <code>-</code> (U+002D) or <code>+</code> (U+002B), followed by a series of one or more characters in the range <code>0</code>…<code>9</code>. For example, <code>-42.42E+42</code> is valid but <code>.5</code> or <code>+2</code> are not.

==float-non-negative==
A series of one or more characters in the range <code>0</code>…<code>9</code>. Then, optionally, a single <code>.</code> (U+002E) followed by a series of one or more characters in the range <code>0</code>…<code>9</code>. Then, optionally, either <code>e</code> or <code>E</code>, optionally followed by <code>-</code> (U+002D) or <code>+</code> (U+002B), followed by a series of one or more characters in the range <code>0</code>…<code>9</code>. Or, alternatively to the foregoing: First, <code>-</code> (U+002D). Then, a series of one or more zeros. Then, optionally, a single <code>.</code> (U+002E) followed by one or more zeros. Then, optionally, either <code>e</code> or <code>E</code>, optionally followed by <code>-</code> (U+002D) or <code>+</code> (U+002B), followed by a series of one or more characters in the range <code>0</code>…<code>9</code>. For example, <code>42.42E+42</code> and <code>-000.000</code> are valid but <code>.5</code> or <code>-0.01</code> are not.

==float-positive==
A series of one or more characters in the range <code>0</code>…<code>9</code>. Then, optionally, a single <code>.</code> (U+002E) followed by a series of one or more characters in the range <code>0</code>…<code>9</code>. One of the digits so far has to be non-zero. Then, optionally, either <code>e</code> or <code>E</code>, optionally followed by <code>-</code> (U+002D) or <code>+</code> (U+002B), followed by a series of one or more characters in the range <code>0</code>…<code>9</code>. For example, <code>42.42E+42</code> is valid but <code>0.0</code> or <code>-2</code> are not.

==hash-name==
A <code>#</code> (number sign) character followed by any string.

==ID==
An ID consists of at least one character but must not contain any whitespace.

==image-candidate-strings==
A comma-separated list of strings, each of which consists of a URL optionally followed by either a pixel density descriptor or a width descriptor.

==image-candidate-strings-width-required==
A comma-separated list of strings, each of which must consist of a URL followed by a width descriptor.

==integer==
One or more digits (<code>0</code>–<code>9</code>), optionally preceded by a hyphen (<code>-</code>). For example: <code>42</code> and <code>-273</code> are valid, but <code>+42</code> is not.

==integer-non-negative==
One or more digits (<code>0</code>–<code>9</code>). For example: <code>42</code> and <code>0</code> are valid, but <code>-273</code> is not.

==integer-positive==
One or more digits (<code>0</code>–<code>9</code>), with at least one which is non-zero. For example: <code>42</code> is valid, but <code>00</code> is not.

== integrity-metadata ==
A whitespace-separated list of values, where each value is consists of one of <code>sha256</code> or <code>sha384</code> or <code>sha512</code>, followed by a hyphen (<code>-</code>), followed by a base64-encoded cryptographic hash.

==iri==
An absolute URL. For example: <code><nowiki>http://</nowiki>example.org/hello</code>, but not <code>/hello</code>. Spaces should be escaped as <code>%20</code>.

==iri-ref==
Any URL. For example: <code>/hello</code>, <code>#canvas</code>, or <code><nowiki>http://</nowiki>example.org/</code>. Characters should be represented in [http://www.macchiato.com/unicode/nfc-faq NFC] and spaces should be escaped as <code>%20</code>. Common non-alphanumeric characters other than <code>! $ & ' ( ) * + - . / : ; = ? @ _ ~</code> generally must be [https://en.wikipedia.org/wiki/Percent-encoding percent-encoded]. For example, the pipe character (<code>|</code>) must be encoded as <code>%7C</code>.

==iri-ref-http-or-https==
A list of <code>http</code> or <code>https</code> [https://wiki.whatwg.org/wiki/MicrosyntaxDescriptions#iri-ref URLs].

==language==
An [https://tools.ietf.org/html/rfc5646 RFC 5646] language tag consists of hyphen-separated ASCII-alphanumeric subtags. There is a primary tag identifying a natural language by its shortest ISO 639 language code (e.g. <code>en</code> for English) and zero or more additional subtags adding precision. The most common additional subtag type is a region subtag which most commonly is a two-letter ISO 3166 country code (e.g. <code>GB</code> for the United Kingdom). IANA maintains a [https://www.iana.org/assignments/language-subtag-registry registry of permissible subtags].

==link-rel==
A whitespace-separated list of link types listed as allowed on <code><link></code> in the [https://html.spec.whatwg.org/multipage/semantics.html#linkTypes HTML specification] or listed as an allowed on <code><link></code> on the [http://microformats.org/wiki/existing-rel-values#HTML5_link_type_extensions Microformats wiki] without duplicate keywords in the list. You can register link types on the [http://microformats.org/wiki/existing-rel-values#HTML5_link_type_extensions Microformats wiki] yourself.

==media-query==
One or more media queries, combined in a comma-separated list. Each media query consists of a optional media type and zero or more expressions that check for the conditions of particular media features. A media type is one of the following: <code>all</code>, <code>print</code>, <code>screen</code>, or <code>speech</code>. The following media types are deprecated: <code>braille</code>, <code>embossed</code>, <code>handheld</code>, <code>projection</code>, <code>tty</code>, and <code>tv</code>. For information about valid media features and about the exact syntax of media queries, see the [https://drafts.csswg.org/mediaqueries/ Media Queries] specification.

==meta-charset==
The string <code>text/html;</code>, optionally followed by whitespace, followed by <code>charset=</code>, followed by a preferred encoding name according to the [https://encoding.spec.whatwg.org/ Encoding Standard]. Example: <code>text/html; charset=utf-8</code>

==meta-name==
A metadata name listed in the [https://html.spec.whatwg.org/multipage/semantics.html#standard-metadata-names HTML specification] or listed in the [https://wiki.whatwg.org/wiki/MetaExtensions WHATWG wiki]. You can register metadata names on the [https://wiki.whatwg.org/wiki/MetaExtensions WHATWG wiki] yourself.

==mime-type==
A [https://tools.ietf.org/html/rfc2616#section-3.7 media-type as defined in RFC 2616]; that is, typically, a required ''type'', followed by a "<code>/</code>" character, followed by a required ''subtype'', optionally followed by one or more instances of a "<code>;</code>" character followed by a ''parameter''. Examples: <code>text/css</code>, <code>text/css;charset=utf-8</code>.

==mime-type-list==
(WF2)

==month==
An ISO 8601 date with year and month, i.e. <code>YYYY-MM</code>. Example: <code>2007-11</code>.

==non-empty-string==
Any string that is not the empty string.

==pattern==
(WF2)

==polyline==
...

==ratio==
(progress content)

==rectangle==
...

==sandbox-allow-list==
An unordered set of unique space-separated keywords; the allowed keywords are <code>allow-forms</code>, <code>allow-modals</code>, <code>allow-pointer-lock</code>, <code>allow-popups</code>, <code>allow-popups-to-escape-sandbox</code>, <code>allow-same-origin</code>,<code> allow-scripts</code>, and <code>allow-top-navigation</code>.

==script==
Any text content that does not contain the character sequence "<code></code>" and that does not contain any occurrence of the string "<code></script</code>" followed by a space character, "<code>></code>", or "<code>/</code>". For further details, see [https://html.spec.whatwg.org/multipage/scripting.html#restrictions-for-contents-of-script-elements Restrictions for contents of script elements].

==script-documentation==
Zero or more ''code comments'', each of which is either a single-line comment starting with "<code>//</code>" or a multi-line comment starting with "<code>/*</code>" and ending with "<code>*/</code>". The content must also meet the constraints of the [https://wiki.whatwg.org/wiki/MicrosyntaxDescriptions#script script] microsyntax. For further details, see [https://html.spec.whatwg.org/multipage/scripting.html#inline-documentation-for-external-scripts Inline documentation for external scripts].

==simple-color==
A string of seven characters that starts with <code>#</code> and ends with six characters each of which is <code>0</code>…<code>9</code>, <code>a</code>…<code>f</code> or <code>A</code>…<code>F</code>.

==source-size-list==
A comma-separated list of zero or more source sizes (<media-condition> <length>) optionally followed by a default size (<length>) but at least one of them.

==string-without-line-breaks==
Any string that does not contain the carriage return character or the line feed character.

==svg-pathdata==
A list of zero or more path-data expressions, where each expression consists of a one-letter command followed by numbers that serve as arguments for the command (in most cases, pairs of coordinates). Commas and/or whitespace must be used to separate the arguments for a command from one another—but commas must not be used to separate commands, though whitespace can optionally be used to do so. Examples: "<code>M 100 100 L 300 100 L 200 300 z</code>" or "<code>M100,100L300,100,200,300z</code>". For more information, see the [http://www.w3.org/TR/SVG11/paths.html#PathData section on path data in the SVG 1.1 specification].

==time==
A time (hour, minute, seconds, fractional seconds) is encoded according to ISO 8601 with no time zone: two digits (<code>0</code>–<code>9</code>) for the hour, a colon, two digits for the minute, optionally a colon and two digits for the second, and optionally (if the seconds are present) a period (<code>.</code>) and one, two, or three digits for the fraction of a second. All the numbers must be in base ten and zero-padded if necessary. For instance: <code>23:59:00.000</code> or <code>00:00:05</code>.

==time-datetime==
One of the following: [https://html.spec.whatwg.org/multipage/infrastructure.html#valid-month-string month], [https://html.spec.whatwg.org/multipage/infrastructure.html#valid-date-string date], [https://html.spec.whatwg.org/multipage/infrastructure.html#valid-yearless-date-string yearless date], [https://html.spec.whatwg.org/multipage/infrastructure.html#valid-time-string time], [https://html.spec.whatwg.org/multipage/infrastructure.html#valid-local-date-and-time-string local date and time], [https://html.spec.whatwg.org/multipage/infrastructure.html#valid-time-zone-offset-string time-zone offset], [https://html.spec.whatwg.org/multipage/infrastructure.html#valid-global-date-and-time-string global date and time], [https://html.spec.whatwg.org/multipage/infrastructure.html#valid-week-string week], [https://html.spec.whatwg.org/multipage/infrastructure.html#valid-non-negative-integer non-negative integer], or [https://html.spec.whatwg.org/multipage/infrastructure.html#valid-duration-string duration]. For more information and examples, see the [https://html.spec.whatwg.org/multipage/semantics.html#datetime-value section on the datetime value in the HTML specification].

==week==
A week consists of a year and a week number encoded according to ISO 8601: four or more digits (<code>0</code>–<code>9</code>) representing the year, a hyphen (<code>-</code>), a literal <code>W</code>, and two digits for the week, zero-padded if necessary. The week number must be a number greater than or equal to <code>01</code>. Week <code>01</code> of a given year is the week containing the 4th of January; weeks start on Monday. For instance: <code>2005-W52</code> is the week that ended on Sunday the first of January, 2006.

[[Category:Validator.nu Documentation]]

2015-03-22T01:23:19Z

MikeSmith:

{{Obsolete|spec=https://github.com/validator/validator/wiki/Output:-GNU}}

This format is an adaptation of the [https://www.gnu.org/prep/standards/standards.html#Errors GNU error format].

==Media Type==

This format has semantics beyond the semantics of <code>text/plain</code>. However, for compatibility and given the lack of a specific media type, this format uses the media type <code>text/plain; charset=utf-8</code>.

==Character Encoding==

This format is defined in terms of Unicode characters. For transport as bytes, the Unicode characters are encoded as UTF-8.

==General Format==

The format consists of messages represented as text lines.

Each line consists of the URI of the file that the message pertains to, U+003A COLON, optionally a position descriptor, U+003A COLON if there was a position descriptor, U+0020 SPACE, type descriptor, U+003A COLON, U+0020 SPACE, message and U+000A LINE FEED.

When there are no lines, there are characters—not even a single U+000A LINE FEED.

==URI of the File==

The URI of the file is its IRI converted to the URI form with U+0022 QUOTATION MARK before and after or nothing (not even quotes) if the IRI of the document is not available. (Literal U+0022 QUOTATION MARK never appears in the URI. <code>%22</code> may appear instead.)

==Position Descriptor==

The position descriptor indicates the source position that the message pertains to in terms of lines and columns. The first line is line number 1. The first character on a line occupies column number 1. Columns are counted as UTF-16 code units without tab expansion. (The GNU spec doesn't specify how non-ASCII is counted and specifies tab expansion to stops at every 8 columns.)

The position descriptor takes one of these formats:

* ''line number''
* ''line number'', U+002E FULL STOP, ''column number''
* ''start line number'', U+002D HYPEN-MINUS, ''end line number''
* ''start line number'', U+002E FULL STOP, ''start column number'', U+002D HYPEN-MINUS, ''end line number'', U+002E FULL STOP, ''end column number''

Start and end are inclusive. The numbers consist of one or more characters in the range from U+0030 DIGIT ZERO to U+0039 DIGIT NINE interpreted as a decimal number.

==Type Descriptor==

The type descriptor consists of a supertype descriptor optionally followed by U+0020 SPACE and a subtype descriptor.

The supertype descriptor denotes the general class of the message. The permissible values are <code>info</code>, <code>error</code> and <code>non-document-error</code>.

<CODE>info</CODE>
means an informational message or warning that does not affect the validity of
the document being checked. <CODE>error</CODE> signifies
a problem that causes the validation/checking to fail. <CODE>non-document-error</CODE>
signifies an error that causes the checking to end in an indeterminate state because
the document being validated could not be examined to the end. Examples of such errors include broken schemas, bugs in the validator and IO errors. (Note that when a schema has parse errors, they are first reported as <CODE>error</CODE>s and then a catch-all <CODE>non-document-error</CODE> is also emitted.)

When the supertype descriptor is <CODE>info</CODE> the permissible value for the subtype descriptor is <CODE>warning</CODE>, which means that the message seeks to warn about the user of a formally conforming but in some way questionable issue. Otherwise, the message is taken to generally informative.

When the supertype descriptor is <CODE>error</CODE> the permissible value for the subtype descriptor is <CODE>fatal</CODE>, which means that the error is an XML well-formedness error or, in the case of HTML, a condition that the implementor has opted to treat analogously to XML well-formedness errors (e.g. due to usability or performance considerations). Further errors are suppressed after a fatal error. In the absence of the <CODE>"subtype"</CODE> key, a <CODE>"type":"error"</CODE> message means a spec violation in general.

When the supertype descriptor is <CODE>non-document-error</CODE> the permissible value for the subtype descriptor are <CODE>io</CODE> (signifies an
input/output error), <CODE>schema</CODE> (indicates that
initializing a schema-based validator failed) and <CODE>internal</CODE>
(indicates that the validator/checker found an error bug in itself,
ran out of memory, etc., but was still able to emit a message). In the absence of the subtype descriptor key, a <CODE>non-document-error</CODE> message means a problem external to the document in general.

==Message==

The message is a human-readable string that does not contain U+000A LINE FEED or U+000D CARRIAGE RETURN. It may be the empty string. ([[Validator.nu Common Input Parameters#asciiquotes|ASCII quotes can be requested]].)

==Processing Model==

Clients that consume the message format are referred to as
processors.

If the input contains a line that is not in the format described above, the input is deemed to be in an unknown format and not processable according to this processing model.

For forward compatibility, processors must treat unknown subtype descriptors as if there were no subtype descriptor when deciding the semantics according to the previous paragraphs.

Processors must process the lines in a way that is consistent with
the semantics of the lines.

===Determining Outcome===

The outcome of the validation process may be success, failure or indeterminate.

# If there are one or more <CODE>non-document-error</CODE> messages, the outcome is indeterminate.
# Else if there are one or more <CODE>error</CODE> messages, the outcome is failure.
# Else the outcome is success.

Note that <code>info</code> messages can be suppressed with by setting the input parameter [[Validator.nu Common Input Parameters#level|<code>level</code>]] to <code>error</code> in which case success is equivalent to this format containing no lines.

==See also==
*[[Validator.nu Web Service Interface]]

[[Category:Validator.nu Documentation]]