MicrosyntaxDescriptions

The purpose of this page is to enable collaborative creation of brief advisory text for each HTML5 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 WHATWG version of HTML 5 is OK, copying text from RFCs or W3C specs is not OK.

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

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 <a> and <area> in the HTML specification, or must be listed as allowed on <a> and <area> on the Microformats wiki, or must be an absolute URL. You can register link types on the Microformats wiki yourself.

browsing-context

A browsing context name is any string that does not start with an underscore (_).

browsing-context-or-keyword

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

cdo-cdc-pair

Any text content that does not contain the character sequence "<!--" without a later occurrence of the character sequence "-->".

charset

An preferred encoding name according to the Encoding Standard. Example: utf-8

charset-list

A whitespace-separated list of preferred encoding names according to the Encoding Standard. Example: utf-8 windows-1252

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 (0–9), optionally preceded by a hyphen (-). Examples of circles: 5,5,10 and -5,0,20

date

A date in the form YYYY-MM-DD. Example: 2002-09-29.

date-or-time

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

datetime

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

datetime-local

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

datetime-tz

A global date and time string; that is, a date, followed by a “T” or a single space, followed by a time, followed by time-zone information, where: the date must be in the form YYYY-MM-DD • the time must begin in the form hh:mm, followed by :ss, optionally followed by “.” and one, two, or three or digits • the time-zone information must be either “Z” or in the form +hh:mm or the form -hh:mm • Examples: 1996-01-01T12:05:25-02:00, 1996-01-01T12:05:25Z

email

An e-mail address must match the addr-spec production defined in RFC 2822 section 3.4.1 excluding the CFWS production everywhere and excluding the FWS production everywhere except in the quoted-string production.

float

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

float-non-negative

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

float-positive

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

hash-name

A # (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 (0–9), optionally preceded by a hyphen (-). For example: 42 and -273 are valid, but +42 is not.

integer-non-negative

One or more digits (0–9). For example: 42 and 0 are valid, but -273 is not.

integer-positive

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

iri

An absolute URL. For example: http://example.org/hello, but not /hello. Spaces should be escaped as %20.

iri-ref

Any URL. For example: /hello, #canvas, or http://example.org/. Characters should be represented in NFC and spaces should be escaped as %20.

language

An 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. en 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. GB for the United Kingdom). IANA maintains a registry of permissible subtags.

link-rel

A whitespace-separated list of link types listed as allowed on <link> in the HTML specification or listed as an allowed on <link> on the Microformats wiki without duplicate keywords in the list. You can register link types on the Microformats wiki yourself.

media-query

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

meta-charset

The string text/html;, optionally followed by whitespace, followed by charset=, followed by a preferred encoding name according to the Encoding Standard. Example: text/html; charset=utf-8

meta-name

A metadata name listed in the HTML specification or listed in the WHATWG wiki. You can register metadata names on the WHATWG wiki yourself.

mime-type

A media-type as defined in RFC 2616; that is, typically, a required type, followed by a "/" character, followed by a required subtype, optionally followed by one or more instances of a ";" character followed by a parameter. Examples: text/css, text/css;charset=utf-8.

mime-type-list

(WF2)

month

An ISO 8601 date with year and month, i.e. YYYY-MM. Example: 2007-11.

non-empty-string

Any string that is not the empty string.

pattern

(WF2)

polyline

...

ratio

(progress content)

rectangle

...

script

Any text content that does not contain the character sequence "<!--" without a later occurrence of the character sequence "-->" and that does not contain any occurrence of the string "</script" followed by a space character, ">", or "/". For further details, see Restrictions for contents of script elements.

script-documentation

Zero or more code comments, each of which is either a single-line comment starting with "//" or a multi-line comment starting with "/*" and ending with "*/". The content must also meet the constraints of the script microsyntax. For further details, see Inline documentation for external scripts.

simple-color

A string of seven characters that starts with # and ends with six characters each of which is 0…9, a…f or A…F.

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: "M 100 100 L 300 100 L 200 300 z" or "M100,100L300,100,200,300z". For more information, see the 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 (0–9) 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 (.) 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: 23:59:00.000 or 00:00:05.

time-datetime

One of the following: month, date, yearless date, time, local date and time, time-zone offset, global date and time, week, non-negative integer, or duration. For more information and examples, see the 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 (0–9) representing the year, a hyphen (-), a literal W, and two digits for the week, zero-padded if necessary. The week number must be a number greater than or equal to 01. Week 01 of a given year is the week containing the 4^th of January; weeks start on Monday. For instance: 2005-W52 is the week that ended on Sunday the first of January, 2006.