AMP HTML is a subset of HTML for authoring content pages such as news articles in a way that guarantees certain baseline performance characteristics.
Being a subset of HTML, it puts some restrictions on the full set of tags and functionality available through HTML but it does not require the development of new rendering engines: Existing user agents can render AMP HTML just like all other HTML.
Also, AMP HTML documents can be uploaded to a web server and served just like any other HTML document; no special configuration for the server is necessary. However, they are also designed to be optionally served through specialized AMP serving systems that proxy AMP documents. These documents serve them from their own origin and are allowed to apply transformations to the document that provide additional performance benefits. An incomplete list of optimizations such a serving system might do is:
- Replace image references with images sized to the viewer’s viewport.
- Inline images that are visible above the fold.
- Inline CSS variables.
- Preload extended components.
- Minify HTML and CSS.
By using the AMP format, content producers are making the content in AMP files available to be crawled (subject to robots.txt restrictions), cached, and displayed by third parties.
Performance
Predictable performance is a key design goal for AMP HTML. Primarily we are aiming at reducing the time until the content of a page can be consumed / used by the user. In concrete terms this means that:- HTTP requests necessary to render and fully layout the document should be minimized.
- Resources such as images or ads should only be downloaded if they are likely to be seen by the user.
- Browsers should be able to calculate the space needed by every resource on the page without fetching that resource.
The AMP HTML format
Sample document
<!doctype html>
<html ⚡>
<head>
<meta charset="utf-8">
<title>Sample document</title>
<link rel="canonical" href="./regular-html-version.html">
<meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1">
<style amp-custom>
h1 {color: red}
</style>
<script type="application/ld+json">
{
"@context": "http://schema.org",
"@type": "NewsArticle",
"headline": "Article headline",
"image": [
"thumbnail1.jpg"
],
"datePublished": "2015-02-05T08:00:00+08:00"
}
</script>
<script async custom-element="amp-carousel" src="https://cdn.ampproject.org/v0/amp-carousel-0.1.js"></script>
<style amp-boilerplate>body{-webkit-animation:-amp-start 8s steps(1,end) 0s 1 normal both;-moz-animation:-amp-start 8s steps(1,end) 0s 1 normal both;-ms-animation:-amp-start 8s steps(1,end) 0s 1 normal both;animation:-amp-start 8s steps(1,end) 0s 1 normal both}@-webkit-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-moz-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-ms-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-o-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}</style><noscript><style amp-boilerplate>body{-webkit-animation:none;-moz-animation:none;-ms-animation:none;animation:none}</style></noscript>
<script async src="https://cdn.ampproject.org/v0.js"></script>
</head>
<body>
<h1>Sample document</h1>
<p>
Some text
<amp-img src=sample.jpg width=300 height=300></amp-img>
</p>
<amp-ad width=300 height=250
type="a9"
data-aax_size="300x250"
data-aax_pubname="test123"
data-aax_src="302">
</amp-ad>
</body>
</html>Required markup
AMP HTML documents MUST- start with the doctype
<!doctype html>. 🔗 - contain a top-level
<html ⚡>tag (<html amp>is accepted as well). 🔗 - contain
<head>and<body>tags (They are optional in HTML). 🔗 - contain a
<link rel="canonical" href="$SOME_URL" />tag inside their head that points to the regular HTML version of the AMP HTML document or to itself if no such HTML version exists. 🔗 - contain a
<meta charset="utf-8">tag as the first child of their head tag. 🔗 - contain a
<meta name="viewport" content="width=device-width,minimum-scale=1">tag inside their head tag. It’s also recommend to includeinitial-scale=1(1). 🔗 - contain a
<script async src="https://cdn.ampproject.org/v0.js"></script>tag inside their head tag. 🔗 - contain the AMP boilerplate code in their head tag. 🔗
width=device-width,minimum-scale=1 is required to ensure GPU rasterization is enabled.Metadata
It is encouraged that AMP HTML documents are annotated with standardized metadata: Open Graph Protocol, Twitter Cards, etc.We also recommend that AMP HTML documents are marked up with schema.org/CreativeWork or any of its more specific types such as schema.org/NewsArticle or schema.org/BlogPosting.
HTML Tags
HTML tags can be used unchanged in AMP HTML. Certain tags have equivalent custom tags (such as<img> and <amp-img>) and other tags are outright prohibited:| Tag | Status in AMP HTML |
|---|---|
| script | Prohibited unless the type is application/ld+json.
(Other non-executable values may be added as needed.) Exception is the
mandatory script tag to load the AMP runtime and the script tags to load
extended components. |
| base | Prohibited |
| img | Replaced with amp-img. |
| video | Replaced with amp-video. |
| audio | Replaced with amp-audio. |
| iframe | Replaced with amp-iframe. |
| frame | Prohibited. |
| frameset | Prohibited. |
| object | Prohibited. |
| param | Prohibited. |
| applet | Prohibited. |
| embed | Prohibited. |
| form | Prohibited. Support coming in the future. |
| input elements | Prohibited. Includes input, textarea, select, option. Notably, button element is allowed. |
| button | Allowed. |
style |
Required style tags for adjusting opacity. One additional style tag is allowed in head tag for the purpose of custom styling. This style tag must have the attribute amp-custom. [🔗](https://github.com/ampproject/amphtml/blob/master/spec/#cust) |
| link | rel values registered on microformats.org are allowed. If a rel value is missing from our whitelist, please submit an issue. stylesheet and other values like preconnect, prerender and prefectch
that has side effects in the browser are disallowed. There is a special
case for fetching stylesheets from whitelisted font providers. |
| meta | The http-equiv attribute is banned. Otherwise allowed. |
a |
The href attribute value must not begin with javascript:. If set, the target attribute value must be _blank. Otherwise allowed. [🔗](https://github.com/ampproject/amphtml/blob/master/spec/#ancr) |
| svg | Most SVG elements are allowed. |
Comments
Conditional HTML comments are not allowed.HTML attributes
Attribute names starting withon (such as onclick or onmouseover) are disallowed in AMP HTML. The attribute with the literal name on (no suffix) is allowed.The
style attribute must not be used.XML-related attributes, such as xmlns, xml:lang, xml:base, and xml:space are disallowed in AMP HTML.
Links
Thejavascript: schema is disallowed.Stylesheets
Major semantic tags and the AMP custom elements come with default styles to make authoring a responsive document reasonably easy. An option to opt out of default styles may be added in the future.@-rules
The following @-rules are allowed in stylesheets:@font-face, @keyframes, @media, @supports.@import will not be allowed. Others may be added in the future.Author stylesheets
Authors may add custom styles to a document using a single<style amp-custom> tag in the head of the document.Selectors
The following restrictions apply to selectors in author style sheets:Universal selector
The universal selector* may
not be used in author stylesheets. This is because it can have negative
performance implications and could be used to circumvent the rules set
out in the following paragraph.not selector
:not() may not be used in selectors because it can be used to simulate the universal selector.Pseudo-selectors, pseudo-classes and pseudo-elements
Pseudo-selectors, pseudo-classes and pseudo-elements are only allowed in selectors that contain tag names and those tag names must not start withamp-.Example OK:
a:hover, div:last-of-typeExample not OK:
amp-img:hover, amp-img:last-of-typeClass and tag names
Class names, in author stylesheets, may not start with the string-amp-.
These are reserved for internal use by the AMP runtime. It follows,
that the user’s stylesheet may not reference CSS selectors for -amp- classes and i-amp tags. These classes and elements are not meant to be customized by authors. Authors, however, can override styles of amp- classes and tags for any CSS properties not explicitly forbidden by these components’ spec.To prevent usage of attribute selectors to circumvent class name limitations it is generally not allowed for CSS selectors to contain tokens and strings starting with
-amp- and i-amp.Important
Usage of the !important qualifier is not allowed. This is a necessary requirement to enable AMP to enforce its element sizing invariants.Properties
These CSS properties are permanently banned:behavior-moz-binding
filter
opacity, transform (also -vendorPrefix-transform).In the following examples
<property> needs to be in the whitelist above.transition <property>(Also -vendorPrefix-transition)@keyframes name { from: {<property>: value} to {<property: value>} }(also@-vendorPrefix-keyframes)
overflow (and overflow-y, overflow-x) may not be styled as “auto” or “scroll”. No user defined element in an AMP document may have a scrollbar.Maximum size
It is a validation error if the author stylesheet is larger than 50,000 bytes.Custom fonts
Authors may include stylesheets for custom fonts. The 2 supported methods are link tags pointing to whitelisted font providers and@font-face inclusion.Example:
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Tangerine">- https://fast.fonts.net
- https://fonts.googleapis.com
Authors are free to include all custom fonts via a
@font-face CSS instruction via their custom CSS. Fonts included via @font-face must be fetched via the HTTP or HTTPS scheme.AMP runtime
The AMP runtime is a piece of JavaScript that runs inside every AMP document. It provides implementations for AMP custom elements, manages resource loading and prioritization and optionally includes a runtime validator for AMP HTML for use during development.The AMP runtime is loaded via the mandatory
<script src="https://cdn.ampproject.org/v0.js"></script> tag in the AMP document <head>.The AMP runtime can be placed into a development mode for any page. Development mode will trigger AMP validation on the embedded page, which will emit the validation status and any errors to the javascript developer console. Development mode may be triggered by appending
#development=1 to the URL of
the page.Resources
Resources such as images, videos, audio files or ads must be included into an AMP HTML file through custom elements such as<amp-img>.
We call them managed resources because whether and when they will be
loaded and displayed to the user is decided by the AMP runtime.There are no particular guarantees as to the loading behavior of the AMP runtime, but it should generally strive to load resources quickly enough, so that they are loaded by the time the user would like to see them if possible. The runtime should prioritize resources currently in viewport and attempt to predict changes to the viewport and preload resources accordingly.
The AMP runtime may at any time decide to unload resources that are not currently in viewport or reuse the resource containers such as iframes to reduce overall RAM consumption.
AMP Components
AMP HTML uses custom elements called, “AMP components” to substitute built-in resource-loading tags such as<img> and <video> and to implement features with complex interactions such as image lightboxes or carousels.See the AMP component spec for details about supported components.
There are 2 types of supported AMP components:
- Built-in
- Extended
<amp-img>. Extended components must be explicitly included into the document.Common attributes
layout, width, height, media, placeholder, fallback
These attributes define the layout of an element. The key goal here is to ensure that
the element can be displayed and its space can be properly reserved before any of the
JavaScript or remote resources have been downloaded.See the AMP Layout System for details about the layout system.
on
The on attribute is used to install event handlers on elements. The events that are supported depend on the element.The value for the syntax is a simple domain specific language of the form:
eventName:targetId[.methodName[(arg1=value, arg2=value)]]on="tap:fooId.showLightbox"If
methodName is omitted the default method is executed if defined for the element.
Example: on="tap:fooId"Some actions, if documented, may accept arguments. The arguments defined in the parenthesis in the
key=value notation. The accepted values are:- simple unquoted strings:
simple-value; - quoted strings:
"string value"or'string value'; - boolean values:
trueorfalse; - numbers:
11or1.1.
Extended components
Extended components are components that do not necessarily ship with the AMP runtime. Instead they must be explicitly included into the document.Extended components are loaded by including a
<script> tag in the head of the document like this:<script async custom-element="amp-carousel" src="https://cdn.ampproject.org/v0/amp-carousel-0.1.js"></script><script> tag must have an async attribute and must have a custom-element attribute referencing the name of the element.Runtime implementations may use the name to render placeholders for these elements.
The script URL must start with “https://cdn.ampproject.org” and must follow a very strict pattern of
/v\d+/[a-z-]+-(latest|\d+|\d+.\d+).js.URL
The URL for extended components is of the form:https://cdn.ampproject.org/$RUNTIME_VERSION/$ELEMENT_NAME-$ELEMENT_VERSION.jsVersioning
Extended components are versioned via semver. The version is referenced explicitly (See $ELEMENT_VERSION above) when loading the component in the URL. It may have the value “latest”. Changes to the PATCH version component (x in 1.1.x) must strictly maintain backward compatibility or fix urgent security issues.AMP documents may only reference versions with one or two components. Version “1” states “I accept every version of this component with major version 1”. Version “1.1” states “I accept every PATCH level of 1.1”. It is now allowed to explicitly reference the PATCH level in the version string.
Extended templates
Templates render HTML content based on the language-specific template and provided JSON data.See the AMP template spec for details about supported templates.
Extended templates are not shipped with the AMP runtime and have to be downloaded just as with extended elements. Extended components are loaded by including a
<script> tag in the head of the document like this:<script async custom-template="amp-mustache" src="https://cdn.ampproject.org/v0/amp-mustache-0.1.js"></script><script> tag must have an async attribute and must have a custom-template attribute referencing the type of the
template. The script URL must start with “https://cdn.ampproject.org” and must follow a very strict pattern of
/v\d+/[a-z-]+-(latest|\d+|\d+.\d+).js.The templates are declared in the document as following:
<template type="amp-mustache" id="template1">
Hello !
</template>type attribute is required and must reference a declared custom-element script.The
id attribute is optional. Individual AMP elements discover their own templates. Typical scenario
would involve an AMP element looking for a <template> either among its children or referenced by ID.The syntax within the template element depends on the specific template language. However, the template language could be restricted within AMP. For instance, in accordance with the “template” element, all productions have to be over a valid well-formed DOM. All of the template outputs are also subject to sanitizing to ensure AMP-valid output.
See documentation for a specific extended template on the syntax and restrictions.
URL
The URL for extended components is of the form:https://cdn.ampproject.org/$RUNTIME_VERSION/$TEMPLATE_TYPE-$TEMPLATE_VERSION.jsVersioning
See versioning of custom elements for more details.Security
AMP HTML documents must not trigger errors when served with a Content Security Policy that does not include the keywordsunsafe-inline and unsafe-eval.The AMP HTML format is designed so that is always the case.
All AMP template elements must go through AMP security review before they can be submitted into AMP repository.
SVG
Currently, the following SVG elements are allowed:- basics: “svg”, “g”, “path”, “glyph”, “glyphRef”, “marker”, “view”
- shapes: “circle”, “line”, “polygon”, “polyline”, “rect”
- text: “text”, “textPath”, “tref”, “tspan”
- rendering: “clipPath”, “filter”, “linearGradient”, “radialGradient”, “mask”, “pattern”, “vkern”, “hkern”
- special: “defs” (all children above are allowed here), “symbol”, “use”
- aria: “desc”, “title”
- “xlink:href”: only URIs starting with “#” are allowed
- “style”
AMP document discovery
If AMP documents are alternative representations of a canonical document, then the canonical document should point to the AMP document via alink tag with the relation “amphtml”.Example:
<link rel="amphtml" href="https://www.example.com/url/to/amp/document.html">Note, that AMP document may also be linked to directly. The mechanism described here provides a standardized way for software to discover whether an AMP version exists for a canonical document.
Source: AMP HTML Specification
No comments:
Post a Comment