This page lists the allowed extension values for the rel="" attribute in HTML5. You may add your own values to this list, which makes them legal HTML5 rel values. We ask that you try to avoid redundancy; if someone has already defined a value that does roughly what you want, please reuse it. Note that rel tokens are ASCII-lowercase before comparison against canonical value, so the canonical values should be listed without uppercase ASCII letters.

This page lists the allowed extension values for the rel="" attribute in HTML5. You may add your own values to this list, which makes them legal HTML5 rel values. We ask that you try to avoid redundancy; if someone has already defined a value that does roughly what you want, please reuse it. Note that rel tokens are ASCII-lowercase before comparison against canonical value, so the canonical values should be listed without uppercase ASCII letters.

−

{| class=wikitable

+

{| class="wikitable sortable"

|-

|-

−

! rowspan=2 | Keyword

+

! Keyword

−

! colspan=2 | Effect on...

+

! Effect on <code>link</code>

−

! rowspan=2 | Brief description

+

! Effect on <code>a</code>, <code>area</code>

−

! rowspan=2 | Link to more details

+

! Brief description

−

! rowspan=2 | Synonyms

+

! Link to more details

−

! rowspan=2 | Status

+

! Synonyms

−

|-

+

! Status

−

! link

+

|-

−

! a and area

+

| pronunciation

+

| external resource

+

| not allowed

+

| The referenced file contains a set of rules that associates strings of characters (e.g. words) with pronunciation instructions. For example, a rule can define whether the word "tomato" is to be spoken in the british or north-american way. These pronunciation rules should be processed by voice-enabled user-agents (e.g. web browsers that support TTS rendering), but conversely, "pronunciation" link/rel files can be completely ignored by systems that do not have speech capabilities. An example of possible format is W3C PLS (Pronunciation Lexicon Specification), with the MIME type "application/pls+xml" (and usually, the extension ".pls"). When several pronunciation lexicons are referenced within a single HTML document, and/or when a pronunciation rule is specified more than once for a given string of characters, the last occurrence of the rule takes precedence (in document order), such that any previously-defined pronunciation rule gets overridden.

| The linked document contains administrative option(s) for the current document and related pages.

+

|

+

| option

+

| Proposal

|-

|-

| ajax

| ajax

Line 39:

Line 55:

| alternate

| alternate

|colspan=6| See HTML5

|colspan=6| See HTML5

+

|-

+

| answer

+

| hyperlink

+

| hyperlink

+

| A link to the answer to the question this section or document asks, e.g. in a FAQ or in a sample exam. Unlike ‘reply’ or ‘comment’ this resource necessarily solves the problem.

+

| [[Talk:RelExtensions#Q_and_A|Q&A]]

+

| (reply, comment)

+

| Proposal

+

|-

+

| application-manifest

+

| external resource

+

| Not allowed

+

| A manifest for this web application. The manifest contains metadata about the web application, such as its name, description, and permissions the application might require.

+

|

+

|

+

| Proposal

|-

|-

| archives

| archives

Line 52:

Line 84:

| hyperlink

| hyperlink

| not allowed

| not allowed

−

| Robots (e.g., search engines) should treat the document containing the tag as a minor variation of the linked document, which may result in the removal of the former from a web index and in the consolidation of its quality signals in the latter.

+

| Robots (e.g., search engines) should treat the document containing the tag as a minor variation of the linked document, which may result in the removal of the former from a web index and in the consolidation of its quality signals in the latter. Links with rel=canonical must not specify a language, type, or different kind of media; the referenced document must have the same language, type and target media.

| The referenced document contains additional (or complete) details about the current document (for example, a "read more..." hyperlink on a blog page that leads to the full posting).

−

|

−

|

−

| Proposal

|-

|-

| dns-prefetch

| dns-prefetch

Line 245:

Line 269:

|

|

| Accepted

| Accepted

+

|-

+

| gallery

+

| hyperlink

+

| hyperlink

+

| A ''graphic'' index that the current document or section is a part of or that illustrates the same topic.

+

|

+

| (index, list)

+

| Proposal

|-

|-

| glossary

| glossary

Line 324:

Line 356:

| license

| license

|colspan=6| See HTML5

|colspan=6| See HTML5

+

|-

+

| login

+

| hyperlink

+

| hyperlink

+

| The login keyword indicates that the referenced document provides an interface (user, pwd) to authenticate a registered user of the page/or to registrate a new user.

+

|

+

| search

+

| Proposal

|-

|-

| logout

| logout

Line 333:

Line 373:

| Proposal

| Proposal

|-

|-

−

| longdesc

+

| <span id="longdesc">longdesc</span>

−

| yes

+

| hyperlink

−

| yes

+

| hyperlink

−

| Related to the @longdesc question. Proposed as an an equivalent altenrative to using @longdesc.

+

| Related to [http://www.w3.org/html/wg/tracker/issues/30 ISSUE-30]. <br/><abbr title="Assistive Technology">AT</abbr> should treat an element wrapped in a link with <code>rel="longdesc"</code> as equivalent to an element with <code>longdesc="URI"</code>.

| Like ‘print’ this relation references a resource that represents the same content or topic, but in a ''very'' different manner. It is similar to media=projection, but is to be used where text is substituted by graphics, animations and sounds, which goes beyond mere style switching.

+

This relation is also appropriate for links from thumbnail to full resolution images.

| The initial posting this document or section is a reply to or index of.

+

| [[Talk:RelExtensions#Threading|Thread]]

+

| subject, (top)

| Proposal

| Proposal

|-

|-

Line 674:

Line 787:

| Proposal

| Proposal

|}

|}

+

<!-- Science: proof, lemma, theorem -->

−

The "Effect on... link" column must either say "not allowed" if the rel value is not allowed on &lt;link> elements, "hyperlink" if the rel value creates a hyperlink, or "external resource" if the rel value creates a link to an external resource.

+

The "Effect on link" column must either say "not allowed" if the rel value is not allowed on &lt;link> elements, "hyperlink" if the rel value creates a hyperlink, or "external resource" if the rel value creates a link to an external resource.

−

The "Effect on... a and area" column must either say "not allowed" or "hyperlink".

+

The "Effect on a and area" column must either say "not allowed" or "hyperlink".

For the "Status" section to be changed to "Accepted", the proposed keyword must either have been through the [http://microformats.org/wiki/process Microformats process], and been approved by the Microformats community; or must be defined by a W3C specification in the Candidate Recommendation or Recommendation state. If it fails to go through this process, it is "Rejected".

For the "Status" section to be changed to "Accepted", the proposed keyword must either have been through the [http://microformats.org/wiki/process Microformats process], and been approved by the Microformats community; or must be defined by a W3C specification in the Candidate Recommendation or Recommendation state. If it fails to go through this process, it is "Rejected".

−

For more details, see [http://whatwg.org/specs/web-apps/current-work/#linkTypes the HTML5 specification]. See also [http://microformats.org/wiki/existing-rel-values the Microformats wiki page on this matter].

+

For more details, see [http://whatwg.org/specs/web-apps/current-work/#linkTypes the HTML5 specification].

+

+

===See also===

+

*[http://microformats.org/wiki/existing-rel-values the Microformats wiki page on this matter].

+

*[http://blogs.plos.org/mfenner/2011/02/14/how-to-use-citation-typing-ontology-cito-in-your-blog-posts/ How to use Citation Typing Ontology (CiTO) in your blog posts] - proposes several values for marking up academic citations, but confuses the direction of the relationship (note comments)

+

+

[[Category:Registries]]

Latest revision as of 18:32, 3 November 2012

This page lists the allowed extension values for the rel="" attribute in HTML5. You may add your own values to this list, which makes them legal HTML5 rel values. We ask that you try to avoid redundancy; if someone has already defined a value that does roughly what you want, please reuse it. Note that rel tokens are ASCII-lowercase before comparison against canonical value, so the canonical values should be listed without uppercase ASCII letters.

Keyword

Effect on link

Effect on a, area

Brief description

Link to more details

Synonyms

Status

pronunciation

external resource

not allowed

The referenced file contains a set of rules that associates strings of characters (e.g. words) with pronunciation instructions. For example, a rule can define whether the word "tomato" is to be spoken in the british or north-american way. These pronunciation rules should be processed by voice-enabled user-agents (e.g. web browsers that support TTS rendering), but conversely, "pronunciation" link/rel files can be completely ignored by systems that do not have speech capabilities. An example of possible format is W3C PLS (Pronunciation Lexicon Specification), with the MIME type "application/pls+xml" (and usually, the extension ".pls"). When several pronunciation lexicons are referenced within a single HTML document, and/or when a pronunciation rule is specified more than once for a given string of characters, the last occurrence of the rule takes precedence (in document order), such that any previously-defined pronunciation rule gets overridden.

A manifest for this web application. The manifest contains metadata about the web application, such as its name, description, and permissions the application might require.

Proposal

archives

See HTML5

author

See HTML5

bookmark

See HTML5

canonical

hyperlink

not allowed

Robots (e.g., search engines) should treat the document containing the tag as a minor variation of the linked document, which may result in the removal of the former from a web index and in the consolidation of its quality signals in the latter. Links with rel=canonical must not specify a language, type, or different kind of media; the referenced document must have the same language, type and target media.

More than one domain may have largely similar or identical content but only one of the domains should be indexed for search engines. E.g., a company may have short and long domain names for the same content.

Where the canonical value should point to a group of pages, but the link can point to only one page, the group of pages can be clarified by choosing the first page in the group and assigning the URL for this rel link.

For security against traffic theft, rev must be meaningless.
This is only shorthand for providing two link elements, one on the noncanonical page to a "canonical" page and the other on the canonical page to the "first" page of the group.
Where the group of pages corresponds to a subdirectory and a canonical URL value can point to the subdirectory resulting in a user arriving at the subdirectory's index page which is part of the group, this shorthand is unnecessary and one rel="canonical" will suffice.

Both bare and www-prefixed domain names usually direct to the same site. Especially when external links to a site vary in the form used, search engine indexing concentrated on only one domain form may raise its credibility. The rel value is the form preferred for indexing, e.g., href="http://example.net". Nothing to the right of the top-level domain is needed.

Indicates a same page jump from the current fragment to another fragment. (E.g. sometimes online newspapers insert direct text saying "article continues below the image/advert" - they could instead use "jump" link. Ultimately, it indicates a page internal link.)

The linked document contains a version of the current document in an alternative language. "[ISO 639-1 code]" is replaced with the appropriate ISO 639-1 language code. The ISO 639-1 code is used when the browser (or other user agent) wants to display either the full name of the language or a flag, as a visual aid for the end user.

Proposal

lang-orig-[ISO 639-1 code]

hyperlink

hyperlink

The linked document contains a version of the current document in the language the document was originally written in. "[ISO 639-1 code]" is replaced with the appropriate ISO 639-1 language code. The ISO 639-1 code is used when the browser (or other user agent) wants to display either the full name of the language or a flag, as a visual aid for the end user.

Proposal

last

See HTML5

latest-version

hyperlink

hyperlink

The referenced document is the latest version of the current document.

Denies prefetching (not fetching) as a cost-control option for website owners, especially where pages are dynamic, leading to prefetching of wrong and useless pages.

The link provides a per-page denial whereas a and area provide a per-element denial.
For link, attributes rel="noprefetch" denies prefetching of the page at the href URL and rev="noprefetch" denies prefetching of the page bearing the link.
For a and area, rel is as above and rev is meaningless.

Like ‘print’ this relation references a resource that represents the same content or topic, but in a very different manner. It is similar to media=projection, but is to be used where text is substituted by graphics, animations and sounds, which goes beyond mere style switching.

This relation is also appropriate for links from thumbnail to full resolution images.

The referenced document is recommended for printing, even though the referent document is capable of being printed and both documents are of the same type, medium, and language. A typical case is where content spread over multiple pages is also available on a single page that is more convenient to print.

This is semantically more specific than "canonical" and "alternate". Where type, medium, and/or language differ, consider "alternate"; where any of them differ but the purpose is printing, consider applying both values.

The linked document is the page/email that has been translation source for the current document. It also indicates that the current document is a translation and not an original work.

Proposal

translator

hyperlink

hyperlink

The linked document is the page/email an agent (people or firm or...) responsible for the translation of the page. It also indicates that the current page is a translation of an other document, which should be linked through a rel="translatedfrom".

Proposal

up

See HTML5

us

hyperlink

hyperlink

The referenced document represents the same organisation as does the current document [cf rel-me]

Proposal

webmaster

hyperlink

hyperlink

The linked document is the page/email an agent (people or firm or...) available for requests about the content of the page.

The "Effect on link" column must either say "not allowed" if the rel value is not allowed on <link> elements, "hyperlink" if the rel value creates a hyperlink, or "external resource" if the rel value creates a link to an external resource.

The "Effect on a and area" column must either say "not allowed" or "hyperlink".

For the "Status" section to be changed to "Accepted", the proposed keyword must either have been through the Microformats process, and been approved by the Microformats community; or must be defined by a W3C specification in the Candidate Recommendation or Recommendation state. If it fails to go through this process, it is "Rejected".