Microformats Wiki - User contributions [en]

mf2-json

2026-03-10T21:12:32Z

Tantek: r

#redirect:[[microformats2-json]]

mf2json

2026-03-10T21:12:16Z

Tantek: redirect from shorthand to full name

#redirect:[[microformats2-json]]

microformats2-json

2026-03-10T21:11:47Z

Tantek: note abbreviation mf2json e.g. https://indieweb.org/mf2json

This page contains an informative description of <dfn style="font-style:normal;font-weight:bold">microformats2 JSON</dfn> (<abbr><dfn>mf2json</dfn></abbr>), the canonical output format of the [[microformats2-parsing|microformats2 parsing]] algorithm. Note that the [[microformats2-parsing|microformats2 parsing specification]] is the only authoritative source for its own output.

'''Goal:''' Document possible values – with examples – of the official serialisation format of microformats generated by [[microformats2#Parsers|microformats2 parsers]]. This format can be used to compare parsers and create [[test-suite|test suites]]. It also clarifies the format for other specifications that rely on the serialisation, such as [https://micropub.net/ Micropub].

'''Audience:''' Parser authors, parser users, web developers. This document is written for anyone working with microformats2 in their serialised form, so they can read about the format generated by the parsing algorithm without having to understand the actual parsing itself.

'''Author(s):''' [[User:Zegnat|Martijn van der Ven]]

<div style="margin:1em;padding:1em;background:#FFDC00;font-size:smaller">⚠️ The JSON format used is not pinned to a specific [https://indieweb.org/JSON#Specs JSON specification]. See [https://github.com/microformats/microformats2-parsing/issues/23 issue #23] for a discussion on the subject.</div>

== Parsed Document Format ==

Parsers collect not only microformats2 objects, but also [[rel|link relationships]]. Parsing an entire document will result in an outer object with 3 members named <code>items</code>, <code>rels</code>, and <code>rel-urls</code>:

<source lang=javascript>{
"items": [],
"rels": {},
"rel-urls": {}
}</source>

# <code>items</code> is an array of [[microformats2-json#microformat2_Objects|microformats2 objects]], ordered according to their order in the source document.
# <code>rels</code> is an object where the member names reflect all <code>rel</code>-values found in the source document.
# <code>rel-urls</code> is an object where the member names reflect all URLs found in the source document with <code>rel</code>-values attached.

== microformat2 Objects ==

<div style="margin:1em;padding:1em;background:#F8F7EC;font-size:smaller">🕰️ '''This section is outdated.''' An extra optional member called <code>id</code> was [http://microformats.org/wiki/index.php?title=microformats2-parsing&diff=66967&oldid=66966 added in December].</div>

The '''microformats2 object''' is an object with 2 required members named <code>type</code> and <code>properties</code>, as well as an optional member named <code>children</code>:

<source lang=javascript>{
"type": [],
"properties": {},
"children": []
}</source>

# <code>type</code> is an array of the types that identify the microformat, ordered alphabetically.
# <code>properties</code> is an object where the member names reflect all properties found for the microformat.
# The optional member <code>children</code> is an array of other microformats2 objects that were found nested in the current one.

=== type ===

<div style="margin:1em;padding:1em;background:#7FDBFF;font-size:smaller">ℹ️ '''This section needs expanding.''' It needs an example of a microformats2 object that uses multiple types and still makes sense.</div>

The <code>type</code> member contains an alphabetically sorted array of root class names. These names express what the microformat is expressing, and are often coupled to which properties to expect through documented conventions.

The root class names are individual strings that match the pattern <code>h-([0-9a-z]+-)?[a-z]+</code>.

The following example shows an <code>h-entry</code> type microformats2 object, with a single property attached. The <code>h-entry</code> type is [[h-entry|documented on the wiki]], this way types point towards documented conventions that hold true no matter what the source document was.

<source lang=javascript>{
"type": ["h-entry"],
"properties": {
"summary": ["A short published note."]
}
}</source>

=== properties ===

<div style="margin:1em;padding:1em;background:#F8F7EC;font-size:smaller">🕰️ '''This section is outdated.''' A new [[microformats2-parsing#parse_an_img_element_for_src_and_alt|valid value for images]] was [http://microformats.org/wiki/index.php?title=microformats2-parsing&diff=66969&oldid=66967 added in January].</div>

The <code>properties</code> member contains an object where every member name is a microformats2 property name, and every member value is an array of the found microformats2 values. Even when only one value is given, it will be inside an array.

Valid values in the value array are one of the following:

# a string value, the most common value,
# an embedded markup object, containing both a plain string value and the verbatim mark-up from the source document, or
# another microformat2 object.

If a microformat2 object is used as the value of a property, it will gain the additional member <code>value</code> to express a plain string representation. If a consuming application does not understand the nested microformat2 object, it can opt to treat it as that string.

If a microformat2 object is used as the value of a property, when the parser is also instructed to return it as an embedded markup object, it will gain the additional member <code>html</code>.

The following example shows an <code>h-entry</code> type microformats2 object, with 3 properties to show the 3 different types of properties. The <code>name</code> is a single string, the <code>content</code> contains verbatim HTML from the source document, and the <code>author</code> is a nested microformat2 <code>h-card</code> object. The <code>in-reply-to</code> property has been added to show how one property may contain multiple valid values.

To see what these properties mean in the context of an <code>h-entry</code> type, see [[h-entry#Core_Properties|the Core Properties section on the type’s wiki page]].

<source lang=javascript>{
"type": ["h-entry"],
"properties": {
"name": ["An example entry"],
"content": [
{
"html": "Ut non sit saepe porro porro est aut. Dicta ut repellat quisquam repellendus et iste consequatur.\nConsequuntur repellat sed aut in et dolores. Consequatur amet quo enim.",
"value": "Ut non sit saepe porro porro est aut. Dicta ut repellat quisquam repellendus et iste consequatur.\nConsequuntur repellat sed aut in et dolores. Consequatur amet quo enim."
}
],
"author": [
{
"type": ["h-card"],
"properties": {
"name": ["Mx Example"],
"url": ["https://example.com/"]
},
"value": "Mx Example"
}
],
"in-reply-to": [
{
"type": ["h-cite"],
"properties": {
"name": ["Example Domain"],
"author": ["IANA"],
"url": ["https://example.org/"]
},
"value": "https://example.org/"
},
"https://example.net/"
]
}
}</source>

=== children ===

The optional <code>children</code> member is added when nested microformats are found and contains an array of microformat2 objects.

This happens when other objects are contained with outer ones, e.g. data is marked up with microformats within the content of an <code>h-entry</code>. Another possibility is that the outer object exists to group all its nested objects, such as an <code>[[h-feed]]</code>.

The following example shows an <code>h-feed</code> type microformats2 object with a few properties that describe the feed, and an array of <code>h-entry</code> objects as its children.

<source lang=javascript>{
"type": ["h-feed"],
"properties": {
"author": ["https://example.org/"],
"name": ["Example Feed"]
},
"children": [
{
"type": ["h-entry"],
"properties": {
"name": ["Entry 1"],
"content": [
{
"html": "Ut non sit saepe porro porro est aut.\nDicta ut repellat quisquam repellendus et iste consequatur.",
"value": "Ut non sit saepe porro porro est aut.\nDicta ut repellat quisquam repellendus et iste consequatur."
}
]
}
},
{
"type": ["h-entry"],
"properties": {
"name": ["Entry 2"],
"content": [
{
"html": "Ut non sit saepe porro porro est aut.\nDicta ut repellat quisquam repellendus et iste consequatur.",
"value": "Ut non sit saepe porro porro est aut.\nDicta ut repellat quisquam repellendus et iste consequatur."
}
]
}
},
{
"type": ["h-entry"],
"properties": {
"name": ["Entry 3"],
"content": [
{
"html": "Ut non sit saepe porro porro est aut.\nDicta ut repellat quisquam repellendus et iste consequatur.",
"value": "Ut non sit saepe porro porro est aut.\nDicta ut repellat quisquam repellendus et iste consequatur."
}
]
}
}
]
}</source>

== rels Object ==

The '''rels object''' is an object with any amount of members, where every member name is a link relationship (see [[existing-rel-values|the documented existing relationships]] for examples) and every member value is an array of URLs.

Any relationship can have 1 or more URLs in its matching array. And any URL can be in several arrays, if it has several relationships associated with it.

The following example shows a rels object where 4 URLs were found in the source document:

* <code><nowiki>https://example.com/</nowiki></code> identifies the homepage using [[rel-home|the <code>home</code> relationship value]],
* <code><nowiki>https://example.com/fr/</nowiki></code> identifies an alternative version of the home page, combining the <code>home</code> and [[rel-alternate|<code>alternate</code> relationship]] values,
* <code><nowiki>https://example.com/a</nowiki></code> and <code><nowiki>https://example.com/b</nowiki></code> both identify an author of the current page using [[rel-author|the <code>author</code> relationship value]].

<source lang=javascript>{
"home": [
"https://example.com/",
"https://example.com/fr/"
],
"author": [
"https://example.com/a",
"https://example.com/b"
],
"alternate": ["https://example.com/fr/"]
}</source>

== rel-urls Object ==

The '''rel-urls object''' is an object with any amount of members, where every member name is a URL and every member value is an object.

The value object will always contain a member with the name <code>rels</code>. That member’s value will be an array of alphabeticall sorted link relationships applicable to the URL.

The value object may additionally contain any members with the following names:

* <code>hreflang</code>
* <code>media</code>
* <code>title</code>
* <code>type</code>

The values of these members are always a single string. The value is taken from the link’s attribute in the source document matching the member name. E.g. in HTML the value of an <code><a></code> element’s <code>hreflang</code> attribute will be the value of the URL’s <code>hreflang</code> member in the rel-urls object.

In addition the optional member named <code>text</code> is added if any text is associated with the URL in the source document. E.g. in HTML the text within an <code><a></code> element will be used.

The following example shows what the companion rel-urls object to the above rels object might look like. It shows the text that was used to link to the authors, giving us more context of who they are. It also makes clear that the alternative version of the home page is in fact in French and meant for handheld devices.

<source lang=javascript>{
"https://example.com/": {
"rels": ["home"],
"text": "Example Homepage"
},
"https://example.com/a": {
"rels": ["author"],
"text": "Mx Adam"
},
"https://example.com/b": {
"rels": ["author"],
"text": "Mx Baker"
},
"https://example.com/fr/": {
"rels": ["alternate", "home"],
"hreflang": "fr",
"media": "handheld",
"text": "Example page d’accueil"
}
}</source>

The rel-urls object was a later addition to the specification. It exists because so much information was lost when only the rels object was created. The discussion that shaped it [[microformats2-parsing-brainstorming#more_information_for_rel-based_formats|can be read on the brainstorming page]].

== See Also ==

* [https://tools.ietf.org/html/rfc8259 RFC 8259: The JavaScript Object Notation (JSON) Data Interchange Format]
* [https://github.com/Zegnat/microformats2-json-schema JSON Schema for microformats2 objects], by [https://vanderven.se/martijn/ Martijn van der Ven]
* [https://github.com/cleverdevil/microformats2 Type- and vocabulary-aware microformats2 JSON validator in Python], by [https://cleverdevil.io/ Jonathan LaCour]

source-code-brainstorming

2026-02-12T21:21:36Z

Tantek: /* Alternatives */ provide a more clear separation between current thoughts vs past thoughts, move pre 2025 alternatives to bottom

Per the microformats [[process]], this page is for brainstorming about ideas, proposals, constraints, requirements for a microformat for indicating the link relationship between a document (or site) and its source code.

Background research:
* [[source-code-examples]]
* [[source-code-formats]]

== Alternatives ==
=== Current proposed alternatives ===
2025+ brainstorming update:
* '''<code>rel=code</code>'''. Good: shorter than alternatives, sufficiently unique to convey meaning, clearly express a semantic for "the code for the current page is over there".
** alt: <code>rel=source</code>. Good: short, covers lots of use-cases. Bad: ambiguous term. could be better used to define a source where the information came from. When someone writes an article, which is based on information from somewhere else, <code>rel="source"</code> would be a more appropriate name.
** alt: <code>rel=source-code</code>. Good: better than "sourcecode". Bad: Longer than "code" with no discernible benefit.
* '''<code>rel=repository</code>'''. Good: more precise semantic for just the (presumably revision control) repository file for the current page, without asserting a 'code' semantic. From [https://chat.indieweb.org/dev/2025-05-25#t1748200051542500 IndieWeb dev chat 2025-05-25]. Alternatives:
** alt: <code>rel=repo</code>. Advantage: shorter. Disadvantage: less obvious.
** alt: <code>rel=vcs</code>. Advantage: even shorter. Disadvantage: acronym, even less obvious.
* '''<code>rel="code repository"</code>''' to link to the code file for a page in a repository. Good: combine multiple precise semantics to express an even more precise semantic. From [https://chat.indieweb.org/dev/2025-05-25#t1748200073140900 IndieWeb dev chat 2025-05-25].
* '''<code>rel="directory repository"</code>''' to link to the folder of the file for a page, in a repository, re-using pre-existing [[rel-directory]] semantics. From [https://chat.indieweb.org/dev/2025-05-25#t1748200111083300 IndieWeb dev chat 2025-05-25].
* '''<code>rel="repository root"</code>''' (order doesn't matter), or <code>rel="repository home"</code> to link to the repository root (or home) for the file for the current page. From [https://chat.indieweb.org/dev/2025-05-25#t1748200152614400 IndieWeb dev chat 2025-05-25].
* '''<code>rel="edit repository"</code>''' links to the edit state of the file for the current page, in a repository so you can immediately start typing into the text area, in contrast to say plain <code>rel="edit"</code> for when linking to the edit state locally on the page itself like on a MediaWiki install (Wikipedia etc.) that directly shows you a textarea to edit the page you are viewing. Good: similar combination of multiple precise semantics to express both. From [https://chat.indieweb.org/dev/2025-05-25#t1748200217297200 IndieWeb dev chat 2025-05-25].
* ...

=== Potential algorithm for finding a representative URL for editing/viewing source ===

A UX pattern relevant to the proposed rels above is to find the URL that has the highest combination of specificity given the user's privilege.

An algorithm for parsing could be:

* Find all <code>link</code> then <code>a</code> tags that contain the <code>edit</code> <code>rel</code> value.
** Return the first matching <code>link</code> tag found. If none found, return the first matching <code>a</code> tag found. Else, go onto the next step.
* Find all <code>link</code> and <code>a</code> tags that contain <code>rel</code> values of both <code>code</code> and <code>repository</code>. Return the first one found. Else, go onto the next step.
** Return the first matching <code>link</code> tag found. If none found, return the first matching <code>a</code> tag found. Else, go onto the next step.
* Find all <code>link</code> and <code>a</code> tags that contain the <code>code</code> <code>rel</code> attribute.
** Return the first matching <code>link</code> tag found. If none found, return the first matching <code>a</code> tag found. Else, go onto the next step.
* Find all <code>link</code> and <code>a</code> tags that contain have <code>rel</code> values of both <code>directory</code> and <code>repository</code>.
** Return the first matching <code>link</code> tag found. If none found, return the first matching <code>a</code> tag found. Else, go onto the next step.
* Find all <code>link</code> and <code>a</code> tags that contain the <code>directory</code> <code>rel</code> attribute.
** Return the first matching <code>link</code> tag found. If none found, return the first matching <code>a</code> tag found. Else, go onto the next step.
* Find all <code>link</code> and <code>a</code> tags that contain have <code>rel</code> values of both <code>home</code> and <code>repository</code>.
** Return the first matching <code>link</code> tag found. If none found, return the first matching <code>a</code> tag found. Else, go onto the next step.
* Find all <code>link</code> and <code>a</code> tags that contain have <code>rel</code> values of both <code>root</code> and <code>repository</code>.
** Return the first matching <code>link</code> tag found. If none found, return the first matching <code>a</code> tag found. Else, go onto the next step.
* If no links are found, return null.

In addition, a check should be done against the HTTP <code>Link></code> headers using the same order of precedence as outlined above:

* edit
* code repository
* code directory
* home repository
* root repository

<code>repository</code> is a modifier that may appear at any point in a rel value.

=== Summary of alternatives before 2025 ===
Summary of prior (pre-2025) brainstorm alternatives:
* <code>rel=source</code>. Good: short, covers lots of use-cases. Bad: ambiguous term. could be better used to define a source where the information came from. When someone writes an article, which is based on information from somewhere else, <code>rel="source"</code> would be a more appropriate name.
* <code>rel=code</code>. Good: clearly express a semantic for "the code for the current page is over there". Issues: which code? The HTML, the PHP, something else? Re-proposed in [https://chat.indieweb.org/dev/2025-05-25#t1748200034668000 IndieWeb dev chat 2025-05-25]
* <code>rel=sourcecode</code>. Good: more specific than others. Bad: naming is less readable with two adjacent words.

== Needs refactoring ==
{{note|The rest of this page needs some analysis and refactoring, moving e.g. "examples demonstrate situations where an explicit rel value could be used" to the [[source-code-examples]] page}}

== Usage ==

<pre><nowiki><a href="https://github.com/adactio/html5forwebdesigners" rel="source">the source for this book</a></nowiki></pre>

<pre><nowiki><link href="https://github.com/adactio/html5forwebdesigners" rel="source" /></nowiki></pre>

== Use Cases ==

When an author links to a project's (or document's) source code (e.g. on GitHub, Google Code, etc.) a rel value of "source" could be used to explicitly define that relationship.

== Discussions ==

=== <code>rel="code"</code> ===

<code>source</code> could be better used to define a source where the information came from. When someone writes an article, which is based on informations somewhere else, <code>rel="source"</code> would be a more appropriate name.

Better naming recommendations for the case of this rel-Attribute:

<ol>
<li><code>code</code></li>
<li><code>sourcecode</code></li>
</ol>

=== Use when linking to project source code ===

Could this really be used to link to a project’s (rather than the current document’s) source code?

Using the Unison.js example, with all HTML attributes removed except <code>rel</code> and <code>href</code>:

<pre><nowiki>
<a rel="source" href="https://github.com/bjork24/Unison">View on GitHub</a>
</nowiki></pre>

Following the [[rel-faq]], this would be interpreted as:

:The resource indicated by https://github.com/bjork24/Unison is a "source" for the current document.

But it isn’t. [http://responsivedesign.is/resources/javascript-jquery/unison.js The Unison.js project page on responsivedesign.is] does not seem to use Unison.js in any way.

Related post:
* https://chat.indieweb.org/microformats/2021-05-20#t1621544703548300

=== Relations between one URI and a linked URI ===

To think about the relations in between the current resource (URI) and the linked one, a way is to imagine what would be the "title" attribute that would help users take an action on the link. Basically, we are telling something along the line: "Explore the hosted source code of this project we are talking about on this page." The relation between this current resource I'm reading and the resource I'm linking to is more of a "owl:seeAlso" aka additional information, but it's not really a relation which is related to the source code. In the past, it would have been simply "download the gzipped tarball". Maybe there is no real usage for a meaningful "rel" value.

== Examples ==

These examples demonstrate situations where an explicit rel value could be used to mark up an existing document (or project's) link to its source.

* [https://daneden.me/ Dan Eden's website] links to [https://github.com/daneden/daneden.me the source code on GitHub].
* [http://danielmall.com/ Dan Mall's website] links to [https://github.com/danielmall/danielmallcom the source code on GitHub].
* [http://tom.preston-werner.com/ Tom Preston-Warner] links to [http://github.com/mojombo his Github account].
* [http://responsivedesign.is/resources/javascript-jquery/unison.js The Unison.js project] links to [https://github.com/bjork24/Unison the source code on Github] and [https://github.com/bjork24/Unison/archive/master.zip a direct link to download a .zip file of the source code].
* [http://refresh-dc.org Refresh DC] links to [https://github.com/jgarber623/refresh-dc.org the source code on GitHub].

== See Also ==
* [[source-code]]
* [[source-code-examples]]
* [[source-code-formats]]

microformats2

2026-01-05T19:13:49Z

Tantek: link up top for devs to see the parser spec

__TOC__
Welcome to the microformats2 home page.

== Summary ==
Microformats2 is the latest version of microformats, the simplest way to markup structured information in HTML. Microformats2 improves ease of use and implementation for both authors (publishers) and developers ([[microformats2-parsing|parser]] implementers).
* Developers: see the '''[[microformats2-parsing]]''' specification
Microformats2 replaces and supersedes both classic microformats (sometimes called microformats1), as well as incorporates lessons learned from [[microdata]] and [[RDFa]].

=== simple microformats2 examples ===
Here are a few simple microformats2 examples along with canonical [[JSON]].

==== person example ====
* Simple person reference:
<syntaxhighlight lang="html">
Frances Berriman
</syntaxhighlight>

Parsed JSON:
<syntaxhighlight lang="json">
{
"items": [{
"type": ["h-card"],
"properties": {
"name": ["Frances Berriman"]
}
}]
}
</syntaxhighlight>

----

==== hyperlinked person ====
* Simple hyperlinked person reference
<syntaxhighlight lang="html">
<a class="h-card" href="http://benward.me">Ben Ward</a>
</syntaxhighlight>

Parsed JSON:
<syntaxhighlight lang="json">
{
"items": [{
"type": ["h-card"],
"properties": {
"name": ["Ben Ward"],
"url": ["http://benward.me"]
}
}]
}
</syntaxhighlight>

----

==== hyperlinked person image ====
* Simple hyperlinked person image
<syntaxhighlight lang="html">
<a class="h-card" href="http://rohit.khare.org/">
<img alt="Rohit Khare"
src="https://s3.amazonaws.com/twitter_production/profile_images/53307499/180px-Rohit-sq_bigger.jpg" />
</a>
</syntaxhighlight>

Parsed JSON:
<syntaxhighlight lang="json">
{
"items": [{
"type": ["h-card"],
"properties": {
"name": ["Rohit Khare"],
"url": ["http://rohit.khare.org/"],
"photo": ["https://s3.amazonaws.com/twitter_production/profile_images/53307499/180px-Rohit-sq_bigger.jpg"]
}
}]
}
</syntaxhighlight>

Additional simple cases details in [[microformats-2-implied-properties]].

----

==== detailed person example ====
* More detailed person
<syntaxhighlight lang="html">
<div class="h-card">
<img class="u-photo" alt="photo of Mitchell"
src="https://webfwd.org/content/about-experts/300.mitchellbaker/mentor_mbaker.jpg"/>
<a class="p-name u-url"
href="http://blog.lizardwrangler.com/"
>Mitchell Baker</a>
(<a class="u-url"
href="https://twitter.com/MitchellBaker"
>@MitchellBaker</a>)
Mozilla Foundation

Mitchell is responsible for setting the direction and scope of the Mozilla Foundation and its activities.

Strategy
Leadership
</div>
</syntaxhighlight>

Parsed JSON:
<syntaxhighlight lang="json">
{
"items": [{
"type": ["h-card"],
"properties": {
"photo": ["https://webfwd.org/content/about-experts/300.mitchellbaker/mentor_mbaker.jpg"],
"name": ["Mitchell Baker"],
"url": [
"http://blog.lizardwrangler.com/",
"https://twitter.com/MitchellBaker"
],
"org": ["Mozilla Foundation"],
"note": ["Mitchell is responsible for setting the direction and scope of the Mozilla Foundation and its activities."],
"category": [
"Strategy",
"Leadership"
]
}
}]
}
</syntaxhighlight>

----
=== details from examples ===
Details demonstrated by the examples:
# The JSON <code>"type"</code> uses the full microformat root class name (e.g. <code>"h-card"</code>) for consistent identification.
# all properties are optional and syntactically plural with parsed values provided in document order; particular microformats (and applications there-of) may apply specific/singular semantics to first value of a property.

=== microformats2 design ===

microformats2 has the following key design aspects:

; Prefixes for class names
: All microformats class names use prefixes. Prefixes are '''syntax independent from vocabularies''', which are developed separately.
* <code>h-*</code> for root class names (e.g. <code>h-card</code>)
* <code>p-*</code> for plain text properties (e.g. <code>p-name</code>)
* <code>u-*</code> for URL properties (e.g. <code>u-photo</code>)
* <code>dt-*</code> for date/time properties (e.g. <code>dt-bday</code>)
* <code>e-*</code> for embedded markup properties (e.g. <code>e-note</code>) 

See [[microformats2-prefixes]] for more details.

; Flat sets of optional properties
: All microformats consist of a root, and a collection of properties. Hierarchical data is represented with nested microformats, typically as property values themselves. Properties are all optional and potentially multivalued (applications needing a singular semantic may use first instance).

; Single class markup for common uses
: Common simple markup patterns require only a single microformat root class name, which parsers use to find a few generic properties: <code>name</code>, <code>url</code>, <code>photo</code>. The simple microformats2 examples above demonstrate these.

----

Parsing each prefix (including generating canonical JSON) is detailed step-by-step in:
* The '''[[microformats2-parsing|microformats2 parsing specification]]'''

'''Note:''' Most properties are specified and used with a single specific prefix (or occasionally two or three) that is self-evident from context. However, any parsing prefix can be used with any property, especially if you find a good reason to do so!

== v2 vocabularies ==
Status: '''draft'''. Please review and provide feedback in [[IRC]].
* [[h-adr]]
* [[h-card]]
* [[h-entry]]
* [[h-event]]
* [[h-feed]]
* [[h-geo]]
* [[h-item]]
* [[h-listing]]
* [[h-product]]
* [[h-recipe]]
* [[h-resume]]
* [[h-review]]
* [[h-review-aggregate]]

See below for vocabulary summaries.

=== h-adr ===
{{main|h-adr}}

The '''h-adr''' microformat is for marking up structured locations such as addresses, physical and/or postal. This is an update to [[adr]].

root class name: '''<code>h-adr</code>''' 
profile/itemtype: <nowiki>http://microformats.org/profile/h-adr</nowiki>

properties:
* '''<code>p-post-office-box</code>'''
* '''<code>p-extended-address</code>'''
* '''<code>p-street-address</code>'''
* '''<code>p-locality</code>'''
* '''<code>p-region</code>'''
* '''<code>p-postal-code</code>'''
* '''<code>p-country-name</code>'''
* '''<code>p-label</code>''' - new in [[vCard4]] ([[RFC6350]])
* '''<code>p-geo</code>''' (or '''<code>u-geo</code>''' with a RFC 5870 geo: URL) - new in [[vCard4]] ([[RFC6350]])
* '''<code>p-latitude</code>''' - new in [[vCard4]] ([[RFC6350]] from RFC 5870)
* '''<code>p-longitude</code>''' - new in [[vCard4]] ([[RFC6350]] from RFC 5870)
* '''<code>p-altitude</code>''' - new in [[vCard4]] ([[RFC6350]] from RFC 5870)

For backward compatibility, microformats2 parsers {{should}} detect the following root class name and property names. A microformats2 parser may use existing classic microformats [[parsers]] to extract these properties. If an "h-adr" is found, don't look for an "adr" on the same element.

compat root class name: <code id="adr">adr</code> 
properties: (parsed as '''p-''' plain text unless otherwise specified)
* <code>post-office-box</code>
* <code>extended-address</code>
* <code>street-address</code>
* <code>locality</code>
* <code>region</code>
* <code>postal-code</code>
* <code>country-name</code>

=== h-card ===
{{main|h-card}}

The '''h-card''' microformat is for marking up people and organizations. This is an update to [[hCard]].

root class name: '''<code>h-card</code>''' 
profile/itemtype: <nowiki>http://microformats.org/profile/h-card</nowiki>

properties:
* '''<code>p-name</code>'''
* '''<code>p-honorific-prefix</code>'''
* '''<code>p-given-name</code>'''
* '''<code>p-additional-name</code>'''
* '''<code>p-family-name</code>'''
* '''<code>p-sort-string</code>'''
* '''<code>p-honorific-suffix</code>'''
* '''<code>p-nickname</code>'''
* '''<code>u-email</code>'''
* '''<code>u-logo</code>'''
* '''<code>u-photo</code>'''
* '''<code>u-url</code>'''
* '''<code>u-uid</code>'''
* '''<code>p-category</code>'''
* '''<code>p-adr</code>'''
* '''<code>p-post-office-box</code>'''
* '''<code>p-extended-address</code>'''
* '''<code>p-street-address</code>'''
* '''<code>p-locality</code>'''
* '''<code>p-region</code>'''
* '''<code>p-postal-code</code>'''
* '''<code>p-country-name</code>'''
* '''<code>p-label</code>'''
* '''<code>p-geo</code>''' or '''<code>u-geo</code>''' with a RFC 5870 geo: URL, new in [[vCard4]] ([[RFC6350]])
* '''<code>p-latitude</code>'''
* '''<code>p-longitude</code>'''
* '''<code>p-altitude</code>''' - new in [[vCard4]] ([[RFC6350]] from RFC 5870)
* '''<code>p-tel</code>'''
* '''<code>p-note</code>'''
* '''<code>dt-bday</code>'''
* '''<code>u-key</code>'''
* '''<code>p-org</code>'''
* '''<code>p-job-title</code>''' - previously 'title' in hCard, disambiguated.
* '''<code>p-role</code>
* '''<code>u-impp</code>''' per RFC 4770, new in [[vCard4]] ([[RFC6350]])
* '''<code>p-sex</code>''' new in [[vCard4]] ([[RFC6350]])
* '''<code>p-gender-identity</code>''' new in [[vCard4]] ([[RFC6350]])
* '''<code>dt-anniversary</code>''' new in [[vCard4]] ([[RFC6350]])
* ...

Reserved properties: (properties not used much (if at all) in practice)
* '''<code>p-organization-name</code>'''
* '''<code>p-organization-unit</code>'''
* '''<code>p-tz</code>'''
* '''<code>dt-rev</code>'''
* ...

For backward compatibility, microformats2 parsers {{should}} detect the following root class name and property names. A microformats2 parser may use existing classic microformats [[parsers]] to extract these properties. If an "h-card" is found, don't look for a "vcard" on the same element.

compat root class name: <code id="vcard">vcard</code> 
properties: (parsed as '''p-''' plain text unless otherwise specified)
* <code>fn</code> - parse as '''<code>p-name</code>'''
* <code>honorific-prefix</code>
* <code>given-name</code>
* <code>additional-name</code>
* <code>family-name</code>
* <code>honorific-suffix</code>
* <code>nickname</code>
* <code>email</code> - parse as '''u-'''
* <code>logo</code> - parse as '''u-'''
* <code>photo</code> - parse as '''u-'''
* <code>url</code> - parse as '''u-'''
* <code>uid</code> - parse as '''u-'''
* <code>category</code>
* <code>adr</code> - parse as '''<code>p-adr h-adr</code>''' including compat root class <code>adr</code>
* <code>extended-address</code>
* <code>street-address</code>
* <code>locality</code>
* <code>region</code>
* <code>postal-code</code>
* <code>country-name</code>
* <code>label</code>
* <code>geo</code> - parse as '''<code>p-geo h-geo</code>''' including compat root class <code>geo</code>
* <code>latitude</code>
* <code>longitude</code>
* <code>tel</code>
* <code>note</code>
* <code>bday</code> - parse as '''dt-'''
* <code>key</code> - parse as '''u-'''
* <code>org</code>
* <code>organization-name</code>
* <code>organization-unit</code>
* <code>title</code> - parse as '''p-job-title'''
* <code>role</code>
* ...

Reserved: (backward compat properties that parsers {{may}} implement, if they do, they {{must}} implement in this way:
* <code>tz</code>
* <code>rev</code> - parse as '''dt-'''
* ...

Note: use of 'value' within 'tel' should be automatically handled by the support of the [[value-class-pattern]]. And for now, the 'type' subproperty of 'tel' is dropped/ignored. If there is demonstrable documented need for additional tel types (e.g. fax), we can introduce new flat properties as needed (e.g. p-tel-fax).

=== h-entry ===
{{main|h-entry}}

The '''h-entry''' microformat is for marking up syndicatable content such as blog posts, notes, articles, comments, photos and similar. This is an update to [[hAtom]].

root class name: '''<code>h-entry</code>''' 
profile/itemtype: <nowiki>http://microformats.org/profile/h-entry</nowiki>

properties:
* '''<code>p-name</code>''' (was p-entry-title, see issues)
* '''<code>p-summary</code>''' (was p-entry-summary, see issues)
* '''<code>e-content</code>''' (was e-entry-content, see issues)
* '''<code>dt-published</code>'''
* '''<code>dt-updated</code>'''
* '''<code>p-author</code>'''
* '''<code>p-category</code>'''
* '''<code>u-url</code>'''
* '''<code>u-uid</code>'''
* '''<code>p-geo</code>'''
* '''<code>p-latitude</code>'''
* '''<code>p-longitude</code>'''

This is an update to [[hAtom]].

Brainstorming:

The following properties are proposed additions to h-entry above and beyond what hAtom (or Atom) provides, based on various existing link preview markup conventions:
* '''<code>u-photo</code>'''
* '''<code>u-audio</code>''' - consider special u- parsing rules for <code><audio></code>
* '''<code>u-video</code>''' - consider special u- parsing rules for <code><video></code>
* '''<code>u-in-reply-to</code>''' - for links to other posts that this post is a reply to (comment regarding, etc.)

Backward compatibility:

(*)hAtom-specific implementations that perform custom display or translation (e.g. to Atom XML) {{should}} prefer <code>p-name</code> over <code>p-entry-title</code>, and use <code>p-entry-title</code> value(s) as a fallback if there is no <code>p-name</code>.

For hAtom backward compatibility, microformats2 parsers {{should}} detect the following root class name and property names. A microformats2 parser may use existing classic microformats [[parsers]] to extract these properties. If an "h-entry" is found, don't look for a "hentry" on the same element.

compat root class name: <code id="hentry">hentry</code> 
properties: (parsed as '''p-''' plain text unless otherwise specified)
* <code>entry-title</code> - parse as '''<code>p-name</code>'''
* <code>entry-summary</code>
* <code>entry-content</code> - parse as '''e-'''
* <code>published</code> - parse as '''dt-'''
* <code>updated</code> - parse as '''dt-'''
* <code>author</code> - including compat root <code>vcard</code> in the absence of <code>h-card</code>
* <code>category</code>
* <code>geo</code> - parse as '''<code>p-geo h-geo</code>''' including compat root <code>geo</code>
* <code>latitude</code>
* <code>longitude</code>
* ...

FAQ:
<div class="discussion">
* '''What is the <code>p-name</code> of a [http://indiewebcamp.com/note note]?'''
** A few options, from simplest to most detailed.
*** '''same as the p-content/e-content''' property.
*** '''same as the <code>title</code> element''' on the note permalink post page. When publishing a note on its own permalink post page, the contents of the note are likely abbreviated for the title of the page. The same abbreviation can be used for the p-name.
*** '''first sentence of the p-content/e-content''' property. It may be better for [http://indiewebcamp.com/syndication syndication] and [[link-preview]] purposes to provide just the first sentence of the note as the <code>p-name</code>. Similarly if only a portion of the content is syndicated to other sites, that portion can be marked up as the <code>p-summary</code>.
* ...
</div>

Resolved Issues:
* 2012-245 Resolved. See [http://krijnhoetmer.nl/irc-logs/microformats/20120830#l-120 2012-243 IRC discussion/consensus] for:
** Use '''<code>p-summary</code> instead of <code>p-entry-summary</code>'''. The historical semantic of "entry-summary" is not different from "summary" in any significant (or discernible way). Collapsing the two will simplify the overall microformats2 vocabularies further. In microformats2, entry-summary is no more.
** Use '''<code>e-content</code> instead of <code>e-entry-content</code>'''. Same point and advantage. In microformats2, entry-content is no more.
** '''drop <code>p-entry-title</code>'''. Unnecessary and subsumed by "p-name". Would consider move to backward compat only if cases are presented - known publishing uses are expected to be updated shortly.

=== h-event ===
{{main|h-event}}

The '''h-event''' microformat is for marking up events. This is an update to [[hCalendar]].

root class name: '''<code>h-event</code>''' 
profile/itemtype: <nowiki>http://microformats.org/profile/h-event</nowiki>

properties:
* '''<code>p-name</code>'''
* '''<code>p-summary</code>'''(*)
* '''<code>dt-start</code>'''
* '''<code>dt-end</code>'''
* '''<code>dt-duration</code>'''
* '''<code>p-description</code>'''
* '''<code>u-url</code>'''
* '''<code>p-category</code>'''
* '''<code>p-location</code>'''
* '''<code>p-geo</code>'''
* '''<code>p-latitude</code>'''
* '''<code>p-longitude</code>'''
* ...

This is an update to [[hCalendar]].

(*)hCalendar-specific implementations that perform custom display or translation (e.g. to iCalendar .ics) {{should}} prefer <code>p-name</code> over <code>p-summary</code>, and use <code>p-summary</code> value(s) as a fallback if there is no <code>p-name</code>.

For backward compatibility, microformats2 parsers {{should}} detect the following root class name and property names. A microformats2 parser may use existing classic microformats [[parsers]] to extract these properties. If an "h-event" is found, don't look for a "vevent" on the same element.

compat root class name: <code id="vevent">vevent</code> 
properties: (parsed as '''p-''' plain text unless otherwise specified)
* <code>summary</code> - parse as '''<code>p-name</code>'''
* <code>dtstart</code> - parse as '''<code>dt-start</code>'''
* <code>dtend</code> - parse as '''<code>dt-end</code>'''
* <code>duration</code> - parse as '''<code>dt-duration</code>'''
* <code>description</code>
* <code>url</code> - parse as '''u-'''
* <code>category</code>
* <code>location</code> - including compat root <code>vcard</code> in the absence of <code>h-card</code>, and compat root <code>adr</code> in the absence of <code>h-adr</code>
* <code>geo</code> - parse as '''<code>p-geo h-geo</code>''' including compat root <code>geo</code>
* <code>latitude</code>
* <code>longitude</code>
* ...

=== h-geo ===
{{main|h-geo}}

The '''h-geo''' microformat is for marking up WGS84 geophysical coordinates. This is an update to [[geo]].

root class name: '''<code>h-geo</code>''' 
profile/itemtype: <nowiki>http://microformats.org/profile/h-geo</nowiki>

properties:
* '''<code>p-latitude</code>'''
* '''<code>p-longitude</code>'''
* '''<code>p-altitude</code>''' - new in [[vCard4]] ([[RFC6350]] from RFC 5870)

For backward compatibility, microformats2 parsers {{should}} detect the following root class name and property names. A microformats2 parser may use existing classic microformats [[parsers]] to extract these properties. If an "h-geo" is found, don't look for an "geo" on the same element.

compat root class name: <code id="geo">geo</code>
properties: (parsed as '''p-''' plain text unless otherwise specified)
* <code>latitude</code>
* <code>longitude</code>

=== h-item ===
{{main|h-item}}

The '''h-item''' microformat is for marking up the item of an [[h-review]] or [[h-product]]. This is an update to part of [[hReview]].

root class name: '''<code>h-item</code>''' 
profile/itemtype: <nowiki>http://microformats.org/profile/h-item</nowiki>

properties:
* '''<code>p-name</code>'''
* '''<code>u-photo</code>'''
* '''<code>u-url</code>'''

Note: in practice, due to the microformats2 implied property rules, it is expected that most uses of "h-item" won't require any explicit properties at all (since microformats2 parsers will infer name, photo, and url properties from the structure of the element with "h-item" and its contained content/elements if any).

=== h-product ===
{{main|h-product}}

The '''h-product''' microformat is for marking up products. This is an update to [[hProduct]].

root class name: '''<code>h-product</code>''' 
profile/itemtype: <nowiki>http://microformats.org/profile/h-product</nowiki>

properties:
* '''<code>p-name</code>''' - name of the product
* '''<code>u-photo</code>''' - photo of the product
* '''<code>p-brand</code>''' - manufacturer, can also be a nested <code>h-card</code>
* '''<code>p-category</code>''' - freeform categories or tags applied to the item by the reviewer
* '''<code>e-description</code>'''
* '''<code>u-url</code>''' - URL of the product
* '''<code>u-identifier</code>''' - includes type (e.g. mpn, upc, isbn, issn, sn, vin, sku etc.) and value.
* '''<code>p-review</code>''' - a review of the product, can also be a nested <code>h-review</code>
* '''<code>p-price</code>''' - retail price of the product

For backward compatibility, microformats2 parsers {{should}} detect the following root class name and property names. A microformats2 parser may use existing classic microformats [[parsers]] to extract these properties. If an "h-product" is found, don't look for an "hproduct" on the same element.

compat root class name: <code id="hproduct">hproduct</code> 
properties: (parsed as '''p-''' plain text unless otherwise specified)
* <code>fn</code> - parse as '''<code>p-name</code>'''
* <code>photo</code> - parse as '''u-'''
* <code>brand</code>
* <code>category</code>
* <code>description</code>
* <code>identifier</code> - parse as '''u-'''
* <code>url</code> - parse as '''u-'''
* <code>review</code> - including compat root class <code>hreview</code> in the absence of <code>h-review</code>
* <code>price</code>

Note: [[hProduct]] has at least one experimental property which has real world adoption due to [[Google]] and [[Bing]] search support of hProduct. Currently this is: '''price'''

=== h-recipe ===
{{main|h-recipe}}

The '''h-recipe''' microformat is for marking up food recipes. This is an update to [[hRecipe]].

root class name: '''<code>h-recipe</code>''' 
profile/itemtype: <nowiki>http://microformats.org/profile/h-recipe</nowiki>

properties:
* '''<code>p-name</code>''' - the name of the recipe
* '''<code>p-ingredient</code>''' - describes one or more ingredients used in the recipe.
* '''<code>p-yield</code>''' - Specifies the quantity produced by the recipe, like how many persons it satisfyies
* '''<code>e-instructions</code>''' - the method of the recipe.
* '''<code>dt-duration</code>''' - the time it takes to prepare the meal described by the recipe.
* '''<code>u-photo</code>''' - an accompanying image

Experimental properties with wide adoption
* '''<code>p-summary</code>''' - provides a short summary or introduction
* '''<code>p-author</code>''' - the person who wrote the recipe with <code>h-card</code>
* '''<code>dt-published</code>''' - the date the recipe was published
* '''<code>p-nutrition</code>''' - nutritional information like calories, fat, dietary fiber etc.
* ...

For backward compatibility, microformats2 parsers {{should}} detect the following root class name and property names. A microformats2 parser may use existing classic microformats [[parsers]] to extract these properties. If an "h-recipe" is found, don't look for an "hrecipe" on the same element.

compat root class name: <code id="hrecipe">hrecipe</code> 
properties: (parsed as '''p-''' plain text unless otherwise specified)
* <code>fn</code> - parse as '''<code>p-name</code>'''
* <code>ingredient</code>
* <code>yield</code>
* <code>instructions</code> - parse as '''e-'''
* <code>duration</code> - parse as '''dt-'''
* <code>photo</code> - parse as '''u-'''
* <code>summary</code>
* <code>author</code> - including compat root <code>vcard</code> in the absence of <code>h-card</code>
* <code>nutrition</code>

Note: [[hRecipe]] has a number of experimental properties which have real world adoption due to [[Google]] recipe search support of hRecipe. These are: summary, author, published and nutrition

=== h-resume ===
{{main|h-resume}}

The '''h-resume''' microformat is for marking up resumes. This is an update to [[hResume]].

root class name: '''<code>h-resume</code>''' 
profile/itemtype: <nowiki>http://microformats.org/profile/h-resume</nowiki>

properties:
* '''<code>p-summary</code>''' - overview of qualifications and objectives
* '''<code>p-contact</code>''' - current contact info in an <code>h-card</code>
* '''<code>p-education</code>''' - an education <code>h-calendar</code> event, years, nested <code>h-card</code> of the school, location.
* '''<code>p-experience</code>''' - a job or other professional experience <code>h-calendar</code> event, years, nested <code>h-card</code> of the organization, location, job-title.
* '''<code>p-skill</code>''' - a skill or ability, optionally including level and/or duration of experience
* '''<code>p-affiliation</code>''' - an affiliation with an <code>h-card</code> organization

For backward compatibility, microformats2 parsers {{should}} detect the following root class name and property names. A microformats2 parser may use existing classic microformats [[parsers]] to extract these properties. If an "h-resume" is found, don't look for an "hresume" on the same element.

compat root class name: <code id="hresume">hresume</code> 
properties: (parsed as '''p-''' plain text unless otherwise specified)
* <code>summary</code>
* <code>contact</code> - including compat root <code>vcard</code> in the absence of <code>h-card</code>
* <code>education</code> - including compat root <code>vevent</code> in the absence of <code>h-event</code>
* <code>experience</code> - including compat root <code>vevent</code> in the absence of <code>h-event</code>
* <code>skill</code>
* <code>affiliation</code> - including compat root <code>vcard</code> in the absence of <code>h-card</code>

Note: skill has a [[hresume-skill-brainstorm|proposed expansion into competency]] with explicit summary, rating and/or duration components. Based on existing real world adoption, we should consider an h-competency vocabulary with p-summary, p-rating, and dt-duration properties.

=== h-review ===
{{main|h-review}}

The '''h-review''' microformat is for marking up reviews. This is an update to [[hReview]]. See also [[h-item]].

root class name: '''<code>h-review</code>''' 
profile/itemtype: <nowiki>http://microformats.org/profile/h-review</nowiki>

properties:
* '''<code>p-name</code>''' - name of the review
* '''<code>p-item</code>''' - thing been reviewed i.e. business or person (h-card), event (h-event), place (h-adr or h-geo), product (h-product), website, url, or other item ([[h-item]]).
* '''<code>p-author</code>''' - person who authored the review, optionally with an embedded [[h-card]]
* '''<code>dt-published</code>''' - date time of when the review was written and published
* '''<code>p-rating</code>''' - value from 1-5 indicating a rating for the item (5 best).
* '''<code>p-best</code>''' - define best rating value. can be numerically lower than worst.
* '''<code>p-worst</code>''' - define worst rating value. can be numerically higher than best.
* '''<code>e-content</code>''' - the full text written evaluation and opinion of the reviewer
* '''<code>p-category</code>''' - freeform categories or tags applied to the item by the reviewer
* '''<code>u-url</code>''' - URL of the review

For backward compatibility, microformats2 parsers {{should}} detect the following root class name and property names. A microformats2 parser may use existing classic microformats [[parsers]] to extract these properties. If an "h-review" is found, don't look for an "hreview" on the same element.

compat root class name: <code id="hreview">hreview</code> 
properties: (parsed as '''p-''' plain text unless otherwise specified)
* <code>summary</code> parse as '''<code>p-name</code>'''
* <code>fn</code> - parse as '''p-name''' of the item being reviewed (p-item h-item p-name)
* <code>photo</code> - parse as '''u-photo''' of the item being reviewed (p-item h-item u-photo)
* <code>url</code> - parse as '''u-url''' of the item being reviewed (p-item h-item u-url)
* <code>reviewer</code> - including compat root vcard in the absence of h-card
* <code>dtreviewed</code> - parse as '''dt-'''
* <code>rating</code>
* <code>best</code>
* <code>worst</code>
* <code>description</code> - parse as '''e-'''
* <code>rel="tag"</code> - parse as '''p-category'''
* <code>rel="self bookmark"</code> - parse as '''u-url'''. note that <code>rel</code> attribute value is treated as a space separated set, thus any presence of "self" and "bookmark" within such a set in a rel value is accepted.

Note: The [[hReview]] format has three properties which make use of <code>rel</code> attribute, these are <code>tag</code>, permalink (via the <code>self</code> and <code>bookmark</code> values) and <code>license</code>. Microformats2 parsers {{should}} map these URLs into the page scoped rel collection.

=== h-review-aggregate ===
{{main|h-review-aggregate}}

The '''h-review-aggregate''' microformat is for marking up aggregate reviews of a single item. This is an update to [[hreview-aggregate]]. See also [[h-item]].

root class name: '''<code>h-review-aggregate</code>''' 
profile/itemtype: <nowiki>http://microformats.org/profile/h-review-aggregate</nowiki>

properties:
* '''<code>p-name</code>''' - name of the review
* '''<code>p-item</code>''' - thing been reviewed i.e. business or person (h-card), event (h-event), place (h-adr or h-geo), product (h-product), website, url, or other item (h-item).
* '''<code>p-rating</code>''' - value from 1-5 indicating average rating for the item (5 best).
* '''<code>p-best</code>''' - define best rating value. can be numerically lower than worst.
* '''<code>p-worst</code>''' - define worst rating value. can be numerically higher than best.
* '''<code>p-count</code>''' - number of reviews aggregated.
* '''<code>p-votes</code>''' - number of reviewers who have rated the product, thus contributing to the average rating.
* '''<code>p-category</code>''' - freeform categories or tags applied to the item by the reviewer
* '''<code>u-url</code>''' - URL of the review

For backward compatibility, microformats2 parsers {{should}} detect the following root class name and property names. A microformats2 parser may use existing classic microformats [[parsers]] to extract these properties. If an "h-review-aggregate" is found, don't look for an "hreview-aggregate" on the same element.

compat root class name: <code id="hreview-aggregate">hreview-aggregate</code> 
properties: (parsed as '''p-''' plain text unless otherwise specified)
* <code>summary</code> parse as '''<code>p-name</code>'''
* <code>fn</code> - parse as '''p-name''' of the item being reviewed (p-item h-item p-name)
* <code>photo</code> - parse as '''u-photo''' of the item being reviewed (p-item h-item u-photo)
* <code>url</code> - parse as '''u-url''' of the item being reviewed (p-item h-item u-url)
* <code>rating</code>
* <code>best</code>
* <code>worst</code>
* <code>count</code>
* <code>votes</code>
* <code>rel="tag"</code> - parse as '''p-category'''
* <code>rel="self bookmark"</code> - parse as '''u-url'''. note that <code>rel</code> attribute value is treated as a space separated set, thus any presence of "self" and "bookmark" within such a set in a rel value is accepted.

=== v2 vocab notes ===
Notes:
* All v2 vocabularies are defined as flat lists of properties of an object/item, and thus can be used in microformats-2 syntax as shown, or in microdata items, or RDFa. The microformats-2 property parsing prefixes "p-", "u-", "dt-", "e-" are omitted when using defined properties in microdata itemprop and RDFa property as those syntaxes have their own element-specific parsing rules.
* Profile URLs are provided for use with the HTML4 <code>profile</code> attribute, microdata <code>itemtype</code> attribute, and RDFa <code>vocab</code> & <code>typeof</code> attributes (though the latter requires slicing off the trailing segment of the profile for the typeof attribute, and leaving the rest in vocab).
* microformats2 properties may also be explicitly bound as URIs using [[rel-profile]], the [[html5-profile]] attribute proposal, or an HTML5 'vocab' attribute instead. If URI bound terms are important to you, please express interest on [[rel-profile]], [[html5-profile]], or contribute to an [[html5-vocab]] draft.

=== v2 vocab to-do ===
To do:
* write a simple tutorial for creating/getting started with microformats-2 markup for new content
* examples in each h-* spec listed above of how to embed other microformats in them
* actual profile documents at <nowiki>http://microformats.org/profile/h-*</nowiki> URLs mentioned above.
* Provide any necessary microdata-specific language as needed (e.g. to be comparably understandable to the [http://www.whatwg.org/specs/web-apps/current-work/#vcard sample vCard4/hCard1 microdata vocabulary]. Also provide any necessary RDFa-specific language as needed. Both preferably in a generic vocabulary-independent way.
* write a porting guide mapping v1 property -> v2 property
** use-case: simple search/replace in templates (e.g. in case web author doesn't remember existing microformats vocabs and where they used them).
** advise using *both* in existing templates (e.g. in case some CSS depends on the existing microformats)
* analyzie/document how well the microformats2 model and vocabularies satisfy the [http://lists.whatwg.org/htdig.cgi/whatwg-whatwg.org/2009-May/019681.html use-cases used to design/create microdata].

== combining microformats ==
Since microformats2 uses simple flat sets of properties for each microformat, multiple microformats are combined to indicate additional structure.

=== h-event location h-card ===
Events commonly have venue information with additional structure, like address information. For example:

<syntaxhighlight lang="html">
<div class="h-event">
<a class="p-name u-url" href="http://indiewebcamp.com/2012">
IndieWebCamp 2012
</a>
from <time class="dt-start">2012-06-30</time>
to <time class="dt-end">2012-07-01</time> at

<a class="p-name p-org u-url" href="http://geoloqi.com/">
Geoloqi
</a>,
920 SW 3rd Ave. Suite 400,
Portland,
<abbr class="p-region" title="Oregon">OR</abbr>

</div>
</syntaxhighlight>

The nested h-card used to structure the p-location of the h-event is represented as a structured value for "location" in the JSON, which has an additional key, "value" that represents the plain text version parsed from the p-location.

Parsed JSON:
<syntaxhighlight lang="json">
{
"items": [{
"type": ["h-event"],
"properties": {
"name": ["IndieWebCamp 2012"],
"url": ["http://indiewebcamp.com/2012"],
"start": ["2012-06-30"],
"end": ["2012-07-01"],
"location": [{
"value": "Geoloqi",
"type": ["h-card"],
"properties": {
"name": ["Geoloqi"],
"org": ["Geoloqi"],
"url": ["http://geoloqi.com/"],
"street-address": ["920 SW 3rd Ave. Suite 400"],
"locality": ["Portland"],
"region": ["Oregon"]
}
}]
}
}]
}
</syntaxhighlight>

Questions:
<div class="discussion">
* Should the nested hCard be present also as a top-level item in the JSON? - [[User:Tantek|Tantek]] 02:02, 19 June 2012 (UTC)
** My current (2012-243) leaning is no. - [[User:Tantek|Tantek]] 18:53, 30 August 2012 (UTC)
** If so, how do we avoid expansion of the JSON geometrically proportional to the depth of microformat nesting? (Or do we not worry about it?)
* Should there be a canonical hierarchical JSON and a canonical flattened JSON? - [[User:Tantek|Tantek]] 02:02, 19 June 2012 (UTC)
** My current (2012-243) leaning is no, we stick with one canonical JSON for uf2 which is hierarchical. - [[User:Tantek|Tantek]] 18:53, 30 August 2012 (UTC)
** If so, should the flattened JSON have references from properties to nested microformats that have been pushed to the top level per flattening? - [[User:Tantek|Tantek]] 02:02, 19 June 2012 (UTC)
*** If so, what convention does/do JSON follow for such synthetic local reference identifiers? - [[User:Tantek|Tantek]] 02:02, 19 June 2012 (UTC)
</div>

Notes:
* The 'location' value reflects the visible text of its element, including spaces and punctuation, as well as the state abbreviation 'OR'. The 'h-card' property values are only what is marked up, and thus include structure values without extra punctuation, and the state takes the expanded form from the <code>title</code> attribute of its <code><abbr></code> element.

=== h-card org h-card ===
People often publish information general to their company rather than specific to them, in which case, they may wish to encapsulate that in separately nested microformat. E.g. here is a simple h-card example with org property:

[http://blog.lizardwrangler.com Mitchell Baker] (Mozilla Foundation)

with source:
<syntaxhighlight lang="html">
<div class="h-card">
<a class="p-name u-url"
href="http://blog.lizardwrangler.com/"
>Mitchell Baker</a>
(Mozilla Foundation)
</div>
</syntaxhighlight>

Parsed JSON:
<syntaxhighlight lang="json">
{
"items": [{
"type": ["h-card"],
"properties": {
"name": ["Mitchell Baker"],
"url": ["http://blog.lizardwrangler.com/"],
"org": ["Mozilla Foundation"]
}
}]
}
</syntaxhighlight>

Sometimes such organization affiliations are hyperlinked to the website of the organization:

[http://blog.lizardwrangler.com Mitchell Baker] ([http://mozilla.org/ Mozilla Foundation])

You can mark that up with a nested h-card:
<syntaxhighlight lang="html">
<div class="h-card">
<a class="p-name u-url"
href="http://blog.lizardwrangler.com/"
>Mitchell Baker</a>
(<a class="p-org h-card"
href="http://mozilla.org/"
>Mozilla Foundation</a>)
</div>
</syntaxhighlight>

Parsed JSON:
<syntaxhighlight lang="json">
{
"items": [{
"type": ["h-card"],
"properties": {
"name": ["Mitchell Baker"],
"url": ["http://blog.lizardwrangler.com/"],
"org": [{
"value": "Mozilla Foundation",
"type": ["h-card"],
"properties": {
"name": ["Mozilla Foundation"],
"url": ["http://mozilla.org/"]
}
}]
}
}]
}
</syntaxhighlight>

Note: the nested h-card has implied 'name' and 'url' properties, just like any other root-class-name-only h-card on an <code><a href></code> would.

'''FOR PARSERS ONLY:'''

The nested 'h-card' could be marked up as an 'h-org' as well, which adds it to the nested microformat's type array, all as part of the property specified by the 'p-org'.

<syntaxhighlight lang="html">
<div class="h-card">
<a class="p-name u-url"
href="http://blog.lizardwrangler.com/"
>Mitchell Baker</a>
(<a class="p-org h-card h-org"
href="http://mozilla.org/"
>Mozilla Foundation</a>)
</div>
</syntaxhighlight>

Parsed JSON:
<syntaxhighlight lang="json">
{
"items": [{
"type": ["h-card"],
"properties": {
"name": ["Mitchell Baker"],
"url": ["http://blog.lizardwrangler.com/"],
"org": [{
"value": "Mozilla Foundation",
"type": ["h-card", "h-org"],
"properties": {
"name": ["Mozilla Foundation"],
"url": ["http://mozilla.org/"]
}
}]
}
}]
}
</syntaxhighlight>

'''FOR PARSERS ONLY:'''

Without a property class name like 'p-org' holding all the nested objects together, we need to introduce another array for nested children (similar to the existing DOM element notion of children) of a microformat that are not attached to a specific property:

<syntaxhighlight lang="html">
<div class="h-card">
<a class="p-name u-url"
href="http://blog.lizardwrangler.com/"
>Mitchell Baker</a>
(<a class="h-org h-card"
href="http://mozilla.org/"
>Mozilla Foundation</a>)
</div>
</syntaxhighlight>

Parsed JSON:
<syntaxhighlight lang="json">
{
"items": [{
"type": ["h-card"],
"properties": {
"name": ["Mitchell Baker"],
"url": ["http://blog.lizardwrangler.com/"]
},
"children": [{
"type": ["h-card","h-org"],
"properties": {
"name": ["Mozilla Foundation"],
"url": ["http://mozilla.org/"]
}
}]
}]
}
</syntaxhighlight>

Since there's no property class name on the element with classes 'h-card' and 'h-org', the microformat representing that element is collected into the children array.

Such a nested microformat implies some relationship (containment, being related), but is not as useful as if the nested microformat was a specific property of its parent.

For this reason it's recommended that authors should not publish nested microformats without a property class name, and instead, when nesting microformats, authors should always specify a property class name (like 'p-org') on the same element as the root class name(s) of the nested microformat(s) (like 'h-card' and/or 'h-org').

'''FOR PARSERS ONLY:'''

Or the nested object could be only marked up with 'h-card'. Source:

<syntaxhighlight lang="html">
<div class="h-card">
<a class="p-name u-url"
href="http://blog.lizardwrangler.com/"
>Mitchell Baker</a>
(<a class="h-card"
href="http://mozilla.org/"
>Mozilla Foundation</a>)
</div>
</syntaxhighlight>

Parsed JSON:
<syntaxhighlight lang="json">
{
"items": [{
"type": ["h-card"],
"properties": {
"name": ["Mitchell Baker"],
"url": ["http://blog.lizardwrangler.com/"]
},
"children": [{
"type": ["h-card"],
"properties": {
"name": ["Mozilla Foundation"],
"url": ["http://mozilla.org/"]
}
}]
}]
}
</syntaxhighlight>

'''TO DO: Add h-event h-card example and JSON, per real world publishing examples like [http://www.swingtime.co.uk/List/ClSouth.html Swing Time: Classes in Southern England].'''

== authoring ==
=== minimal markup ===
The best way to use microformats-2 is with as little additional markup as possible. This keeps your code cleaner, improves its maintainability, and thus the quality and longevity of your microformats.

One big advantage of microformats-2 over previous microformats (and others) is the ability to add one class name to an existing element to create a structured item.

See the [[microformats-2#simple_microformats_2_examples|simple examples at the top]] for a start, e.g.

Simple hCards work just by adding <code>class="h-card"</code> :
<syntaxhighlight lang="html">
Frances Berriman

<a class="h-card" href="http://benward.me">Ben Ward</a>

<img class="h-card" alt="Sally Ride"
src="http://upload.wikimedia.org/wikipedia/commons/a/a4/Ride-s.jpg"/>

<a class="h-card" href="http://tantek.com">
<img alt="Tantek Çelik" src="http://ttk.me/logo.jpg"/>
</a>
</syntaxhighlight>

* Tip: Inside an open tag, put the <code>class</code> attribute first, then any human text content attributes (e.g. <code>alt</code>), then URL attributes (e.g. <code>href</code> <code>src</code>), and lastly other attributes (e.g. <code>style</code>). Putting the class attribute first ties it closely to the element name/tag itself, makes it more obvious, and thus more likely to be kept up to date.

=== backward compatible ===
If you depend on current microformats [[implementations]], while they're being updated to support [[microformats2]], you can include both existing classic microformats and microformats2 markup.

In short: use both sets of class names simultaneously.

When doing so, use them on the same element, with the microformats-2 class name first, followed immediately by the existing microformats class name.

Here are the microformats-2 hCards from above with current [[hCard]] markup as well, which may require adding a wrapping element (e.g. a <code></code>) to separate the root class name element from explicit property class name elements:

<syntaxhighlight lang="html">

Frances Berriman



<a class="p-name fn u-url url" href="http://benward.me">Ben Ward</a>



<img class="p-name fn u-photo photo" alt="Sally Ride"
src="http://upload.wikimedia.org/wikipedia/commons/a/a4/Ride-s.jpg"/>



<a class="u-url url" href="http://tantek.com">
<img class="p-name fn u-photo photo" alt="Tantek Çelik"
src="http://ttk.me/logo.jpg"/>
</a>

</syntaxhighlight>

Tips:
* use the microformats-2 class name first, e.g.
** <code>class="h-card vcard"</code>
** <code>class="u-url url"</code>
* and pair them when using an element for multiple properties, e.g.:
** <code>class="p-name fn u-url url"</code>
** <code>class="p-name fn u-photo photo"</code>
* put microformats classes after classes for CSS (since page authors will likely interact more with their own classes for design than with microformats classes), e.g. as used on individual microformats [[events]] pages:
** <code>class="event-page h-event vevent"</code>

The prefixes (h-, p-, etc.) of microformats2 class names provide easier recognition, and when followed by the similarly named existing class name, they're more easily recognized as related and thus kept together when the markup is maintained over time.

Related FAQ: [[microformats2-faq#when_using_both_h-card_and_vcard_which_should_be_first_and_why|When using both h-card and vcard which should be first and why?]]

== extensions ==
microformats2 is extensible by means of two separate but syntactically similar extension prefixes for experiments intended to be iterated & evolved and for vendor specific extensions not intended for standardization.

=== experimental extensions ===
There have been times when specific sites have wanted to extend microformats beyond the set of properties in the microformat vocabulary, and currently lack any '''experimental''' way to do so - to try and see if a feature (or even a whole format) is interesting in the real world before bothering to pursue researching and walking it through the microformats process. Thus:

For experimental extensions for the purpose of prototyping to learn more, iterate, towards possibly standardizing, use the <code>-x-</code> prefix before root and property class names.

Specifically:
* '*-x-' + '-' + meaningful name for root and property class names
** where "*" indicates the single-character-prefix as defined above
** where "x" indicates a literal 'x' for an experimental extension

Examples:
* "p-x-prep-time" - a possible experimental property name to be added to [[h-recipe]] upon consideration/documentation of real-world usage/uptake.

See [[microformats2-experimental-properties]] for more examples.

=== vendor extensions ===
For vendor specific extensions, microformats2 uses a mechanism similar to CSS vendor extensions, using a similar syntax as experimental extensions, except with a vendor prefix instead of a literal 'x'.

* '*-x-' + '-' + meaningful name for root and property class names
** where "*" indicates the single-character-prefix as defined above
** where "x" indicates a vendor prefix (more than one character, e.g. like CSS vendor extension abbreviations, or some stock symbols, avoiding first words/phrases/abbreviations of microformats properties like dt-, numbers allowed after first character)

Examples:
* "h-bigco-one-ring" - a hypothetical "bigco" vendor-specific "one-ring" microformat root class name.
* "p-goog-preptime" - to represent [http://www.google.com/support/webmasters/bin/answer.py?answer=173379 Google's "preptime" property extension] to [[hRecipe]] (aside: "duration" may be another property type to consider separate from "datetime" as it may be subject to different parsing rules.)

See [[vendor-prefixes]] for more examples.

=== extensions background ===
This extensibility mechanism is a composition of the following (at least somewhat) successful extension syntaxes:
* [http://www.w3.org/TR/CSS21/syndata.html#vendor-keywords CSS 2.1 4.1.2.1 Vendor-specific extensions]
* IETF MIME/content-type "x-*" extensions per RFC 2045 Section 6.3. [http://en.wikipedia.org/wiki/Internet_media_type]
* IETF MIME experimental fields (e.g. x-spam-score)
* HTTP header extensions (e.g. x-pingback)
* note also [http://www.mnot.net/blog/2009/02/18/x- some critical thoughts from mnot]

In particular:

Proprietary extensions to formats have typically been shortlived experimental failures with one big recent exception.

Proprietary or experimental CSS3 property implementations have been very successful.

There has been much use of border radius properties and animations/transitions which use CSS properties with vendor-specific prefixes like:

* -moz-border-radius
* -webkit-border-radius

etc.

Note that these are merely string '''prefixes''', not bound to any URL, and thus not namespaces in any practical sense of the word. This is quite an important distinction, as avoiding the need to bind to a URL has made them easier to support and use.

This use of vendor specific CSS properties allowed the larger web design/development/implementor communities to experiment and iterate on new CSS features while the features were being developed and standardized.

The benefits have been two-fold:
* designers have been able to make more attractive sites sooner (at least in some browsers)
* features have been market / real-world tested before being fully standardized, thus resulting in better features

Implementers have used/introduced "x-" prefixes for IETF MIME/content-types for experimental content-types, MIME parameter extensions, and HTTP header extensions, per RFC 2045 Section 6.3, RFC 3798 section 3.3, and [https://secure.wikimedia.org/wikipedia/en/wiki/List_of_HTTP_header_fields#Common_non-standard_headers Wikipedia: HTTP header fields - non-standard headers] (could use RFC reference instead) respectively, like:

* application/x-latex (per [https://secure.wikimedia.org/wikipedia/en/wiki/Internet_media_type#Type_x Wikipedia Internet media type: Type x])
* x-spam-score (in email headers)
* X-Pingback (per [http://en.wikipedia.org/wiki/Pingback Wikipedia:Pingback])

Some standard types started as experimental "x-" types, thus demonstrating this experiment first, standardize later approach has worked for at least some cases:

* image/x-png (standardized as image/png, both per [http://tools.ietf.org/html/rfc2083 RFC2083])

See [[microformats2-origins#VENDOR_EXTENSIONS]] for more background.

== validators ==
microformats2 validators:

{{new}} Test your microformatted web page with:
* https://pin13.net/mf2/

Barnaby Walters has a hosted version of the open source php-mf2 [[parser]] where you can enter your markup into a textarea and see how it's parsed:
* http://waterpigs.co.uk/php-mf2/

See the [[validators]] page for a longer list of validators.

== Examples in the wild ==
Please add new examples in the wild of microformats-2 to the top of this list. When it gets too big we can move it to a separate page like [[microformats-2-examples-in-wild]].

* ...
* David John Mead marks up his profile, blog posts and comments with h-card, h-entry and h-cite on [http://davidjohnmead.com davidjohnmead.com]
* [[User:Brian|Brian Suda]] marks up his blog posts up with h-entry and h-card on [http://optional.is/required/ optional.is]
* Ashton McAllan marks up her blog posts, reposts, comments and likes with h-entry, h-card and h-cite on [https://acegiak.net/ acegiak.net]
* Emma Kuo marks up her blog posts and notes with h-entry and h-card on [http://notenoughneon.com/ notenoughneon.com]
* Scott Jenson marks up his blog posts with h-entry and h-card on [http://jenson.org/ jenson.org]
* Emily McAllen marks up her blog posts with h-entry and h-card on [http://blackwoolholiday.com/ blackwoolholiday.com]
* Ryan Barrett marks up his blog posts, notes, replies and likes with h-entry and h-card on [https://snarfed.org/ snarfed.org]
* Barry Frost marks up his notes with h-entry, h-card and h-cite on [http://barryfrost.com/ barryfrost.com]
* Amber Case marks up her profile, blog posts, replies and notes with h-entry and h-card on [http://caseorganic.com/ caseorganic.com]
* Johannes Ernst marks up his blog posts with h-entry on [http://upon2020.com/blog/ upon2020.com]
* Michiel de Jong marks up his profile and notes with h-entry and h-card on [https://michielbdejong.com/ michielbdejong.com]
* Mike Taylor marks up his profile and blog posts with h-card and h-entry on [https://bear.im/bearlog/ bear.im]
* Erin Jo Ritchey marks up her profile, posts and comments using h-card, h-entry and h-cite with idno on [http://erinjo.is/ erinjo.is]
* Jeena Paradies marks up his profile, blog posts, notes and comments using h-card, h-entry and h-cite on [https://jeena.net/ jeena.net]
* Andy Sylvester marks up his profile, blog posts and comments using h-card and h-entry on [http://andysylvester.com/2014/03/01/howto-setting-up-the-selfoss-feed-reader-with-microformats-support/ andysylvester.com] (note: as of 2014-03-13 using h-entry for comments instead of correct h-cite --[[User:Barnabywalters|bw]] 14:44, 13 March 2014 (UTC))
* Hakan Demir marks up his Coupon and Voucher blog posts with h-entry and h-card on [http://www.gutscheinflagge.de/ gutscheinflagge.de]
* Chloe Weil marks up her blog posts with h-entry on [http://chloeweil.com/blog chloeweil.com]
* Christophe Ducamp marks up his blog posts and profile with h-entry and h-card on [http://christopheducamp.com/ christopheducamp.com]
* Glenn Jones marks up his blog posts, notes, replies, profile and comments with h-entry, h-card and h-cite on [http://glennjones.net/ glennjones.net]
* Marcus Povey marks up his blog posts and profile with h-entry and h-card on [http://www.marcus-povey.co.uk/ marcus-povey.co.uk]
* Eugen Busoiu marks up his web profile with h-card on [http://eugenbusoiu.com/#utm_source=microformats2&utm_medium=h-card&utm_campaign=Microformats eugenbusoiu.com]]
* Matthias Pfefferle marks up his blog posts, comments and profile with h-card, h-cite and h-entry on [http://notizblog.org/ notizblog.org]
* Kyle Mahan marks up his profile and notes with h-card and h-entry on [http://kylewm.com/ kylewm.com]
* Emil Björklund marks up his blog posts with h-entry and h-card ([http://thatemil.com/blog/2013/09/16/webmentioning-adactio/ example])
* App.net rolled out support for h-card and h-entry on all profile pages and permalink pages as of 2013-08-06 ([https://alpha.app.net/voidfiles example])
* Brett Comnes marks up his posts with h-entry and h-card ([http://bret.io/2013/06/29/getting-started-with-bower/ example])
* Ben Werdmuller marks up his posts with h-card and h-entry, u-in-reply-to and u-like ([http://werd.io/view/51d5097fbed7ded0633a5956 example])
* Sandeep Shetty marks his posts up with h-card and h-entry, as well as draft u-in-reply-to and experimental u-like properties ([http://sandeep.io/101 example])
* Laurent Eschenauer marks up his posts with h-entry ([http://eschnou.com/entry/first-autonomous-flight-of-my-nodecopter-62-24992.html example])
* Tom Morris marks up his posts using h-entry ([http://tommorris.org/posts/8417 example])
* Sinolandquality marks up some of their content using h-feed and h-entry on [http://www.sinolandquality.com/Blog/?page_id=3516&utm_content=buffere4d40&utm_medium=social&utm_source=twitter.com&utm_campaign=buffer sinolandquality.com]
* [http://www.w3.org/conf/ W3Conf 2013] uses h-event for the main event, and h-card for all the speakers and notable attendees. The h-cards make particularly good use of implied name, url, and photo properties.
* [http://wordpress.org/extend/themes/sempress SemPress] is a WordPress theme that supports h-card, h-feed/h-entry and h-as-*
* [http://the-pastry-box-project.net/ The Pastry Box Project] use h-card and h-entry markup on their homepage and individual thoughts pages
* Tom Morris uses h-card and [[XFN]] to markup [http://tommorris.org/pages/blogroll his blogroll].
* Aaron Parecki uses h-card to markup both authorship and references to people in his notes permalinks, e.g. [http://aaronparecki.com/2012/230/reply/1 2012/230/reply/1].
* [http://tantek.com/ Tantek Çelik] uses h-card, h-event, and h-entry on his home page, as well as h-entry on all post permalinks, e.g. [http://tantek.com/2012/243/t1/name-beats-title-modern-use-dubline-core-wrong-uf2 2012-243 post], with [[rel-prev]]/[[rel-next]] (if applicable) to indicate prev/next posts, and with [[rel-author]] to his home page with canonical hCard to indicate authorship.
* [http://waterpigs.co.uk/ Barnaby Walters] uses h-card on his home page, h-card, h-entry and XFN markup on his [http://waterpigs.co.uk/notes notes page].
** 2013-01-25 Barnaby Walters: <cite>[http://waterpigs.co.uk/articles/experimental-markup Experimental Markup]</cite> - describes how he's using microformats2 vocabularies: <code>h-adr</code>, <code>h-card</code>, <code>h-entry</code>, <code>h-event</code>, <code>h-geo</code>, <code>h-review</code>, and experimental vocabularies: <code>h-feed</code> (embedded for update histories), [[activity-streams]] objects <code>h-as-article</code>, <code>h-as-collection</code>, <code>h-as-note</code>, <code>h-as-update</code>, as well as experimental properties: <code>u-alternate</code> and <code>u-as-downstream-duplicate</code> (links to POSSE copies), and <code>u-in-reply-to</code> (links to content that the posts are in reply to).
* [http://tantek.com/presentations/2012/06/microformats microformats.org at 7 years] presentation with h-event and h-card markup for people and organizations.
* [http://tantek.com/presentations/2012/06/pdf2012-indieweb.html Rise of the Indie Web hCards] (from Personal Democracy Forum 2012 #pdf12 #pdf2012) has [[microformats-2]] h-calendar and h-card markup
* WebMaker by Mozilla has [[microformats-2]] h-calendar and h-card on event search (e.g. [https://webmaker.org/en-US/events/near/?lat=45.5234515&lng=-122.6762071 search near Portland Oregon]) and event pages (e.g. [https://webmaker.org/en-US/events/192f56eb9/ IndieWebCamp 2012]).[https://twitter.com/microformats/status/212207925643587585]
* WebFWD by Mozilla has [[microformats-2]] h-card markup on [https://webfwd.org/about/experts/ experts] and [https://webfwd.org/about/team/ team] pages
* [http://indiewebcamp.com IndieWebCamp] has [[microformats-2]] h-event markup with nested h-cards for the organizers and the location.
* [https://wiki.mozilla.org/Events Mozilla Events] page has [[microformats-2]] h-event markup with attendees marked up with h-card.
* The [http://pdx.esri.com/blog/2013/10/17/introducing-mapattack/ Esri PDX Blog] has h-entry markup on all blog posts (as of 2013-10-19), and h-product markup on [http://pdx.esri.com/projects/terraformer/ project pages]

=== offline ===
* spreadly marks up share permalink pages with h-entry, as well as minimal h-cards and experimental p-like properties

== Implementations ==
Test your microformatted web page with:

=== Live Textarea Input ===
Use any of these to enter HTML+microformats2 markup and see the parsed result!

* https://microformats.io hosts several of the parser libraries listed below for interactive testing
** https://go.microformats.io
** https://node.microformats.io/
** https://php.microformats.io/
** https://python.microformats.io/
** https://ruby.microformats.io/
** or look for "Parser Libraries" on the homepage
* https://pin13.net/mf2/ (where it says "Microformats Parser")


=== Blogging tools ===
* '''Storytlr''' parses the <code>target</code> from [http://indiewebcamp.com/pingback pingbacks] for [https://github.com/storytlr/storytlr/blob/master/protected/application/public/controllers/PingbackController.php#L63 h-entry with properties and nested h-card] for information to automatically display in the [http://web.archive.org/web/20130425010536/http://eschnou.com/entry/testing-indieweb-federation-with-waterpigscouk-aaronpareckicom-and--62-24908.html comments section on a post] (archived; [http://eschnou.com/entry/testing-indieweb-federation-with-waterpigscouk-aaronpareckicom-and--62-24908.html original]).
** Note: per storytlr.org, retrieved 2022-05-22:
<blockquote>Storytlr is no longer maintained and '''might be unsafe to run on a public server'''. It is running on an old version of PHP and the Zend framework and has not been upgraded to latest versions and security patches.</blockquote>

=== Converters ===
* '''[https://github.com/snarfed/granary granary]''' is a library and REST API that converts between silo APIs, [[ActivityStreams]], [[microformats2]], and Atom (all directions). Supported silos include Facebook, Twitter, Instagram, Google+, and Flickr. Users include [http://brid.gy/ Bridgy], [http://reader.kylewm.com/ Woodwind], and [https://facebook-atom.appspot.com/ facebook-atom] and [https://twitter-atom.appspot.com/ twitter-atom], among others.

* '''[http://pipes.yahoo.com/pipes/pipe.info?_id=afc5568b4e8643bfb05436b1caaf91bc microformats to RSS]''' - a Yahoo! pipe that converts a URL containing an [[h-feed]] containing h-entries, into an [[RSS]] feed ([http://waterpigs.co.uk/notes/4SeNi5/ 2013-10-21 blog post announcing])

* '''[https://xray.p3k.io XRay]''' ([https://github.com/aaronpk/XRay source code]) - Returns a normalized representation of the microformats data at a URL

=== Parsers ===
Parsers, open source libraries, in alphabetical order by programming language:

If you are implementing a microformats2 parser, see:
* [[microformats2-parsing]]

==== Parsers in production ====
The following parsers are of very high quality, in active development, and use on live sites on the web in production.

===== Java =====
* [[any23]] Apache Any23 (Anything to Triples)] a library, a web service and a command line tool that extracts structured data in RDF format from a variety of Web documents: http://any23.apache.org

===== Javascript =====
* '''microformats-parser''' for both browser and node.js
** github open source: https://github.com/aimee-gm/microformats-parser (current)
** live: https://aimee-gm.github.io/microformats-parser/

Previously:
* '''microformat-node''' Node.js microformats2 parser
** github open source: https://github.com/microformats/microformat-node (current)
*** forked from https://github.com/glennjones/microformat-node
** test suite: https://github.com/microformats/tests

** command line: https://github.com/JerrySievert/mf2
* '''microformat-shiv''' - cross browser javascript microformats2 parser which can also be used in browser extensions.

** github open source: https://github.com/glennjones/microformat-shiv

===== PHP =====
* '''php-mf2''' - PHP microformats2 parser
** github open source: https://github.com/indieweb/php-mf2
** Packagist: https://packagist.org/packages/mf2/mf2
** live:
*** textarea entry: http://waterpigs.co.uk/php-mf2/
*** URL and textarea entry: https://pin13.net/mf2/
** [https://github.com/barnabywalters/php-mf-cleaner mf-cleaner]: functions for working with the raw mf2 data structure

===== Python =====
* '''mf2py''' Python microformats2 parser
** main entry: [[mf2py]]
** github open source: https://github.com/tommorris/mf2py
** live:
*** URL entry: [https://mf2py.herokuapp.com/ mf2py.herokuapp.com]
*** textarea entry: https://kartikprabhu.com/connection/mfparser
*** another textarea: http://www.unmung.com/?html=
*** URL and/or textarea: https://kylewm.com/services/mf2

===== Ruby =====
* '''indieweb/microformats-ruby''' Ruby microformats parser
** github open source: https://github.com/indieweb/microformats-ruby
** live text entry: https://microformats-parser-ruby.herokuapp.com

===== Haskell =====
* '''myfreeweb/microformats2-parser''' Haskell microformats2 parser
** github open source: https://github.com/myfreeweb/microformats2-parser
** live textarea entry: https://unrelenting.technology/mf2/

==== Development parsers ====
The following parsers are in-development and have key microformats2 functionality yet are incomplete, not fully tested, or have other limitations. Contributions welcome!

===== Erlang =====
* '''hazybluedot/mf2erl''' Erlang microformats2 parser
** github open source: https://github.com/hazybluedot/mf2erl

===== Elixir =====
* '''ckruse/microformats-elixir''' Elixir microformats2 parser
** github open source: https://github.com/ckruse/microformats2-elixir

===== Go =====
* '''willnorris/microformats''' Golang microformats2 parser
** github open source: https://github.com/willnorris/microformats
** live textarea entry: https://go.microformats.io/

===== Java =====
* '''Apache Any23''' a library, a web service and a command line tool that extracts structured data in RDF format from a variety of Web documents. Supports Microformats1 and 2.
** Download recent release: http://any23.apache.org/download.html
** live: http://any23-vm.apache.org/
** source: http://any23.apache.org/build-src.html
* '''mf2j''' An early-stage Java microformats2 parser
** github open source: https://github.com/kylewm/mf2j
** live: https://mf2j.herokuapp.com/?url={http://example.com}

===== Perl =====
* '''Web::Microformats2''' Perl microformats2 parser
** https://metacpan.org/pod/Web::Microformats2
** open source: https://github.com/jmacdotorg/microformats2-perl

==== Experiments ====
Experiments and other proof of concept microformat2 parsing support.
* '''Rust''' - https://gitlab.com/maxburon/microformats-parser
* ...

=== Outreach ===
* [https://github.com/mozilla/fathom/issues/42 Mozilla Fathom: examples with nested classes, e.g. microformats2]

== Presentations ==
Presentations about microformats2:
* 2013-01-24 <cite>[http://waterpigs.co.uk/presentations/microformats-2/ Microformats 2]</cite> presentation by [[User:Barnabywalters|Barnaby Walters]] at the [[events/2013-01-24-exeter-web-meetup|Exeter Web Meetup]] in Devon, UK.
* 2012-09-21 <cite>[http://tantek.com/presentations/2012/09/microformats2/ microformats2 & bits of HTML5: The Evolution Of Web Data]</cite> presentation by [[User:Tantek|Tantek Çelik]] ([http://twitter.com/t @t]) at [[events/2012-09-21-refreshlx|RefreshLX]] in Lisbon, Portugal.
* 2012-07-21 <cite>[http://tantek.com/presentations/2012/07/html5-uf2/ HTML5 and microformats2: The Evolution Of Web Data]</cite> presentation by [[User:Tantek|Tantek Çelik]] ([http://twitter.com/t @t]) at [[events/2012-07-21-cascadesf|Innovators of the Web conference]] in San Francisco, CA.
* 2012-07-14 <cite>[http://tantek.com/presentations/2012/07/html5-microformats2/ HTML5 and microformats2: The Evolution Of Web Data]</cite> presentation by [[User:Tantek|Tantek Çelik]] ([http://twitter.com/t @t]) at [[events/2012-07-14-open-web-camp-4|Open Web Camp IV]] in San Jose, CA.

== Testimonials ==
* <blockquote class="twitter-tweet">To prove the web standards community can come up with better standards than the SE’s, compare this: http://microformats.org/wiki/microformats-2 with schema . org — Joost de Valk (@yoast) [https://twitter.com/yoast/status/298907685452124160 2013-02-05 13:35]</blockquote>
* <blockquote class="twitter-tweet">... I’m hoping SE’s will pick up microformats2. It’s SO much cleaner. — Joost de Valk (@yoast) [https://twitter.com/yoast/status/298911287117758464 2013-02-05 13:49]</blockquote>
* <blockquote class="twitter-tweet">... But damn Microformats2 are sexy. — Joost de Valk (@yoast) [https://twitter.com/yoast/status/298912179292344320 2013-02-05 13:53]</blockquote>

== Origins ==
This page was originally used to brainstorm and develop microformats2 in an exploratory manner, with problem statements, questions, lessons learned from past and other formats.

Now that [[microformats2-parsing]] is a Microformats specification, the original brainstorming has been moved to a separate page for anyone who wants to understand more about how we came up with the design of microformats2, and how it evolved in the early years.
* [[microformats2-origins]]

== See Also ==
* [[microformats2]]
* [[microformats2-brainstorming]] - moving more experimental / undeveloped / and rejected thoughts ideas here to simplify/progress *this* page further.
* [[microformats2-experimental-properties]] - listing experimental (-x- prefixed) properties and their use
* [[microformats2-prefixes]]
* [[vendor-prefixes]]
* [[microformats2-faq]]
* [[microformats2-parsing]]
* 2010-05-02 [[events/2010-05-02-microformats-2-0|microformats 2.0 discussion session at FOO East]]

Main Page

2025-12-19T23:29:23Z

Tantek: move new microformats to a new section for easier discovery

{{DISPLAYTITLE:Welcome to the microformats wiki!}}

'''<dfn>microformats</dfn>''' are HTML for marking up [[h-card|people, organizations]], [[h-event|events]], [[h-adr|locations]], [[h-entry|blog posts]], [[h-product|products]], [[h-review|reviews]], [[h-resume|resumes]], [[h-recipe|recipes]] etc. Sites use microformats to publish a standard API that is consumed and used by [[search engines]], [[browsers]], and other web sites. See [[what-are-microformats]] for more.

* See '''[[microformats2]]''' for a technical overview and summary of how to use microformats on public web pages and for APIs.

If you are looking for the '''microformats.org blog''', see:
* https://microformats.org/blog ([https://microformats.org/feed RSS feed])
__TOC__
==Introduction==
{{main|introduction|Introduction}}
This wiki is the central resource of the microformats community and provides microformats authoring guides, references, specifications, drafts, publishing patterns, research, brainstorming, and issue tracking.

== Get Started==
{{main|get-started|Getting Started}}
Get started with microformats:

* Make sure your pages and web apps use proper ‘[[posh|<abbr title="Plain Old Semantic HTML">POSH</abbr>]]’ <abbr title="HyperText Mark-up Language">HTML</abbr>.
* Mark-up your contact info with [[h-card]], link to other profiles with [[rel-me]]
* Mark-up your blog with [[h-entry]]. See https://indieweb.org/ for more
* Questions? Read the [[faq|frequently asked questions]], ask on [[IRC]]
* Want to learn more in person? Check out microformats [[events]]

== How to contribute ==
Want to join in and contribute?

* [[get-started|Get started]] by adding microformats to your website, services, and products
* Join the [[irc|IRC Channel]] to learn and help answer questions.
* Write a [[testimonial]]
* Do something on the [[to-do|to do list]].
* [[Main_Page#microformats_wiki_translations|Translate this microformats wiki into other languages]] to make microformats more accessible to readers of languages around the world.
* Before proposing any new microformats, make sure your website is [[POSH]], [[get-started|uses existing microformats]], and then read the [[process]].

This wiki has a number of enhancements to assist development and contributions to microformats. Before you start editing, see the [[wiki-2|wiki introduction page]] for instructions.

== Specifications ==
'''[[microformats2]]''' is stable, has a test suite, publishers, and interoperable implementations. Use it on public web pages and developing more parsers and applications.

Current, stable microformats open standard specifications.

=== Parsing ===
If you are implementing a microformats2 parser, see:
* [[microformats2-parsing]]

=== Vocabularies ===
microformats2 vocabularies:
* [[h-adr]]
* [[h-card]]
* [[h-entry]]
* [[h-event]]
* [[h-feed]]
* [[h-geo]]
* [[h-item]]
* [[h-listing]]
* [[h-product]]
* [[h-recipe]]
* [[h-resume]]
* [[h-review]]
* [[h-review-aggregate]]

=== rel microformats ===
Some microformats require only a rel attribute and are widely supported by consuming sites and software.
* [[rel-author]] - link to the author's home page (from an article)
* [[rel-enclosure]] - link to attachments (e.g. files) to download and cache
* [[rel-license]] - licensed content
* [[rel-nofollow]] - links in untrusted 3rd party content
* [[rel-tag]] - tag posts and pages by subject
* [[XFN]] - social relationships and [[rel-me]] links among profiles for the same person

=== Classic Microformats ===
In addition use well established classic microformats for the primary subject of a page for legacy [[search engines]] support.

* [[hatom|hAtom]] - blog posts and other date-stamped content
* [[hcalendar|hCalendar]] - events
* [[hcard|hCard]] - people, organizations, contacts
* [[hlisting|hListing]] - listings for products or services
* [[hmedia|hMedia]] - media info about images, video, audio
* [[hproduct|hProduct]] - products
* [[hrecipe|hRecipe]] - cooking+baking recipes
* [[hresume|hResume]] - individual resumes and CVs
* [[hreview|hReview]] - individual reviews and ratings
* [[hreview-aggregate|hReview-aggregate]] - aggregate reviews and ratings

* [[adr|adr]] - address location information
* [[geo|geo]] - latitude & longitude location ([http://en.wikipedia.org/wiki/WGS84 WGS84] geographic coordinates)

==== Classic Drafts ====
Drafts are classic microformats which have varying degrees of support by consuming applications. They are stable and yet still open to change based on consuming application support, per the [[process]] to become specifications.

* [[hnews|hNews]] - news articles, extension of hAtom

* [[rel-home]] - link to the homepage of a site
* [[rel-payment]] - link to a payment mechanism

* [[XMDP]] - define a microformat vocabulary / profile
* [[xoxo|XOXO]] - outlines

== Design Patterns ==
{{design_patterns}} 

== New microformats ==
''If you're tempted to try your hand at writing a microformat please read '''[[process|the process]]''' page first!'' and then take a look at
* past '''[[exploratory-discussions]]'''
for details of prior research, analysis of real-world [[examples]], existing formats, and [[brainstorming]] of possible new microformats, per the microformats [[process]].

== Archived ==
Past specifications, drafts, and exploratory discussions which have either lacked (or lost) wide publishing support, implementation, or have been superceded by newer specs (see also [[process#related_issues_questions_regarding_document_stages|when does it make sense to demote a microformat spec]]). These may eventually be retired, deprecated, or reincorporated into other exploratory discussions.
* [[haudio|hAudio]]
* [[robots-exclusion|robots exclusion]]
* [[xfolk|xFolk]] - tagged links

* [[rel-directory]] - link to web directories
* [[vote-links|VoteLinks]]

== Examples ==
* [[examples-in-the-wild]]
* [[implementations]]
* [[zen-garden]]

== Resources ==
See [[resources]].

== User centric development ==
*[[user-interface]]
*[[data-portability]]
*[[social-network-portability]]
*[http://indiewebcamp.com/ indieweb]

== Shared work areas ==
* [[to-do]]
* [[templates]]
* [http://microformats.org/wiki/delete pages for deletion] 
* [[Special:Specialpages|"Special" wiki pages]]
* [[year-in-review]]

== Tools, test cases, additional research ==
The first place to look for examples, code, and test cases is in the pages for each individual microformat. There are only a few cross-cutting [[tools|tools and services]] that need to process more than one microformat. That section is intended for editors, [[parsers]], [[validators]], test cases, and other information relevant across multiple microformats.
 
== Microformats wiki translations ==
You may read and edit microformats articles in many other languages:

* languages with over 100 articles
** [[Main_Page-fr|Français (French)]] {{UpdateMarker-fr}}
* languages with over 10 articles
** [[Main_Page-ja|日本語 (Japanese)]]
** [[Main_Page-pt-br|Português (Brazilian Portuguese)]]
** [[Main_Page-ru|Русский (Russian)]]
* languages with over 2 articles
** [[Main_Page-cs|Česky (Czech)]]
** [[Main_Page-zh|汉语 (Chinese)]]
** [[Main_Page-de|Deutsch (German)]]
** [[Main_Page-es|Español (Spanish)]]
** [[Main_Page-gl|Galego (Galician)]]
** [[Main_Page-id|Indonesia (Bahasa Indonesia)]]
** [[Main_Page-pl|Polski (Polish)]]
** [[Main_Page-ro|Română (Romanian)]]
* languages just started
** [[Main_Page-ar|العربية (Arabic)]]
** [[Main_Page-fa|پارسی (Farsi)]]
** [[Main_Page-ka|ქართული (Georgian)]] {{NewMarker}} 
** [[Main_Page-it|Italiano (Italian)]]
** [[Main_Page-ko|한국어 (Korean)]]
** [[Main_Page-th|ภาษาไทย (Thai)]]
** [[Main_Page-tr|Türkçe (Turkish)]] {{NewMarker}} 
* elsewhere
**[http://en.wikipedia.org/wiki/Microformat Wikipedia's article on microformats] has been translated into a number of languages.

See also [[other-languages]], and [[how-to-start-new-translation|how-to-start-a-new-translation]].

== community ==
microformats.org is a community focused on using an empirical (rather than aspirational) [[process]] to research web data & information human publishing behaviors, openly document it on our wiki (http://microformats.org/wiki/), discuss it in [[IRC]], then brainstorm ideas & proposals based on that research for simple formats based on HTML to interoperably represent that information on the web, incrementally implement, and iterate.

Main Page

2025-12-19T23:09:39Z

Tantek: /* community */ rm irc: link dupe from main IRC page (send people there for the actual chat link)

{{DISPLAYTITLE:Welcome to the microformats wiki!}}

'''<dfn>microformats</dfn>''' are HTML for marking up [[h-card|people, organizations]], [[h-event|events]], [[h-adr|locations]], [[h-entry|blog posts]], [[h-product|products]], [[h-review|reviews]], [[h-resume|resumes]], [[h-recipe|recipes]] etc. Sites use microformats to publish a standard API that is consumed and used by [[search engines]], [[browsers]], and other web sites. See [[what-are-microformats]] for more.

* See '''[[microformats2]]''' for a technical overview and summary of how to use microformats on public web pages and for APIs.

If you are looking for the '''microformats.org blog''', see:
* https://microformats.org/blog ([https://microformats.org/feed RSS feed])
__TOC__
==Introduction==
{{main|introduction|Introduction}}
This wiki is the central resource of the microformats community and provides microformats authoring guides, references, specifications, drafts, publishing patterns, research, brainstorming, and issue tracking.

== Get Started==
{{main|get-started|Getting Started}}
Get started with microformats:

* Make sure your pages and web apps use proper ‘[[posh|<abbr title="Plain Old Semantic HTML">POSH</abbr>]]’ <abbr title="HyperText Mark-up Language">HTML</abbr>.
* Mark-up your contact info with [[h-card]], link to other profiles with [[rel-me]]
* Mark-up your blog with [[h-entry]]. See https://indieweb.org/ for more
* Questions? Read the [[faq|frequently asked questions]], ask on [[IRC]]
* Want to learn more in person? Check out microformats [[events]]

== How to contribute ==
Want to join in and contribute?

* [[get-started|Get started]] by adding microformats to your website, services, and products
* Join the [[irc|IRC Channel]] to learn and help answer questions.
* Write a [[testimonial]]
* Do something on the [[to-do|to do list]].
* [[Main_Page#microformats_wiki_translations|Translate this microformats wiki into other languages]] to make microformats more accessible to readers of languages around the world.
* Before proposing any new microformats, make sure your website is [[POSH]], [[get-started|uses existing microformats]], and then read the [[process]].

This wiki has a number of enhancements to assist development and contributions to microformats. Before you start editing, see the [[wiki-2|wiki introduction page]] for instructions.

== Specifications ==
'''[[microformats2]]''' is stable, has a test suite, publishers, and interoperable implementations. Use it on public web pages and developing more parsers and applications.

Current, stable microformats open standard specifications.

=== Parsing ===
If you are implementing a microformats2 parser, see:
* [[microformats2-parsing]]

=== Vocabularies ===
microformats2 vocabularies:
* [[h-adr]]
* [[h-card]]
* [[h-entry]]
* [[h-event]]
* [[h-feed]]
* [[h-geo]]
* [[h-item]]
* [[h-listing]]
* [[h-product]]
* [[h-recipe]]
* [[h-resume]]
* [[h-review]]
* [[h-review-aggregate]]

=== rel microformats ===
Some microformats require only a rel attribute and are widely supported by consuming sites and software.
* [[rel-author]] - link to the author's home page (from an article)
* [[rel-enclosure]] - link to attachments (e.g. files) to download and cache
* [[rel-license]] - licensed content
* [[rel-nofollow]] - links in untrusted 3rd party content
* [[rel-tag]] - tag posts and pages by subject
* [[XFN]] - social relationships and [[rel-me]] links among profiles for the same person

=== Classic Microformats ===
In addition use well established classic microformats for the primary subject of a page for legacy [[search engines]] support.

* [[hatom|hAtom]] - blog posts and other date-stamped content
* [[hcalendar|hCalendar]] - events
* [[hcard|hCard]] - people, organizations, contacts
* [[hlisting|hListing]] - listings for products or services
* [[hmedia|hMedia]] - media info about images, video, audio
* [[hproduct|hProduct]] - products
* [[hrecipe|hRecipe]] - cooking+baking recipes
* [[hresume|hResume]] - individual resumes and CVs
* [[hreview|hReview]] - individual reviews and ratings
* [[hreview-aggregate|hReview-aggregate]] - aggregate reviews and ratings

* [[adr|adr]] - address location information
* [[geo|geo]] - latitude & longitude location ([http://en.wikipedia.org/wiki/WGS84 WGS84] geographic coordinates)

==== Classic Drafts ====
Drafts are classic microformats which have varying degrees of support by consuming applications. They are stable and yet still open to change based on consuming application support, per the [[process]] to become specifications.

* [[hnews|hNews]] - news articles, extension of hAtom

* [[rel-home]] - link to the homepage of a site
* [[rel-payment]] - link to a payment mechanism

* [[XMDP]] - define a microformat vocabulary / profile
* [[xoxo|XOXO]] - outlines

''If you're tempted to try your hand at writing a microformat please read '''[[process|the process]]''' page first!'' and then take a look at [[exploratory-discussions]] for details of prior research, analysis of real-world [[examples]], existing formats, and brainstorming of possible new microformats, per the microformats [[process]].

== Design Patterns ==
{{design_patterns}} 

== Archived ==
Past specifications, drafts, and exploratory discussions which have either lacked (or lost) wide publishing support, implementation, or have been superceded by newer specs (see also [[process#related_issues_questions_regarding_document_stages|when does it make sense to demote a microformat spec]]). These may eventually be retired, deprecated, or reincorporated into other exploratory discussions.
* [[haudio|hAudio]]
* [[robots-exclusion|robots exclusion]]
* [[xfolk|xFolk]] - tagged links

* [[rel-directory]] - link to web directories
* [[vote-links|VoteLinks]]

== Examples ==
* [[examples-in-the-wild]]
* [[implementations]]
* [[zen-garden]]

== Resources ==
See [[resources]].

== User centric development ==
*[[user-interface]]
*[[data-portability]]
*[[social-network-portability]]
*[http://indiewebcamp.com/ indieweb]

== Shared work areas ==
* [[to-do]]
* [[templates]]
* [http://microformats.org/wiki/delete pages for deletion] 
* [[Special:Specialpages|"Special" wiki pages]]
* [[year-in-review]]

== Tools, test cases, additional research ==
The first place to look for examples, code, and test cases is in the pages for each individual microformat. There are only a few cross-cutting [[tools|tools and services]] that need to process more than one microformat. That section is intended for editors, [[parsers]], [[validators]], test cases, and other information relevant across multiple microformats.

 
== Microformats wiki translations ==
You may read and edit microformats articles in many other languages:

* languages with over 100 articles
** [[Main_Page-fr|Français (French)]] {{UpdateMarker-fr}}
* languages with over 10 articles
** [[Main_Page-ja|日本語 (Japanese)]]
** [[Main_Page-pt-br|Português (Brazilian Portuguese)]]
** [[Main_Page-ru|Русский (Russian)]]
* languages with over 2 articles
** [[Main_Page-cs|Česky (Czech)]]
** [[Main_Page-zh|汉语 (Chinese)]]
** [[Main_Page-de|Deutsch (German)]]
** [[Main_Page-es|Español (Spanish)]]
** [[Main_Page-gl|Galego (Galician)]]
** [[Main_Page-id|Indonesia (Bahasa Indonesia)]]
** [[Main_Page-pl|Polski (Polish)]]
** [[Main_Page-ro|Română (Romanian)]]
* languages just started
** [[Main_Page-ar|العربية (Arabic)]]
** [[Main_Page-fa|پارسی (Farsi)]]
** [[Main_Page-ka|ქართული (Georgian)]] {{NewMarker}} 
** [[Main_Page-it|Italiano (Italian)]]
** [[Main_Page-ko|한국어 (Korean)]]
** [[Main_Page-th|ภาษาไทย (Thai)]]
** [[Main_Page-tr|Türkçe (Turkish)]] {{NewMarker}} 
* elsewhere
**[http://en.wikipedia.org/wiki/Microformat Wikipedia's article on microformats] has been translated into a number of languages.

See also [[other-languages]], and [[how-to-start-new-translation|how-to-start-a-new-translation]].

== community ==
microformats.org is a community focused on using an empirical (rather than aspirational) [[process]] to research web data & information human publishing behaviors, openly document it on our wiki (http://microformats.org/wiki/), discuss it in [[IRC]], then brainstorm ideas & proposals based on that research for simple formats based on HTML to interoperably represent that information on the web, incrementally implement, and iterate.

events/2012-04-24-meetup

2025-11-29T19:36:27Z

Tantek: .

{{DISPLAYTITLE:Microformats Meetup, San Francisco}}
__TOC__
One of several microformats [[meetup]] [[events]].

<div class="event-page h-event vevent">
== Details ==
;When
:<time class="value">2012-04-24</time> from <time class="value">19:00</time> to <time class="value">20:30</time>
;Where
:Pancho Villa, 16th st., San Francisco, <abbr class="region" title="California">CA</abbr>
;What
:Microformats Meetup, San Francisco
;Web
:http://plancast.com/p/avpn
:https://www.facebook.com/events/352625364773228/



'''[http://h2vx.com/ics/microformats.org/wiki/events/2012-04-24-meetup Add this event to your calendar]''' http://www.boogdesign.com/images/buttons/microformat_hcalendar.png

== Weekly Meetup ==
<div class="p-description description">The microformats community has grown and stablized over the past few years, news of adoptions, new ideas and challenges come up frequently enough that there are no shortage of new topics to discuss on a weekly basis.

Come along, meet up with the microformats community in San Francisco

In another city? Check out [[weekly-meetup#Other_Cities|Weekly Meetup: Other Cities]] and help organize one in your own city!</div>

== Tags ==
Use the following tags on related content (blog posts, photos, [http://twitter.com tweets]):
tags:
<kbd class="tags" style="display:block">
'''microformats-dinner'''
microformats-meetup
microformats
san-francisco
mission
pancho-villa
''microformats-meetup-2012-04-24''

</kbd>

If you use Twitter, mention ''@microformats''' in tweets about the event, and track them on [http://search.twitter.com/search?q=microformats+dinner Twitter Search].

== Attendees ==
Add yourself alphabetically sorted by family name if you plan on attending or attended this event.

* [[User:Tantek|Tantek Çelik]]
* [[User:Kevin Marks|Kevin Marks]]
* Will Norris
* Erin O'Connor
* Tess O'Connor
* [https://twitter.com/lizasperling Liza Sperling]
* ...

== Notes ==
Topics:
* [[hCard]] spec content design
* [[microformats-2]]
* [[govUKopenstandards]] Drafting a response to this
* [[relmeauth]] / [[web-sign-in]] / http://indieauth.com / http://browserid.org
* ...

== Photographs ==


[http://statigr.am/viewer.php#/detail/177037314873317250_32880212 http://distilleryimage6.instagram.com/bcd122708e8611e1b9f1123138140926_7.jpg] ([http://web.stagram.com/p/177037314873317250_32880212], photo by [https://twitter.com/lizasperling Liza Sperling])

[https://plus.sandbox.google.com/u/0/107379489464447013340/posts/cU9KYGECo6m https://lh5.googleusercontent.com/-5YEaGz-_umA/T5dwwxmGiYI/AAAAAAAAiQI/1iRLz10IdaU/s500/12+-+1.jpg] ([https://plus.sandbox.google.com/u/0/107379489464447013340/posts/cU9KYGECo6m], photo by [https://plus.sandbox.google.com/u/0/107379489464447013340 Liza Sperling])

''Add another photograph from this event here''.

* Search for photographs from this event on Flickr: [http://flickr.com/photos/tags/microformats-meetup-2012-04-24 Photographs tagged microformats-meetup-2012-04-24] or for [http://flickr.com/photos/tags/microformats-meetup all photographs from microformats meetups].

== Articles and Blog Posts ==
Articles and blog posts following up on the meetup. Add a link to your post in the list below:

* …


Also, find posts on this meetup on [http://blogsearch.google.co.uk/blogsearch?q=microformats-meetup-2012-04-24 Google Blog Search] or [http://technorati.com/search/microformats-meetup-2012-04-24 Technorati].

</div> 

== Related Pages==
{{events-related-pages}}

events/2011-02-22-microformats-dinner

2025-11-29T19:36:07Z

Tantek: /* Meetup */ .

{{DISPLAYTITLE:Microformats Dinner & Drinks}}
__TOC__
One of several microformats [[meetup]] [[events]].

<div class="event-page vevent">
== Details ==
;When
:2011-02-22 from 19:00 to 21:00
;Where
:dinner at Naan N Chutney, 525 Haight Street, San Francisco, CA 94117 USA, followed by pints at Toronado, 547 Haight Street, San Francisco, CA 94117 USA
;What
:Microformats Weekly Meetup Dinner, San Francisco
;Web
:https://www.facebook.com/event.php?eid=132373920166828
:http://plancast.com/p/40nv
:http://upcoming.org/event/7852575

'''[http://h2vx.com/ics/microformats.org/wiki/events/2011-02-22-weekly-dinner-sf Add this event to your calendar]''' http://www.boogdesign.com/images/buttons/microformat_hcalendar.png

== Meetup ==
<div class="description">
Microformats community member and web developer extraordinaire Theresa "Tess" O'Connor (AKA hober) has moved to San Francisco - let's give her a warm welcome!

* Dinner: 7-8pm @ Naan & Chutney, 525 Haight st.
* Drinks: 8pm-on @ Toronado, 547 Haight st.

Come meet up with fellow web designers, developers, microformats enthusiasts for a bite or a pint - we've got a lot to celebrate and talk about:
* Facebook's adoption of hCalendar+hCard for events
* microformats for input
* the path from draft to specification to standard

Curries for dinner at Naan & Chutney, followed by a selection of excellent brews at Toronado just a few doors down.

The microformats community has grown and stabilized over the past few years, news of adoptions, new ideas and challenges come up frequently enough that there are no shortage of new topics to discuss on a regular basis.

Come along, meet up with the microformats community in San Francisco.

In another city? Check out [[weekly-meetup#Other_Cities|Weekly Meetup: Other Cities]] and help organize one in your own city!</div>

== Tags ==
Use the following tags on related content (blog posts, photos, [http://twitter.com tweets]):

tags:
<kbd class="tags" style="display:block">
'''microformats-dinner'''
microformats-meetup
microformats
san-francisco
lower-haight
haight-street
naan-n-chutney
toronado
''microformats-dinner-2011-02-22''
''upcoming:event=7852575''
</kbd>

If you use Twitter, mention ''@microformats dinner''' in tweets about the event, and track them on [http://search.twitter.com/search?q=microformats+dinner Twitter Search].

== Attendees ==
Add yourself alphabetically sorted by family name if you plan on attending or attended this event.

* [[User:Tantek|Tantek Çelik]]
* Theresa O'Connor
* ...

== Photographs ==
* Search for photographs from this event on Flickr: [http://flickr.com/photos/tags/microformats-dinner-2011-02-22 Photographs tagged microformats-dinner-2011-02-22] or for [http://flickr.com/photos/tags/microformats-dinner all photographs from microformats dinners].

''Add a photograph from this event here''.

== Notes ==

== Articles and Blog Posts ==
Articles and blog posts following up on the meetup. Add a link to your post in the list below:

* ...

Also, find posts on this meetup on [http://blogsearch.google.com/blogsearch?q=microformats-dinner-2011-02-22 Google Blog Search] or [http://technorati.com/search/microformats-dinner-2011-02-22 Technorati].

</div> 

== Related Pages==
{{events-related-pages}}

turns-nine-upgrade-to-microformats2

2025-11-29T19:35:29Z

Tantek: /* Goal */ .

published on tantek.com and the [[blog]]:
* http://tantek.com/2014/171/b1/microformats-org-turns-nine
* http://microformats.org/2014/06/20/microformats-org-turns-9-upgrade-to-microformats2

= microformats.org turns 9 - upgrade to microformats2 and more =

Nine years ago we launched microformats.org with a basic premise: that it is possible to express meaning on the web in HTML in a simple way—far simpler than the complex alternatives (XML) being promoted by mature companies and standards organizations alike.

None of the other alternatives promoted in the 2000s (even by big companies like Google and Yahoo) survive to this day in any meaningful way:
* [[Google Base]]
* [[Google Data]]
* Yahoo's [[CommonTag]].org
* too many XML approaches to count

From this experience, we conclude that what large companies support (or claim to prefer) is often a trailing indicator (at best).

Large companies tend to promote more complex solutions, perhaps because they can afford the staff, time, and other resources to develop and support complex solutions. Such approaches fundamentally lack empathy for independent developers and designers, who don't have time to keep up with all the complexity.

If there's one value that's at the heart of microformats' focus and continued evolution of [[simplicity]], it is that empathy for independent developers and designers, for small consulting shops, for curious hobbyists who are most enabled and empowered by the simplest possible solutions to problems.

We now know that no amount of large company marketing and evangelism can make up for a focus on ever simpler solutions which take less time to learn, use, and reliably maintain. As long as we focus on that, we will create better solutions.

== Community Changes ==
Speaking of taking less time, we've learned some community lessons about that too. Perhaps the most important is that as a community we are far more efficiently productive using just [[IRC]] and the wiki, than any amount of use of email. In fact, the microformats drafts that were developed wtih the most email (e.g. hAudio) turned out to be the hardest to follow and discuss (too many long emails), and sadly ended up lacking the simplicity that real world publishers wanted (e.g. last.fm).

Email tends to bias design and discussions towards those who have more time to read and write long emails, and (apparently) enjoy that for its own sake, than those who want to quickly research & brainstorm, and get to actually creating, building, and deploying things with microformats.

Thus we're making these changes effective today:
* [[IRC]] for all microformats discussions, whether research, questions, or brainstorming
* [[email]] only for occasional announcements and to direct people to IRC.
* [[wiki]] for capturing questions, brainstorming, conclusions, and different points of view

We're going to update the site to direct all discussion (e.g links) to the IRC channel accordingly.

Hope to see you there: [ircs://irc.libera.chat:6697/microformats #microformats on libera.chat]

== Upgrading to microformats2 ==
Over the past few years [[microformats2]] has proven itself in practice, with numerous sites both publishing and consuming, several open source parsing libraries, and a growing test suite. All the lessons learned from the evolution from original microformats, from RDFa, and from microdata have been incorporated into microformats2 which is now the simplest to both publish and parse.

It's time to throw the switch and upgrade everything to [[microformats2]]. This means three things:

=== Upgrading microformats.org ===
First, we're starting by upgrading the links on the microformats.org home page to point to the microformats2 drafts, which are ready for use.

We'll be incrementally upgrading the markup of the microformats.org site itself to use microformats2 markup.

=== Upgrade sites ===
Second, if you publish any kind of semantic information, start upgrading your web pages to microformats2 across the board.

If you're concerned about what search engines claim to support, there are two approaches to choose from:
# Know that search engines are a trailing indicator, and as microformats2 usage grows, they'll index it as well.
# Or: Use one classic microformat (supported by all major [[search engines]]) at top of your page, e.g. on the <code><body></code>, in addition to your microformats2 markup throughout your pages. Search engines only really care to summarize the primary topic or purpose of a web page in their "rich snippets" or "cards", and thus that's sufficient.

Check out the latest [[validators]] which now include some microformats2 support as well!

=== Upgrade tools ===
Third, this is a call to upgrade all microformats supporting tools to microformats2. As nearly all of these are open source, this is an open call for contributions, updates, patches, etc. for:
* [[Operator]]
* [[H2VX]]
* [[validators]]
* [[hCard creator]]
* [[hCalendar creator]]
* [[hReview creator]]
* ...

If it generates microformats, upgrade it to instead generate microformats2.

If it consumes microformats, upgrade it to also consume microformats2 (which may be most easily done by making use of one of the microformats2 parsers that has backward compatible parsing built in).

== Goal ==
As we enter the tenth year of microformats.org let's make it our collective goal to upgrade our pages, our sites, and our tools to microformats2.

Our goal is to complete all the above upgrades by microformats.org's tenth birthday, if not sooner. Let's get to work.

Thanks to Barnaby Walters and fellow microformats [[admins]] Kevin Marks & Tess O'Connor for reviewing drafts of this post. Thanks to Kevin especially for some copy edits!

twitter-syntax

2025-11-02T11:12:20Z

Tantek: restore hreview section to a past section and update with past tesnse

{{DISPLAYTITLE:Twitter Syntax}}

There used to be an [https://web.archive.org/web/20090101120857/http://help.twitter.com/index.php?pg=kb.page&id=75 Official Twitter Commands] page and a [https://web.archive.org/web/20081111234228/http://twitter.com/help/lingo Twitter Lingo page]. This information is now mostly of historic interest.

These commands could be sent to the appropriate number (below) to interact with Twitter on a mobile phone.

;Following [http://twitter.com/blog/2007/07/friends-followers-and-notifications.html changes at Twitter] this page may need to be updated.

==Numbers==

<div class="vcard">Twitter Canada: cell 21212</div>
<div class="vcard">Twitter USA: cell 40404</div>
<div class="vcard">Twitter International[https://help.x.com/en/using-x/sms-fees]: cell +44 7624 800 379</div>

=== Obsolete Numbers ===
<div class="vcard">Twitter UK: cell +44 7624 801423</div> [https://blog.x.com/official/en_us/a/2008/changes-for-some-sms-users-good-and-bad-news.html The ability to receive SMS updates in the UK was removed in 2008].

== Commands ==

=== Messages ===
* '''@username + message''': directs a twitter at another person, and causes your twitter to save in their "replies" tab. Aka "at replies" or "@replies". Note that since @-reply handling change in (May?) 2009 (citation to Twitter blog post needed), messages starting with <kbd>@username</kbd> passed along only to your followers who also follow @username.
** '''.@username + message''': similar but the "." prefix is used to force/trick Twitter to have the message show up in the person's "replies" tab as well as be sent to all of your followers. Work around for the @-reply change mentioned above.
* '''d username + message''': sends a person a private message that goes to their device, and saves in their web archive.
** '''dm username + message''' also works. Side effect, you can't start a tweet with "d " or "dm "[https://twitter.com/holly/status/615648195767500800]

=== Friends and Followers ===

* '''invite phone number''': 415-555-1212 john sends a text invite to john
* '''accept''': this command will accept a friend invitation. Example: Accept Jade. NOTE: when you accept, you must type in the name exactly as it was sent to you in order for Twitter to recognize it properly.
* '''deny''': this command will deny a friend invitation.
* '''delete''': for now, deleting friends must be done from the web.
* '''fav username''': marks a person's last twitter as a favorite

* '''get ''username''''': gets this person's last update
* '''on''' or '''start''' or '''wake''': enables twitter phone updates
** '''on username''': turns on notifications for a specific person on your device. For example, ON alissa.
* '''off''' or '''stop''' or '''sleep''': disables twitter phone updates
** '''off username''':turns off notifications for a specific person on your device. For example, OFF blaine.
* '''follow all''': turns on phone updates (entire friends list)
** '''follow username''': you will get phone updates from this person (requires initial approval)
*** shortcut: '''F'''
* '''leave all''': turns off phone updates (entire friends list)
** '''leave username''': disables phone updates from this person
*** shortcut: '''L'''
* '''nudge username''': encourages this person to update
* '''whois username''': text WHOIS BIZ to 40404 you will get the info Biz has filled out in his settings

=== Finding Out Stuff ===

* '''followers''': find out who is following your updates ''(no longer supported)''
* '''stats''': find out how many people are following you, and how many friends you have
* '''help''': sends back a list of twitter lingo commands

To update your own Twitter timeline, just text whatever is on your mind to the Twitter number: 40404, or use +447781488126 if you are outside the US.

=== Tracking ===

* '''track word''': get notifications via SMS or IM when a word is mentioned. type again to turn off.
* '''untrack word''': stops tracking a word
* '''untrack all''': stops tracking all words
* '''track off''': stops tracking all words
* '''tracks''': returns a list of words you're tracking

==hash tags==
[http://hashtags.org/ Hashtags] (aka "#tags") allow tagging of Twitter posts. For example, post "I love #microformats a lot" to Twitter and the post is tagged "microformats".

==group accounts==

Groups of multiple people may share a single Twitter account to represent their organization.

* Attribution: Ending a message with <code>^XX</code>, indicates the author of a message on a group account. The <code>XX</code> initials correspond to one of the staff representing the group. (This convention popularized by [http://cotweet.com CoTweet], adopted by [[microformateers]]. e.g. [https://twitter.com/Microformateers/status/5294239824], [https://twitter.com/cotweet/])

== past ==
=== hreview ===
* starting a message with "@hreview" used to be aggregated by <nowiki>http://microrevie.ws</nowiki> (dead site) and republished with [[hReview]] markup there.

==See also==
*[[picoformats]]
*[[twitter-nanoformats|twitter nanoformats]]
*[http://pigsonthewing.wordpress.com/2008/01/05/suggested-method-of-publishing-microformats-in-twitter-posts/ A suggested method of publishing microformats in Twitter posts]

existing-rel-values

2025-10-12T21:32:40Z

Tantek: fix atproto rel link

{{DISPLAYTITLE: existing rel values }}

This page contains tables of known HTML rel values from specifications, formats, proposals, brainstorms, and non-trivial [[POSH]] usage in the wild. In addition, dropped and rejected values are listed at the end for comprehensiveness.

usage: see [[rel-faq#How_is_rel_used|how is 'rel' used]]. Regarding rev, see: [[rel-faq#Should_rev_even_be_used|should 'rev' even be used]].

This page is also the official rel registry ([https://html.spec.whatwg.org/multipage/links.html#other-link-types WHATWG HTML] ([http://www.whatwg.org/specs/web-apps/current-work/multipage/links.html#other-link-types original link]), [http://www.w3.org/TR/html5/links.html#other-link-types W3C HTML5]). Add new and proposed rel values to the following section:
* [[existing-rel-values#HTML5_link_type_extensions|HTML5 link type extension]]

== formats ==
These rel values are defined formats from specifications (HTML 4, microformats) are thus are recommended for general use. Alphabetically ordered by value.

Note:
* Do not add proposed rel values for HTML5 here, add them to the [[#HTML5_link_type_extensions|HTML5 link type extensions]] table.
* Do not add rel values you find in the wild to this table of rel formats, instead add them to the table in the [[existing-rel-values#POSH_usage|POSH section]].
* Do not add non-HTML rel values you find to this table of rel formats, instead add them to the table in the [[existing-rel-values#non_HTML_rel_values|non HTML rel values section]].
* Do not add rel values from obsolete/superceded proposals or drafts, instead add them to the table in the "dropped" section.

Sources:
* W3C Recommendations:
** [http://www.w3.org/TR/html401/types.html#h-6.12 HTML 4.01 section 6.12 Link types] (HTML4 Link types)
** [http://www.w3.org/TR/grddl/ Gleaning Resource Descriptions from Dialects of Languages] (GRDDL)
* [[microformats]] specifications
** [[xfn]]
** [[rel-license]]
** [[rel-nofollow]]

{| border="1"
|+
! Keyword
! Effect on <code>link</code>
! Effect on <code>a</code>, <code>area</code>
! Brief description (from the relevant specification where possible)
! Link to defining specification

|-
| [[rel-acquaintance|acquaintance]]
| not allowed
| external relation
| the person represented by the current document considers the person represented by the referenced document to be an acquaintance
| [[XFN]]

|-
| [[rel-alternate|alternate]]
| external resource
| external relation
| Designates substitute versions for the document in which the link occurs. When used together with the <code>lang</code> attribute, it implies a translated version of the document. When used together with the <code>media</code> attribute, it implies a version designed for a different medium (or media).
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-appendix|appendix]]
| allowed
| allowed
| Refers to a document serving as an appendix in a collection of documents.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-bookmark|bookmark]]
| not allowed
| allowed
| Refers to a bookmark. A bookmark is a link to a key entry point within an extended document. The <code>title</code> attribute may be used, for example, to label the bookmark. Note that several bookmarks may be defined in each document.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-chapter|chapter]]
| allowed
| allowed
| Refers to a document serving as a chapter in a collection of documents.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-child|child]]
| external relation
| external relation
| The referenced person is a child of the person represented by the current document. It may also indicate that the target document is a hierarchical child, or subdocument, of the current document.
| [[XFN]], [https://www.w3.org/TR/relations.html HTML 4.0 Specification]

|-
| [[rel-colleague|colleague]]
| not allowed
| external relation
| the referenced person is a colleague of the person represented by the current document
| [[XFN]]

|-
| [[rel-contact|contact]]
| not allowed
| external relation
| the person represented by the current document considers the person represented by the referenced document to be a contact
| [[XFN]]

|-
| [[rel-contents|contents]]
| allowed
| allowed
| Refers to a document serving as a table of contents. Some user agents also support the synonym ToC (from "Table of Contents").
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-copyright|copyright]]
| allowed
| allowed
| Refers to a copyright statement for the current document.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-co-resident|co-resident]]
| not allowed
| external relation
| the referenced person lives in the same residence as the person represented by the current document
| [[XFN]]

|-
| [[rel-co-worker|co-worker]]
| not allowed
| external relation
| the referenced person is a co-worker of the person represented by the current document
| [[XFN]]

|-
| [[rel-crush|crush]]
| not allowed
| external relation
| this person considers the referenced person to be a crush (i.e. has a crush on the referenced person)
| [[XFN]]

|-
| [[rel-date|date]]
| not allowed
| external relation
| this person considers the referenced person to be a date (i.e. is dating the referenced person)
| [[XFN]]

|-
| [[rel-friend|friend]]
| not allowed
| external relation
| the person represented by the current document considers the person represented by the referenced document to be a friend
| [[XFN]]

|-
| [[rel-glossary|glossary]]
| allowed
| allowed
| Refers to a document providing a list of terms and their definitions that pertain to the current document.||[http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-help|help]]
| allowed
| allowed
| Refers to a document offering help (more information, links to other sources information, etc.)
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-its-rules|its-rules]]
| allowed
| not allowed
| Refers to a document with external ITS rules.
| [http://www.w3.org/TR/its20/#selection-global-html5 Internationalization Tag Set (ITS) Version 2.0]

|-
| [[rel-kin|kin]]
| not allowed
| external relation
| the referenced person is part of the extended family of the person represented by the current document
| [[XFN]]

|-
| [[rel-license|license]]
| allowed
| allowed
| …indicates that the <nowiki>[referenced document]</nowiki> is a license for the current page.
| [[rel-license]]

|-
| [[rel-me|me]]
| external relation
| external relation
| the referenced document represents the same person as does the current document
| [[XFN]]

|-
| [[rel-met|met]]
| not allowed
| external relation
| this person has met the referenced person
| [[XFN]]

|-
| [[rel-muse|muse]]
| not allowed
| external relation
| the referenced person inspires the person represented by the current document
| [[XFN]]

|-
| [[rel-neighbor|neighbor]]
| not allowed
| external relation
| the referenced person lives nearby the person represented by the current document
| [[XFN]]

|-
| [[rel-next|next]]
| external relation
| external relation
| Refers to the next document in a linear sequence of documents. User agents may choose to preload the "next" document, to reduce the perceived load time.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-nofollow|nofollow]]
| not allowed
| external relation
| indicates that the destination of that hyperlink {{should-not}} be afforded any additional weight or ranking by user agents which perform link analysis upon web pages (e.g. search engines).
| [[rel-nofollow]]

|-
| [[rel-parent|parent]]
| external relation
| external relation
| The referenced person is a parent of the person represented by the current document. It may also indicate that the target document is the hierarchical parent, or container, of the current document.
| [[XFN]], [https://www.w3.org/TR/relations.html HTML 4.0 Specification]

|-
| [[rel-prev|prev]]
| external relation
| external relation
| Refers to the previous document in an ordered series of documents. Some user agents also support the synonym "Previous".
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-previous|previous]]
| external relation
| external relation
| Synonym of <code>prev</code>
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-section|section]]
| allowed
| allowed
| Refers to a document serving as a section in a collection of documents.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-sibling|sibling]]
| not allowed
| external relation
| the referenced person is a sibling of the person represented by the current document
| [[XFN]]

|-
| [[rel-spouse|spouse]]
| not allowed
| external relation
| the referenced person is a spouse of the person represented by the current document
| [[XFN]]

|-
| [[rel-start|start]]
| allowed
| allowed
| Refers to the first document in a collection of documents. This link type tells search engines which document is considered by the author to be the starting point of the collection.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-stylesheet|stylesheet]]
| external resource
| not allowed
| a style sheet for the current document used with the invisible <link href> element which is not ideal for content relationships. Content relationships should be user visible and thus uses with <a href> are strongly preferred. Unfortunately the use of stylesheet in user visible content like <a href> appears to be strictly theoretical.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-subsection|subsection]]
| allowed
| allowed
| Refers to a document serving as a subsection in a collection of documents.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-sweetheart|sweetheart]]
| not allowed
| external relation
| this person considers the referenced person to be their sweetheart
| [[XFN]]

|-
| [[rel-tag|tag]]
| not allowed
| allowed
| …indicates that the <nowiki>[referenced document]</nowiki> is an author-designated "tag" (or keyword/subject) for the current page.
| [[rel-tag]]

|-
| [[rel-toc|toc]]
| allowed
| allowed
| Synonym of <code>contents</code> (from "Table Of Contents")
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-transformation|transformation]]
| allowed
| allowed
| Relates a source document to a transformation, usually represented in XSLT, that relates the source document syntax to the RDF graph syntax. Used in [[grddl|GRDDL]]
| [http://www.w3.org/TR/grddl/#transformation GRDDL]

|}

=== notes ===
*<code>rel="alternate"</code> can take further meaning from additional attributes, such as
** <code>rel="alternate" lang="fr"</code> (French language version of this page)
** <code>rel="alternate" media="print"</code> (printable version of this page)
** <code>rel="alternate" media="handheld"</code> (version of the page intended or better for handheld/portable devices like PDAs, cell phones, etc.)

*Synonyms such as "previous", "toc" are not as widely supported as the main term.

== proposals ==
A few rel values have been developed as drafts as a result of going through most of the microformats [[process]], and are thus listed here for your serious consideration. You may use these values, and if you find any problems with them please point them out on the respective "issues" page for the rel value.

{| border="1"
|+
! rel value !! summary !! proposed in !! external spec (if any)
|-
| [[rel-pronunciation|pronunciation]] || …indicates that the destination of the 'link' element is a document providing a pronunciation lexicon for speech-synthesis purposes. || [[rel-pronunciation]]
|-
| [[rel-directory|directory]] || …indicates that the destination of the hyperlink is a directory listing containing an entry for the current page. || [[rel-directory]]
|-
| [[rel-enclosure|enclosure]] || …indicates that the destination of that hyperlink is intended to be downloaded and cached. || [[rel-enclosure]] || [http://www.apps.ietf.org/rfc/rfc4287.html RFC4287]
|-
| [[rel-home|home]] || …indicates that the <nowiki>[referenced document]</nowiki> is the homepage of the site in which the current page appears. || [[rel-home]]
|-
| [[rel-payment|payment]] || …indicates that the destination of the hyperlink provides a way to show or give support (e.g. financial) for the current page|| [[rel-payment]]
|-
| vcs-* || …indicates that the destination of the hyperlink is the location of a Version Control System repository related to that page.|| || [https://joeyh.name/rfc/rel-vcs/ rel=vcs-*]
|}

== HTML5 link type extensions ==

The following values are registered as link type extensions per the [http://www.whatwg.org/specs/web-apps/current-work/multipage/links.html#other-link-types requirements in the WHATWG HTML spec] and the [http://www.w3.org/TR/html5/links.html#other-link-types requirements in the W3C HTML5 spec].

Before you register a new value:
* '''Please check the [[#formats|Formats table]] and DO NOT re-register''' rel values that are already there. Please note that the W3C HTML WG has made a [http://lists.w3.org/Archives/Public/public-html/2011Feb/att-0481/issue-118-decision.html Decision] to drop <code>index</code>, <code>up</code>, <code>first</code> and <code>last</code> from the HTML5 spec itself.
* '''Please check the [[#dropped|Dropped table]] and DO NOT register''' values that are already there. If you believe a rel value was dropped from another specification without prejudice, please provide link/cite to explicit text/decision stating as such, e.g. the value was merely postponed, or perhaps expected to be spun-out into its own spec from the group developing that specification.

Note that entries in the [[#formats|Formats table]] and entries that are already in HTML5 as built-in keywords are also considered extensions with the "Ratified" status.

Please make sure that registrations added here have all the required data filled in ''including'':
* "Effect on link"
* "Effect on a and area" and
* a link to a spec that documents the keyword ''as an HTML <code>rel</code> keyword''. (A spec that merely defines the file format of the link target but does not define the <code>rel</code> keyword for use in HTML is not the kind of spec that is being required here.)

Entries lacking any of the above required data will likely be removed.

Changes to this registry will not be reflected in validators in real time. But validators will typically get automatically updated with the changes within one week or so

{| border="1"
|+
! Keyword
! Effect on <code>link</code>
! Effect on <code>a</code>, <code>area</code>
! Brief description
! Link to specification
! Synonyms
! Status

|-
| [[rel-about|about]]
| Hyperlink
| Hyperlink
| The resource linked to contains information about the current page.
| [https://www.rfc-editor.org/rfc/rfc6903.html#section-2 RFC6903]
| It might combine with [[rel-me]] or [[rel-author]] in links to an "about" section focused on an author
| proposed

|-
| [[rel-amphtml|amphtml]]
| Hyperlink
| Hyperlink
| Specify an alternate version of the document written in AMP HTML
| [https://github.com/ampproject/amphtml AMP HTML documentation]
| could be combined with rel=alternate
| proposed

|-
| [[rel-apple-touch-icon|apple-touch-icon]]
| External Resource
| Not allowed
| Specify a Webpage Icon for a “Web Clip”, or “touch icon”, for mobile devices (not limited to Apple devices).
| [http://developer.apple.com/library/safari/#documentation/appleapplications/reference/safariwebcontent/configuringwebapplications/configuringwebapplications.html Apple's Safari Web Content Guide]
| probably redundant with rel=icon
| proposed

|-
| [[rel-apple-touch-icon-precomposed|apple-touch-icon-precomposed]]
| External Resource
| Not allowed
| Specify a Webpage Icon for a “Web Clip”, or “touch icon”, for mobile devices (not limited to Apple devices).
| [http://developer.apple.com/library/safari/#documentation/appleapplications/reference/safariwebcontent/configuringwebapplications/configuringwebapplications.html Apple's Safari Web Content Guide]
| probably redundant with rel=icon
| proposed

|-
| [[rel-apple-touch-startup-image|apple-touch-startup-image]]
| External Resource
| Not allowed
| Specify a splashscreen for Web apps on iOS Safari
| [http://developer.apple.com/library/safari/#documentation/appleapplications/reference/safariwebcontent/configuringwebapplications/configuringwebapplications.html Apple's Safari Web Content Guide]
| maybe redundant with rel=icon with the sizes attribute?
| proposed

|-
| [[rel-archived|archived]]
| External Resource
| Hyperlink Annotation
| The target resource is archived and kept largely or solely for historical purposes.
| [https://sitemorse.com/rel-archived/ rel="archived" description]
|
| proposed

|-
| [[rel-atproto|atproto]]
| external relation
| external relation
| indicates the link is an ATProto account handle
| [https://indieweb.org/rel-atproto IndieWeb: rel-atproto]
|
| proposed

|-
| [[rel-attachment|attachment]]
| Hyperlink
| Hyperlink
| The resource linked to is "attached" to this document, similar to email attachments. Used in WordPress.
| No formal specification
|
| proposed

|-
| [[rel-authn|authn]]
| external relation
| external relation
| use only the referenced profiles (URLs) for authenticating the current page/site/user e.g. via [[rel-me]]
| [https://indieweb.org/rel-authn IndieWeb: rel-authn]
|
| proposed

|-
| [[rel-authorization_endpoint|authorization_endpoint]]
| External Resource
| Not allowed
| Specify a hosted authorization server
| [https://www.w3.org/TR/indieauth/ IndieAuth spec]
|
| proposed

|-
| [[rel-canonical|canonical]]
| Hyperlink
| Hyperlink
| Specifies the canonical URL for the current document in order to help avoid duplicate content.
| [http://en.wikipedia.org/wiki/Canonical_meta_tag Canonical meta tag] [http://www.Google.com/support/webmasters/bin/answer.py?answer=139066#2 Canonicalization at Google Webmaster Central] [http://www.Bing.com/community/site_blogs/b/webmaster/archive/2009/02/12/partnering-to-help-solve-duplicate-content-issues.aspx Microsoft Webmaster Center] [http://www.YSearchBlog.com/2009/02/12/fighting-duplication-adding-more-arrows-to-your-quiver/ Yahoo! Search Blog]
|
| proposed

|-
| [[rel-category|category]]
| Hyperlink
| Hyperlink
| Refers to a category assigned to the current document or post. Implemented by WordPress for indicating a relation between a blog post and a category.
| [[rel-category]]
|
| proposed

|-
| [[rel-code-repository|code-repository]]
| Hyperlink
| Hyperlink
| indicates a code repository location. For link, it specifically indicates, in the case of server-generated content, the location of source code responsible for the generation of the current page, or, in the case of static files, where copies of the current page are housed). If the specific data/content built up at the page is stored separately from the generator (e.g., the code for a CMS vs. the specific CMS instance's SQL tables or JSON data files), this only refers to the generator and [[rel-content-repository|content-repository]] should be used to indicate the location for the storage of content. Otherwise, the code repository can be considered as also including the content. While the repository should contain its own license file, the [[rel-code-license|code-license]] rel-value is proposed as a direct pointer to the license (see also [[rel-content-license|content-license]]).
|
|
| proposed

|-
| [[rel-code-license|code-license]]
| Hyperlink
| Hyperlink
| indicates a license for code (a proposed broader replacement for [[rel-jslicense|jslicense]]). For link, it specifically indicates, in the case of server-generated content, the location of the license for all source code responsible for the generation of the current page, or, in the case of static files, the location of the license for all of these files). If the specific data/content built up at the page is stored separately from the generator (e.g., the code for a CMS vs. the specific CMS instance's SQL tables or JSON data files), this only refers to the generator and [[rel-content-license|content-license]] should be used to indication the license for the content. Otherwise, code-license can be considered as also covering the license of the content. Pointing to the repository containing the static or generator code files should be done with [[rel-code-repository|code-repository]] (and [[rel-content-repository|content-repository]] for any separate content).
|
|
| proposed

|-
| [[rel-component|component]]
| External Resource
| Not allowed
| Specify an HTML document that is treated as a component of this document.
| [https://dvcs.w3.org/hg/webcomponents/raw-file/tip/spec/components/index.html Web Components]
|
| proposed

|-
| [[rel-chrome-webstore-item|chrome-webstore-item]]
| External Resource
| Not allowed
| Link tag to declare for app and extensions inline installations hosted in the Chrome Web Store.
| [https://developers.google.com/chrome/web-store/docs/inline_installation Using Inline Installation]
|
| proposed

|-
| [[rel-content-repository|content-repository]]
| Hyperlink
| Hyperlink
| indicates a repository housing data content. For link, it specifically indicates, in the case of server-generated content, the location where separately housed data files used to populate the current page are stored (otherwise "code-repository" is sufficient to include content as well as code). If the specific data/content built up at the page is stored separately from the generator (e.g., the code for a CMS vs. the specific CMS instance's SQL tables or JSON data files), this only refers to the data/content files and [[rel-code-repository|code-repository]] should be used to indicate the location for the storage of the generator source files. Otherwise, [[rel-code-repository|code-repository]] can be considered as also including the content instead. While the repository should contain its own license file, the [[rel-content-license|content-license]] rel-value is proposed as a direct pointer to the license (see also [[rel-code-license|code-license]]).
|
|
| proposed

|-
| [[rel-content-license|content-license]]
| Hyperlink
| Hyperlink
| indicates a license for data content. For link, it specifically indicates, in the case of server-generated content, the location of the license for all separately housed data files used to populate the current page are stored, (otherwise "code-license" is sufficient to cover the license of content as well as code)). If the specific data/content built up at the page is stored separately from the generator (e.g., the code for a CMS vs. the specific CMS instance's SQL tables or JSON data files), this only refers to the data/content files and [[rel-code-license|code-license]] should be used to indication the license for the generator source files. Otherwise, code-license can be considered as also covering the license of the content. Pointing to the repository containing the data files should be done with [[rel-content-repository|content-repository]] (and [[rel-code-repository|code-repository]] for the static or generator code files).
|
|
| proposed

|-
| [[rel-dcterms.(property)#conformsTo|DCTERMS.conformsTo]]
| External Resource
| Not allowed
| An established standard to which the described resource conforms. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
| It may be replaced by the literal value in form of <code><meta name="DCTERMS.conformsTo" content="..." /></code>
| proposed

|-
| [[rel-dcterms.(property)#contributor|DCTERMS.contributor]]
| External Resource
| Not allowed
| An entity responsible for making contributions to the resource. Examples include a person, an organization, or a service. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
| It may be replaced by the literal value in form of <code><meta name="DCTERMS.contributor" content="..." /></code>
| proposed

|-
| [[rel-dcterms.(property)#creator|DCTERMS.creator]]
| External Resource
| Not allowed
| An entity primarily responsible for making the resource. Examples include a person, an organization, or a service. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
| It may be replaced by the literal value in form of <code><meta name="DCTERMS.creator" content="..." /></code>
| proposed

|-
| [[rel-dcterms.(property)#description|DCTERMS.description]]
| External Resource
| Not allowed
| An account of the resource. Description may include but is not limited to: an abstract, a table of contents, a graphical representation, or a free-text account of the resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
| It may be replaced by the literal value in form of <code><meta name="DCTERMS.description" content="..." /></code>
| proposed

|-
| [[rel-dcterms.(property)#hasFormat|DCTERMS.hasFormat]]
| External Resource
| Not allowed
| A related resource that is substantially the same as the pre-existing described resource, but in another format. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#hasPart|DCTERMS.hasPart]]
| External Resource
| Not allowed
| A related resource that is included either physically or logically in the described resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#hasVersion|DCTERMS.hasVersion]]
| External Resource
| Not allowed
| A related resource that is a version, edition, or adaptation of the described resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#isFormatOf|DCTERMS.isFormatOf]]
| External Resource
| Not allowed
| A related resource that is substantially the same as the described resource, but in another format. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#isPartOf|DCTERMS.isPartOf]]
| External Resource
| Not allowed
| A related resource in which the described resource is physically or logically included. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#isReferencedBy|DCTERMS.isReferencedBy]]
| External Resource
| Not allowed
| A related resource that references, cites, or otherwise points to the described resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#isReplacedBy|DCTERMS.isReplacedBy]]
| External Resource
| Not allowed
| A related resource that supplants, displaces, or supersedes the described resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#isRequiredBy|DCTERMS.isRequiredBy]]
| External Resource
| Not allowed
| A related resource that requires the described resource to support its function, delivery, or coherence. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#isVersionOf|DCTERMS.isVersionOf]]
| External Resource
| Not allowed
| A related resource of which the described resource is a version, edition, or adaptation. Changes in version imply substantive changes in content rather than differences in format. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#license|DCTERMS.license]]
| External Resource
| Not allowed
| A legal document giving official permission to do something with the resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
| It may be replaced by the literal value in form of <code><meta name="DCTERMS.license" content="..." /></code>
| proposed

|-
| [[rel-dcterms.(property)#mediator|DCTERMS.mediator]]
| External Resource
| Not allowed
| An entity that mediates access to the resource and for whom the resource is intended or useful. In an educational context, a mediator might be a parent, teacher, teaching assistant, or care-giver. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
| It may be replaced by the literal value in form of <code><meta name="DCTERMS.mediator" content="..." /></code>
| proposed

|-
| [[rel-dcterms.(property)#publisher|DCTERMS.publisher]]
| External Resource
| Not allowed
| An entity responsible for making the resource available. Examples include a person, an organization, or a service. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
| It may be replaced by the literal value in form of <code><meta name="DCTERMS.publisher" content="..." /></code>
| proposed

|-
| [[rel-dcterms.(property)#references|DCTERMS.references]]
| External Resource
| Not allowed
| A related resource that is referenced, cited, or otherwise pointed to by the described resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#relation|DCTERMS.relation]]
| External Resource
| Not allowed
| A related resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#replaces|DCTERMS.replaces]]
| External Resource
| Not allowed
| A related resource that is supplanted, displaced, or superseded by the described resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#requires|DCTERMS.requires]]
| External Resource
| Not allowed
| A related resource that is required by the described resource to support its function, delivery, or coherence. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#rightsHolder|DCTERMS.rightsHolder]]
| External Resource
| Not allowed
| A person or organization owning or managing rights over the resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
| It may be replaced by the literal value in form of <code><meta name="DCTERMS.rightsHolder" content="..." /></code>
| proposed

|-
| [[rel-dcterms.(property)#source|DCTERMS.source]]
| External Resource
| Not allowed
| A related resource from which the described resource is derived. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#subject|DCTERMS.subject]]
| External Resource
| Not allowed
| The topic of the resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-disclosure|disclosure]]
| Not allowed
| External Resource
| The 'disclosure' Link Relation Type designates a list of patent disclosures or a particular patent disclosure itself made with respect to material for which such relation type is specified.
| [http://tools.ietf.org/html/draft-yevstifeyev-disclosure-relation The 'disclosure' Link Relation Type]
|
| proposed

|-
| [[rel-discussion|discussion]]
| Hyperlink
| Hyperlink
| Refers to discussion of the current document or post.
| [[rel-discussion]]
|
| proposed

|-
| [[rel-donation|donation]]
| Hyperlink
| Hyperlink
| Indicates that the destination of the hyperlink provides a way to show or give support (e.g. financial) for the current page on a voluntary basis
| No formal specification
| Closely related to [[rel-payment]]
| proposed

|-
| [[rel-dns-prefetch|dns-prefetch]]
| External Resource
| Not allowed
| Tells the browser to perform dns lookup for host names ahead of use.
| [https://developer.mozilla.org/En/Controlling_DNS_prefetching Mozilla documentation] [http://dev.chromium.org/developers/design-documents/dns-prefetching Google documentation]
|
| proposed

|-
| [[rel-edit|edit]]
| External Resource
| Hyperlink
| Tells the browser the URL for editing the current page
| [http://universaleditbutton.org/Registered_MIME_type#Alternate_Linking_Scheme Universal Edit Button Alternate Linking Scheme]. Implemented in at least [http://mediawiki.org MediaWiki].
|
| proposed

|-
| [[rel-edituri|EditURI]]
| External Resource
| Not allowed
| A blogging auto discovery value, commonly used by WordPress
| [http://bitworking.org/projects/atom/draft-gregorio-09.html#Edit AtomAPI]
|
| proposed

|-
| [[rel-enclosure|enclosure]]
| External Resource
| External Resource
| Indicates that the referred resource is intended to be downloaded and cached.
| [[rel-enclosure]]
|
| proposed

|-
| [[rel-entry-content|entry-content]]
| Not allowed
| External Resource
| Indicates that the referenced document is an alternative display source for an Internet Explorer Web Slice.
| [http://msdn.microsoft.com/en-us/library/cc304073(VS.85).aspx#_alternative Web Slice format specification 0.9]
|
| proposed

|-
| [[rel-external|external]]
| Not allowed
| Hyperlink
| Indicates that the referenced document is not part of the same site as the current document.
| [[rel-external]]
|
| proposed

|-
| [[rel-first|first]]
| Hyperlink
| Hyperlink
| Indicates that the document is part of a sequence, and that the link is leading to the document that is the first logical document in the sequence.
| [https://www.w3.org/TR/2011/WD-html5-20110113/links.html#link-type-first W3C Working Draft 13 January 2011]
|
| proposed

|-
| [[rel-gbfs|gbfs]]
| External Resource
| Not allowed
| The location of the gbfs auto-discovery file
| [https://github.com/NABSA/gbfs/blob/master/gbfs.md General Bikeshare Feed Specification]
|
| proposed

|-
| [[rel-gtfs-static|gtfs-static]]
| External Resource
| Not allowed
| Indicates the associated GTFS Static file
| [https://developers.google.com/transit/gtfs/reference General Transit Feed Specification Reference]
|
| proposed

|-
| [[rel-gtfs-realtime|gtfs-realtime]]
| External Resource
| Not allowed
| Indicates the associated GTFS-Realtime file
| [https://developers.google.com/transit/gtfs-realtime/reference GTFS-realtime Reference]
|
| proposed

|-
| [[rel-home|home]]
| Hyperlink
| Hyperlink
| Refers to the top level document for the current document. It can be combined with 'alternate' to indicate a feed for the site of the current page.
| [[rel-home]]
| [[rel-root]]
| proposed

|-
| [[rel-hub|hub]]
| Hyperlink
| Hyperlink
| Refers to a hub that enables registration for notification of updates to the current page.
| [http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html#discovery PubSubHubbub Spec] [https://www.w3.org/TR/websub/ WebSub spec]
|
| proposed

|-
| [[rel-import|import]]
| External Resource
| Not allowed
| HTML Imports are a way to include and reuse HTML documents in other HTML documents.
| [http://www.w3.org/TR/html-imports HTML Imports]
|
| proposed

|-
| [[rel-in-reply-to|in-reply-to]]
| Hyperlink
| Hyperlink
| Refers to an original post that the current page is a comment on or reply to.
| [[rel-in-reply-to]]
|
| proposed

|-
| [[rel-root|root]]
| Hyperlink
| Hyperlink
| The target document is the root node of the hierarchical tree structure that hosts the current document
| No formal specification
| [[rel-home]]
| proposed

|-
| [[rel-index|index]]
| Hyperlink
| Hyperlink
| Refers to a document providing a list of topics with pointers that pertain to the current document.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4]
|
| proposed

|-
| [[rel-issues|issues]]
| Hyperlink
| Hyperlink
| Refers to issues regarding the current document or specification.
| [[rel-discussion]]
|
| proposed

|-
| [[rel-jslicense|jslicense]]
| Hyperlink
| Hyperlink
| Refers to a document with JavaScript source code and license information (also called a [http://www.gnu.org/licenses/javascript-labels.html JavaScript License Web Labels] page). We might want choose a keyword for this that is more general -- there are many situations besides JavaScript in which it is desirable or required by license agreements (e.g., GNU GPL) to make an offer of both the source code and a copy of a license when distributing object code versions of a given work.
| [[rel-jslicense]]
|
| proposed

|-
| [[rel-last|last]]
| Hyperlink
| Hyperlink
| Indicates that the document is part of a sequence, and that the link is leading to the document that is the last logical document in the sequence.
| [https://www.w3.org/TR/2011/WD-html5-20110113/links.html#link-type-last W3C Working Draft 13 January 2011]
|
| proposed

|-
| [[rel-lightbox|lightbox]]
| Not allowed
| Img Pop-Up
| Images with this attribute are displayed in a larger way than embedded in a website (or how you specified it) when clicked (e.g. with installed "Lightbox 2"-Plugin). When adding [group] to rel="lightbox" all images get a clickable button for next/prev; insert into <code><a rel="lightbox[group]"><img src="http:example.com/img.jpg"></a></code>
| [http://lokeshdhakar.com/projects/lightbox2/ Lightbox 2] (needs actual specification to be kept in this list, this link is just documentation of one implementation)
|
| proposed

|-
| [[rel-lightvideo|lightvideo]]
| Not allowed
| Video Pop-Up
| Loads the video in a lightbox effect
| [https://www.drupal.org/node/252276 Lightbox2 - How to display video content]
|
| proposed

|-
| [[rel-main|main]]
| Hyperlink
| Hyperlink
| The current page is a subsection or a less important page than the target resource
| No formal specification
| It can be a synonym of [[rel-parent]] when the latter refers to a document and not a person. It differs however from [[rel-home]] and [[rel-root]], as the latter refer only to the topmost resource in the hierarchical tree structure (and in this case they may be combined with [[rel-main|main]]). Note that [[rel-main]] does not necessarily refer to a higher node in a tree structure, as the target resource can simply be a more important sibling node.
| proposed

|-
| [[rel-manifest|manifest]]
| External Resource
| Not allowed
| Imports or links to a manifest
| [http://w3c.github.io/manifest/#linking W3C Manifest for web application]
|
| proposed

|-
| [[rel-mask-icon|mask-icon]]
| External Resource
| Not allowed
| Specify a Webpage Icon for a “Pinned Tabs” on Safari 9.
| probably redundant with rel-icon
|
| proposed

|-
| [[rel-meta|meta]]
| External Resource
| Not allowed
| External metadata about the HTML document
| [http://www.w3.org/TR/2004/REC-rdf-syntax-grammar-20040210/#section-rdf-in-HTML W3C's RDF/XML Syntax Specification]
|
| proposed

|-
| [[rel-micropub|micropub]]
| External Resource
| Not allowed
| the micropub endpoint for creating new posts
| [https://www.w3.org/TR/micropub/ Micropub scecification]
|
| proposed

|-
| [[rel-noopener|noopener]]
| Not allowed
| Annotation
| Requires that any browsing context created by following the hyperlink must not have an opener browsing context.
| [https://html.spec.whatwg.org/multipage/semantics.html#link-type-noopener 4.6.6.11 Link type ”noopener"]
|
| proposed

|-
| [[rel-openid.delegate|openid.delegate]]
| External Resource
| Not allowed
| When the page that contains the link is used as an OpenID indentifier, the relying party perform sOpenID 1.1 authentication with the link target as the identifier instead.
| [http://openid.net/specs/openid-authentication-1_1.html#delegating_authentication OpenID Authentication 1.1]
|
| proposed

|-
| [[rel-openid.server|openid.server]]
| External Resource
| Not allowed
| The OpenID server for the relying party to contact for OpenID 1.1 authentication
| [http://openid.net/specs/openid-authentication-1_1.html#anchor4 OpenID Authentication 1.1]
|
| proposed

|-
| [[rel-openid2.local_id|openid2.local_id]]
| External Resource
| Not allowed
| When the page that contains the link is used as an OpenID indentifier, the relying party perform sOpenID 2.0 authentication with the link target as the identifier instead.
| [http://openid.net/specs/openid-authentication-2_0.html#rfc.section.7.3.3 OpenID Authentication 2.0]
|
| proposed

|-
| [[rel-openid2.provider|openid2.provider]]
| External Resource
| Not allowed
| The OpenID server for the relying party to contact for OpenID 2.0 authentication
| [http://openid.net/specs/openid-authentication-2_0.html#rfc.section.7.3.3 OpenID Authentication 2.0]
|
| proposed

|-
| [[rel-p3pv1|p3pv1]]
| External Resource
| Not allowed
| References a machine-readable privacy policy description in the P3P format
| [http://www.w3.org/TR/P3P/#syntax_link P3P spec]
|
| proposed

|-
| [[rel-pgpkey|pgpkey]]
| External Resource
| Not allowed
| Associates a PGP key with a Web page so that the Web page URL can be used as the commenter's URL in PGP-signed blog comments and the blogging system receiving the comment can fetch the key and verify the signature as belonging to the owner of the URL.
| [http://golem.ph.utexas.edu/~distler/blog/archives/000320.html PGP-Signed Comments]
|
| proposed

|-
| [[rel-pingback|pingback]]
| External Resource
| Not allowed
| gives the address of the pingback server that handles pingbacks to the current document
| [http://www.hixie.ch/specs/pingback/pingback Pingback]
|
| proposed

|-
| [[rel-preconnect|preconnect]]
| External Resource
| Not allowed
| Indicates an origin that will be used to fetch required resources. Initiating an early connection, which includes the DNS lookup, TCP handshake, and optional TLS negotiation, allows the user agent to mask the high costs of connection establishment latency.
| [http://www.w3.org/TR/resource-hints/ Resource Hints Working Draft]
|
| proposed

|-
| [[rel-prerender|prerender]]
| External Resource
| External Resource
| Prerenders the Web page targeted by the link including running it scripts.
| [[rel-prerender]]
|
| proposed

|-
| [[rel-profile|profile]]
| External Resource
| Contextual External Resource
| indicate[s] that the destination of that hyperlink is a metadata profile (e.g. an [[XMDP]] profile) for the current page or portion thereof. See also [[xmdp-brainstorming]].
| [http://microformats.org/wiki/rel-profile rel-profile]
|
| proposed

|-
| [[rel-publisher|publisher]]
| External Resource
| External Resource
| Indicates that the referenced document is a metadata profile (e.g., a social-media/real-name profile such as a Google+ profile) for the publisher of the current page, or some portion of the current page.
| [https://support.google.com/plus/answer/1713826?hl=en Google help page]
|
| proposed

|-
| [[rel-radioepg|radioepg]]
| External Resource
| External Resource
| Indicates that the referenced document is a RadioDNS Service Information document (ETSI TS 102 818 s10.2.3) containing information on the radio station that publishes the current page
| [https://radiodns.org/developers/documentation RadioDNS Documentation]
|
| proposed

|-
| [[rel-rendition|rendition]]
| External Resource
| External Resource
| Indicates some example rendering, interpretation, or depiction of the source. User agents may choose to execute, display, or render the target in-place; or navigate to the target.
| [http://www.globalmentor.com/specs/html-rel-rendition/ HTML rel rendition]
|
| proposed

|-
| [[rel-reply-to|reply-to]]
| External Resource
| Hyperlink
| indicates any mailbox(es) (i.e. email addresses) to which responses are to be sent. ''Note: this is distinct from the 'in-reply-to' value which refers to the originating document, not to the address where comments should be sent.
| [http://tools.ietf.org/html/rfc2822 RFC2822] (originally [http://tools.ietf.org/html/rfc822#section-4.4.3 RFC822])
|
| ratified

|-
| [[rel-schema.DCTERMS|schema.DCTERMS]]
| External Resource
| Not allowed
| Maps the prefix "DCTERMS" for use in other Dublin-Core related link relations (such as DCTERMS.creator) and meta keywords
| [http://dublincore.org/documents/dc-html/#sect-4.2 Section 4.2 of "Expressing Dublin Core metadata using HTML/XHTML meta and link elements"]
| see also [https://wiki.whatwg.org/wiki/MetaExtensions "WhatWG MetaExtensions Wiki] for usage examples in meta keywords
| proposed

|-
| [[rel-service|service]]
| External Resource
| Not allowed
| Atom Publishing Protocol editing service autodiscovery.
| [http://wiki.whatwg.org/wiki/ServiceRelExtension Documentation on the WHATWG wiki]
|
| proposed

|-
| [[rel-shortlink|shortlink]]
| External Resource
| Not allowed
| Specifies the preferred shortened URL for the page.
| [http://code.google.com/p/shortlink/wiki/Specification shortlink spec]
|
| proposed

|-
| [[rel-sidebar|sidebar]]
| Hyperlink
| Hyperlink
| Indicates that the referenced document is intended to be shown in a secondary browsing context.
| [[rel-sidebar]]
|
| proposed

|-
| [[rel-sitemap|sitemap]]
| External Resource
| Not allowed
| Provides a link to an XML document describing the layout of the site.
| [[rel-sitemap]]
|
| proposed

|-
| [[rel-subresource|subresource]]
| External Resource
| Not allowed
| An external resource intended for use within the current page.
| [http://www.chromium.org/spdy/link-headers-and-server-hint/link-rel-subresource Chromium documentation]
|
| proposed

|-
| [[rel-sword|sword]]
| Hyperlink
| Not allowed
| SWORD is a lightweight protocol for remotely depositing content into repositories. .[http://swordapp.org/ The SWORD project]
| [[rel-sword]]
|
| proposed

|-
| [[rel-syndication|syndication]]
| Hyperlink
| Hyperlink
| Refers to a page which is a syndicated copy of the current page.
| [[rel-syndication]]
|
| proposed

|-
| [[rel-timesheet|timesheet]]
| External Resource
| Not allowed
| Applies a timesheet to the document.
| [http://www.w3.org/TR/timesheets/#smilTimesheetsNS-Elements-Timesheet non-normative section in the Timesheet spec]
|
| proposed

|-
| [[rel-token_endpoint|token_endpoint]]
| External Resource
| Not allowed
| Specify an HTTP endpoint that Micropub clients can use to obtain an access token given an authorization code
| [https://www.w3.org/TR/indieauth/ IndieAuth spec]
|
| proposed

|-
| [[rel-webmention|webmention]]
| External Resource
| Hyperlink
| gives the address of the webmention endpoint that handles webmentions to the current document
| [https://www.w3.org/TR/webmention/ Webmention specification]
|
| proposed

|-
| [[rel-widget|widget]]
| External Resource
| External Resource
| Autodiscovery for W3C widgets
| [http://dev.w3.org/2006/waf/widgets/Overview.html#linking-to-a-widget-package-from-a-html- non-normative section in the Widget packaging spec]
|
| proposed

|-
| [[rel-wlwmanifest|wlwmanifest]]
| External Resource
| Not allowed
| Windows Live Writer manifest autodiscovery
| [http://msdn.microsoft.com/en-us/library/bb463263.aspx documentation on MSDN]
|
| proposed

|-
| [[rel-image_src|image_src]]
| External Resource
| Not allowed
| Specify a Webpage Icon for use by Facebook, Yahoo, Digg, etc.
| Unknown, but see for instance [http://www.niallkennedy.com/blog/2009/03/enhanced-social-share.html this]
| probably redundant with rel=icon
| proposed

|-
| [[rel-cmis-acl|http://docs.oasis-open.org/ns/cmis/link/200908/acl]]
| External Resource
| External Resource
| Identifies the resource containing a CMIS ACL document for the link context
| [http://docs.oasis-open.org/cmis/CMIS/v1.0/cs01/cmis-spec-v1.0.html#_Toc243905525 CMIS 1.0, Section 3.4.3.4]
|
| proposed

|-
| [[rel-stylesheet/less|stylesheet/less]]
| External Resource
| Not allowed
| Less CSS framework stylesheets.
| [http://lesscss.org/#-client-side-usage Less CSS usage]
|
| proposed

|-
| [[rel-yandex-tableau-widget|yandex-tableau-widget]]
| External Resource
| Not allowed
| Lets webmasters configure the appearance of their own site widgets in Yandex.Browser
| [https://api.yandex.com/tableau/ Yandex's Tableau API]
|
| proposed

|}

== brainstorming ==
Several rel values are being brainstormed as potential microformats and are thus listed here. If you find you have a use for such semantics in real world examples, consider trying out these values and provide feedback on the respective brainstorming page(s) with your results and experiences.

You may list new proposed rel values here, and even better if you can list and link to POSH uses in the wild.

{| border="1"
|+
! rel value !! summary !! brainstormed in and usage in the wild

|-
| [[rel-accessibility|accessibility]] || indicate[s] that the destination of that hyperlink contains accessibility information for the current page. || [http://www.brucelawson.co.uk/2009/rel-accessibility/ blog post] which itself uses the rel value in a <link> tag in the head of the document.

|-
| [[rel-author|author]] || indicate[s] that the destination of that hyperlink represents the author of the current page. Combines with [[rel-me|rel-me]] to chain authorship information. || Google has said it will index rel-Author in this [http://googlewebmastercentral.blogspot.com/2011/06/authorship-markup-and-web-search.html blog post], with further [http://www.google.com/support/webmasters/bin/answer.py?answer=1229920 discussion of the rel-me connection] See also [http://dev.w3.org/html5/spec/Overview.html#link-type-author the HTML5 spec]

|-
| [[rel-bibliography|bibliography]] || indicate[s] that the destination of that hyperlink is a bibliography for the current page. || [http://microformats.org/discuss/mail/microformats-discuss/2007-October/010863.html mailing list post, 2007-10-15]

|-
| [[rel-cite|cite]] || indicate[s] that the destination of that hyperlink is an authoritative source or a precedent to the current page. || [[distributed-conversation-brainstorming]]

|-
| [[rel-embed|embed]] || destination of the link is an version of the current page suitable for embedding in other pages || [https://indieweb.org/rel-embed IndieWeb rel-embed examples and brainstorming]

|-
| [[rel-group|group]] || the referenced document represents a group to which the person represented by the current document belongs || [[group-brainstorming]]

|-
| [[rel-longdesc|longdesc]] || Alternative to the img longdesc attribute, for use on visible links || [http://www.google.com/search?q=rel%3D%22longdesc%22 Google search for rel=longdesc in the wild] shows many sources of proposals. Please edit this to list the earliest and perhaps most recent/comprehensive proposal. No known real world POSH usage in the wild yet.

|-
| [[rel-map|map]] || Link to a map. Possibly embedded within an adr, hCard, geo or hCalendar. Parsers {{may}} attempt to parse the URL if it is a link to a known map site (e.g. Geohash, Google Maps, Multimap) and extract co-ordinates and other useful data. || (to [[User:TobyInk|TobyInk]] by email)

|-
| [[rel-member|member]] || the referenced document represents a member of the group represented by the current document || [[group-brainstorming]]

|-
| [[rel-m_PageScroll2id|m_PageScroll2id]] || JS to scroll to a defined ID || [[group-brainstorming]]

|-
| [[rel-prefetch|prefetch]] || indicates the URL and content-type of a resource that is likely to be a required resource when the next action or navigation is triggered. Initiating an early fetch allows the user agent to mask the request latency of the resource and make it available sooner to the application.|| [https://igrigorik.github.io/resource-hints/#prefetch resource hints draft]

|-
| [[rel-preload|preload]] || indicates the URL and content-type of a resource that should be fetched as early as possible by the user agent. Initiating an early fetch allows the user agent to mask the request latency of the resource and make it available sooner to the application.|| [https://igrigorik.github.io/resource-hints/#preload resource hints draft]

|-
| [[rel-prerender|prerender]] || indicates the URL of the next navigation target. Initiating a prerender allows the user agent to deliver an instant navigation experience: the user agent downloads the top-level resource and its assets, and performs all of the processing steps required to show the page without actually showing it to the user.|| [https://igrigorik.github.io/resource-hints/#prerender resource hints draft]

|-
| [[rel-profile|profile]] || indicate[s] that the destination of that hyperlink is a metadata profile (e.g. an [[XMDP]] profile) for the current page or portion thereof || [[xmdp-brainstorming]]

|-
| [[rel-shortlink|shortlink]] || the referenced document represents the current document but with a shorter URL || [http://samj.net/2009/04/introducing-relshort-better-alternative.html blog post]
|-
| source || the referenced document represents the source code for the current document or project || [[source-brainstorming]] [http://adactio.com/journal/6667/ blog post]

|-
| vcalendar-parent || link from an event to a containing event || [[User:TobyInk/hcalendar-1.1|hCalendar 1.1 draft]]
|-
| vcalendar-child || link from an event to a contained event || [[User:TobyInk/hcalendar-1.1|hCalendar 1.1 draft]]
|-
| vcalendar-sibling || link from an event to a related event with the same container || [[User:TobyInk/hcalendar-1.1|hCalendar 1.1 draft]]

|-
| [[rel-status|status]] || the referenced document represents the status (or source of status updates) for the author of this document || [http://monkinetic.com/2009/11/24/status-autodiscovery-relstatus.html blog post]

|-
| https://api.w.org/ || Link to Wordpress API || [https://wordpress.org/themes/twentysixteen/ Official Wordpress theme]

|}

=== more brainstorming ===
See also:
* [[genealogy-brainstorming]] for some thoughts on possible additional values for family relationships (use existing [[XFN]] [[rel-parent|parent]], [[rel-child|child]], [[rel-sibling|sibling]], [[rel-spouse|spouse]], [[rel-kin|kin]] values first though)
* [[xpn-brainstorming]] for some thoughts on possible additional values for professional relationships (use existing [[XFN]] [[rel-co-worker|co-worker]], [[rel-colleague|colleague]] values first though)

== POSH usage ==
There are numerous rel values used as [[POSH]], both in the wild, whose origins are not necessarily known, nor are their meanings consistent. There are also numerous rel values from external proposals of varying degrees of merit. It is useful to document their existence and summarize their implied meanings/usage intent as research that may be used to perhaps take one or more of them thru the microformats [[process]] if there is both sufficient interest and sufficient in the wild usage.

Note: If a value is missing from this table, it may have either already been promoted by writing it up as a proposal, or demoted by being explicitly dropped. Please check the other tables first before adding to this table.

Note: this list is incomplete, please help complete it from the following sources:

External sources:
* [http://developer.mozilla.org/about/meta Meta Information in DevMo Docs] (DevMo)
* [http://wiki.mozilla.org/Microsummaries Microsummary]
* [http://lachy.id.au/dev/markup/specs/wclr/ Web Communication Link Relationships] (WCLR)
* [http://www.w3.org/MarkUp/Relationships.html W3C Link Relationship values draft] (LRdraft) - from a draft of the HTML spec circa 1991.
* [http://www.whatwg.org/specs/web-apps/current-work/multipage/section-links.html#linkTypes HTML5 draft] '''Liable to change'''
* [http://wiki.foaf-project.org/Autodiscovery FOAF Project Wiki: Autodiscovery] (FOAF)
* [http://www.apps.ietf.org/rfc/rfc4685.html RFC4685]
* [http://googlewebmastercentral.blogspot.com/2009/02/specify-your-canonical.html Google Blog]

{| border="1"
|+
! rel value !! summary !! origin !! proposal(s)

|-
| [[rel-archive|archive]] || index of archived entries || unknown, perhaps Wordpress open source blogging software || WCLR

|-
| [[rel-archives|archives]] || Provides a link to a collection of records, documents, or other materials of historical interest. || || HTML5

|-
|[[rel-author|author]]||see brainstorming above for suggested use by google||unknown || DevMo / HTML5

|-
| [[rel-canonical|canonical]] || To help search engines disambiguate the same page with multiple representations || Google || [http://googlewebmastercentral.blogspot.com/2009/02/specify-your-canonical.html Google]/[http://www.bing.com/community/blogs/webmaster/archive/2009/02/12/partnering-to-help-solve-duplicate-content-issues.aspx Microsoft]/[http://www.ysearchblog.com/2009/02/12/fighting-duplication-adding-more-arrows-to-your-quiver/ Yahoo!], [http://blog.ask.com/2009/02/ask-is-going-canonical.html Ask Jeeves]

|-
| [[rel-comment|comment]] || … || … || WCLR

|-
| [[rel-contribution|contribution]] || … || … || WCLR

|-
| [[rel-edituri|EditURI]]
| Location of the xml-rpc gateway for a Wordpress install that allows external programs to add, edit and delete posts. Used by "[http://codex.wordpress.org/Weblog_Client WordPress blog client]" software for automating posting and updating blog content from your desktop. || Seen in [http://www.wordpress.org/ WordPress], e.g. [http://www.tom-watson.co.uk/]. || Description stubbed in [[rel-edituri]].

|-
| [[rel-endorsed|endorsed]] || … || … || WCLR

|-
| [[rel-fan|fan]] || xxxx. || … || [[hcard-user-profile-authoring]]

|-
| [[rel-feed|feed]] || Gives the address of a syndication feed for the current document. || … || WCLR/ HTML5

|-
| [[rel-footnote|footnote]] || Location of the footnote on a link to a footnote. || Markdown preprocessors such as [http://maruku.rubyforge.org/ Maruku] || HTML5

|-
| [[rel-icon|icon]] || Imports an icon to represent the current document. (Allowed in <code>link</code> only) || [http://dev.w3.org/html5/spec-LC/links.html#rel-icon HTML5] || WCLR/HTML5

|-
| [[rel-kinetic-stylesheet|kinetic-stylesheet]] || Imports a [http://kssproject.org/ KSS] 'kinetic stylesheet' to bind dynamic behavior to elements || Used in the [http://plone.org Plone] Content Management System || …

|-
| [[rel-lightbox|lightbox]] || Hook - Indicates that following the link will trigger a "lightbox" script (Allowed in <code>link</code> only) || ([http://www.google.co.uk/search?q=rel%3D%22lightbox%22 Google search for rel=lightbox in the wild]) Use "lightbox" instead of "clearbox" or "prettyPhoto" || …

|-
| [[rel-made|made]] || … || … || LRdraft

|-
| [[rel-meta|meta]] || … || [http://www.w3.org/TR/1999/REC-rdf-syntax-19990222/#transport 1999 W3C RDF syntax REC] || FOAF

|-
| [[rel-microsummary|microsummary]]|| … || … ||[http://wiki.mozilla.org/Microsummaries Microsummary], be aware of: [[page-summary-formats#Issues_2|microsummary issues]]

|-
| [[rel-noreferrer|noreferrer]] || indicates that no referrer information is to be leaked when following the link. || [http://dev.w3.org/html5/spec-LC/links.html#rel-noreferrer HTML5] || HTML5

|-
| [[rel-openid-delegate|openid.delegate]] || … || ([http://www.google.co.uk/search?q=%22rel%3Dopenid%22 Google search for rel=openid.* in the wild]) || …

|-
| [[rel-openid-server|openid.server]] || … || ([http://www.google.co.uk/search?q=%22rel%3Dopenid%22 Google search for rel=openid.* in the wild]) || …

|-
| [[rel-permalink|permalink]] || indicate a permanent link for some, or all, content within the document. obsolete; use <code>bookmark</code> instead. || … || WCLR

|-
| [[rel-pgpkey|pgpkey]] || (see also rel-publickey) || … || [http://golem.ph.utexas.edu/~distler/blog/archives/000320.html], [http://golem.ph.utexas.edu/~distler/blog/archives/000325.html]

|-
| [[rel-pingback|pingback]] || Gives the address of the pingback server that handles pingbacks to the current document. (Allowed in <code>link</code> only) || … || WCLR/ HTML5

|-
| [[rel-popover|popover]] || Used by a JS widget to display a large, descriptive tooltip. || [http://twitter.github.com/bootstrap Twitter's Bootstrap] [http://twitter.github.com/bootstrap/javascript.html#popovers Popover.js] || …

|-
| [[rel-prefetch|prefetch]] || Specifies that the target resource should be pre-emptively cached. (Allowed in <code>link</code> only) || … || HTML5

|-
| [[rel-privacy|privacy]] || Specifies that the target resource is the privacy policy. || … || …

|-
| [[rel-publickey|publickey]] || (see also rel-pgpkey) || … || [http://rasterweb.net/raster/2002/12/12/20021212072812/]

|-
| [[rel-referral|referral]] || … || … || WCLR

|-
| [[rel-related|related]] || … || … || WCLR

|-
| [[rel-replies|replies]] || indicates a continued thread || unknown || [http://www.apps.ietf.org/rfc/rfc4685.html RFC4685]

|-
| [[rel-respond-proxy|respond-proxy]] || Working with respond.js - proxy on external server || [https://github.com/scottjehl/Respond] || [https://github.com/scottjehl/Respond]

|-
| [[rel-respond-redirect|respond-redirect]] || Working with respond.js - redirect location on local server || [https://github.com/scottjehl/Respond] || [https://github.com/scottjehl/Respond]

|-
| [[rel-resource|resource]] || … || … || WCLR

|-
| [[rel-search|search]] || … || unknown || unknown

|-
| [[rel-sitemap|sitemap]] || Links to a site map document. || … || http://www.sitemaps.org/

|-
| [[rel-sponsor|sponsor]] || … || … || WCLR

|-
| [[rel-tooltip|tooltip]] || Used by a JS widget to display a tooltip similar (though more customizable) to what is shown by browsers if the 'title' attribute is present. || [http://twitter.github.com/bootstrap Twitter's Bootstrap] [http://twitter.github.com/bootstrap/javascript.html#tooltips Tooltip.js] (and likely other JS tools) || …

|-
| [[rel-trackback|trackback]] || … || unknown, perhaps open source Movable Type blogging software || WCLR

|-
| [[rel-unendorsed|unendorsed]] || (probably redundant to [[rel-nofollow|nofollow]]) || … || WCLR

|-
| [[rel-user|user]] || … || … || WCLR
|-
| [[rel-wlwmanifest|wlwmanifest]] || Used by "[http://explore.live.com/windows-live-writer Windows Live Writer]," a Microsoft [http://codex.wordpress.org/Weblog_Client blog client] for automating posting and updating blog content from your desktop. || Seen in [http://www.wordpress.org/ WordPress], e.g. [http://www.tom-watson.co.uk/]. Similar values are probably used by other blog content management systems as well. || …

|}

=== WCLR ===

The WCLR proposal is described by its author (in e-mail, 2007-09-25) as:

<blockquote>
…now effectively obsolete, since HTML5 and Microformats cover all the worthwhile relationships in that already.

These are [http://www.whatwg.org/specs/web-apps/current-work/multipage/section-links.html#linkTypes covered by HTML5 already]:

* permalink -> bookmark
* archive -> archives
* feed
* pingback
* unendorsed -> nofollow

The rest now seem unnecessary.
</blockquote>

Nonetheless, there may be some mileage in using them in microformats, at least until HTML5 is widely available.

== Dublin Core ==
In the past, Dublin Core values have been added to this page in the table about HTML5 features, but no examples, nor an actual specification explicitly stating how the value(s) should be used in HTML could be found. The linked specifications below have been updated so we should start considering Dublin Core values accordingly.

{| border="1"
|+
! rel value !! summary !! source
|-
| schema.DC || a specification of all metadata terms maintained by the Dublin Core Metadata Initiative, with regard to the fifteen terms of the Dublin Core Metadata Element Set already published || [http://www.dublincore.org/documents/dcq-html/ Dublin Core]

|-
| schema.DCTERMS || a specification of all metadata terms maintained by the Dublin Core Metadata Initiative, reflecting the changes described more fully in the 2012 document "Maintenance changes to DCMI Metadata Terms" [http://dublincore.org/usage/decisions/2012/dcterms-changes/] || [http://www.dublincore.org/documents/dcq-html/ Dublin Core]
|-
|}

'''Issues need updating given new information from linked resources.'''

Notes:
* Dublin Core. This search may help: [http://www.google.co.uk/search?as_q=rel%3Dschema.*&hl=en&num=10&btnG=Google+Search&as_epq=&as_oq=&as_eq=&lr=&as_ft=i&as_filetype=&as_qdr=all&as_occt=any&as_dt=i&as_sitesearch=http%3A%2F%2Fdublincore.org&as_rights=&safe=images].
** '''examples from that search only use invisible <code><link href></code> element'''. At first glance it appears the results from the search show only uses with the invisible <code><link href></code> element which is not ideal for content relationships. Content relationships should be user visible and thus uses with <code><a href></code> are strongly preferred.
*** [http://www.ietf.org/rfc/rfc2731.txt RFC2731] defines <code>rel="schema.AC"</code> and <code>rel="schema.RC"</code> with the pattern <code>rel="schema.PREFIX"</code> as a syntax for defining namespaces for use in meta[@name], *[@rel], *[@rev] and (as per eRDF) *[@class] attributes. A link to a Dublin Core metadata schema is generally not suitable for end users, so <code><link href></code> appears to be more appropriate than <code><a href></code> for those that use Dublin Core metadata schemas.
*** The scheme proposed above provides metadata namespace declarations. As described by DCMI specifications, such indications '''cannot''' be provided w/o a suitable namespace. In order to give complete pieces of information, the correct description set must be: <code><link rel="schema.DCTERMS" href="http://purl.org/dc/terms/"></code> (for the namespace declaration, followed by) <code><meta name="DCTERMS.<nowiki>[element]</nowiki>" content="<nowiki>[element.value]</nowiki>"></code> for related elements.
**** Note: [http://purl.org/dc/terms/ schema.DCTERMS] is conventionally related to an upgraded elements list than [http://purl.org/dc/elements/1.1/ schema.DC] and should be preferred as rel values. Both are discussed here for subject completeness)
** '''proposal to use in content currently only theoretical'''. Thus unfortunately the use of Dublin Core in user visible content like <code><a href></code> appears to be strictly theoretical. See [http://microformats.org/discuss/mail/microformats-discuss/2008-January/011445.html microformats-discuss/2008-January/011445.html] for a proposal to use Dublin Core in user visible content.
*** '''recent improvements'''. DCMI solves some trouble concerning metadata through the ''description set model''. Some of these informations cannot currently be provided in any standard ways other than DC, namely dates, validity and periodicity. Following this public bug report ([https://www.w3.org/Bugs/Public/show_bug.cgi?format=multiple&id=22520]), the correct namespace declaration for DC and DCTERMS metadata are now considered valid HTML code. We '''must''' encourage this practice both for internal usefulness and for shared practices.

* The Dublin Core document [http://dublincore.org/documents/dc-html/ "Expressing Dublin Core metadata using HTML/XHTML meta and link elements"] is a specification for, and gives examples of, both <link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"> and <link rel="schema.DCTERMS" href="http://purl.org/dc/terms/">. Note that Dublin Core encourages the use of DCTERMS elements over DC. A list of projects which use Dublin Core metadata is maintained [http://dublincore.org/projects/ here].
* [http://dublincore.org/documents/dc-html/ "Expressing Dublin Core metadata using HTML/XHTML meta and link elements"] also includes examples of <link rel="DCTERMS.[element]" href="">, where [element] = subject, isReferencedBy, creator, and publisher. The <link> tag is used instead of the <meta> tag whenever the content is a URL. (Note that this use is different from, but related to, <link rel="schema.DCTERMS" href="">.) Potentially, ''any'' of the 55 DCTERMS elements could be used in this way, and this could include use in HTML 5.
** As said before, HTML5 validators now allow the use of <code><link rel="schema.DCTERMS" href="http://purl.org/dc/terms/"></code> for namespace declarations.

* According to DCMI specification linked above, as well as [http://dublincore.org/documents/dc-html/ "Expressing Dublin Core metadata using HTML/XHTML meta and link elements"] documentation, HTML5 @rel attribute proposed values table has been updated. It now includes a subset of DCMI ''/terms/'' namespace properties, more specifically those whose value can (or must) be logically expressed by a resource, so that the "href" attribute value becomes a non-literal value surrogate referring to the resource itself.
** Elements from ''/elements/1.1/'' namespace have not been included on purpose. According to [http://wiki.dublincore.org/index.php/FAQ/DC_and_DCTERMS_Namespaces "FAQ/DC and DCTERMS Namespaces"], the old namespace is maintained for legacy purposes only and it is not as suitable for non-literal values as the ones denoted by <code><link></code> elements.

== Use with HTTP Link Header ==
You can also use any of the rel values (that are allowed for link elements) with HTTP Link Headers,

Example: returning a Javascript file with a license (since JS itself has no way to indicate a license)
<syntaxhighlight lang=text>
Link: <http://creativecommons.org/publicdomain/zero/1.0/>; rel="license"
</syntaxhighlight>

For multiple licenses (e.g. CC-SA and GPL), simply use multiple <code>Link:</code> headers.
<syntaxhighlight lang=text>
Link: <http://creativecommons.org/licenses/by-sa/3.0/>; rel="license"
Link: <http://www.gnu.org/licenses/gpl.html>; rel="license"
</syntaxhighlight>

Example: similarly, linking to a copyright statement for an image:
<syntaxhighlight lang=text>
Link: <http://example.org/copyright.html>; rel="copyright"
</syntaxhighlight>
or providing a brief inline copyright statement:
<syntaxhighlight lang=text>
Link: <data:text/plain;charset=utf-8,Copyright 2013 ExampleCo, All Rights Reserved.>; rel="copyright"
</syntaxhighlight>

== unspecified ==
Some rel values have been added to this page perhaps in one of the tables above, but no examples, nor an actual specification explicitly stating that the value(s) should be used in the HTML 'rel' attribute could be found. They are listed here in the hopes someone can discover more specific/precise URLs to examples or specifications about them (preferably both). Until such precise URLs to examples/specs are provided, the values can be treated as they are purely theoretical and thus of little interest.

A simple list here is sufficient.

== non HTML rel values ==
There are markup languages other than HTML that also have a rel attribute, often based upon the HTML rel attribute.
It is useful to document some of these other languages and their rel values for both reference purposes, and to provide background research for the possible development and re-use of these values in HTML, as [[poshformats]] or [[microformats]]

Sources:
* [[Atom]] [[RFC4287]] specification.
* See http://www.iana.org/assignments/link-relations.html for more.
* See [http://amundsen.com/media-types/maze/format/#link-relations Maze+XML]
* See [http://amundsen.com/media-types/collection/format/#link-relations Collection+JSON]
* See [http://www.opensearch.org/Specifications/OpenSearch/1.1#Url_rel_values OpenSearch]
* See [http://tools.ietf.org/html/rfc6861 The Create-Form and Edit-Form Link Relations (RFC6861)]
* See [http://rels.messages.io Workflow-Related Link Relations at Messages.io]

{| border="1"
|+
! rel value !! summary (from the relevant specification where possible)) !! defining specification

|-
| self
| From http://www.ietf.org/rfc/rfc4287.txt : <blockquote>The value "self" signifies that the IRI in the value of the href attribute identifies a resource equivalent to the containing element.</blockquote>
| [[Atom]] http://www.ietf.org/rfc/rfc4287.txt

|-
| http://gdata.youtube.com/schemas/2007#in-reply-to || See http://code.google.com/apis/youtube/2.0/developers_guide_protocol_comments.html || YouTube extension to Atom

|-
| collection || Refers to a resource which represents a collection of which the current resource is a member.

When used in the Maze+XML media type, the associated URI returns the available collection of mazes.
|| Maze+XML, Collection+JSON, OpenSearch

|-
| compensatingtx || Link to a resource representing information about a compensating transaction for each member transaction of a [http://www.cs.cornell.edu/andru/cs711/2002fa/reading/sagas.pdf Long-Lived Compensating Transaction] || See [http://rels.messages.io/#compensatingtx Compensating Transaction Link Relation]

|-
| east || Refers to a resource to the "east" of the current resource.

When used in the Maze+XML media type, the associated URI points to a neighboring cell resource to the east in the active maze.

|| Maze+XML

|-
| events || Link to a collection resource representing a list of subscribe-able events. || See [http://rels.messages.io/#events Events Link Relation]

|-
| exit || Refers to a resource that represents the exit or end of the current client actvity or process.

When used in the Maze+XML media type, the associated URI points to the final exit resource of the active maze.

|| Maze+XML

|-
| north || Refers to a resource that is "north" of the current resource.

When used in the Maze+XML media type, the associated URI points to a neighboring cell resource to the north in the active maze.

|| Maze+XML

|-
| south || Refers to a resource that is "south" of the current resource.

When used in the Maze+XML media type, the associated URI points to a neighboring cell resource to the south in the active maze.

|| Maze+XML

|-
| [[rel-via|via]] || Identifies a resource that is the source of the information in the context. || Atom 1.0 Syndication format (RFC 4287)

|-
| west || Refers to a resource that is "west" of the current resource.

When used in the Maze+XML media type, the associated URI points to a neighboring cell resource to the west in the active maze.

|| Maze+XML

|-
| item || The target IRI points to a resource that is a member of a collection represented by the context IRI. || Collection+JSON

|-
| create-form || When included in a resource, the "create-form" link relation MAY identify a target resource that represents the form to append a new member to the link context. || See [http://tools.ietf.org/html/rfc6861 The Create-Form and Edit-Form Link Relations (RFC6861)]

|-
| edit-form || When included in a resource, the "edit-form" link relation identifies a target resource that represents the form for editing associated resource. || See [http://tools.ietf.org/html/rfc6861 The Create-Form and Edit-Form Link Relations (RFC6861)]

|-
| lightframe || Opens the target in a lightbox. On inclusion it provides a simple target the lightframe and loads the content in a lightbox effect || Lightbox

|-
| superbox[image] || jQuery Superbox! is a script which allows you display windows with the lightbox effect. || superbox

|-
| wp-video-lightbox || wp-video-lightbox! is a rel to anchor tag script display videos with the lightbox effect. || wp-video-lightbox

|-
| youtube || Opens the target youtube video in using the Swipebox Plugin || Swipebox

|-
| shadowbox || shadowbox is a jQuery script for images displaying with the "lightbox" effects. || shadowbox

|-
| permission || When included in a resource, the "permission" link relation MAY identify a target resource that represents the list of entities that can access or modify the resource in the link context. || See [http://cdoc.io/spec.html#permission-link-relation Collection Document Media Type Specification]

|-
| sub || When included in a resource representation of an event, the "sub" (subscription) link relation MAY identify a target resource that represents the ability to subscribe to the pub/sub event-type resource in the link context. || See [http://rels.messages.io/#sub Subscription Link Relation]

|-
| unsub || When included in a resource representation of an event, the "unsub" (subscription cancellation) link relation MAY identify a target resource that represents the ability to un-subscribe from the pub/sub event-type resource in the link context. || See [http://rels.messages.io/#unsub Subscription Cancellation Link Relation]

|-
| version-history
| When included on a versioned resource, this link points to a resource containing the version history for this resource.
| [http://tools.ietf.org/html/rfc5829 RFC 5829]

|-
| latest-version
| When included on a versioned resource, this link points to a resource containing the latest (e.g., current) version.
| [http://tools.ietf.org/html/rfc5829 RFC 5829]

|-
| working-copy
| When included on a versioned resource, this link points to a working copy for this resource.
| [http://tools.ietf.org/html/rfc5829 RFC 5829]

|-
| working-copy-of
| When included on a working copy, this link points to the versioned resource from which this working copy was obtained.
| [http://tools.ietf.org/html/rfc5829 RFC 5829]

|-
| predecessor-version
| When included on a versioned resource, this link points to a resource containing the predecessor version in the version history.
| [http://tools.ietf.org/html/rfc5829 RFC 5829]

|-
| successor-version
| When included on a versioned resource, this link points to a resource containing the successor version in the version history.
| [http://tools.ietf.org/html/rfc5829 RFC 5829]

|-
| ... || ... || ...

|}

== dropped ==
The following rel values were in earlier version(s) of specification(s) and it is presumed by their absence from the most recent version of the respective specification(s) that they have been deprecated or obsoleted.

In general, you {{should not}} use any dropped values.

If any such values have been superceded by standard values (see the first table on this page), then you {{must not}} use the dropped versions.

In particular:
* if a rel value was in a draft and is missing (without explanation) from the final spec, or
* if a rel value was in a previous version of and is missing (without explanation) from an update to the specification (even a draft update)

Then absent any other information or explanation, it is presumed that the group/editors working on that specification decided to explicitly drop it (either in development, or in the updated version) and thus it should be obsoleted (not re-registered).

If you wish to add them, please research why such values were omitted from latter specifications before doing so. If you do discover the reasoning, please add a short statement or link to thereof into the appropriate place in the following table.

If there is more data, e.g. a link to an email of discussion of the spec development that explains ''why'' the rel value was dropped, and it explicitly states, e.g. it was without prejudice, or merely post-poned, or perhaps expected to be spun-out into its spec (or some other explicit positive reason), then it makes to link/cite that explicit text as part of a proposal.

Sources:
* [http://www.w3.org/MarkUp/html3/ HTML3] (HTML3) / has been superceded by [http://www.w3.org/MarkUp/Wilbur/ HTML 3.2] - which itself has been superceded by [http://www.w3.org/TR/REC-html40 HTML 4.0] - which itself has been updated by [http://w3.org/TR/html401 HTML 4.01], commonly referred to as "HTML 4" in this wiki and other places.)
* [http://www.w3.org/TR/relations.html Proposed HTML 4.0 link types] (HTML4dropped) - obsoleted/superceded by the HTML 4.0 Recommendation. Any values that were in the "Proposed HTML 4.0 link types" document but didn't make it into the HTML 4.0 Recommendation were thus explicitly dropped and should be avoided.

{| border="1"
|+
! rel value !! summary !! defining specification !! why dropped

|-
|[[rel-banner|banner]]||Was used to reference another document to be used as banner for this document (i.e. a form of "include" statement).|| HTML3 ||unknown

|-
| [[rel-begin|begin]] || identifies the author-defined start of a sequence of documents of which the current document is a node.
|| HTML4dropped||unknown

|-
| [[rel-biblioentry|biblioentry]] || identifies a bibliographic entry || HTML4dropped||unknown

|-
| [[rel-bibliography|bibliography]] || identifies a bibliography || HTML4dropped||unknown

|-
| [[rel-child|child]] (obsolete/superceded) || the target document is a hierarchical child, or subdocument, of the current document|| HTML4dropped||unknown

|-
| [[rel-citation|citation]] || the target is a bibliographic citation || HTML4dropped||unknown

|-
| [[rel-collection|collection]] || the target document is an collection that contains the current document || HTML4dropped||unknown

|-
| [[rel-definition|definition]] || identifies a definition of a term || HTML4dropped||unknown

|-
| [[rel-disclaimer|disclaimer]] || identifies a hypertext link to a legal disclaimer || HTML4dropped||unknown

|-
| [[rel-editor|editor]] || identifies a hypertext link to an editor || HTML4dropped||unknown

|-
| [[rel-end|end]] || identifies the author-defined end of a sequence of documents of which the current document is a node. || HTML4dropped||unknown

|-
| [[rel-footnote|footnote]] || the anchor is a footnote marker and the target is a footnote || HTML4dropped||unknown

|-
| [[rel-navigate|navigate]] || the target document contains information such as a image map that will help users to gain a sense of how and where to found information || HTML4dropped||unknown

|-
| [[rel-origin|origin]] || synonym for <code>top</code> || HTML4dropped||unknown

|-
| [[rel-parent|parent]] (obsolete/superceded) || the target document is the hierarchical parent, or container, of the current document|| HTML4dropped||unknown

|-
| [[rel-pointer|pointer]] || the target is a pointer to the real target. This value can be used by a user agent to perform a pre-fetch of the specified target for evaluation until the real target is reached || HTML4dropped||unknown

|-
| [[rel-publisher|publisher]] || identifies a hypertext link to a publisher || HTML4dropped||unknown

|-
| [[rel-sibling|sibling]] (obsolete/superceded) || the target document is a child of a common parent, or a hierarchical peer of the current document|| HTML4dropped||unknown

|-
| [[rel-top|top]] || the target document is the logical top node of the tree (see also <code>begin</code>) || HTML4dropped||unknown

|-
| [[rel-trademark|trademark]] || identifies a hypertext link to a trademark notice || HTML4dropped||unknown

|-
| [[rel-translation|translation]] || the target is a translation to another language || HTML4dropped||unknown

|-
| [[rel-urc|urc]] || identifies a Universal Resource Citation || HTML4dropped||unknown

|-
|}

== dropped without prejudice ==
In one known instance (from HTML4 to HTML5), some rel values were in an earlier version of a specification (or a proposal) and were dropped from a latter (draft) version, and it was noted that these values were dropped with the intent that they could still be proposed in a registry and thus they explicitly were not deprecated or obsoleted. This section documents such values as separate from the [[#dropped|dropped]] section.

In general, you {{should not}} use any dropped values.

If any such values have been superceded by standard values (see the first table on this page), then you {{must not}} use the dropped versions.

Rel values that were dropped without prejudice from a specification will be considered similar to new values that have never been specified.

If you know of additional rel values that were dropped without prejudice from an update to a specification, please cite a URL and quote from the group developing the specification that officially states from that group that the dropping of the values was done without prejudice, or equivalent statement (such as explicit allowance of external registration, proposal, and/or development).

This table serves a historical purpose. If you wish to propose a value from this table, please copy it and leave it in place.

Sources:
* Several rel values were [http://www.w3.org/Bugs/Public/show_bug.cgi?id=7475#c15 explicitly dropped from HTML5]. Per: [http://lists.w3.org/Archives/Public/public-html/2011Feb/att-0481/issue-118-decision.html Issue 118 Decision] ('''emphasis''' added): <blockquote>"The final proposal argues for the removal of some relation values, to wit, it suggests removal of '''index, up, first and last'''. It was pointed out in survey comments that these relations are already registered in the IANA link relation registry. Presumably, '''these relations could also be entered in whatever other registry or registries HTML5 adopts for this purpose'''...."Next Steps..."Since the relations to be removed are already registered at the IANA link relation registry, no further action is needed to include them there. WG members are '''free to register or record these relations elsehwere''' [sic], as well."</blockquote>

{| border="1"
|+
! rel value
! summary
! defining specification
! why dropped

|-
| [[rel-first|first]]
| Synonym for <code>start</code>
| HTML4dropped - never in an official spec
| [http://lists.w3.org/Archives/Public/public-html/2011Feb/att-0481/issue-118-decision.html Explicitly dropped from HTML5 interim draft yet permitted for external registry]

|-
| [[rel-index|index]]
| Refers to a document providing an index for the current document.
| was in [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4]; the token has been re-registered within the [[#HTML5_link_type_extensions|HTML5 link type extensions]] and is now valid.
| [http://lists.w3.org/Archives/Public/public-html/2011Feb/att-0481/issue-118-decision.html Explicitly dropped from HTML5 interim draft yet permitted for external registry]

|-
| [[rel-last|last]]
| Refers to the last document in a collection of documents.
| HTML4dropped - never in an official spec
| [http://lists.w3.org/Archives/Public/public-html/2011Feb/att-0481/issue-118-decision.html Explicitly dropped from HTML5 interim draft yet permitted for external registry]

|-
| [[rel-up|up]]
| When the document forms part of a hierarchy, this link references the immediate parent of the current document. Synonym for <code>parent</code>.
| was in [http://www.w3.org/MarkUp/html3/dochead.html HTML3] - but [http://www.w3.org/TR/html401/types.html#type-links dropped in HTML4]
| [http://lists.w3.org/Archives/Public/public-html/2011Feb/att-0481/issue-118-decision.html Explicitly dropped from HTML5 interim draft yet permitted for external registry]

|-
|}

See related [http://dev.w3.org/html5/spec/links.html#linkTypes HTML5: Link types] for existing HTML5 specified rel values.

== rejected ==
Some rel values have been proposed and rejected. They are listed here to make that explicit. Authors {{must not}} use rejected rel values.

Source: [[rejected-formats]].

{| border="1"
|+
! rel value !! origin / proposal !! why rejected
|-
| [[rel-logo|logo]]
| [http://relogo.org Relogo.org]
| [[rejected-formats#Logo]]
|-
|[[rel-pavatar|pavatar]] || [http://pavatar.com/ pavatar] || [[rejected-formats#Pavatar]]
|-
|}

== tools ==
See [[implementations]].

== addtional external research ==
Here are some additional historical references to the development or rel-values which may be useful when researching values, especially why specific values may have been proposed but abandoned.
* 1996-06-07 [http://www.w3.org/MarkUp/draft-ietf-html-relrev-00.txt Hypertext links in HTML] (copies: [http://ftp.ics.uci.edu/pub/ietf/html/draft-ietf-html-relrev-00.txt ftp.ics.uci.edu])
* 1996-11-13 [http://www.w3.org/Architecture/NOTE-link Describing and Linking Web Resources]
* 1997-01-23 [http://lists.gnu.org/archive/html/lynx-dev/1997-01/msg00537.html LYNX-DEV Lynx and the LINK tag]
* 1997-01-24 [http://lists.w3.org/Archives/Public/w3c-sgml-wg/1997Jan/0357.html Taxonomy list]
* 1997-03-28 [http://www.w3.org/TR/WD-htmllink-970328 W3C Working Draft: Hypertext Links and Meta Information in HTML]

=== previous attempts at documenting ===
There have been previous attempts at documenting known rel values, most of which fell out of date due to being dependent on a single author maintaining them. They're listed here purely for historical reasons, and are not sufficient to be references of their own (since they're just individual curations of other references)
* [http://fantasai.tripod.com/qref/Appendix/LinkTypes/ltdef.html Link Type Definitions Glossary] by fantasai
* ...

== related ==
{{rel-related-pages}}
* [[elemental-microformats]]
* [[existing-rev-values]]
* [[existing-class-names]]

== copyright ==

{{cc-pd-license}}

existing-rel-values

2025-10-11T17:17:06Z

Tantek: add rel-authn with IndieWeb wiki page for it as spec, good enough for now

{{DISPLAYTITLE: existing rel values }}

This page contains tables of known HTML rel values from specifications, formats, proposals, brainstorms, and non-trivial [[POSH]] usage in the wild. In addition, dropped and rejected values are listed at the end for comprehensiveness.

usage: see [[rel-faq#How_is_rel_used|how is 'rel' used]]. Regarding rev, see: [[rel-faq#Should_rev_even_be_used|should 'rev' even be used]].

This page is also the official rel registry ([https://html.spec.whatwg.org/multipage/links.html#other-link-types WHATWG HTML] ([http://www.whatwg.org/specs/web-apps/current-work/multipage/links.html#other-link-types original link]), [http://www.w3.org/TR/html5/links.html#other-link-types W3C HTML5]). Add new and proposed rel values to the following section:
* [[existing-rel-values#HTML5_link_type_extensions|HTML5 link type extension]]

== formats ==
These rel values are defined formats from specifications (HTML 4, microformats) are thus are recommended for general use. Alphabetically ordered by value.

Note:
* Do not add proposed rel values for HTML5 here, add them to the [[#HTML5_link_type_extensions|HTML5 link type extensions]] table.
* Do not add rel values you find in the wild to this table of rel formats, instead add them to the table in the [[existing-rel-values#POSH_usage|POSH section]].
* Do not add non-HTML rel values you find to this table of rel formats, instead add them to the table in the [[existing-rel-values#non_HTML_rel_values|non HTML rel values section]].
* Do not add rel values from obsolete/superceded proposals or drafts, instead add them to the table in the "dropped" section.

Sources:
* W3C Recommendations:
** [http://www.w3.org/TR/html401/types.html#h-6.12 HTML 4.01 section 6.12 Link types] (HTML4 Link types)
** [http://www.w3.org/TR/grddl/ Gleaning Resource Descriptions from Dialects of Languages] (GRDDL)
* [[microformats]] specifications
** [[xfn]]
** [[rel-license]]
** [[rel-nofollow]]

{| border="1"
|+
! Keyword
! Effect on <code>link</code>
! Effect on <code>a</code>, <code>area</code>
! Brief description (from the relevant specification where possible)
! Link to defining specification

|-
| [[rel-acquaintance|acquaintance]]
| not allowed
| external relation
| the person represented by the current document considers the person represented by the referenced document to be an acquaintance
| [[XFN]]

|-
| [[rel-alternate|alternate]]
| external resource
| external relation
| Designates substitute versions for the document in which the link occurs. When used together with the <code>lang</code> attribute, it implies a translated version of the document. When used together with the <code>media</code> attribute, it implies a version designed for a different medium (or media).
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-appendix|appendix]]
| allowed
| allowed
| Refers to a document serving as an appendix in a collection of documents.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-bookmark|bookmark]]
| not allowed
| allowed
| Refers to a bookmark. A bookmark is a link to a key entry point within an extended document. The <code>title</code> attribute may be used, for example, to label the bookmark. Note that several bookmarks may be defined in each document.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-chapter|chapter]]
| allowed
| allowed
| Refers to a document serving as a chapter in a collection of documents.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-child|child]]
| external relation
| external relation
| The referenced person is a child of the person represented by the current document. It may also indicate that the target document is a hierarchical child, or subdocument, of the current document.
| [[XFN]], [https://www.w3.org/TR/relations.html HTML 4.0 Specification]

|-
| [[rel-colleague|colleague]]
| not allowed
| external relation
| the referenced person is a colleague of the person represented by the current document
| [[XFN]]

|-
| [[rel-contact|contact]]
| not allowed
| external relation
| the person represented by the current document considers the person represented by the referenced document to be a contact
| [[XFN]]

|-
| [[rel-contents|contents]]
| allowed
| allowed
| Refers to a document serving as a table of contents. Some user agents also support the synonym ToC (from "Table of Contents").
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-copyright|copyright]]
| allowed
| allowed
| Refers to a copyright statement for the current document.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-co-resident|co-resident]]
| not allowed
| external relation
| the referenced person lives in the same residence as the person represented by the current document
| [[XFN]]

|-
| [[rel-co-worker|co-worker]]
| not allowed
| external relation
| the referenced person is a co-worker of the person represented by the current document
| [[XFN]]

|-
| [[rel-crush|crush]]
| not allowed
| external relation
| this person considers the referenced person to be a crush (i.e. has a crush on the referenced person)
| [[XFN]]

|-
| [[rel-date|date]]
| not allowed
| external relation
| this person considers the referenced person to be a date (i.e. is dating the referenced person)
| [[XFN]]

|-
| [[rel-friend|friend]]
| not allowed
| external relation
| the person represented by the current document considers the person represented by the referenced document to be a friend
| [[XFN]]

|-
| [[rel-glossary|glossary]]
| allowed
| allowed
| Refers to a document providing a list of terms and their definitions that pertain to the current document.||[http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-help|help]]
| allowed
| allowed
| Refers to a document offering help (more information, links to other sources information, etc.)
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-its-rules|its-rules]]
| allowed
| not allowed
| Refers to a document with external ITS rules.
| [http://www.w3.org/TR/its20/#selection-global-html5 Internationalization Tag Set (ITS) Version 2.0]

|-
| [[rel-kin|kin]]
| not allowed
| external relation
| the referenced person is part of the extended family of the person represented by the current document
| [[XFN]]

|-
| [[rel-license|license]]
| allowed
| allowed
| …indicates that the <nowiki>[referenced document]</nowiki> is a license for the current page.
| [[rel-license]]

|-
| [[rel-me|me]]
| external relation
| external relation
| the referenced document represents the same person as does the current document
| [[XFN]]

|-
| [[rel-met|met]]
| not allowed
| external relation
| this person has met the referenced person
| [[XFN]]

|-
| [[rel-muse|muse]]
| not allowed
| external relation
| the referenced person inspires the person represented by the current document
| [[XFN]]

|-
| [[rel-neighbor|neighbor]]
| not allowed
| external relation
| the referenced person lives nearby the person represented by the current document
| [[XFN]]

|-
| [[rel-next|next]]
| external relation
| external relation
| Refers to the next document in a linear sequence of documents. User agents may choose to preload the "next" document, to reduce the perceived load time.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-nofollow|nofollow]]
| not allowed
| external relation
| indicates that the destination of that hyperlink {{should-not}} be afforded any additional weight or ranking by user agents which perform link analysis upon web pages (e.g. search engines).
| [[rel-nofollow]]

|-
| [[rel-parent|parent]]
| external relation
| external relation
| The referenced person is a parent of the person represented by the current document. It may also indicate that the target document is the hierarchical parent, or container, of the current document.
| [[XFN]], [https://www.w3.org/TR/relations.html HTML 4.0 Specification]

|-
| [[rel-prev|prev]]
| external relation
| external relation
| Refers to the previous document in an ordered series of documents. Some user agents also support the synonym "Previous".
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-previous|previous]]
| external relation
| external relation
| Synonym of <code>prev</code>
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-section|section]]
| allowed
| allowed
| Refers to a document serving as a section in a collection of documents.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-sibling|sibling]]
| not allowed
| external relation
| the referenced person is a sibling of the person represented by the current document
| [[XFN]]

|-
| [[rel-spouse|spouse]]
| not allowed
| external relation
| the referenced person is a spouse of the person represented by the current document
| [[XFN]]

|-
| [[rel-start|start]]
| allowed
| allowed
| Refers to the first document in a collection of documents. This link type tells search engines which document is considered by the author to be the starting point of the collection.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-stylesheet|stylesheet]]
| external resource
| not allowed
| a style sheet for the current document used with the invisible <link href> element which is not ideal for content relationships. Content relationships should be user visible and thus uses with <a href> are strongly preferred. Unfortunately the use of stylesheet in user visible content like <a href> appears to be strictly theoretical.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-subsection|subsection]]
| allowed
| allowed
| Refers to a document serving as a subsection in a collection of documents.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-sweetheart|sweetheart]]
| not allowed
| external relation
| this person considers the referenced person to be their sweetheart
| [[XFN]]

|-
| [[rel-tag|tag]]
| not allowed
| allowed
| …indicates that the <nowiki>[referenced document]</nowiki> is an author-designated "tag" (or keyword/subject) for the current page.
| [[rel-tag]]

|-
| [[rel-toc|toc]]
| allowed
| allowed
| Synonym of <code>contents</code> (from "Table Of Contents")
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4 Link types]

|-
| [[rel-transformation|transformation]]
| allowed
| allowed
| Relates a source document to a transformation, usually represented in XSLT, that relates the source document syntax to the RDF graph syntax. Used in [[grddl|GRDDL]]
| [http://www.w3.org/TR/grddl/#transformation GRDDL]

|}

=== notes ===
*<code>rel="alternate"</code> can take further meaning from additional attributes, such as
** <code>rel="alternate" lang="fr"</code> (French language version of this page)
** <code>rel="alternate" media="print"</code> (printable version of this page)
** <code>rel="alternate" media="handheld"</code> (version of the page intended or better for handheld/portable devices like PDAs, cell phones, etc.)

*Synonyms such as "previous", "toc" are not as widely supported as the main term.

== proposals ==
A few rel values have been developed as drafts as a result of going through most of the microformats [[process]], and are thus listed here for your serious consideration. You may use these values, and if you find any problems with them please point them out on the respective "issues" page for the rel value.

{| border="1"
|+
! rel value !! summary !! proposed in !! external spec (if any)
|-
| [[rel-pronunciation|pronunciation]] || …indicates that the destination of the 'link' element is a document providing a pronunciation lexicon for speech-synthesis purposes. || [[rel-pronunciation]]
|-
| [[rel-directory|directory]] || …indicates that the destination of the hyperlink is a directory listing containing an entry for the current page. || [[rel-directory]]
|-
| [[rel-enclosure|enclosure]] || …indicates that the destination of that hyperlink is intended to be downloaded and cached. || [[rel-enclosure]] || [http://www.apps.ietf.org/rfc/rfc4287.html RFC4287]
|-
| [[rel-home|home]] || …indicates that the <nowiki>[referenced document]</nowiki> is the homepage of the site in which the current page appears. || [[rel-home]]
|-
| [[rel-payment|payment]] || …indicates that the destination of the hyperlink provides a way to show or give support (e.g. financial) for the current page|| [[rel-payment]]
|-
| vcs-* || …indicates that the destination of the hyperlink is the location of a Version Control System repository related to that page.|| || [https://joeyh.name/rfc/rel-vcs/ rel=vcs-*]
|}

== HTML5 link type extensions ==

The following values are registered as link type extensions per the [http://www.whatwg.org/specs/web-apps/current-work/multipage/links.html#other-link-types requirements in the WHATWG HTML spec] and the [http://www.w3.org/TR/html5/links.html#other-link-types requirements in the W3C HTML5 spec].

Before you register a new value:
* '''Please check the [[#formats|Formats table]] and DO NOT re-register''' rel values that are already there. Please note that the W3C HTML WG has made a [http://lists.w3.org/Archives/Public/public-html/2011Feb/att-0481/issue-118-decision.html Decision] to drop <code>index</code>, <code>up</code>, <code>first</code> and <code>last</code> from the HTML5 spec itself.
* '''Please check the [[#dropped|Dropped table]] and DO NOT register''' values that are already there. If you believe a rel value was dropped from another specification without prejudice, please provide link/cite to explicit text/decision stating as such, e.g. the value was merely postponed, or perhaps expected to be spun-out into its own spec from the group developing that specification.

Note that entries in the [[#formats|Formats table]] and entries that are already in HTML5 as built-in keywords are also considered extensions with the "Ratified" status.

Please make sure that registrations added here have all the required data filled in ''including'':
* "Effect on link"
* "Effect on a and area" and
* a link to a spec that documents the keyword ''as an HTML <code>rel</code> keyword''. (A spec that merely defines the file format of the link target but does not define the <code>rel</code> keyword for use in HTML is not the kind of spec that is being required here.)

Entries lacking any of the above required data will likely be removed.

Changes to this registry will not be reflected in validators in real time. But validators will typically get automatically updated with the changes within one week or so

{| border="1"
|+
! Keyword
! Effect on <code>link</code>
! Effect on <code>a</code>, <code>area</code>
! Brief description
! Link to specification
! Synonyms
! Status

|-
| [[rel-about|about]]
| Hyperlink
| Hyperlink
| The resource linked to contains information about the current page.
| [https://www.rfc-editor.org/rfc/rfc6903.html#section-2 RFC6903]
| It might combine with [[rel-me]] or [[rel-author]] in links to an "about" section focused on an author
| proposed

|-
| [[rel-amphtml|amphtml]]
| Hyperlink
| Hyperlink
| Specify an alternate version of the document written in AMP HTML
| [https://github.com/ampproject/amphtml AMP HTML documentation]
| could be combined with rel=alternate
| proposed

|-
| [[rel-apple-touch-icon|apple-touch-icon]]
| External Resource
| Not allowed
| Specify a Webpage Icon for a “Web Clip”, or “touch icon”, for mobile devices (not limited to Apple devices).
| [http://developer.apple.com/library/safari/#documentation/appleapplications/reference/safariwebcontent/configuringwebapplications/configuringwebapplications.html Apple's Safari Web Content Guide]
| probably redundant with rel=icon
| proposed

|-
| [[rel-apple-touch-icon-precomposed|apple-touch-icon-precomposed]]
| External Resource
| Not allowed
| Specify a Webpage Icon for a “Web Clip”, or “touch icon”, for mobile devices (not limited to Apple devices).
| [http://developer.apple.com/library/safari/#documentation/appleapplications/reference/safariwebcontent/configuringwebapplications/configuringwebapplications.html Apple's Safari Web Content Guide]
| probably redundant with rel=icon
| proposed

|-
| [[rel-apple-touch-startup-image|apple-touch-startup-image]]
| External Resource
| Not allowed
| Specify a splashscreen for Web apps on iOS Safari
| [http://developer.apple.com/library/safari/#documentation/appleapplications/reference/safariwebcontent/configuringwebapplications/configuringwebapplications.html Apple's Safari Web Content Guide]
| maybe redundant with rel=icon with the sizes attribute?
| proposed

|-
| [[rel-archived|archived]]
| External Resource
| Hyperlink Annotation
| The target resource is archived and kept largely or solely for historical purposes.
| [https://sitemorse.com/rel-archived/ rel="archived" description]
|
| proposed

|-
| [[rel-attachment|attachment]]
| Hyperlink
| Hyperlink
| The resource linked to is "attached" to this document, similar to email attachments. Used in WordPress.
| No formal specification
|
| proposed

|-
| [[rel-authn|authn]]
| external relation
| external relation
| use only the referenced profiles (URLs) for authenticating the current page/site/user e.g. via [[rel-me]]
| [https://indieweb.org/rel-authn IndieWeb: rel-authn]
|
| proposed

|-
| [[rel-authorization_endpoint|authorization_endpoint]]
| External Resource
| Not allowed
| Specify a hosted authorization server
| [https://www.w3.org/TR/indieauth/ IndieAuth spec]
|
| proposed

|-
| [[rel-canonical|canonical]]
| Hyperlink
| Hyperlink
| Specifies the canonical URL for the current document in order to help avoid duplicate content.
| [http://en.wikipedia.org/wiki/Canonical_meta_tag Canonical meta tag] [http://www.Google.com/support/webmasters/bin/answer.py?answer=139066#2 Canonicalization at Google Webmaster Central] [http://www.Bing.com/community/site_blogs/b/webmaster/archive/2009/02/12/partnering-to-help-solve-duplicate-content-issues.aspx Microsoft Webmaster Center] [http://www.YSearchBlog.com/2009/02/12/fighting-duplication-adding-more-arrows-to-your-quiver/ Yahoo! Search Blog]
|
| proposed

|-
| [[rel-category|category]]
| Hyperlink
| Hyperlink
| Refers to a category assigned to the current document or post. Implemented by WordPress for indicating a relation between a blog post and a category.
| [[rel-category]]
|
| proposed

|-
| [[rel-code-repository|code-repository]]
| Hyperlink
| Hyperlink
| indicates a code repository location. For link, it specifically indicates, in the case of server-generated content, the location of source code responsible for the generation of the current page, or, in the case of static files, where copies of the current page are housed). If the specific data/content built up at the page is stored separately from the generator (e.g., the code for a CMS vs. the specific CMS instance's SQL tables or JSON data files), this only refers to the generator and [[rel-content-repository|content-repository]] should be used to indicate the location for the storage of content. Otherwise, the code repository can be considered as also including the content. While the repository should contain its own license file, the [[rel-code-license|code-license]] rel-value is proposed as a direct pointer to the license (see also [[rel-content-license|content-license]]).
|
|
| proposed

|-
| [[rel-code-license|code-license]]
| Hyperlink
| Hyperlink
| indicates a license for code (a proposed broader replacement for [[rel-jslicense|jslicense]]). For link, it specifically indicates, in the case of server-generated content, the location of the license for all source code responsible for the generation of the current page, or, in the case of static files, the location of the license for all of these files). If the specific data/content built up at the page is stored separately from the generator (e.g., the code for a CMS vs. the specific CMS instance's SQL tables or JSON data files), this only refers to the generator and [[rel-content-license|content-license]] should be used to indication the license for the content. Otherwise, code-license can be considered as also covering the license of the content. Pointing to the repository containing the static or generator code files should be done with [[rel-code-repository|code-repository]] (and [[rel-content-repository|content-repository]] for any separate content).
|
|
| proposed

|-
| [[rel-component|component]]
| External Resource
| Not allowed
| Specify an HTML document that is treated as a component of this document.
| [https://dvcs.w3.org/hg/webcomponents/raw-file/tip/spec/components/index.html Web Components]
|
| proposed

|-
| [[rel-chrome-webstore-item|chrome-webstore-item]]
| External Resource
| Not allowed
| Link tag to declare for app and extensions inline installations hosted in the Chrome Web Store.
| [https://developers.google.com/chrome/web-store/docs/inline_installation Using Inline Installation]
|
| proposed

|-
| [[rel-content-repository|content-repository]]
| Hyperlink
| Hyperlink
| indicates a repository housing data content. For link, it specifically indicates, in the case of server-generated content, the location where separately housed data files used to populate the current page are stored (otherwise "code-repository" is sufficient to include content as well as code). If the specific data/content built up at the page is stored separately from the generator (e.g., the code for a CMS vs. the specific CMS instance's SQL tables or JSON data files), this only refers to the data/content files and [[rel-code-repository|code-repository]] should be used to indicate the location for the storage of the generator source files. Otherwise, [[rel-code-repository|code-repository]] can be considered as also including the content instead. While the repository should contain its own license file, the [[rel-content-license|content-license]] rel-value is proposed as a direct pointer to the license (see also [[rel-code-license|code-license]]).
|
|
| proposed

|-
| [[rel-content-license|content-license]]
| Hyperlink
| Hyperlink
| indicates a license for data content. For link, it specifically indicates, in the case of server-generated content, the location of the license for all separately housed data files used to populate the current page are stored, (otherwise "code-license" is sufficient to cover the license of content as well as code)). If the specific data/content built up at the page is stored separately from the generator (e.g., the code for a CMS vs. the specific CMS instance's SQL tables or JSON data files), this only refers to the data/content files and [[rel-code-license|code-license]] should be used to indication the license for the generator source files. Otherwise, code-license can be considered as also covering the license of the content. Pointing to the repository containing the data files should be done with [[rel-content-repository|content-repository]] (and [[rel-code-repository|code-repository]] for the static or generator code files).
|
|
| proposed

|-
| [[rel-dcterms.(property)#conformsTo|DCTERMS.conformsTo]]
| External Resource
| Not allowed
| An established standard to which the described resource conforms. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
| It may be replaced by the literal value in form of <code><meta name="DCTERMS.conformsTo" content="..." /></code>
| proposed

|-
| [[rel-dcterms.(property)#contributor|DCTERMS.contributor]]
| External Resource
| Not allowed
| An entity responsible for making contributions to the resource. Examples include a person, an organization, or a service. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
| It may be replaced by the literal value in form of <code><meta name="DCTERMS.contributor" content="..." /></code>
| proposed

|-
| [[rel-dcterms.(property)#creator|DCTERMS.creator]]
| External Resource
| Not allowed
| An entity primarily responsible for making the resource. Examples include a person, an organization, or a service. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
| It may be replaced by the literal value in form of <code><meta name="DCTERMS.creator" content="..." /></code>
| proposed

|-
| [[rel-dcterms.(property)#description|DCTERMS.description]]
| External Resource
| Not allowed
| An account of the resource. Description may include but is not limited to: an abstract, a table of contents, a graphical representation, or a free-text account of the resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
| It may be replaced by the literal value in form of <code><meta name="DCTERMS.description" content="..." /></code>
| proposed

|-
| [[rel-dcterms.(property)#hasFormat|DCTERMS.hasFormat]]
| External Resource
| Not allowed
| A related resource that is substantially the same as the pre-existing described resource, but in another format. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#hasPart|DCTERMS.hasPart]]
| External Resource
| Not allowed
| A related resource that is included either physically or logically in the described resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#hasVersion|DCTERMS.hasVersion]]
| External Resource
| Not allowed
| A related resource that is a version, edition, or adaptation of the described resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#isFormatOf|DCTERMS.isFormatOf]]
| External Resource
| Not allowed
| A related resource that is substantially the same as the described resource, but in another format. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#isPartOf|DCTERMS.isPartOf]]
| External Resource
| Not allowed
| A related resource in which the described resource is physically or logically included. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#isReferencedBy|DCTERMS.isReferencedBy]]
| External Resource
| Not allowed
| A related resource that references, cites, or otherwise points to the described resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#isReplacedBy|DCTERMS.isReplacedBy]]
| External Resource
| Not allowed
| A related resource that supplants, displaces, or supersedes the described resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#isRequiredBy|DCTERMS.isRequiredBy]]
| External Resource
| Not allowed
| A related resource that requires the described resource to support its function, delivery, or coherence. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#isVersionOf|DCTERMS.isVersionOf]]
| External Resource
| Not allowed
| A related resource of which the described resource is a version, edition, or adaptation. Changes in version imply substantive changes in content rather than differences in format. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#license|DCTERMS.license]]
| External Resource
| Not allowed
| A legal document giving official permission to do something with the resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
| It may be replaced by the literal value in form of <code><meta name="DCTERMS.license" content="..." /></code>
| proposed

|-
| [[rel-dcterms.(property)#mediator|DCTERMS.mediator]]
| External Resource
| Not allowed
| An entity that mediates access to the resource and for whom the resource is intended or useful. In an educational context, a mediator might be a parent, teacher, teaching assistant, or care-giver. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
| It may be replaced by the literal value in form of <code><meta name="DCTERMS.mediator" content="..." /></code>
| proposed

|-
| [[rel-dcterms.(property)#publisher|DCTERMS.publisher]]
| External Resource
| Not allowed
| An entity responsible for making the resource available. Examples include a person, an organization, or a service. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
| It may be replaced by the literal value in form of <code><meta name="DCTERMS.publisher" content="..." /></code>
| proposed

|-
| [[rel-dcterms.(property)#references|DCTERMS.references]]
| External Resource
| Not allowed
| A related resource that is referenced, cited, or otherwise pointed to by the described resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#relation|DCTERMS.relation]]
| External Resource
| Not allowed
| A related resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#replaces|DCTERMS.replaces]]
| External Resource
| Not allowed
| A related resource that is supplanted, displaced, or superseded by the described resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#requires|DCTERMS.requires]]
| External Resource
| Not allowed
| A related resource that is required by the described resource to support its function, delivery, or coherence. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#rightsHolder|DCTERMS.rightsHolder]]
| External Resource
| Not allowed
| A person or organization owning or managing rights over the resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
| It may be replaced by the literal value in form of <code><meta name="DCTERMS.rightsHolder" content="..." /></code>
| proposed

|-
| [[rel-dcterms.(property)#source|DCTERMS.source]]
| External Resource
| Not allowed
| A related resource from which the described resource is derived. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-dcterms.(property)#subject|DCTERMS.subject]]
| External Resource
| Not allowed
| The topic of the resource. 
Requires Dublin Core namespace declaration: <code>'''<link rel="schema.DCTERMS" href="<nowiki>http://purl.org/dc/terms/</nowiki>" />'''</code>
| [http://dublincore.org/documents/dcmi-terms/ DCMI Metadata Terms]
|
| proposed

|-
| [[rel-disclosure|disclosure]]
| Not allowed
| External Resource
| The 'disclosure' Link Relation Type designates a list of patent disclosures or a particular patent disclosure itself made with respect to material for which such relation type is specified.
| [http://tools.ietf.org/html/draft-yevstifeyev-disclosure-relation The 'disclosure' Link Relation Type]
|
| proposed

|-
| [[rel-discussion|discussion]]
| Hyperlink
| Hyperlink
| Refers to discussion of the current document or post.
| [[rel-discussion]]
|
| proposed

|-
| [[rel-donation|donation]]
| Hyperlink
| Hyperlink
| Indicates that the destination of the hyperlink provides a way to show or give support (e.g. financial) for the current page on a voluntary basis
| No formal specification
| Closely related to [[rel-payment]]
| proposed

|-
| [[rel-dns-prefetch|dns-prefetch]]
| External Resource
| Not allowed
| Tells the browser to perform dns lookup for host names ahead of use.
| [https://developer.mozilla.org/En/Controlling_DNS_prefetching Mozilla documentation] [http://dev.chromium.org/developers/design-documents/dns-prefetching Google documentation]
|
| proposed

|-
| [[rel-edit|edit]]
| External Resource
| Hyperlink
| Tells the browser the URL for editing the current page
| [http://universaleditbutton.org/Registered_MIME_type#Alternate_Linking_Scheme Universal Edit Button Alternate Linking Scheme]. Implemented in at least [http://mediawiki.org MediaWiki].
|
| proposed

|-
| [[rel-edituri|EditURI]]
| External Resource
| Not allowed
| A blogging auto discovery value, commonly used by WordPress
| [http://bitworking.org/projects/atom/draft-gregorio-09.html#Edit AtomAPI]
|
| proposed

|-
| [[rel-enclosure|enclosure]]
| External Resource
| External Resource
| Indicates that the referred resource is intended to be downloaded and cached.
| [[rel-enclosure]]
|
| proposed

|-
| [[rel-entry-content|entry-content]]
| Not allowed
| External Resource
| Indicates that the referenced document is an alternative display source for an Internet Explorer Web Slice.
| [http://msdn.microsoft.com/en-us/library/cc304073(VS.85).aspx#_alternative Web Slice format specification 0.9]
|
| proposed

|-
| [[rel-external|external]]
| Not allowed
| Hyperlink
| Indicates that the referenced document is not part of the same site as the current document.
| [[rel-external]]
|
| proposed

|-
| [[rel-first|first]]
| Hyperlink
| Hyperlink
| Indicates that the document is part of a sequence, and that the link is leading to the document that is the first logical document in the sequence.
| [https://www.w3.org/TR/2011/WD-html5-20110113/links.html#link-type-first W3C Working Draft 13 January 2011]
|
| proposed

|-
| [[rel-gbfs|gbfs]]
| External Resource
| Not allowed
| The location of the gbfs auto-discovery file
| [https://github.com/NABSA/gbfs/blob/master/gbfs.md General Bikeshare Feed Specification]
|
| proposed

|-
| [[rel-gtfs-static|gtfs-static]]
| External Resource
| Not allowed
| Indicates the associated GTFS Static file
| [https://developers.google.com/transit/gtfs/reference General Transit Feed Specification Reference]
|
| proposed

|-
| [[rel-gtfs-realtime|gtfs-realtime]]
| External Resource
| Not allowed
| Indicates the associated GTFS-Realtime file
| [https://developers.google.com/transit/gtfs-realtime/reference GTFS-realtime Reference]
|
| proposed

|-
| [[rel-home|home]]
| Hyperlink
| Hyperlink
| Refers to the top level document for the current document. It can be combined with 'alternate' to indicate a feed for the site of the current page.
| [[rel-home]]
| [[rel-root]]
| proposed

|-
| [[rel-hub|hub]]
| Hyperlink
| Hyperlink
| Refers to a hub that enables registration for notification of updates to the current page.
| [http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html#discovery PubSubHubbub Spec] [https://www.w3.org/TR/websub/ WebSub spec]
|
| proposed

|-
| [[rel-import|import]]
| External Resource
| Not allowed
| HTML Imports are a way to include and reuse HTML documents in other HTML documents.
| [http://www.w3.org/TR/html-imports HTML Imports]
|
| proposed

|-
| [[rel-in-reply-to|in-reply-to]]
| Hyperlink
| Hyperlink
| Refers to an original post that the current page is a comment on or reply to.
| [[rel-in-reply-to]]
|
| proposed

|-
| [[rel-root|root]]
| Hyperlink
| Hyperlink
| The target document is the root node of the hierarchical tree structure that hosts the current document
| No formal specification
| [[rel-home]]
| proposed

|-
| [[rel-index|index]]
| Hyperlink
| Hyperlink
| Refers to a document providing a list of topics with pointers that pertain to the current document.
| [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4]
|
| proposed

|-
| [[rel-issues|issues]]
| Hyperlink
| Hyperlink
| Refers to issues regarding the current document or specification.
| [[rel-discussion]]
|
| proposed

|-
| [[rel-jslicense|jslicense]]
| Hyperlink
| Hyperlink
| Refers to a document with JavaScript source code and license information (also called a [http://www.gnu.org/licenses/javascript-labels.html JavaScript License Web Labels] page). We might want choose a keyword for this that is more general -- there are many situations besides JavaScript in which it is desirable or required by license agreements (e.g., GNU GPL) to make an offer of both the source code and a copy of a license when distributing object code versions of a given work.
| [[rel-jslicense]]
|
| proposed

|-
| [[rel-last|last]]
| Hyperlink
| Hyperlink
| Indicates that the document is part of a sequence, and that the link is leading to the document that is the last logical document in the sequence.
| [https://www.w3.org/TR/2011/WD-html5-20110113/links.html#link-type-last W3C Working Draft 13 January 2011]
|
| proposed

|-
| [[rel-lightbox|lightbox]]
| Not allowed
| Img Pop-Up
| Images with this attribute are displayed in a larger way than embedded in a website (or how you specified it) when clicked (e.g. with installed "Lightbox 2"-Plugin). When adding [group] to rel="lightbox" all images get a clickable button for next/prev; insert into <code><a rel="lightbox[group]"><img src="http:example.com/img.jpg"></a></code>
| [http://lokeshdhakar.com/projects/lightbox2/ Lightbox 2] (needs actual specification to be kept in this list, this link is just documentation of one implementation)
|
| proposed

|-
| [[rel-lightvideo|lightvideo]]
| Not allowed
| Video Pop-Up
| Loads the video in a lightbox effect
| [https://www.drupal.org/node/252276 Lightbox2 - How to display video content]
|
| proposed

|-
| [[rel-main|main]]
| Hyperlink
| Hyperlink
| The current page is a subsection or a less important page than the target resource
| No formal specification
| It can be a synonym of [[rel-parent]] when the latter refers to a document and not a person. It differs however from [[rel-home]] and [[rel-root]], as the latter refer only to the topmost resource in the hierarchical tree structure (and in this case they may be combined with [[rel-main|main]]). Note that [[rel-main]] does not necessarily refer to a higher node in a tree structure, as the target resource can simply be a more important sibling node.
| proposed

|-
| [[rel-manifest|manifest]]
| External Resource
| Not allowed
| Imports or links to a manifest
| [http://w3c.github.io/manifest/#linking W3C Manifest for web application]
|
| proposed

|-
| [[rel-mask-icon|mask-icon]]
| External Resource
| Not allowed
| Specify a Webpage Icon for a “Pinned Tabs” on Safari 9.
| probably redundant with rel-icon
|
| proposed

|-
| [[rel-meta|meta]]
| External Resource
| Not allowed
| External metadata about the HTML document
| [http://www.w3.org/TR/2004/REC-rdf-syntax-grammar-20040210/#section-rdf-in-HTML W3C's RDF/XML Syntax Specification]
|
| proposed

|-
| [[rel-micropub|micropub]]
| External Resource
| Not allowed
| the micropub endpoint for creating new posts
| [https://www.w3.org/TR/micropub/ Micropub scecification]
|
| proposed

|-
| [[rel-noopener|noopener]]
| Not allowed
| Annotation
| Requires that any browsing context created by following the hyperlink must not have an opener browsing context.
| [https://html.spec.whatwg.org/multipage/semantics.html#link-type-noopener 4.6.6.11 Link type ”noopener"]
|
| proposed

|-
| [[rel-openid.delegate|openid.delegate]]
| External Resource
| Not allowed
| When the page that contains the link is used as an OpenID indentifier, the relying party perform sOpenID 1.1 authentication with the link target as the identifier instead.
| [http://openid.net/specs/openid-authentication-1_1.html#delegating_authentication OpenID Authentication 1.1]
|
| proposed

|-
| [[rel-openid.server|openid.server]]
| External Resource
| Not allowed
| The OpenID server for the relying party to contact for OpenID 1.1 authentication
| [http://openid.net/specs/openid-authentication-1_1.html#anchor4 OpenID Authentication 1.1]
|
| proposed

|-
| [[rel-openid2.local_id|openid2.local_id]]
| External Resource
| Not allowed
| When the page that contains the link is used as an OpenID indentifier, the relying party perform sOpenID 2.0 authentication with the link target as the identifier instead.
| [http://openid.net/specs/openid-authentication-2_0.html#rfc.section.7.3.3 OpenID Authentication 2.0]
|
| proposed

|-
| [[rel-openid2.provider|openid2.provider]]
| External Resource
| Not allowed
| The OpenID server for the relying party to contact for OpenID 2.0 authentication
| [http://openid.net/specs/openid-authentication-2_0.html#rfc.section.7.3.3 OpenID Authentication 2.0]
|
| proposed

|-
| [[rel-p3pv1|p3pv1]]
| External Resource
| Not allowed
| References a machine-readable privacy policy description in the P3P format
| [http://www.w3.org/TR/P3P/#syntax_link P3P spec]
|
| proposed

|-
| [[rel-pgpkey|pgpkey]]
| External Resource
| Not allowed
| Associates a PGP key with a Web page so that the Web page URL can be used as the commenter's URL in PGP-signed blog comments and the blogging system receiving the comment can fetch the key and verify the signature as belonging to the owner of the URL.
| [http://golem.ph.utexas.edu/~distler/blog/archives/000320.html PGP-Signed Comments]
|
| proposed

|-
| [[rel-pingback|pingback]]
| External Resource
| Not allowed
| gives the address of the pingback server that handles pingbacks to the current document
| [http://www.hixie.ch/specs/pingback/pingback Pingback]
|
| proposed

|-
| [[rel-preconnect|preconnect]]
| External Resource
| Not allowed
| Indicates an origin that will be used to fetch required resources. Initiating an early connection, which includes the DNS lookup, TCP handshake, and optional TLS negotiation, allows the user agent to mask the high costs of connection establishment latency.
| [http://www.w3.org/TR/resource-hints/ Resource Hints Working Draft]
|
| proposed

|-
| [[rel-prerender|prerender]]
| External Resource
| External Resource
| Prerenders the Web page targeted by the link including running it scripts.
| [[rel-prerender]]
|
| proposed

|-
| [[rel-profile|profile]]
| External Resource
| Contextual External Resource
| indicate[s] that the destination of that hyperlink is a metadata profile (e.g. an [[XMDP]] profile) for the current page or portion thereof. See also [[xmdp-brainstorming]].
| [http://microformats.org/wiki/rel-profile rel-profile]
|
| proposed

|-
| [[rel-publisher|publisher]]
| External Resource
| External Resource
| Indicates that the referenced document is a metadata profile (e.g., a social-media/real-name profile such as a Google+ profile) for the publisher of the current page, or some portion of the current page.
| [https://support.google.com/plus/answer/1713826?hl=en Google help page]
|
| proposed

|-
| [[rel-radioepg|radioepg]]
| External Resource
| External Resource
| Indicates that the referenced document is a RadioDNS Service Information document (ETSI TS 102 818 s10.2.3) containing information on the radio station that publishes the current page
| [https://radiodns.org/developers/documentation RadioDNS Documentation]
|
| proposed

|-
| [[rel-rendition|rendition]]
| External Resource
| External Resource
| Indicates some example rendering, interpretation, or depiction of the source. User agents may choose to execute, display, or render the target in-place; or navigate to the target.
| [http://www.globalmentor.com/specs/html-rel-rendition/ HTML rel rendition]
|
| proposed

|-
| [[rel-reply-to|reply-to]]
| External Resource
| Hyperlink
| indicates any mailbox(es) (i.e. email addresses) to which responses are to be sent. ''Note: this is distinct from the 'in-reply-to' value which refers to the originating document, not to the address where comments should be sent.
| [http://tools.ietf.org/html/rfc2822 RFC2822] (originally [http://tools.ietf.org/html/rfc822#section-4.4.3 RFC822])
|
| ratified

|-
| [[rel-schema.DCTERMS|schema.DCTERMS]]
| External Resource
| Not allowed
| Maps the prefix "DCTERMS" for use in other Dublin-Core related link relations (such as DCTERMS.creator) and meta keywords
| [http://dublincore.org/documents/dc-html/#sect-4.2 Section 4.2 of "Expressing Dublin Core metadata using HTML/XHTML meta and link elements"]
| see also [https://wiki.whatwg.org/wiki/MetaExtensions "WhatWG MetaExtensions Wiki] for usage examples in meta keywords
| proposed

|-
| [[rel-service|service]]
| External Resource
| Not allowed
| Atom Publishing Protocol editing service autodiscovery.
| [http://wiki.whatwg.org/wiki/ServiceRelExtension Documentation on the WHATWG wiki]
|
| proposed

|-
| [[rel-shortlink|shortlink]]
| External Resource
| Not allowed
| Specifies the preferred shortened URL for the page.
| [http://code.google.com/p/shortlink/wiki/Specification shortlink spec]
|
| proposed

|-
| [[rel-sidebar|sidebar]]
| Hyperlink
| Hyperlink
| Indicates that the referenced document is intended to be shown in a secondary browsing context.
| [[rel-sidebar]]
|
| proposed

|-
| [[rel-sitemap|sitemap]]
| External Resource
| Not allowed
| Provides a link to an XML document describing the layout of the site.
| [[rel-sitemap]]
|
| proposed

|-
| [[rel-subresource|subresource]]
| External Resource
| Not allowed
| An external resource intended for use within the current page.
| [http://www.chromium.org/spdy/link-headers-and-server-hint/link-rel-subresource Chromium documentation]
|
| proposed

|-
| [[rel-sword|sword]]
| Hyperlink
| Not allowed
| SWORD is a lightweight protocol for remotely depositing content into repositories. .[http://swordapp.org/ The SWORD project]
| [[rel-sword]]
|
| proposed

|-
| [[rel-syndication|syndication]]
| Hyperlink
| Hyperlink
| Refers to a page which is a syndicated copy of the current page.
| [[rel-syndication]]
|
| proposed

|-
| [[rel-timesheet|timesheet]]
| External Resource
| Not allowed
| Applies a timesheet to the document.
| [http://www.w3.org/TR/timesheets/#smilTimesheetsNS-Elements-Timesheet non-normative section in the Timesheet spec]
|
| proposed

|-
| [[rel-token_endpoint|token_endpoint]]
| External Resource
| Not allowed
| Specify an HTTP endpoint that Micropub clients can use to obtain an access token given an authorization code
| [https://www.w3.org/TR/indieauth/ IndieAuth spec]
|
| proposed

|-
| [[rel-webmention|webmention]]
| External Resource
| Hyperlink
| gives the address of the webmention endpoint that handles webmentions to the current document
| [https://www.w3.org/TR/webmention/ Webmention specification]
|
| proposed

|-
| [[rel-widget|widget]]
| External Resource
| External Resource
| Autodiscovery for W3C widgets
| [http://dev.w3.org/2006/waf/widgets/Overview.html#linking-to-a-widget-package-from-a-html- non-normative section in the Widget packaging spec]
|
| proposed

|-
| [[rel-wlwmanifest|wlwmanifest]]
| External Resource
| Not allowed
| Windows Live Writer manifest autodiscovery
| [http://msdn.microsoft.com/en-us/library/bb463263.aspx documentation on MSDN]
|
| proposed

|-
| [[rel-image_src|image_src]]
| External Resource
| Not allowed
| Specify a Webpage Icon for use by Facebook, Yahoo, Digg, etc.
| Unknown, but see for instance [http://www.niallkennedy.com/blog/2009/03/enhanced-social-share.html this]
| probably redundant with rel=icon
| proposed

|-
| [[rel-cmis-acl|http://docs.oasis-open.org/ns/cmis/link/200908/acl]]
| External Resource
| External Resource
| Identifies the resource containing a CMIS ACL document for the link context
| [http://docs.oasis-open.org/cmis/CMIS/v1.0/cs01/cmis-spec-v1.0.html#_Toc243905525 CMIS 1.0, Section 3.4.3.4]
|
| proposed

|-
| [[rel-stylesheet/less|stylesheet/less]]
| External Resource
| Not allowed
| Less CSS framework stylesheets.
| [http://lesscss.org/#-client-side-usage Less CSS usage]
|
| proposed

|-
| [[rel-yandex-tableau-widget|yandex-tableau-widget]]
| External Resource
| Not allowed
| Lets webmasters configure the appearance of their own site widgets in Yandex.Browser
| [https://api.yandex.com/tableau/ Yandex's Tableau API]
|
| proposed

|}

== brainstorming ==
Several rel values are being brainstormed as potential microformats and are thus listed here. If you find you have a use for such semantics in real world examples, consider trying out these values and provide feedback on the respective brainstorming page(s) with your results and experiences.

You may list new proposed rel values here, and even better if you can list and link to POSH uses in the wild.

{| border="1"
|+
! rel value !! summary !! brainstormed in and usage in the wild

|-
| [[rel-accessibility|accessibility]] || indicate[s] that the destination of that hyperlink contains accessibility information for the current page. || [http://www.brucelawson.co.uk/2009/rel-accessibility/ blog post] which itself uses the rel value in a <link> tag in the head of the document.

|-
| [[rel-author|author]] || indicate[s] that the destination of that hyperlink represents the author of the current page. Combines with [[rel-me|rel-me]] to chain authorship information. || Google has said it will index rel-Author in this [http://googlewebmastercentral.blogspot.com/2011/06/authorship-markup-and-web-search.html blog post], with further [http://www.google.com/support/webmasters/bin/answer.py?answer=1229920 discussion of the rel-me connection] See also [http://dev.w3.org/html5/spec/Overview.html#link-type-author the HTML5 spec]

|-
| [[rel-bibliography|bibliography]] || indicate[s] that the destination of that hyperlink is a bibliography for the current page. || [http://microformats.org/discuss/mail/microformats-discuss/2007-October/010863.html mailing list post, 2007-10-15]

|-
| [[rel-cite|cite]] || indicate[s] that the destination of that hyperlink is an authoritative source or a precedent to the current page. || [[distributed-conversation-brainstorming]]

|-
| [[rel-embed|embed]] || destination of the link is an version of the current page suitable for embedding in other pages || [https://indieweb.org/rel-embed IndieWeb rel-embed examples and brainstorming]

|-
| [[rel-group|group]] || the referenced document represents a group to which the person represented by the current document belongs || [[group-brainstorming]]

|-
| [[rel-longdesc|longdesc]] || Alternative to the img longdesc attribute, for use on visible links || [http://www.google.com/search?q=rel%3D%22longdesc%22 Google search for rel=longdesc in the wild] shows many sources of proposals. Please edit this to list the earliest and perhaps most recent/comprehensive proposal. No known real world POSH usage in the wild yet.

|-
| [[rel-map|map]] || Link to a map. Possibly embedded within an adr, hCard, geo or hCalendar. Parsers {{may}} attempt to parse the URL if it is a link to a known map site (e.g. Geohash, Google Maps, Multimap) and extract co-ordinates and other useful data. || (to [[User:TobyInk|TobyInk]] by email)

|-
| [[rel-member|member]] || the referenced document represents a member of the group represented by the current document || [[group-brainstorming]]

|-
| [[rel-m_PageScroll2id|m_PageScroll2id]] || JS to scroll to a defined ID || [[group-brainstorming]]

|-
| [[rel-prefetch|prefetch]] || indicates the URL and content-type of a resource that is likely to be a required resource when the next action or navigation is triggered. Initiating an early fetch allows the user agent to mask the request latency of the resource and make it available sooner to the application.|| [https://igrigorik.github.io/resource-hints/#prefetch resource hints draft]

|-
| [[rel-preload|preload]] || indicates the URL and content-type of a resource that should be fetched as early as possible by the user agent. Initiating an early fetch allows the user agent to mask the request latency of the resource and make it available sooner to the application.|| [https://igrigorik.github.io/resource-hints/#preload resource hints draft]

|-
| [[rel-prerender|prerender]] || indicates the URL of the next navigation target. Initiating a prerender allows the user agent to deliver an instant navigation experience: the user agent downloads the top-level resource and its assets, and performs all of the processing steps required to show the page without actually showing it to the user.|| [https://igrigorik.github.io/resource-hints/#prerender resource hints draft]

|-
| [[rel-profile|profile]] || indicate[s] that the destination of that hyperlink is a metadata profile (e.g. an [[XMDP]] profile) for the current page or portion thereof || [[xmdp-brainstorming]]

|-
| [[rel-shortlink|shortlink]] || the referenced document represents the current document but with a shorter URL || [http://samj.net/2009/04/introducing-relshort-better-alternative.html blog post]
|-
| source || the referenced document represents the source code for the current document or project || [[source-brainstorming]] [http://adactio.com/journal/6667/ blog post]

|-
| vcalendar-parent || link from an event to a containing event || [[User:TobyInk/hcalendar-1.1|hCalendar 1.1 draft]]
|-
| vcalendar-child || link from an event to a contained event || [[User:TobyInk/hcalendar-1.1|hCalendar 1.1 draft]]
|-
| vcalendar-sibling || link from an event to a related event with the same container || [[User:TobyInk/hcalendar-1.1|hCalendar 1.1 draft]]

|-
| [[rel-status|status]] || the referenced document represents the status (or source of status updates) for the author of this document || [http://monkinetic.com/2009/11/24/status-autodiscovery-relstatus.html blog post]

|-
| https://api.w.org/ || Link to Wordpress API || [https://wordpress.org/themes/twentysixteen/ Official Wordpress theme]

|}

=== more brainstorming ===
See also:
* [[genealogy-brainstorming]] for some thoughts on possible additional values for family relationships (use existing [[XFN]] [[rel-parent|parent]], [[rel-child|child]], [[rel-sibling|sibling]], [[rel-spouse|spouse]], [[rel-kin|kin]] values first though)
* [[xpn-brainstorming]] for some thoughts on possible additional values for professional relationships (use existing [[XFN]] [[rel-co-worker|co-worker]], [[rel-colleague|colleague]] values first though)

== POSH usage ==
There are numerous rel values used as [[POSH]], both in the wild, whose origins are not necessarily known, nor are their meanings consistent. There are also numerous rel values from external proposals of varying degrees of merit. It is useful to document their existence and summarize their implied meanings/usage intent as research that may be used to perhaps take one or more of them thru the microformats [[process]] if there is both sufficient interest and sufficient in the wild usage.

Note: If a value is missing from this table, it may have either already been promoted by writing it up as a proposal, or demoted by being explicitly dropped. Please check the other tables first before adding to this table.

Note: this list is incomplete, please help complete it from the following sources:

External sources:
* [http://developer.mozilla.org/about/meta Meta Information in DevMo Docs] (DevMo)
* [http://wiki.mozilla.org/Microsummaries Microsummary]
* [http://lachy.id.au/dev/markup/specs/wclr/ Web Communication Link Relationships] (WCLR)
* [http://www.w3.org/MarkUp/Relationships.html W3C Link Relationship values draft] (LRdraft) - from a draft of the HTML spec circa 1991.
* [http://www.whatwg.org/specs/web-apps/current-work/multipage/section-links.html#linkTypes HTML5 draft] '''Liable to change'''
* [http://wiki.foaf-project.org/Autodiscovery FOAF Project Wiki: Autodiscovery] (FOAF)
* [http://www.apps.ietf.org/rfc/rfc4685.html RFC4685]
* [http://googlewebmastercentral.blogspot.com/2009/02/specify-your-canonical.html Google Blog]

{| border="1"
|+
! rel value !! summary !! origin !! proposal(s)

|-
| [[rel-archive|archive]] || index of archived entries || unknown, perhaps Wordpress open source blogging software || WCLR

|-
| [[rel-archives|archives]] || Provides a link to a collection of records, documents, or other materials of historical interest. || || HTML5

|-
|[[rel-author|author]]||see brainstorming above for suggested use by google||unknown || DevMo / HTML5

|-
| [[rel-canonical|canonical]] || To help search engines disambiguate the same page with multiple representations || Google || [http://googlewebmastercentral.blogspot.com/2009/02/specify-your-canonical.html Google]/[http://www.bing.com/community/blogs/webmaster/archive/2009/02/12/partnering-to-help-solve-duplicate-content-issues.aspx Microsoft]/[http://www.ysearchblog.com/2009/02/12/fighting-duplication-adding-more-arrows-to-your-quiver/ Yahoo!], [http://blog.ask.com/2009/02/ask-is-going-canonical.html Ask Jeeves]

|-
| [[rel-comment|comment]] || … || … || WCLR

|-
| [[rel-contribution|contribution]] || … || … || WCLR

|-
| [[rel-edituri|EditURI]]
| Location of the xml-rpc gateway for a Wordpress install that allows external programs to add, edit and delete posts. Used by "[http://codex.wordpress.org/Weblog_Client WordPress blog client]" software for automating posting and updating blog content from your desktop. || Seen in [http://www.wordpress.org/ WordPress], e.g. [http://www.tom-watson.co.uk/]. || Description stubbed in [[rel-edituri]].

|-
| [[rel-endorsed|endorsed]] || … || … || WCLR

|-
| [[rel-fan|fan]] || xxxx. || … || [[hcard-user-profile-authoring]]

|-
| [[rel-feed|feed]] || Gives the address of a syndication feed for the current document. || … || WCLR/ HTML5

|-
| [[rel-footnote|footnote]] || Location of the footnote on a link to a footnote. || Markdown preprocessors such as [http://maruku.rubyforge.org/ Maruku] || HTML5

|-
| [[rel-icon|icon]] || Imports an icon to represent the current document. (Allowed in <code>link</code> only) || [http://dev.w3.org/html5/spec-LC/links.html#rel-icon HTML5] || WCLR/HTML5

|-
| [[rel-kinetic-stylesheet|kinetic-stylesheet]] || Imports a [http://kssproject.org/ KSS] 'kinetic stylesheet' to bind dynamic behavior to elements || Used in the [http://plone.org Plone] Content Management System || …

|-
| [[rel-lightbox|lightbox]] || Hook - Indicates that following the link will trigger a "lightbox" script (Allowed in <code>link</code> only) || ([http://www.google.co.uk/search?q=rel%3D%22lightbox%22 Google search for rel=lightbox in the wild]) Use "lightbox" instead of "clearbox" or "prettyPhoto" || …

|-
| [[rel-made|made]] || … || … || LRdraft

|-
| [[rel-meta|meta]] || … || [http://www.w3.org/TR/1999/REC-rdf-syntax-19990222/#transport 1999 W3C RDF syntax REC] || FOAF

|-
| [[rel-microsummary|microsummary]]|| … || … ||[http://wiki.mozilla.org/Microsummaries Microsummary], be aware of: [[page-summary-formats#Issues_2|microsummary issues]]

|-
| [[rel-noreferrer|noreferrer]] || indicates that no referrer information is to be leaked when following the link. || [http://dev.w3.org/html5/spec-LC/links.html#rel-noreferrer HTML5] || HTML5

|-
| [[rel-openid-delegate|openid.delegate]] || … || ([http://www.google.co.uk/search?q=%22rel%3Dopenid%22 Google search for rel=openid.* in the wild]) || …

|-
| [[rel-openid-server|openid.server]] || … || ([http://www.google.co.uk/search?q=%22rel%3Dopenid%22 Google search for rel=openid.* in the wild]) || …

|-
| [[rel-permalink|permalink]] || indicate a permanent link for some, or all, content within the document. obsolete; use <code>bookmark</code> instead. || … || WCLR

|-
| [[rel-pgpkey|pgpkey]] || (see also rel-publickey) || … || [http://golem.ph.utexas.edu/~distler/blog/archives/000320.html], [http://golem.ph.utexas.edu/~distler/blog/archives/000325.html]

|-
| [[rel-pingback|pingback]] || Gives the address of the pingback server that handles pingbacks to the current document. (Allowed in <code>link</code> only) || … || WCLR/ HTML5

|-
| [[rel-popover|popover]] || Used by a JS widget to display a large, descriptive tooltip. || [http://twitter.github.com/bootstrap Twitter's Bootstrap] [http://twitter.github.com/bootstrap/javascript.html#popovers Popover.js] || …

|-
| [[rel-prefetch|prefetch]] || Specifies that the target resource should be pre-emptively cached. (Allowed in <code>link</code> only) || … || HTML5

|-
| [[rel-privacy|privacy]] || Specifies that the target resource is the privacy policy. || … || …

|-
| [[rel-publickey|publickey]] || (see also rel-pgpkey) || … || [http://rasterweb.net/raster/2002/12/12/20021212072812/]

|-
| [[rel-referral|referral]] || … || … || WCLR

|-
| [[rel-related|related]] || … || … || WCLR

|-
| [[rel-replies|replies]] || indicates a continued thread || unknown || [http://www.apps.ietf.org/rfc/rfc4685.html RFC4685]

|-
| [[rel-respond-proxy|respond-proxy]] || Working with respond.js - proxy on external server || [https://github.com/scottjehl/Respond] || [https://github.com/scottjehl/Respond]

|-
| [[rel-respond-redirect|respond-redirect]] || Working with respond.js - redirect location on local server || [https://github.com/scottjehl/Respond] || [https://github.com/scottjehl/Respond]

|-
| [[rel-resource|resource]] || … || … || WCLR

|-
| [[rel-search|search]] || … || unknown || unknown

|-
| [[rel-sitemap|sitemap]] || Links to a site map document. || … || http://www.sitemaps.org/

|-
| [[rel-sponsor|sponsor]] || … || … || WCLR

|-
| [[rel-tooltip|tooltip]] || Used by a JS widget to display a tooltip similar (though more customizable) to what is shown by browsers if the 'title' attribute is present. || [http://twitter.github.com/bootstrap Twitter's Bootstrap] [http://twitter.github.com/bootstrap/javascript.html#tooltips Tooltip.js] (and likely other JS tools) || …

|-
| [[rel-trackback|trackback]] || … || unknown, perhaps open source Movable Type blogging software || WCLR

|-
| [[rel-unendorsed|unendorsed]] || (probably redundant to [[rel-nofollow|nofollow]]) || … || WCLR

|-
| [[rel-user|user]] || … || … || WCLR
|-
| [[rel-wlwmanifest|wlwmanifest]] || Used by "[http://explore.live.com/windows-live-writer Windows Live Writer]," a Microsoft [http://codex.wordpress.org/Weblog_Client blog client] for automating posting and updating blog content from your desktop. || Seen in [http://www.wordpress.org/ WordPress], e.g. [http://www.tom-watson.co.uk/]. Similar values are probably used by other blog content management systems as well. || …

|}

=== WCLR ===

The WCLR proposal is described by its author (in e-mail, 2007-09-25) as:

<blockquote>
…now effectively obsolete, since HTML5 and Microformats cover all the worthwhile relationships in that already.

These are [http://www.whatwg.org/specs/web-apps/current-work/multipage/section-links.html#linkTypes covered by HTML5 already]:

* permalink -> bookmark
* archive -> archives
* feed
* pingback
* unendorsed -> nofollow

The rest now seem unnecessary.
</blockquote>

Nonetheless, there may be some mileage in using them in microformats, at least until HTML5 is widely available.

== Dublin Core ==
In the past, Dublin Core values have been added to this page in the table about HTML5 features, but no examples, nor an actual specification explicitly stating how the value(s) should be used in HTML could be found. The linked specifications below have been updated so we should start considering Dublin Core values accordingly.

{| border="1"
|+
! rel value !! summary !! source
|-
| schema.DC || a specification of all metadata terms maintained by the Dublin Core Metadata Initiative, with regard to the fifteen terms of the Dublin Core Metadata Element Set already published || [http://www.dublincore.org/documents/dcq-html/ Dublin Core]

|-
| schema.DCTERMS || a specification of all metadata terms maintained by the Dublin Core Metadata Initiative, reflecting the changes described more fully in the 2012 document "Maintenance changes to DCMI Metadata Terms" [http://dublincore.org/usage/decisions/2012/dcterms-changes/] || [http://www.dublincore.org/documents/dcq-html/ Dublin Core]
|-
|}

'''Issues need updating given new information from linked resources.'''

Notes:
* Dublin Core. This search may help: [http://www.google.co.uk/search?as_q=rel%3Dschema.*&hl=en&num=10&btnG=Google+Search&as_epq=&as_oq=&as_eq=&lr=&as_ft=i&as_filetype=&as_qdr=all&as_occt=any&as_dt=i&as_sitesearch=http%3A%2F%2Fdublincore.org&as_rights=&safe=images].
** '''examples from that search only use invisible <code><link href></code> element'''. At first glance it appears the results from the search show only uses with the invisible <code><link href></code> element which is not ideal for content relationships. Content relationships should be user visible and thus uses with <code><a href></code> are strongly preferred.
*** [http://www.ietf.org/rfc/rfc2731.txt RFC2731] defines <code>rel="schema.AC"</code> and <code>rel="schema.RC"</code> with the pattern <code>rel="schema.PREFIX"</code> as a syntax for defining namespaces for use in meta[@name], *[@rel], *[@rev] and (as per eRDF) *[@class] attributes. A link to a Dublin Core metadata schema is generally not suitable for end users, so <code><link href></code> appears to be more appropriate than <code><a href></code> for those that use Dublin Core metadata schemas.
*** The scheme proposed above provides metadata namespace declarations. As described by DCMI specifications, such indications '''cannot''' be provided w/o a suitable namespace. In order to give complete pieces of information, the correct description set must be: <code><link rel="schema.DCTERMS" href="http://purl.org/dc/terms/"></code> (for the namespace declaration, followed by) <code><meta name="DCTERMS.<nowiki>[element]</nowiki>" content="<nowiki>[element.value]</nowiki>"></code> for related elements.
**** Note: [http://purl.org/dc/terms/ schema.DCTERMS] is conventionally related to an upgraded elements list than [http://purl.org/dc/elements/1.1/ schema.DC] and should be preferred as rel values. Both are discussed here for subject completeness)
** '''proposal to use in content currently only theoretical'''. Thus unfortunately the use of Dublin Core in user visible content like <code><a href></code> appears to be strictly theoretical. See [http://microformats.org/discuss/mail/microformats-discuss/2008-January/011445.html microformats-discuss/2008-January/011445.html] for a proposal to use Dublin Core in user visible content.
*** '''recent improvements'''. DCMI solves some trouble concerning metadata through the ''description set model''. Some of these informations cannot currently be provided in any standard ways other than DC, namely dates, validity and periodicity. Following this public bug report ([https://www.w3.org/Bugs/Public/show_bug.cgi?format=multiple&id=22520]), the correct namespace declaration for DC and DCTERMS metadata are now considered valid HTML code. We '''must''' encourage this practice both for internal usefulness and for shared practices.

* The Dublin Core document [http://dublincore.org/documents/dc-html/ "Expressing Dublin Core metadata using HTML/XHTML meta and link elements"] is a specification for, and gives examples of, both <link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"> and <link rel="schema.DCTERMS" href="http://purl.org/dc/terms/">. Note that Dublin Core encourages the use of DCTERMS elements over DC. A list of projects which use Dublin Core metadata is maintained [http://dublincore.org/projects/ here].
* [http://dublincore.org/documents/dc-html/ "Expressing Dublin Core metadata using HTML/XHTML meta and link elements"] also includes examples of <link rel="DCTERMS.[element]" href="">, where [element] = subject, isReferencedBy, creator, and publisher. The <link> tag is used instead of the <meta> tag whenever the content is a URL. (Note that this use is different from, but related to, <link rel="schema.DCTERMS" href="">.) Potentially, ''any'' of the 55 DCTERMS elements could be used in this way, and this could include use in HTML 5.
** As said before, HTML5 validators now allow the use of <code><link rel="schema.DCTERMS" href="http://purl.org/dc/terms/"></code> for namespace declarations.

* According to DCMI specification linked above, as well as [http://dublincore.org/documents/dc-html/ "Expressing Dublin Core metadata using HTML/XHTML meta and link elements"] documentation, HTML5 @rel attribute proposed values table has been updated. It now includes a subset of DCMI ''/terms/'' namespace properties, more specifically those whose value can (or must) be logically expressed by a resource, so that the "href" attribute value becomes a non-literal value surrogate referring to the resource itself.
** Elements from ''/elements/1.1/'' namespace have not been included on purpose. According to [http://wiki.dublincore.org/index.php/FAQ/DC_and_DCTERMS_Namespaces "FAQ/DC and DCTERMS Namespaces"], the old namespace is maintained for legacy purposes only and it is not as suitable for non-literal values as the ones denoted by <code><link></code> elements.

== Use with HTTP Link Header ==
You can also use any of the rel values (that are allowed for link elements) with HTTP Link Headers,

Example: returning a Javascript file with a license (since JS itself has no way to indicate a license)
<syntaxhighlight lang=text>
Link: <http://creativecommons.org/publicdomain/zero/1.0/>; rel="license"
</syntaxhighlight>

For multiple licenses (e.g. CC-SA and GPL), simply use multiple <code>Link:</code> headers.
<syntaxhighlight lang=text>
Link: <http://creativecommons.org/licenses/by-sa/3.0/>; rel="license"
Link: <http://www.gnu.org/licenses/gpl.html>; rel="license"
</syntaxhighlight>

Example: similarly, linking to a copyright statement for an image:
<syntaxhighlight lang=text>
Link: <http://example.org/copyright.html>; rel="copyright"
</syntaxhighlight>
or providing a brief inline copyright statement:
<syntaxhighlight lang=text>
Link: <data:text/plain;charset=utf-8,Copyright 2013 ExampleCo, All Rights Reserved.>; rel="copyright"
</syntaxhighlight>

== unspecified ==
Some rel values have been added to this page perhaps in one of the tables above, but no examples, nor an actual specification explicitly stating that the value(s) should be used in the HTML 'rel' attribute could be found. They are listed here in the hopes someone can discover more specific/precise URLs to examples or specifications about them (preferably both). Until such precise URLs to examples/specs are provided, the values can be treated as they are purely theoretical and thus of little interest.

A simple list here is sufficient.

== non HTML rel values ==
There are markup languages other than HTML that also have a rel attribute, often based upon the HTML rel attribute.
It is useful to document some of these other languages and their rel values for both reference purposes, and to provide background research for the possible development and re-use of these values in HTML, as [[poshformats]] or [[microformats]]

Sources:
* [[Atom]] [[RFC4287]] specification.
* See http://www.iana.org/assignments/link-relations.html for more.
* See [http://amundsen.com/media-types/maze/format/#link-relations Maze+XML]
* See [http://amundsen.com/media-types/collection/format/#link-relations Collection+JSON]
* See [http://www.opensearch.org/Specifications/OpenSearch/1.1#Url_rel_values OpenSearch]
* See [http://tools.ietf.org/html/rfc6861 The Create-Form and Edit-Form Link Relations (RFC6861)]
* See [http://rels.messages.io Workflow-Related Link Relations at Messages.io]

{| border="1"
|+
! rel value !! summary (from the relevant specification where possible)) !! defining specification

|-
| self
| From http://www.ietf.org/rfc/rfc4287.txt : <blockquote>The value "self" signifies that the IRI in the value of the href attribute identifies a resource equivalent to the containing element.</blockquote>
| [[Atom]] http://www.ietf.org/rfc/rfc4287.txt

|-
| http://gdata.youtube.com/schemas/2007#in-reply-to || See http://code.google.com/apis/youtube/2.0/developers_guide_protocol_comments.html || YouTube extension to Atom

|-
| collection || Refers to a resource which represents a collection of which the current resource is a member.

When used in the Maze+XML media type, the associated URI returns the available collection of mazes.
|| Maze+XML, Collection+JSON, OpenSearch

|-
| compensatingtx || Link to a resource representing information about a compensating transaction for each member transaction of a [http://www.cs.cornell.edu/andru/cs711/2002fa/reading/sagas.pdf Long-Lived Compensating Transaction] || See [http://rels.messages.io/#compensatingtx Compensating Transaction Link Relation]

|-
| east || Refers to a resource to the "east" of the current resource.

When used in the Maze+XML media type, the associated URI points to a neighboring cell resource to the east in the active maze.

|| Maze+XML

|-
| events || Link to a collection resource representing a list of subscribe-able events. || See [http://rels.messages.io/#events Events Link Relation]

|-
| exit || Refers to a resource that represents the exit or end of the current client actvity or process.

When used in the Maze+XML media type, the associated URI points to the final exit resource of the active maze.

|| Maze+XML

|-
| north || Refers to a resource that is "north" of the current resource.

When used in the Maze+XML media type, the associated URI points to a neighboring cell resource to the north in the active maze.

|| Maze+XML

|-
| south || Refers to a resource that is "south" of the current resource.

When used in the Maze+XML media type, the associated URI points to a neighboring cell resource to the south in the active maze.

|| Maze+XML

|-
| [[rel-via|via]] || Identifies a resource that is the source of the information in the context. || Atom 1.0 Syndication format (RFC 4287)

|-
| west || Refers to a resource that is "west" of the current resource.

When used in the Maze+XML media type, the associated URI points to a neighboring cell resource to the west in the active maze.

|| Maze+XML

|-
| item || The target IRI points to a resource that is a member of a collection represented by the context IRI. || Collection+JSON

|-
| create-form || When included in a resource, the "create-form" link relation MAY identify a target resource that represents the form to append a new member to the link context. || See [http://tools.ietf.org/html/rfc6861 The Create-Form and Edit-Form Link Relations (RFC6861)]

|-
| edit-form || When included in a resource, the "edit-form" link relation identifies a target resource that represents the form for editing associated resource. || See [http://tools.ietf.org/html/rfc6861 The Create-Form and Edit-Form Link Relations (RFC6861)]

|-
| lightframe || Opens the target in a lightbox. On inclusion it provides a simple target the lightframe and loads the content in a lightbox effect || Lightbox

|-
| superbox[image] || jQuery Superbox! is a script which allows you display windows with the lightbox effect. || superbox

|-
| wp-video-lightbox || wp-video-lightbox! is a rel to anchor tag script display videos with the lightbox effect. || wp-video-lightbox

|-
| youtube || Opens the target youtube video in using the Swipebox Plugin || Swipebox

|-
| shadowbox || shadowbox is a jQuery script for images displaying with the "lightbox" effects. || shadowbox

|-
| permission || When included in a resource, the "permission" link relation MAY identify a target resource that represents the list of entities that can access or modify the resource in the link context. || See [http://cdoc.io/spec.html#permission-link-relation Collection Document Media Type Specification]

|-
| sub || When included in a resource representation of an event, the "sub" (subscription) link relation MAY identify a target resource that represents the ability to subscribe to the pub/sub event-type resource in the link context. || See [http://rels.messages.io/#sub Subscription Link Relation]

|-
| unsub || When included in a resource representation of an event, the "unsub" (subscription cancellation) link relation MAY identify a target resource that represents the ability to un-subscribe from the pub/sub event-type resource in the link context. || See [http://rels.messages.io/#unsub Subscription Cancellation Link Relation]

|-
| version-history
| When included on a versioned resource, this link points to a resource containing the version history for this resource.
| [http://tools.ietf.org/html/rfc5829 RFC 5829]

|-
| latest-version
| When included on a versioned resource, this link points to a resource containing the latest (e.g., current) version.
| [http://tools.ietf.org/html/rfc5829 RFC 5829]

|-
| working-copy
| When included on a versioned resource, this link points to a working copy for this resource.
| [http://tools.ietf.org/html/rfc5829 RFC 5829]

|-
| working-copy-of
| When included on a working copy, this link points to the versioned resource from which this working copy was obtained.
| [http://tools.ietf.org/html/rfc5829 RFC 5829]

|-
| predecessor-version
| When included on a versioned resource, this link points to a resource containing the predecessor version in the version history.
| [http://tools.ietf.org/html/rfc5829 RFC 5829]

|-
| successor-version
| When included on a versioned resource, this link points to a resource containing the successor version in the version history.
| [http://tools.ietf.org/html/rfc5829 RFC 5829]

|-
| ... || ... || ...

|}

== dropped ==
The following rel values were in earlier version(s) of specification(s) and it is presumed by their absence from the most recent version of the respective specification(s) that they have been deprecated or obsoleted.

In general, you {{should not}} use any dropped values.

If any such values have been superceded by standard values (see the first table on this page), then you {{must not}} use the dropped versions.

In particular:
* if a rel value was in a draft and is missing (without explanation) from the final spec, or
* if a rel value was in a previous version of and is missing (without explanation) from an update to the specification (even a draft update)

Then absent any other information or explanation, it is presumed that the group/editors working on that specification decided to explicitly drop it (either in development, or in the updated version) and thus it should be obsoleted (not re-registered).

If you wish to add them, please research why such values were omitted from latter specifications before doing so. If you do discover the reasoning, please add a short statement or link to thereof into the appropriate place in the following table.

If there is more data, e.g. a link to an email of discussion of the spec development that explains ''why'' the rel value was dropped, and it explicitly states, e.g. it was without prejudice, or merely post-poned, or perhaps expected to be spun-out into its spec (or some other explicit positive reason), then it makes to link/cite that explicit text as part of a proposal.

Sources:
* [http://www.w3.org/MarkUp/html3/ HTML3] (HTML3) / has been superceded by [http://www.w3.org/MarkUp/Wilbur/ HTML 3.2] - which itself has been superceded by [http://www.w3.org/TR/REC-html40 HTML 4.0] - which itself has been updated by [http://w3.org/TR/html401 HTML 4.01], commonly referred to as "HTML 4" in this wiki and other places.)
* [http://www.w3.org/TR/relations.html Proposed HTML 4.0 link types] (HTML4dropped) - obsoleted/superceded by the HTML 4.0 Recommendation. Any values that were in the "Proposed HTML 4.0 link types" document but didn't make it into the HTML 4.0 Recommendation were thus explicitly dropped and should be avoided.

{| border="1"
|+
! rel value !! summary !! defining specification !! why dropped

|-
|[[rel-banner|banner]]||Was used to reference another document to be used as banner for this document (i.e. a form of "include" statement).|| HTML3 ||unknown

|-
| [[rel-begin|begin]] || identifies the author-defined start of a sequence of documents of which the current document is a node.
|| HTML4dropped||unknown

|-
| [[rel-biblioentry|biblioentry]] || identifies a bibliographic entry || HTML4dropped||unknown

|-
| [[rel-bibliography|bibliography]] || identifies a bibliography || HTML4dropped||unknown

|-
| [[rel-child|child]] (obsolete/superceded) || the target document is a hierarchical child, or subdocument, of the current document|| HTML4dropped||unknown

|-
| [[rel-citation|citation]] || the target is a bibliographic citation || HTML4dropped||unknown

|-
| [[rel-collection|collection]] || the target document is an collection that contains the current document || HTML4dropped||unknown

|-
| [[rel-definition|definition]] || identifies a definition of a term || HTML4dropped||unknown

|-
| [[rel-disclaimer|disclaimer]] || identifies a hypertext link to a legal disclaimer || HTML4dropped||unknown

|-
| [[rel-editor|editor]] || identifies a hypertext link to an editor || HTML4dropped||unknown

|-
| [[rel-end|end]] || identifies the author-defined end of a sequence of documents of which the current document is a node. || HTML4dropped||unknown

|-
| [[rel-footnote|footnote]] || the anchor is a footnote marker and the target is a footnote || HTML4dropped||unknown

|-
| [[rel-navigate|navigate]] || the target document contains information such as a image map that will help users to gain a sense of how and where to found information || HTML4dropped||unknown

|-
| [[rel-origin|origin]] || synonym for <code>top</code> || HTML4dropped||unknown

|-
| [[rel-parent|parent]] (obsolete/superceded) || the target document is the hierarchical parent, or container, of the current document|| HTML4dropped||unknown

|-
| [[rel-pointer|pointer]] || the target is a pointer to the real target. This value can be used by a user agent to perform a pre-fetch of the specified target for evaluation until the real target is reached || HTML4dropped||unknown

|-
| [[rel-publisher|publisher]] || identifies a hypertext link to a publisher || HTML4dropped||unknown

|-
| [[rel-sibling|sibling]] (obsolete/superceded) || the target document is a child of a common parent, or a hierarchical peer of the current document|| HTML4dropped||unknown

|-
| [[rel-top|top]] || the target document is the logical top node of the tree (see also <code>begin</code>) || HTML4dropped||unknown

|-
| [[rel-trademark|trademark]] || identifies a hypertext link to a trademark notice || HTML4dropped||unknown

|-
| [[rel-translation|translation]] || the target is a translation to another language || HTML4dropped||unknown

|-
| [[rel-urc|urc]] || identifies a Universal Resource Citation || HTML4dropped||unknown

|-
|}

== dropped without prejudice ==
In one known instance (from HTML4 to HTML5), some rel values were in an earlier version of a specification (or a proposal) and were dropped from a latter (draft) version, and it was noted that these values were dropped with the intent that they could still be proposed in a registry and thus they explicitly were not deprecated or obsoleted. This section documents such values as separate from the [[#dropped|dropped]] section.

In general, you {{should not}} use any dropped values.

If any such values have been superceded by standard values (see the first table on this page), then you {{must not}} use the dropped versions.

Rel values that were dropped without prejudice from a specification will be considered similar to new values that have never been specified.

If you know of additional rel values that were dropped without prejudice from an update to a specification, please cite a URL and quote from the group developing the specification that officially states from that group that the dropping of the values was done without prejudice, or equivalent statement (such as explicit allowance of external registration, proposal, and/or development).

This table serves a historical purpose. If you wish to propose a value from this table, please copy it and leave it in place.

Sources:
* Several rel values were [http://www.w3.org/Bugs/Public/show_bug.cgi?id=7475#c15 explicitly dropped from HTML5]. Per: [http://lists.w3.org/Archives/Public/public-html/2011Feb/att-0481/issue-118-decision.html Issue 118 Decision] ('''emphasis''' added): <blockquote>"The final proposal argues for the removal of some relation values, to wit, it suggests removal of '''index, up, first and last'''. It was pointed out in survey comments that these relations are already registered in the IANA link relation registry. Presumably, '''these relations could also be entered in whatever other registry or registries HTML5 adopts for this purpose'''...."Next Steps..."Since the relations to be removed are already registered at the IANA link relation registry, no further action is needed to include them there. WG members are '''free to register or record these relations elsehwere''' [sic], as well."</blockquote>

{| border="1"
|+
! rel value
! summary
! defining specification
! why dropped

|-
| [[rel-first|first]]
| Synonym for <code>start</code>
| HTML4dropped - never in an official spec
| [http://lists.w3.org/Archives/Public/public-html/2011Feb/att-0481/issue-118-decision.html Explicitly dropped from HTML5 interim draft yet permitted for external registry]

|-
| [[rel-index|index]]
| Refers to a document providing an index for the current document.
| was in [http://www.w3.org/TR/html4/types.html#h-6.12 HTML4]; the token has been re-registered within the [[#HTML5_link_type_extensions|HTML5 link type extensions]] and is now valid.
| [http://lists.w3.org/Archives/Public/public-html/2011Feb/att-0481/issue-118-decision.html Explicitly dropped from HTML5 interim draft yet permitted for external registry]

|-
| [[rel-last|last]]
| Refers to the last document in a collection of documents.
| HTML4dropped - never in an official spec
| [http://lists.w3.org/Archives/Public/public-html/2011Feb/att-0481/issue-118-decision.html Explicitly dropped from HTML5 interim draft yet permitted for external registry]

|-
| [[rel-up|up]]
| When the document forms part of a hierarchy, this link references the immediate parent of the current document. Synonym for <code>parent</code>.
| was in [http://www.w3.org/MarkUp/html3/dochead.html HTML3] - but [http://www.w3.org/TR/html401/types.html#type-links dropped in HTML4]
| [http://lists.w3.org/Archives/Public/public-html/2011Feb/att-0481/issue-118-decision.html Explicitly dropped from HTML5 interim draft yet permitted for external registry]

|-
|}

See related [http://dev.w3.org/html5/spec/links.html#linkTypes HTML5: Link types] for existing HTML5 specified rel values.

== rejected ==
Some rel values have been proposed and rejected. They are listed here to make that explicit. Authors {{must not}} use rejected rel values.

Source: [[rejected-formats]].

{| border="1"
|+
! rel value !! origin / proposal !! why rejected
|-
| [[rel-logo|logo]]
| [http://relogo.org Relogo.org]
| [[rejected-formats#Logo]]
|-
|[[rel-pavatar|pavatar]] || [http://pavatar.com/ pavatar] || [[rejected-formats#Pavatar]]
|-
|}

== tools ==
See [[implementations]].

== addtional external research ==
Here are some additional historical references to the development or rel-values which may be useful when researching values, especially why specific values may have been proposed but abandoned.
* 1996-06-07 [http://www.w3.org/MarkUp/draft-ietf-html-relrev-00.txt Hypertext links in HTML] (copies: [http://ftp.ics.uci.edu/pub/ietf/html/draft-ietf-html-relrev-00.txt ftp.ics.uci.edu])
* 1996-11-13 [http://www.w3.org/Architecture/NOTE-link Describing and Linking Web Resources]
* 1997-01-23 [http://lists.gnu.org/archive/html/lynx-dev/1997-01/msg00537.html LYNX-DEV Lynx and the LINK tag]
* 1997-01-24 [http://lists.w3.org/Archives/Public/w3c-sgml-wg/1997Jan/0357.html Taxonomy list]
* 1997-03-28 [http://www.w3.org/TR/WD-htmllink-970328 W3C Working Draft: Hypertext Links and Meta Information in HTML]

=== previous attempts at documenting ===
There have been previous attempts at documenting known rel values, most of which fell out of date due to being dependent on a single author maintaining them. They're listed here purely for historical reasons, and are not sufficient to be references of their own (since they're just individual curations of other references)
* [http://fantasai.tripod.com/qref/Appendix/LinkTypes/ltdef.html Link Type Definitions Glossary] by fantasai
* ...

== related ==
{{rel-related-pages}}
* [[elemental-microformats]]
* [[existing-rev-values]]
* [[existing-class-names]]

== copyright ==

{{cc-pd-license}}

picoformats

2025-09-05T19:16:51Z

Tantek: /* See Also */ microsyntax pbworks

{{DISPLAYTITLE:picoformats}}
;short URL
:http://ufs.cc/w/pf

<div style="background:#EFE;padding:1em">
See the latest work being done on this in the IndieWebCamp community:
* https://indiewebcamp.com/microsyntax
</div>

== Introduction ==
Picoformats represent an effort being undertaken led by Chris Messina to codify various standards and openly pursue a nomenclature and syntax for communicating and executing commands with mobile devices over SMS or via command line interfaces (CLI).

An example application is [http://dodgeball.com Dodgeball's] use of the at symbol (@) to express checking in to a place.

Using the Microformats process and principles of building block design, our goal is to openly develop a complete syntax for interacting with various mobile services using the characters available on most mobile devices.

== Problem Statement ==
* send messages to user mobiles - via SMS, or a small application, that contains information like appointment times, locations,
directions, and contact info. For example, when2where.com reminds users when they need to leave to get to their appointment, so the
message may be like:

leave @ 4:35PM ~Dentist Office -> Detroit, MI

where the text itself is simple and readable, but there *may* be an small utility that would parse the @ symbol to add the event to the calendar, the ~ to allow the person to quickly call that contact, or the -> to pull up a Map/directions to the location

* allow users to write messages to query an application - this is similar to what Mozes has started with notes:

when2where: ?today --- what appointments to I have today
new @ 4PM ~Olive Garden -> Novi --- add an appointment

In addition to the obvious mobile device arena, picoformats may be usable in any context where "markup" is too heavy. For example, an IRC bot, whereisbot, that announces user locations as they sign into a channel, or allows people to do:

.whereami, or .whereis <nick> to geolocate other people in a channel.

The intention is to 'markup' the information, but putting actual XHTML or XML is annoying, since IRC doesn't parse the information at all. So right now the response is:

ajturner: .whereami
whereisbot: ajturner is in Northville, MI, US [42.4365 x -83.4884]

So then someone could write a Picoformat parser for X-Chat/Colloquy/other that would parse the [ #### x #### ] and provide a Map url link.

Using arrows to denote time and place, familiar from video recorders and other devices.
Some thoughts: <past >future ^now (the hat is also mnemonic for Here + At) or >5 (in five days time) >>5 (in 5 weeks time) >>>5 (5 months)

Meeting <Leeds went well. ^Home. See you >london
Sorry, saw them <<2 wanna go see film >3?

<div id="Documented_Syntaxes">

== Syntaxes ==

=== Generic ===
* @-replies (at start), @-mentions (everywhere in content)
* #-hashtags
* [http://buzzword.org.uk/2009/microturtle/spec MicroTurtle]

=== Service-Specific ===

* [[actiontastic-syntax | Actiontastic]]
* [[brightkite-syntax| BrightKite]]
* [[dodgeball-syntax| Dodgeball]]
* [[dopplr-syntax | Dopplr]]
* [[facebook-syntax | Facebook Mobile]]
* [[gift-syntax | GIFT]] quizes[http://docs.moodle.org/en/GIFT_format]
* [[igtd-syntax | iGTD]]
* [[kiboze-syntax|Kiboze]]
* [[jaiku-syntax|Jaiku]]
* [[mixd-syntax | Mixd]]
* [[plazes-syntax | Plazes]]
* [[poi66-syntax | POI66]] - [http://www.poi66.com/maps/step1.php]
* [[quickpack-syntax | QuickPack]]
* [[remember-the-milk | Remember the Milk for Twitter]]
* [[stikkit-syntax | Stikkit]] [http://stikkit.com/]
* [[swaggle-syntax | Swaggle]] [http://swaggle.mobi/]
* [[textmarks-syntax|Textmarks]]
* [[tfl-syntax | Transport for London]]
* [[tripit-syntax | TripIt]]
* [[twitter-syntax | Twitter]]

</div>

== References ==
* [http://www.kiboze.com/kiboze/CustWorks.aspx Kiboze How it Works]
* Flagr: [http://www.flagr.com/help/howto#mobile_creating_flag Creating mobile flags]
* [http://web.archive.org/web/20090414182811/http://www.dodgeball.com/glossary Dodgeball Glossary]
* [http://twttr.com/t/help/lingo twttr lingo]
* Twitter (or Jaiku) [[twitter-nanoformats]] brainstorm [http://twitternanoformats.wikispaces.com/ A proposal for Twitter nanoformats]
* [http://skobee.com/email_howto Skobee's email syntax]
* [https://www.billmonk.com/about/sms BillMonk syntax]

== concept ==
Thanks to [http://factoryjoe.com/blog Chris Messina] for collecting a bunch of common work in this area, and exploring the area of short semi-structured text for potential "formats" of a sort that could be agreed upon, perhaps among multiple providers to make it easier for users to remember a common user interface.

== See Also ==
* http://www.dumbsto.re/apps - apps that operate purely via txt message commands and work with any phone that supports SMS.
* https://indiewebcamp.com/microsyntax - latest thoughts on a lot of text-based picoformats/microsyntax
* http://microsyntax.pbworks.com/

h-cite

2025-09-01T22:05:48Z

Tantek: /* Offline Citations */ link examples of p-publisher property

<dfn style="font-style:normal;font-weight:bold">h-cite</dfn> is a simple, open format for publishing citations and references to online and other publications. h-cite is one of several open [[microformats|microformat]] draft standards suitable for embedding data in HTML/HTML5.

;Status
:This is a '''Draft Specification'''
;Participate
:[[IRC]]: [irc://irc.libera.chat/microformats #microformats on Libera]
;Editor
:[[User:Tantek|Tantek Çelik]] (Editor)
;License
:{{cc0-owfa-license}}
__TOC__

== Example ==
Here is a simple minimal abstract web citation example:
<syntaxhighlight lang="html">

<time class="dt-published">YYYY-MM-DD</time>
AUTHOR:
<cite><a class="u-url p-name" href="URL">TITLE</a></cite>

</syntaxhighlight>

=== Get started ===
The class '''<code>h-cite</code>''' is a ''root class name'' that indicates the presence of an h-cite.

The classes '''<code>dt-published</code>''', '''<code>p-author</code>''', '''<code>p-name</code>''', and '''<code>u-url</code>''' define ''properties'' of the h-cite.

The class '''<code>h-card</code>''' on the same <code></code> as '''<code>p-author</code>''' indicates the presence of a nested [[h-card]] microformat as the '''author''' of the h-cite.

== Properties ==
h-cite properties (inside class <code>'''h-cite'''</code>)

* '''<code>p-name</code>''' - name of the work
* '''<code>dt-published</code>''' - date (and optionally time) of publication
* '''<code>p-author</code>''' - author of publication, with optional nested [[h-card]]
* '''<code>u-url</code>''' - a URL to access the cited work
* '''<code>u-uid</code>''' - a URL/URI that uniquely/canonically identifies the cited work, canonical permalink.
* '''<code>p-publication</code>''' - for citing articles in publications with more than one author, or perhaps when the author has a specific publication vehicle for the cited work. Also works when the publication is known, but the authorship information is either unknown, ambiguous, unclear, or collaboratively complex enough to be unable to list explicit author(s), e.g. like with many wiki pages.
* '''<code>dt-accessed</code>''' - date the cited work was accessed for whatever reason it is being cited. Useful in case online work changes and it's possible to access the dt-accessed datetimestamped version in particular, e.g. via the Internet Archive.
* '''<code>p-content</code>''' for when the citation includes the content itself, like when citing short text notes (e.g. tweets).

== Status ==
'''h-cite''' is a microformats.org draft specification. Public discussion on h-cite takes place on [[h-cite-feedback]] and the #microformats [[irc]] channel linked in the [[#Status|Status section]].

== Property Details ==
(stub, to be expanded)

All web citation properties are derived from those implied in [[citation-formats#styles|existing citation styling guides]] for citing permalinks to articles and short text notes online.

Date-time properties (dt-published, dt-accessed) may optionally include time information in addition to the date if relevant to the citation (e.g. when citing short text notes (tweets) of which there may be several in a single day).

To be added:
* for each property, what equivalent TCMOS, APA, MLA terms/vocabulary is being expressed/captured as researched in the [[citation-formats#styles|citation formats styles]] section.
* transforms from the web citations proposal properties into each of those citation styles.
** for citations of blog posts / articles
** for citations of text notes / tweets
** see examples in wild below for markup samples to style in each of the TCMOS/APA/MLA styles for blog/note citations.

== Offline Citations ==
The web citation proposal can be used for simple web-to-off-web citation use cases. As suggested by Ed Summers, dropping the hyperlink to the cited web article provides a simple off-web citation, e.g. a citation of a physical book:

<syntaxhighlight lang="html">

<time class="dt-published">YYYY-MM-DD</time>
AUTHOR:
<cite class="p-name">TITLE</cite>

</syntaxhighlight>

Note: physical books typically only provide the YYYY (year) published, not the precise date.

Next steps:
* Try such markup with actual content being published on the web (perhaps a bibliography, list of papers in a resume, etc.)
* See how it works/feels there
* Determine what seems to be missing.
* See if the "p-publisher" property helps in some web-to-off-web citation use cases.
** Used in a couple of instances by the editor in https://tantek.com/publications

== Examples in the wild ==
Real world in the wild examples:
* ... add uses of h-cite you see in the wild here.

* <cite class="h-cite">[http://christopheducamp.com/blog/test-indieweb-parvenir-a-posser-un-article-vers-twitter/ Test #IndieWeb : Parvenir à « POSSEr » un article vers Twitter]</cite> ([http://web.archive.org/web/20130623202346/http://christopheducamp.com/blog/test-indieweb-parvenir-a-posser-un-article-vers-twitter/ archived]) has an h-cite of a short note:
<syntaxhighlight lang="html">
<blockquote>
<cite class="h-cite">
<a class="u-url p-name" href="http://tantek.com/2013/104/t2/urls-readable-speakable-listenable-retypable">
URLs should be readable, speakable, listenable, and unambiguously
retypable, e.g. from print: tantek.com/w/ShortURLPrintExample #UX
</a>
(<abbr class="p-author h-card" title="Tantek Çelik">Çelik</abbr>
<time class="dt-published">2013-04-14</time>)
</cite>
</blockquote>
</syntaxhighlight>

* Mastodon uses h-cite by default to show threads and replies to posts [https://github.com/tootsuite/mastodon/pull/1063 added in 2017]

See also examples documented here:
* https://indieweb.org/h-cite#Indieweb_Examples

Real but not quite wild (used by the specification author)
* Every blog post on http://tantek.com has a text field for copying h-cite markup for that blog post.
* <cite class="h-cite">[http://tantek.com/2012/353/b1/why-html-classes-css-class-selectors Why you should say HTML classes, CSS class selectors, or CSS pseudo-classes, but not CSS classes]</cite> has a couple of interesting uses of h-cite:
** properties used: p-name, u-url, p-author, p-publication, dt-published, dt-accessed (basically all proposed properties except p-content!)
** additional experimental property: p-x-translation - which refers to a nested h-cite with its own implied p-name and implied u-url.

== Background ==
This work is based on how existing [[citation-formats#styles|citation format ''styles'']] (APA, MLA, TCMOS) represent references to articles on the web, and is designed to match the implied schema of those styles. The web citations proposal defines how to markup such reference representation styles in order to satisfy the use-cases above.

=== Goal ===
A primary goal of the web citation effort is to both start small, and always "make small possible", that is, no matter how it is extended, continue permitting very small meaningful citations with perhaps only 2-3 properties (e.g. date published, author, name of work).

=== Previous Proposals ===
The biggest problem with all previous proposals is that they tried to do too much. They didn't design a citation ''micro''format that could be used as a building block, but rather, erred on the side of attempting to describe the myriad types of references to dead-tree resources. They were so over-designed that their authors didn't even dogfood them on their own sites. -- [[User:Tantek|Tantek]] 00:56, 7 August 2012 (UTC)

== FAQ ==
=== Why ===
''Why markup web citations? What problem does it solve?''

A: In the simplest form, marking up a web citation URL, name, date published, author etc. allow for processing of web citations into whatever "style" or "format" (MLA vs APA etc.) a user wishes to publish them themselves.

=== Why not just a href ===
''Doesn't <code><a href></code> solve the problem of marking up citations in an article on the web that refers to other articles on the web?''

A: No, <code><a href></code> is necessary but insufficient for marking up citations to articles on the web.

* '''Insufficient semantic.''' <code><a href></code> is sufficient only for providing a hyperlink (which may or may not be a citation, e.g. it may be a "see also" link rather than link to a source being cited for particular assertion or fact).
* '''A href only marks up article link and name''' An <code><a href></code> can only represent the "url" and "name" of a citation. Where as [[citation-formats#styles|published web citations]] typically also include:
** article author name (sometimes author photo and URL)
** article publication date
** article publication name
** article access date (sometimes, e.g. Wikipedia citations)

== Design Principles ==
Principles driving this proposal:
* '''solve a [[specific]] problem'''. In this case '''web citations''' seeks to solve a ''more'' specific problem than previous proposals, that of citations from the web to the web (more constrained than any publication to any publication).
* [[solve simpler problems first]]. Existing web-to-web citations contain very little information compared to generalized academic citations, thus '''web citations''' is greatly simplified compared to previous proposals by only starting with a handful of properties.
* [[humans first]] - '''web citations''' focuses on the human readability and writability aspects of citations in articles first and foremost, and only secondarily considers the machine readability/reusability of the data contained therein.
* [[reuse]] building blocks - by re-using the better designed aspects of [[citation-formats#styles|existing citation conventions]] for web resources, '''web citations''' builds on top of previous work to make citations human readable/writable, as well as what implied properties are commonly expressed by such previous work.
=== Focus ===
The <dfn>web citations</dfn> proposal uses a smaller, [[simpler]] set of only ''eight'' properties to solve the [[specific]] problem of how to markup citations in an article on the web that refers to other articles on the web. Offline to offline, and online to offline references were specifically not explicitly addressed in initial design.

== First Proposal ==
This design was first publicly proposed as the result of an interactive web citation design discussion during IndieWebCamp2012:
* <time class="dt-published">2012-07-01</time> IndieWebCamp2012: <cite class="p-name">[http://indiewebcamp.com/2012/Academic_Citations_Web Academic Citations for the Web]</cite>

[[Category:Draft Specifications]]

unsubscribe-examples

2025-08-14T23:33:29Z

Tantek: +IndieWeb wiki search

{{stub}}

This page is the start of an attempt to standardize "[[unsubscribe]]" links/actions on the web (in HTML) like for mailing lists, which are perhaps similar to "[[unfollow]]" buttons common on social media profiles.

== unsubscribe examples ==
* ...

== See Also ==
* [[follow link]]
* [https://indieweb.org/wiki/index.php?title=Special%3ASearch&fulltext=1&search=unsubscribe IndieWeb wiki search for 'unsubscribe']

unsubscribe-examples

2025-08-14T23:17:56Z

Tantek: stub

pronouns-brainstorming

2025-07-24T11:29:24Z

Tantek: /* p-pronoun */ move that 's' to the right place

This page is for proposing and experimenting with markup for publishing [[pronouns|pronoun]] information, as well as documenting experimental markup already in use. Per [[process]], this page is part of:
* [[pronouns-examples]]
* [[pronouns-formats]]
* [[pronouns-brainstorming]]

== Experimental Examples ==
=== nominative oblique possessive ===
Ashton McAllan marks up her pronouns as:
<source lang=html4strict>
she /
her /
hers
</source>
in her [[h-card]] on http://acegiak.net/

Each pronoun is listed individually with it's form allowing parsers and programs to identify them for different uses. Other languages may include different forms of pronoun. This solution is suggested after reading [https://en.wikipedia.org/wiki/Personal_pronoun the Wikipedia Personal Pronouns article]

[[User:GRegorLove|gRegor Morrill]] marks up his pronouns similarly (note corrected spelling of "possessive"):
<source lang=html4strict>
Pronouns: he/
him/
his
</source>
on http://gregorlove.com/about/

[https://www.jvt.me/ Jamie Tanna] followed this same pattern, and [https://www.jvt.me/posts/2019/04/10/pronouns-microformats/ blogged about implementing it, and why].

[[User:Jgarber|Jason Garber]] marks up his pronouns using the pattern:
<source lang=html4strict>

I use the pronouns
<a href="https://my.pronoun.is/he/him/his">
he/
him/
his
</a>.

</source>

=== u-pronoun ===
[http://vanderven.se/martijn/ Martijn van der Ven] marks up his pronouns (more clearly on [http://vanderven.se/martijn/gender/ his gender page]) using only a dictionary URL:
<source lang=html4strict>

I use male pronouns (
<a href="https://nl.wiktionary.org/wiki/hij#Persoonlijk_voornaamwoord" lang="nl" class="u-pronoun">hij</a>,
<a href="https://sv.wiktionary.org/wiki/han#Pronomen" lang="sv" class="u-pronoun">han</a>,
<a href="https://en.wiktionary.org/wiki/he#Pronoun" class="u-pronoun">he</a>,
<a href="https://de.wiktionary.org/wiki/er#Personalpronomen" lang="de" class="u-pronoun">er</a>
) but also accept gender-neutral pronouns (
<a href="https://sv.wiktionary.org/wiki/hen#Pronomen" lang="sv" class="u-pronoun">hen</a>,
<a href="https://en.wiktionary.org/wiki/they#Pronoun" class="u-pronoun">they</a>
). If you are writing about me and are in doubt: ask.
</source>

* There is no way Martijn sees himself supporting 4 cases for English (subjective, objective, reflexive, and possessive), 5 cases for German (nominative, accusative, genitive, dative, and possessive), and a possible 13 cases for Finnish in the future. Doubtful anyone else will be doing that either: at least 1 implementation (by [https://unrelenting.technology/ Greg V]) of English p-x-pronoun-* exists in the wild that only specifies 2 cases.
* Simplifying for human visitors who can instantly get started with my pronoun of choice is seen as more important than catering to theoretical computer parsers.
* His thought process [http://wiki.zegnat.net/microformats/pronoun has been documented].
* [https://00dani.me/ Danielle McLean] is also using <code>u-pronoun</code>, linking to the popular [https://pronoun.is/ Pronoun Island] registry page for her pronouns: <code><nowiki><a class="u-pronoun" href="https://pronoun.is/she/her">she/her</a></nowiki></code>.
** Started looking for a way to mark-up pronouns because the p-sex/p-gender-identity combo is “[https://chat.indieweb.org/2017-10-29/1509268972735000 unbelievably terrible]”.
** [https://chat.indieweb.org/2017-10-29/1509269322353000 Agreed with Martijn’s arguments] for why a link is better than per-case mark-up.
* [[User:Sknebel|sknebel]] [https://chat.indieweb.org/microformats/2018-08-19#t1534703222243600 notes] (2018-08-19) that he would prefer to see text (that possibly leads him to Google for proper use) than just URLs in the parser output. Although the URLs are useful, [https://chat.indieweb.org/microformats/2018-08-19#t1534705418184500 a simple name:url pair] would increase the usefulness.
** Possibly something like <code>.[up]-pronoun.h-pronoun > .u-url</code> paired with <code>.[up]-pronoun.h-pronoun > .p-name</code>. [[h-cite]] would be prior art as also expressing “a reference to [something] in some way with name and url”. [https://chat.indieweb.org/microformats/2018-08-19/1534705492641900]

=== p-pronouns ===
The examples show many sites provide a single plain text field for the user to type in their pronouns.

A <code>p-pronouns</code> property can be used to markup the full text of what's been entered by the user

=== p-pronoun ===
Another variant is to markup each individual pronoun with <code>p-pronoun</code> (singular) which then makes it easier for consuming code to a set of pronoun values for it to choose among.

== Other Platforms ==
A [https://github.com/tootsuite/mastodon/issues/3211 GitHub issue about adding pronoun fields] to [https://indieweb.org/Mastodon Mastodon] was [https://chat.indieweb.org/microformats/2018-08-19#t1534700249077000 discussed in #microformats] on 2018-08-19. The comments in the issue bring up some points previously brought up by Martijn in regards to how useful it would be for machines. Also includes interesting survey data showing that just listing the minimal amount of cases does not show all inflections, e.g. does “ne/nim” refer to “ne/nem/neir/neirs/nemself” or “ne/nem/nayr/nayrs/nemself”?

== See Also ==
* [[pronouns]]
* [[pronouns-examples]]
* [[pronouns-formats]]

pronouns-brainstorming

2025-07-20T06:11:18Z

Tantek: subheads, stub p-pronouns and p-pronoun approaches

This page is for proposing and experimenting with markup for publishing [[pronouns|pronoun]] information, as well as documenting experimental markup already in use. Per [[process]], this page is part of:
* [[pronouns-examples]]
* [[pronouns-formats]]
* [[pronouns-brainstorming]]

== Experimental Examples ==
=== nominative oblique possessive ===
Ashton McAllan marks up her pronouns as:
<source lang=html4strict>
she /
her /
hers
</source>
in her [[h-card]] on http://acegiak.net/

Each pronoun is listed individually with it's form allowing parsers and programs to identify them for different uses. Other languages may include different forms of pronoun. This solution is suggested after reading [https://en.wikipedia.org/wiki/Personal_pronoun the Wikipedia Personal Pronouns article]

[[User:GRegorLove|gRegor Morrill]] marks up his pronouns similarly (note corrected spelling of "possessive"):
<source lang=html4strict>
Pronouns: he/
him/
his
</source>
on http://gregorlove.com/about/

[https://www.jvt.me/ Jamie Tanna] followed this same pattern, and [https://www.jvt.me/posts/2019/04/10/pronouns-microformats/ blogged about implementing it, and why].

[[User:Jgarber|Jason Garber]] marks up his pronouns using the pattern:
<source lang=html4strict>

I use the pronouns
<a href="https://my.pronoun.is/he/him/his">
he/
him/
his
</a>.

</source>

=== u-pronoun ===
[http://vanderven.se/martijn/ Martijn van der Ven] marks up his pronouns (more clearly on [http://vanderven.se/martijn/gender/ his gender page]) using only a dictionary URL:
<source lang=html4strict>

I use male pronouns (
<a href="https://nl.wiktionary.org/wiki/hij#Persoonlijk_voornaamwoord" lang="nl" class="u-pronoun">hij</a>,
<a href="https://sv.wiktionary.org/wiki/han#Pronomen" lang="sv" class="u-pronoun">han</a>,
<a href="https://en.wiktionary.org/wiki/he#Pronoun" class="u-pronoun">he</a>,
<a href="https://de.wiktionary.org/wiki/er#Personalpronomen" lang="de" class="u-pronoun">er</a>
) but also accept gender-neutral pronouns (
<a href="https://sv.wiktionary.org/wiki/hen#Pronomen" lang="sv" class="u-pronoun">hen</a>,
<a href="https://en.wiktionary.org/wiki/they#Pronoun" class="u-pronoun">they</a>
). If you are writing about me and are in doubt: ask.
</source>

* There is no way Martijn sees himself supporting 4 cases for English (subjective, objective, reflexive, and possessive), 5 cases for German (nominative, accusative, genitive, dative, and possessive), and a possible 13 cases for Finnish in the future. Doubtful anyone else will be doing that either: at least 1 implementation (by [https://unrelenting.technology/ Greg V]) of English p-x-pronoun-* exists in the wild that only specifies 2 cases.
* Simplifying for human visitors who can instantly get started with my pronoun of choice is seen as more important than catering to theoretical computer parsers.
* His thought process [http://wiki.zegnat.net/microformats/pronoun has been documented].
* [https://00dani.me/ Danielle McLean] is also using <code>u-pronoun</code>, linking to the popular [https://pronoun.is/ Pronoun Island] registry page for her pronouns: <code><nowiki><a class="u-pronoun" href="https://pronoun.is/she/her">she/her</a></nowiki></code>.
** Started looking for a way to mark-up pronouns because the p-sex/p-gender-identity combo is “[https://chat.indieweb.org/2017-10-29/1509268972735000 unbelievably terrible]”.
** [https://chat.indieweb.org/2017-10-29/1509269322353000 Agreed with Martijn’s arguments] for why a link is better than per-case mark-up.
* [[User:Sknebel|sknebel]] [https://chat.indieweb.org/microformats/2018-08-19#t1534703222243600 notes] (2018-08-19) that he would prefer to see text (that possibly leads him to Google for proper use) than just URLs in the parser output. Although the URLs are useful, [https://chat.indieweb.org/microformats/2018-08-19#t1534705418184500 a simple name:url pair] would increase the usefulness.
** Possibly something like <code>.[up]-pronoun.h-pronoun > .u-url</code> paired with <code>.[up]-pronoun.h-pronoun > .p-name</code>. [[h-cite]] would be prior art as also expressing “a reference to [something] in some way with name and url”. [https://chat.indieweb.org/microformats/2018-08-19/1534705492641900]

=== p-pronouns ===
The examples show many sites provide a single plain text field for the user to type in their pronouns.

A <code>p-pronouns</code> property can be used to markup the full text of what's been entered by the user

=== p-pronoun ===
Another variant is to markup each individual pronoun with <code>p-pronouns</code> (singular) which then makes it eaier for consuming code to a set of pronoun values for it to choose among.

== Other Platforms ==
A [https://github.com/tootsuite/mastodon/issues/3211 GitHub issue about adding pronoun fields] to [https://indieweb.org/Mastodon Mastodon] was [https://chat.indieweb.org/microformats/2018-08-19#t1534700249077000 discussed in #microformats] on 2018-08-19. The comments in the issue bring up some points previously brought up by Martijn in regards to how useful it would be for machines. Also includes interesting survey data showing that just listing the minimal amount of cases does not show all inflections, e.g. does “ne/nim” refer to “ne/nem/neir/neirs/nemself” or “ne/nem/nayr/nayrs/nemself”?

== See Also ==
* [[pronouns]]
* [[pronouns-examples]]
* [[pronouns-formats]]

pronouns-brainstorming

2025-07-20T05:43:31Z

Tantek: link to other pages in context up top and See also

This page is for proposing and experimenting with markup for publishing [[pronouns|pronoun]] information, as well as documenting experimental markup already in use. Per [[process]], this page is part of:
* [[pronouns-examples]]
* [[pronouns-formats]]
* [[pronouns-brainstorming]]

== Experimental Examples ==

Ashton McAllan marks up her pronouns as:
<source lang=html4strict>
she /
her /
hers
</source>
in her [[h-card]] on http://acegiak.net/

Each pronoun is listed individually with it's form allowing parsers and programs to identify them for different uses. Other languages may include different forms of pronoun. This solution is suggested after reading [https://en.wikipedia.org/wiki/Personal_pronoun the Wikipedia Personal Pronouns article]

[[User:GRegorLove|gRegor Morrill]] marks up his pronouns similarly (note corrected spelling of "possessive"):
<source lang=html4strict>
Pronouns: he/
him/
his
</source>
on http://gregorlove.com/about/

[https://www.jvt.me/ Jamie Tanna] followed this same pattern, and [https://www.jvt.me/posts/2019/04/10/pronouns-microformats/ blogged about implementing it, and why].

[[User:Jgarber|Jason Garber]] marks up his pronouns using the pattern:
<source lang=html4strict>

I use the pronouns
<a href="https://my.pronoun.is/he/him/his">
he/
him/
his
</a>.

</source>

[http://vanderven.se/martijn/ Martijn van der Ven] marks up his pronouns (more clearly on [http://vanderven.se/martijn/gender/ his gender page]) using only a dictionary URL:
<source lang=html4strict>

I use male pronouns (
<a href="https://nl.wiktionary.org/wiki/hij#Persoonlijk_voornaamwoord" lang="nl" class="u-pronoun">hij</a>,
<a href="https://sv.wiktionary.org/wiki/han#Pronomen" lang="sv" class="u-pronoun">han</a>,
<a href="https://en.wiktionary.org/wiki/he#Pronoun" class="u-pronoun">he</a>,
<a href="https://de.wiktionary.org/wiki/er#Personalpronomen" lang="de" class="u-pronoun">er</a>
) but also accept gender-neutral pronouns (
<a href="https://sv.wiktionary.org/wiki/hen#Pronomen" lang="sv" class="u-pronoun">hen</a>,
<a href="https://en.wiktionary.org/wiki/they#Pronoun" class="u-pronoun">they</a>
). If you are writing about me and are in doubt: ask.
</source>

* There is no way Martijn sees himself supporting 4 cases for English (subjective, objective, reflexive, and possessive), 5 cases for German (nominative, accusative, genitive, dative, and possessive), and a possible 13 cases for Finnish in the future. Doubtful anyone else will be doing that either: at least 1 implementation (by [https://unrelenting.technology/ Greg V]) of English p-x-pronoun-* exists in the wild that only specifies 2 cases.
* Simplifying for human visitors who can instantly get started with my pronoun of choice is seen as more important than catering to theoretical computer parsers.
* His thought process [http://wiki.zegnat.net/microformats/pronoun has been documented].
* [https://00dani.me/ Danielle McLean] is also using <code>u-pronoun</code>, linking to the popular [https://pronoun.is/ Pronoun Island] registry page for her pronouns: <code><nowiki><a class="u-pronoun" href="https://pronoun.is/she/her">she/her</a></nowiki></code>.
** Started looking for a way to mark-up pronouns because the p-sex/p-gender-identity combo is “[https://chat.indieweb.org/2017-10-29/1509268972735000 unbelievably terrible]”.
** [https://chat.indieweb.org/2017-10-29/1509269322353000 Agreed with Martijn’s arguments] for why a link is better than per-case mark-up.
* [[User:Sknebel|sknebel]] [https://chat.indieweb.org/microformats/2018-08-19#t1534703222243600 notes] (2018-08-19) that he would prefer to see text (that possibly leads him to Google for proper use) than just URLs in the parser output. Although the URLs are useful, [https://chat.indieweb.org/microformats/2018-08-19#t1534705418184500 a simple name:url pair] would increase the usefulness.
** Possibly something like <code>.[up]-pronoun.h-pronoun > .u-url</code> paired with <code>.[up]-pronoun.h-pronoun > .p-name</code>. [[h-cite]] would be prior art as also expressing “a reference to [something] in some way with name and url”. [https://chat.indieweb.org/microformats/2018-08-19/1534705492641900]

== Other Platforms ==
A [https://github.com/tootsuite/mastodon/issues/3211 GitHub issue about adding pronoun fields] to [https://indieweb.org/Mastodon Mastodon] was [https://chat.indieweb.org/microformats/2018-08-19#t1534700249077000 discussed in #microformats] on 2018-08-19. The comments in the issue bring up some points previously brought up by Martijn in regards to how useful it would be for machines. Also includes interesting survey data showing that just listing the minimal amount of cases does not show all inflections, e.g. does “ne/nim” refer to “ne/nem/neir/neirs/nemself” or “ne/nem/nayr/nayrs/nemself”?

== See Also ==
* [[pronouns]]
* [[pronouns-examples]]
* [[pronouns-formats]]

pronouns-formats

2025-07-20T05:41:58Z

Tantek: link to other pages in context up top and See also

This page is for documenting existing, stable standards and formats for publishing [[pronouns|pronoun]] information. Per [[process]], this page is part of:
* [[pronouns-examples]]
* [[pronouns-formats]]
* [[pronouns-brainstorming]]

== vCard ==

* [https://mailarchive.ietf.org/arch/msg/vcarddav/FCjVznQHsmtPPLmv2z69OcxL8u0/ VCARDDAV mailing list discussion on adding a pronoun property]

== See Also ==
* [[pronouns]]
* [[pronouns-examples]]
* [[pronouns-brainstorming]]

pronouns-examples

2025-07-20T05:40:31Z

Tantek: link to other pages in context up top and See also

This page documents specific examples of how [[pronouns|pronoun]] information is currently published on the web, as well as UIs which support pronoun fields. Per [[process]], this page is part of:
* [[pronouns-examples]]
* [[pronouns-formats]]
* [[pronouns-brainstorming]]

== Sites and Services ==
Examples of sites/software which allow their users to specify their pronouns, either to be displayed in a profile, or to configure pronouns used by the software to refer to the user.

* [https://bagcheck.com/blog/01-the-gender-question Bagcheck] chose to ask which pronoun you want to use:
** Preferred Possessive Pronoun: ( )Her ( )His ( )Their
* MediaWiki.org has radio button choice on Preferences: "(I prefer not to say)", "She edits wiki pages", "He edits wiki pages"
* MetaFilter updated their user profile field from "Gender" to "Gender and/or pronouns" [http://metatalk.metafilter.com/24423/Making-room-for-pronouns-on-the-profile-page]
* …

== Incidentally in Profiles ==
Examples of pronoun information published by people on sites which don’t explicitly implement pronoun support, e.g. as part of a description field in their profile.

* https://twitter.com/rknLA <q>he/him</q> in profile
* [https://twitter.com/abbieandahalf @abbieandahalf] has "they/them" in their Twitter bio
* [https://twitter.com/brianloveswords @brianloveswords] has "he/him" in his Twitter bio
* [https://twitter.com/lindseybieda @lindseybieda] has "she/her" in her Twitter bio
* [https://twitter.com/jneen_ @jneen_] has http://pronoun.is/she in her Twitter bio
* [http://my.pronoun.is my.pronoun.is] (or just [http://pronoun.is pronoun.is]) is a little website that offers a way to show your pronouns on a silo profile using a link, e.g. [http://my.pronoun.is/they/them my.pronoun.is/they/them]
* …

== Personal Sites ==
See also: [https://indieweb.org/pronoun#IndieWeb_Examples pronoun#Indieweb Examples]

Examples of people who publish pronoun information on their personal sites, sometimes with experimental microformats2 properties.

* http://acegiak.net as of 2015-02-18 using experimental <code>p-x-pronoun-*</code> property classes in an h-card
* http://gregorlove.com/about as of 2015-03-12 using experimental <code>p-x-pronoun-*</code> property classes in an h-card
* http://vanderven.se/martijn/ on 2017-05-21 using experimental <code>u-pronoun</code> property classes in an h-card to link to language-specific wiktionary.org pages for each pronoun
* https://00dani.me/ using experimental a <code>u-pronoun</code> property class linking to a pronoun.is page
* https://aaronparecki.com/about/ plain text <q>He / Him</q> inside an h-card
* https://www.jvt.me on [https://www.jvt.me/posts/2019/04/10/pronouns-microformats/ 2019-04-10] using experimental <code>[x-]pronoun-*</code> property classes in an h-card
* [https://sixtwothree.org sixtwothree.org] on 2019-08-27 using experimental <code>x-pronoun-*</code> property classes in an h-card
* beesbuzz[.]biz/about on 2018-11-16, and to the representative h-card on 2019-12-06 using experimental <code>p-pronouns</code> and <code>p-pronoun-*</code> property classes inside an h-card: <q>she/her or they/them</q>
* https://tantek.com h-card on 2020-10-22 using p-pronouns for the full set as a string, and p-pronoun h-pronoun for each individual pronoun linked to a URL explaining its use.
* https://waterpigs.co.uk using experimental <code>x-pronoun-*</code> classes in an h-card: <q>Pronouns: he/him/his</q>
* …

== See Also ==
* [[pronouns]]
* [[pronouns-formats]]
* [[pronouns-brainstorming]]

h-entry

2025-07-02T23:12:15Z

Tantek: use internet archive link to rescue one example, move a couple of examples to offline

{{DISPLAYTITLE:h-entry}}
<dfn style="font-style:normal;font-weight:bold">h-entry</dfn> is a simple, open format for content on the web. h-entry is often used with content intended to be syndicated, e.g. blog posts. h-entry is one of several open [[microformats|microformat]] standards suitable for embedding data in HTML.

h-entry is the [[microformats2]] update to [[hAtom]], in particular its "hentry" root class which itself was based on [[Atom]]'s "entry" element. For an update to "hfeed" see [[h-feed]].

;Status
:This is a '''Living Specification''' yet mature enough to encourage additional implementations and [[h-entry-issues|feedback]]. This specification has portions that are stable, draft, and proposed. Features are stable unless explicitly labeled draft or proposed, or in draft or proposed sections. Draft and proposed features are likely to change substantively. While substantive changes to stable features are unexpected, it is a living specification subject to substantive change by issues and errata filed in response to implementation experience, requiring consensus among participating implementers as part of an explicit [[#change_control|change control]] process.
;Participate
:[https://github.com/microformats/h-entry/issues Open Issues]
:[[h-entry-issues|Resolved issues before 2012-246]]
:[[IRC]]
:Advance the spec by following explicit [[#change_control|change control]] process
<div class="p-author h-card vcard">
;Editor
:[[User:Tantek|Tantek Çelik]]
</div>
;License
: {{cc0-owfa-license}}
__TOC__

== Example ==
Here is a simple blog post example:

<syntaxhighlight lang="html">
<article class="h-entry">
<h1 class="p-name">Microformats are amazing</h1>
Published by <a class="p-author h-card" href="http://example.com">W. Developer</a>
on <time class="dt-published" datetime="2013-06-13 12:00:00">13th June 2013</time>

In which I extoll the virtues of using microformats.

<div class="e-content">
Blah blah blah
</div>
</article>
</syntaxhighlight>

Parsed JSON:
<syntaxhighlight lang="json">
{
"items": [
{
"type": [
"h-entry"
],
"properties": {
"name": [
"Microformats are amazing"
],
"author": [
{
"value": "W. Developer",
"type": [
"h-card"
],
"properties": {
"name": [
"W. Developer"
],
"url": [
"http://example.com"
]
}
}
],
"published": [
"2013-06-13 12:00:00"
],
"summary": [
"In which I extoll the virtues of using microformats."
],
"content": [
{
"value": "Blah blah blah",
"html": "Blah blah blah"
}
]
}
}
]
}
</syntaxhighlight>

== Get started ==
The class '''<code>h-entry</code>''' is a ''root class name'' that indicates the presence of an h-entry.

'''p-name''', '''p-author''', '''dt-published''' and the other h-entry property classnames listed below define properties of the h-entry.

Note: The purpose of an entry is to place it around both the explicitly written content (in the content property or in other specific properties for non-textual content or responses) and whatever else is the context for that content, including properties for when it was published and/or updated, who created it, tags or categorization, and links to what the content is a response to (perhaps with a quoted excerpt) and/or links to syndicated copies.

== Properties ==
h-entry properties, inside an element with class '''h-entry'''. All properties are both optional and may have multiple instances, e.g. multiple name, url, photo etc. properties.
* See [[microformats2-parsing]] to learn more about property classnames.

=== Core Properties ===
The following ''core'' h-entry properties have broad consensus and are broadly interoperably published and consumed:
* '''<code>p-name</code>''' - entry name/title
* '''<code>p-summary</code>''' - short entry summary
* '''<code>e-content</code>''' - full content of the entry
* '''<code>dt-published</code>''' - when the entry was published
* '''<code>dt-updated</code>''' - when the entry was updated
* '''<code>p-author</code>''' - who wrote the entry, optionally embedded [[h-card]](s)
* '''<code>p-category</code>''' - entry categories/tags
* '''<code>u-url</code>''' - entry permalink URL
* '''<code>u-uid</code>''' - universally unique identifier, typically canonical entry URL
* '''<code>p-location</code>''' - location the entry was posted from, optionally embed [[h-card]], [[h-adr]], or [[h-geo]]
* '''<code id="u-syndication">u-syndication</code>''' - URL(s) of syndicated copies of this post. The property equivalent of [[rel-syndication]] ([https://web.archive.org/web/20141027120218/http://erinjo.is:80/2014/checked-into-rockit-colabs-23 archived example])
* '''<code>u-in-reply-to</code>''' - the URL which the h-entry is considered reply to (i.e. doesn’t make sense without context, could show up in comment thread), optionally an embedded [[h-cite]] ([http://indiewebcamp.com/reply-context reply-context]) ([https://kartikprabhu.com/notes/re-citizen-of-indieweb example])
* '''<code id="p-rsvp">p-rsvp</code>''' (enum, use <data> element or [[value-class-pattern]])
** "yes", "no", "maybe", "interested". Case-insensitive values, normalized to lowercase. Examples:
** <code><nowiki>... <data class="p-rsvp" value="YES">is going</data> to ...</nowiki></code>, or
** <code><nowiki>... <data class="p-rsvp" value="Maybe">might go</data> to ...</nowiki></code>
** <code><nowiki>... <data class="p-rsvp" value="no">unable to go</data> to ...</nowiki></code>
** <code><nowiki>... <data class="p-rsvp" value="interested">am interested/tracking/watching</data> ...</nowiki></code>
* '''<code id="u-like-of">u-like-of</code>''' - the URL which the h-entry is considered a “like” (favorite, star) of. Optionally an embedded [[h-cite]]
* '''<code id="u-repost-of">u-repost-of</code>''' - the URL which the h-entry is considered a “repost” of. Optionally an embedded [[h-cite]].

=== Draft Properties ===
The following draft properties are in use in the wild (published and consumed), and are under strong consideration, but are not yet part of the core:

* '''<code id="p-comment">p-comment</code>''' - optionally embedded (or nested?) [[h-cite]](s), each of which is a comment on/reply to the parent h-entry. See [[comment-brainstorming]] ([http://waterpigs.co.uk/notes/4V2DjG/ example])
** [https://github.com/microformats/h-entry/issues/20 Issue 20]
* '''<code id="u-photo">u-photo</code>''' - one or more photos that is/are considered the primary content of the entry, unless there is a <code>p-location h-card</code>, which is still considered a "checkin" (i.e. with a photo). Otherwise the presence of a u-photo means the name of the entry should be interpreted as a caption on the photo, and the summary/content should be interpreted as a description of the photo.
** [https://github.com/microformats/h-entry/issues/4 Issue 4: u-photo draft->core bc way more than 3+ pub and consuming impls/sites]
*** depends on: [https://github.com/microformats/h-entry/issues/24 Issue 24: Update Definition of Draft Property u-photo]
*** depends on: [https://github.com/microformats/h-entry/issues/23 Issue 23: E-Content Overlaps with u-photo and similar properties]
** Proposed (issue TBF): A <code>u-photo</code> property MUST be on an element that provides a text description for the image (e.g. <code><img alt=""></code>) UNLESS the image is already described inside the contents a text property such as <code>p-name</code>, <code>p-summary</code>, or <code>e-content</code>
* '''<code id="u-video">u-video</code>''' - special u- parsing rules for <code><video src> & <source src></code>
** [https://github.com/microformats/h-entry/issues/5 Issue 5]

=== Proposed Additions ===
The following properties are proposed additions based on various use-cases, such as existing [[link-preview-brainstorming|link preview]] markup conventions, but are awaiting citations of use across multiple sites in the wild, and at least one reader / real world consuming code example:
* '''<code>u-audio</code>''' - special u- parsing rules for <code><audio src> & <source src></code>. Examples: [http://transportini.com/ Transportini],[https://indieweb.org/podcast#How_to_podcast_with_h-feed possibly more]
** [https://github.com/microformats/h-entry/issues/6 Issue 6]
* '''<code>u-like</code>''' - similar to p-comment, URL to a like post of the current post, e.g. in a responses list or facepile.
** [https://github.com/microformats/h-entry/issues/31 Issue 32]
* '''<code>u-repost</code>''' - similar to u-like, URL to a repost of the current post, e.g. in a responses list or facepile.
** [https://github.com/microformats/h-entry/issues/30 Issue 30]
* '''<code>u-bookmark-of</code>''' - indicates this h-entry is a bookmark of another URL. Optionally an [[h-cite]]. See [https://indieweb.org/bookmark indieweb.org/bookmark] for examples in the wild.
** [https://github.com/microformats/h-entry/issues/12 Issue 12]
* '''<code>u-featured</code>''' - a representative photo or image for the entry, e.g. primary photo for an article or subject-cropped photo, suitable for use in a [[link-preview]].
** +1 sknebel: https://github.com/microformats/h-entry/issues/14
* Location Properties - https://github.com/microformats/h-entry/issues/29
** '''<code>p-latitude</code>''' - latitude of the location of the entry
** '''<code>p-longitude</code>''' - longitude of the location of the entry
** '''<code>p-altitude</code>''' - altitude of the location of the entry
* '''<code>p-duration</code>''' - duration of an audio or video file in the entry. https://indieweb.org/duration Multiple publishers and consumers in the wild; https://github.com/snarfed/granary/issues/169 more background.
** [https://github.com/microformats/h-entry/issues/21 Issue 21]
* '''<code>p-size</code>''' - size in bytes of an audio or video file in the entry. https://indieweb.org/size Multiple publishers and consumers in the wild; https://github.com/snarfed/granary/issues/169 more background.
* '''<code>u-listen-of</code>''' - also known as a 'scrobble', indicates this h-entry is a listen of another URL. Optionally an h-cite. https://github.com/microformats/h-entry/issues/11
* '''<code>u-watch-of</code>''' - indicates this h-entry is a watch of another URL, a visual version of the scrobble. Optionally an h-cite. https://github.com/microformats/h-entry/issues/17
* '''<code>p-read-of</code>''' - indicates this h-entry is a read post of some written work (book or other document). The value can be the title of the work or an h-cite. Proposal also mentions <code>u-read-of</code>, where the value would be a URL to the written work or a representative citation page. https://github.com/microformats/h-entry/issues/10
* '''<code>u-translation-of</code>''' - indicates this h-entry is a translation of the linked URL into another language. Can be used in the same way as the existing <code>u-like-of</code> and <code>u-repost-of</code> properties, with just the URL to the original h-entry, or (optionally) contain an embedded <code>h-cite</code>. https://github.com/microformats/h-entry/issues/26
* '''<code>u-checkin</code>''' - the URL of the venue/location h-card which the h-entry is considered a “checkin” of. Optionally an embedded h-card. https://github.com/microformats/h-entry/issues/15
* '''<code>u-review-of</code>''' - the URL which the h-entry is considered a review of, optionally an embedded h-cite, h-card, h-event, or h-item. This could allow retirement of the h-review as unnecessary, in theory.
** [https://github.com/microformats/h-entry/issues/32 Issue 32]

The following interpretation is also proposed addition:
* if the <code>p-location</code> is also an embedded [[h-card]], the entry is treated as a "checkin".
** -1 [[User:Aaronpk|Aaronpk]] 14:22, 19 January 2017 (UTC) [https://aaronparecki.com/2017/01/13/21/ this post] is not a checkin, but has an h-card as the p-location property.

Note: As [[h-entry]] usage grows to express and consume different kinds of content, we expect additional properties may be proposed and iterated as demonstrated by real-world needs, usage, and interoperability.

=== Proposing and upgrading ===
How do you add proposed properties and then upgrade them to draft and then core properties?

See: [[h-entry#change_control|change control]]

== Property Details ==
This section is a stub.
=== p-location ===
'''<code>p-location</code>''' has been re-used from [[h-event]].

== FAQ ==
=== p-name of a note ===
<div class="discussion">
* '''What is the <code>p-name</code> of a [https://indieweb.org/note note]?'''
** You probably should avoid adding <code>p-name</code> to notes. See https://indieweb.org/note for more discussion of the topic.
</div>

=== venue an entry was posted from ===
<div class="discussion">
* '''How do you indicate a named venue where an entry was posted from? Like a restaurant or park.'''
** Use an embedded [[h-card]] microformat on a <code>p-location</code> property value.
</div>

=== address an entry was posted from ===
<div class="discussion">
* '''How do you indicate the address where an entry was posted from? Like a restaurant or park.'''
** If the address is just part of a named venue, see above, use an [[h-card]]
** Otherwise use an embedded [[h-adr]] microformat on a <code>p-location</code> property value.
</div>

=== lat long an entry was posted from ===
<div class="discussion">
* '''How do you indicate the latitude and longitude of where an entry was posted from?'''
** If the location has a name in addition to latitude and longitude, see above, use an [[h-card]]
** Otherwise if there is an address in addition to latitude and longitude, see above, use an [[h-adr]]
** Otherwise use an embedded [[h-geo]] microformat on a <code>p-location</code> property value.
</div>

=== dt-published property and HTML5 time element ===
<div class="discussion">
* '''Does the dt-published property need to be a time element?'''
** The <code>dt-published</code> property should be a <code><time></code> element so that you can take advantage of HTML5's "datetime" property.
** This lets you specify a human-readable date in the value of the attribute, and the ISO8601 machine-readable date in the "datetime" property.
</div>

=== what is the bare minimum list of required properties on an h-entry ===
; What is the bare minimum list of required properties on an h-entry?
: No properties are explicitly required, but in practice a h-entry should have the following properties at a minimum for consumers:
:* <code>url</code>
:* <code>published</code> — if there is no "published" date for the "entry", then reconsider whether it is correct (or worth) marking it up as an entry.

; What properties should an h-entry have in addition to the bare minimum?
: Beyond the bare minimum, a typical h-entry should have the following as well:
:* <code>content</code> (or <code>summary</code> at least) - especially for structured content. For a plain text note, the content/summary (whichever is used) should be the same as the <code>name</code>, otherwise it will be implied from the text content of the root element.
:* <code>name</code> - for explicitly named/titled entries like blog posts and articles. Otherwise the entry is assumed to be a "title-less" [https://indieweb.org/note note] (like a tweet).
:* <code>author</code> - including a nested <code>[[h-card]]</code> with author details like name, photo, url.

== Examples in the wild ==
Real world in the wild examples of sites and services that publish or consume h-entry:

* ... add uses of h-entry you see in the wild here.
* ind.ie mark up their [https://ind.ie/blog blog] listing and [https://ind.ie/blog/autumn-events-2014/ permalink] pages with h-entry
* David John Mead marks up his profile, blog posts and comments with h-card, h-entry and h-cite on [http://davidjohnmead.com davidjohnmead.com]
* [[User:Brian|Brian Suda]] marks up his blog posts up with h-entry and h-card on [http://optional.is/required/ optional.is]
* Ashton McAllen marks up his blog posts, reposts, comments and likes with h-entry, h-card and h-cite on [http://acegiak.net/ acegiak.net]
* Emma Kuo marks up her blog posts and notes with h-entry and h-card on [http://notenoughneon.com/ notenoughneon.com]
* Scott Jenson marks up his blog posts with h-entry and h-card on [http://jenson.org/ jenson.org]
* Emily McAllen marks up her blog posts with h-entry and h-card on [http://blackwoolholiday.com/ blackwoolholiday.com]
* Ryan Barrett marks up his blog posts, notes, replies and likes with h-entry and h-card on [https://snarfed.org/ snarfed.org]
* Barry Frost marks up his notes with h-entry, h-card and h-cite on [http://barryfrost.com/ barryfrost.com]
* Amber Case marks up her profile, blog posts, replies and notes with h-entry and h-card on [http://caseorganic.com/ caseorganic.com]
* Johannes Ernst marks up his blog posts with h-entry on [http://upon2020.com/blog/ upon2020.com]
* Michiel de Jong marks up his profile and notes with h-entry and h-card on [https://michielbdejong.com/ michielbdejong.com]
* Mike Taylor marks up his profile and blog posts with h-card and h-entry on [https://bear.im/bearlog/ bear.im]

* Jeena Paradies marks up his profile, blog posts, notes and comments using h-card, h-entry and h-cite on [https://jeena.net/ jeena.net]
* Andy Sylvester marks up his profile, blog posts and comments using h-card and h-entry on [http://andysylvester.com/2014/03/01/howto-setting-up-the-selfoss-feed-reader-with-microformats-support/ andysylvester.com] (note: as of 2014-03-13 using h-entry for comments instead of correct h-cite --[[User:Barnabywalters|bw]] 14:44, 13 March 2014 (UTC))
* Chloe Weil marks up her blog posts with h-entry on [http://chloeweil.com/blog chloeweil.com]
* Christophe Ducamp marks up his blog posts and profile with h-entry and h-card on [http://christopheducamp.com/ christopheducamp.com]
* Glenn Jones marks up his blog posts, notes, replies, profile and comments with h-entry, h-card and h-cite on [http://glennjones.net/ glennjones.net]
* Marcus Povey marks up his blog posts and profile with h-entry and h-card on [http://www.marcus-povey.co.uk/ marcus-povey.co.uk]
* Matthias Pfefferle marks up his blog posts, comments and profile with h-card, h-cite and h-entry on [http://notizblog.org/ notizblog.org]
* Okinawan-lyrics marks up his posts with h-entry and h-card ([http://www.okinawan-lyrics.com/ example])
* App.net marks up profile pages and permalink pages with h-entry as of 2013-08-06 ([https://alpha.app.net/voidfiles example])
* The Twitter archive browser UI uses h-entry and h-card internally, unfortunately it’s not exposed as HTML in static files anywhere
* Brett Comnes marks up his posts with h-entry and h-card ([http://bret.io/2013/06/29/getting-started-with-bower/ example])
* Ben Werdmuller marks up his posts with h-card and h-entry, u-in-reply-to and u-like ([http://werd.io/view/51d5097fbed7ded0633a5956 example])
* Sandeep Shetty marks his posts up with h-card and h-entry, as well as draft u-in-reply-to and experimental u-like properties ([http://sandeep.io/101 example])
* Laurent Eschenauer marks up his posts with h-entry ([http://eschnou.com/entry/first-autonomous-flight-of-my-nodecopter-62-24992.html example])
* Tom Morris marks up his posts using h-entry ([http://tommorris.org/posts/8417 example])
* Numerous newer W3C specs, e.g.
** [http://www.w3.org/TR/2013/CR-css3-values-20130404/ CSS Values and Units Module Level 3 - 2013-04-04]
** [http://www.w3.org/TR/2013/CR-css3-conditional-20130404/ CSS Conditional Rules Module Level 3 - 2013-04-04]
** [http://www.w3.org/TR/2013/WD-css3-page-20130314/ CSS Paged Media Module Level 3 - 2013-03-14]
** [http://www.w3.org/TR/2013/WD-css-counter-styles-3-20130221/ CSS Counter Styles Level 3 - 2013-02-21]
* [http://wordpress.org/extend/themes/sempress SemPress] is a WordPress theme that supports h-card, h-feed/h-entry.
* [http://the-pastry-box-project.net/ The Pastry Box Project] use h-card and h-entry markup on their homepage and individual thoughts pages
* Aaron Parecki uses h-entry to mark up notes, e.g. [http://aaronparecki.com/2012/230/reply/1 2012/230/reply/1].
* [http://tantek.com/ Tantek Çelik] uses h-entry on his home page, as well as h-entry on all post permalinks, e.g. [http://tantek.com/2012/243/t1/name-beats-title-modern-use-dubline-core-wrong-uf2 2012-243 post], with [[rel-prev]]/[[rel-next]] (if applicable) to indicate prev/next posts
* [http://waterpigs.co.uk/ Barnaby Walters] uses h-entry on all notes and articles, as well as nested within notes as reply contexts [http://waterpigs.co.uk/notes/1468/ example] and comments [http://waterpigs.co.uk/notes/1482/ example].

=== offline ===
* Erin Jo Ritchey marked up her profile, posts and comments using h-card, h-entry and h-cite with idno on <nowiki>http://erinjo.is/</nowiki>
* Kyle Mahan marked up his profile and notes with h-card and h-entry on <nowiki>http://kylewm.com/</nowiki>
* spreadly marks up share permalink pages with h-entry, as well as minimal h-cards and experimental p-like properties

== Validating ==
* '''[http://indiewebify.me/validate-h-entry/ indiewebify.me h-entry validator]''' parses [[h-entry]] markup, finds common errors and makes suggestions for things to add, with code samples
* '''[http://shrewdness.waterpigs.co.uk/test/ Shrewdness h-entry/h-feed validator]''' shows how shrewdness interprets+displays h-entries, with original source and interim formats, works for single h-entries and feed pages

{{h-spec-section-validating}}

== Implementations ==
Software implementations that publish or consume h-entry, including themes, plugins, or extensions:

(This section is a stub that needs expansion! In practice, nearly every CMS on every [https://indieweb.org/ indie web] site supports publishing h-entry by default.)

When adding an implementation, please provide and link to its home page and open source repo if any.
* [https://gnu.io/social/ GNUsocial] [https://git.gnu.io/gnu/gnu-social/ source code]
* [https://hubzilla.org/hubzilla/ Hubzilla] [https://github.org/redmatrix/hubzilla source code]
* [http://friendica.com/ Friendica] [https://github.org/friendica/friendica source code]
* [http://github.com/dissolve/inkblot InkBlot]
* ...

== Backward Compatibility ==
=== Publisher Compatibility ===
For backward compatibility with legacy [[hAtom]] consuming implementations, use [[hAtom]] classnames (or rel values) in addition to the more future-proof h-entry properties, for example:

<syntaxhighlight lang="html">
<article class="h-entry hentry">
<h1 class="p-name entry-title">A Tale Of Two Tags</h1>
<address class="p-author author h-card vcard">
<a href="https://chandra.example.com/" class="u-url url p-name fn" rel="author">Chandra</a>
</address>
<time class="dt-published published" datetime="2012-06-20T08:34:46-07:00">June 20, 2012</time>
<div class="e-content entry-content">
It was the best of visible tags, it was the alternative invisible tags.
The a tag is perhaps the best of HTML, yet its corresponding invisible link tag has uses too.
</div>
<a href="/category/uncategorized/" rel="category tag" class="p-category">General</a>
</article>
</syntaxhighlight>

{{note|Note: you may use any valid HTML5 elements. The <code>article h1 address time</code> elements are used in the example as semantically richer suggestions, however in general <code>div span</code> work fine too. The <code>time</code> element is special though in that its <code>datetime</code> attribute provides a more author/user friendly way of separating a machine readable ISO8601 datetime from a human readable summary.
}}

The list of equivalent [[hAtom]] classnames and rel values is provided below.

=== Parser Compatibility ===
Microformats parsers {{should}} detect classic properties only if a classic root class name is found and parse them as microformats2 properties.

If an "h-entry" is found, don't look for an "hentry" on the same element.

Compat root class name: <code id="hentry">hentry</code> 
Properties: (parsed as '''p-''' plain text unless otherwise specified):

* <code>entry-title</code> - parse as '''<code>p-name</code>'''
* <code>entry-summary</code> - parse as '''<code>p-summary</code>'''
* <code>entry-content</code> - parse as '''<code>e-content</code>'''
* <code>published</code> - parse as '''dt-'''
* <code>updated</code> - parse as '''dt-'''
* <code>author</code> - including compat root <code>vcard</code> in the absence of <code>h-card</code>
* <code>category</code>
* <code>rel=bookmark</code> - parse as '''<code>u-url</code>'''. While not a class name nor typical microformats property, rel=bookmark was the only way to indicate an hentry permalink. Thus parsers should look for rel=bookmark hyperlinks inside an hentry, and take their "href" value as a value for a '''<code>u-url</code>''' property, including handling any relative URL resolution.
* <code>rel=tag</code> - parse as '''<code>p-category</code>'''. While not a class name nor typical microformats property, rel=tag was the typical way to tag an hentry. Thus parsers should look for rel=tag hyperlinks inside an hentry, and take the last path segment of their "href" value as a value for a '''<code>p-category</code>''' property.

Proposed: ([https://github.com/microformats/h-entry/issues/7 follow-up in issue #7])
* <code>time.entry-date[datetime]</code> - in the absence of <code>published</code>, parse as '''<code>dt-published</code>'''. parse for the first <code><time></code> element with class name of <code>entry-date</code> and non-empty <code>datetime</code> attribute inside an hentry, if there is no <code>published</code> property, use that time element's <code>datetime</code> attribute value for the <code>dt-published</code> property. Evidence: default WordPress themes 2011-2014([https://wp-themes.com/twentyeleven/][https://wp-themes.com/twentytwelve/][https://wp-themes.com/twentythirteen/][https://wp-themes.com/twentyfourteen/]).
* <code>rel=author</code> - in the absence of <code>author</code>, parse as '''<code>u-author</code>'''. While not a class name nor typical microformats property, rel=author was commonly used to link to an author's URL. Thus parsers should look for rel=author hyperlinks inside an hentry (or even on the same page, preceding the hentry), use the absolute version of it as a value for the '''<code>u-author</code>''' property if there is no "author" property. (citations to "hentry" examples in the wild that depend on rel=author needed to accepted this proposal. Note: default WordPress themes twentyeleven, twentytwelve, twentythirteen, twentyfourteen all use rel=author but only inside class="author vcard", and thus rel=author can be ignored since authorship is already picked up by existing <code>author</code> backcompat parsing.)

=== Compat FAQ ===
==== What about rel bookmark ====
Also asked as: ''Why use an h-entry u-url u-uid for permalinks when I have [[rel-bookmark|rel=bookmark]]?''

A: tl;dr: use <code>class="u-url u-uid"</code> instead of <code>rel=bookmark</code> for post permalinks because it's simpler (fewer attributes), and works better across contexts (permalink page, recent posts on home page, collection of posts on archive pages).

rel=bookmark was the old [[hAtom]] way of marking up permalinks. Since then two factors have contributed to reducing use of rel inside microformats:
* rel by typically* document scoped in [[HTML5]] - thus making it inappropriate for use in microformats that are aggregated, e.g. a collection of posts on a home page or in monthly archives.
* it is easier to always use class names for properties. When formats use two (or more!) attributes in HTML to specify properties, confusion results in lower data quality (of the markup and thus the stuff that is marked up). Thus per the microformats [[principle]] of [[simplicity]], in [[microformats2]] we only use class names for properties.

<nowiki>*</nowiki> even though rel=bookmark in particular is article-element / sectioning scoped in HTML5[http://www.whatwg.org/specs/web-apps/current-work/multipage/links.html#link-type-bookmark], it's a detail that typical authors are not going to remember, and thus it's not good to depend on it for any kind of format.

==== Why rename entry-title entry-summary entry-content ====
The <code>entry-*</code> classnames in classic [[hAtom]] were prefixed as such due to concerns about vocabulary overlap with the title (as in job title, completely separate semantic) property in [[hCard]] and the summary property in [[hCalendar]] (see: [[hatom-faq#Could_hAtom_instead_use_title_content_and_summary|hAtom FAQ]]).

Following the [[simplicity]] principle, in microformats2, the aforementioned vagueness of '''title''' is dealt with by removing it. As '''name''' is now used consistently across all vocabularies as the property which “names” the microformat, it makes sense to use it to mark up the name of a post.

Likewise, adding entry- to '''summary''' doesn’t add any useful information, and in practice there have been no problems with blog post summaries overlapping with entry summaries, so it makes sense to simplify to '''summary'''. The same applies to '''entry-content''' simplified to '''content'''.

See also: [http://krijnhoetmer.nl/irc-logs/microformats/20120830#l-128 2012-08-30 IRC conversation].

== Related Work ==
Work that re-uses or builds upon h-entry:
* [https://mailpile.pagekite.me:8080/p/Open_Message_Format Mailpile Open Message Format] is using h-entry with structured properties, e.g. p-author h-card.

== Background ==
This work is based on the existing [[hAtom]] microformat, and extensive selfdogfooding in the [http://indiewebcamp.com indie web camp] community.

== change control ==
Minor editorial changes (e.g. fixing minor typos or punctuation) that do not change and preferably clarify the structure and existing intended meaning may be done by anyone without filing issues, requiring only a sufficient "Summary" description field entry for the edit. More than minor but still purely editorial changes may be made by an editor. Anyone may question such editorial changes by undoing corresponding edits without filing an issue. Any further reversion or iteration on such an editorial change must be done by filing an issue.

For the stable features of this document, substantive issue filing, resolution, and edits may be done by filing an [[h-entry-issues|issue]] and discussing them on the issue and on #microformats [[IRC]] with a link to the issue.

Because this is primarily a vocabulary specification, very few issues beyond the list of vocabulary have been filed or required any lengthy discussion. If such a non-trivial issue arises in the future, use the [[microformats2-parsing#change_control|microformats2-parsing change control process]] to resolve them.

In general, non-vocabulary related features or requirements should be avoided in this specification, e.g. changes to microformats2 syntax must be proposed as [[microformats2-parsing]] changes using the [[microformats2-parsing#change_control|microformats2-parsing change control process]].

Beyond that, the following requirements must be met for adding or moving features (e.g. properties and values) to proposed, draft, or stable. File an issue to collect necessary citations for the requirements for each property being proposed or upgraded, explain how citations fulfill the requirements for the phase(s), get consensus on both (resolve any implementer objections) in the issue.

;Proposed
:[[#Proposed_Additions|Proposed features]] must provide documentation of what specific real world use-cases they are solving, preferably with a link to a step-by-step user scenario, e.g. demonstratable using existing non-standard / single-site / single-implementation tools.
;Draft
:[[#Draft_Properties|Draft properties]] must in addition be published and consumed in the wild on the public web, demonstrate solving the use case for which they were proposed, and should provide citations of real world public web sites publishing and (other sites) consuming them, interoperably.
;Stable
:Stable features (e.g. [[#Core_Properties|Core Properties]]) must in addition be published and consumed in the wild on multiple sites by multiple implementations (3+ different sites and implementations for publishing and consuming). When a draft property reaches a critical mass of deployment by numerous sites and implementations (far beyond 3+), due to network effects and backward compatibility considerations it effectively becomes stable, since it becomes increasingly difficult to change it in any way and have so many sites and implementations also change.

For creating an entirely new vocabulary, and more details about how to research existing values, properties, document examples in the wild, etc., see the microformats [[process]].

== See Also ==
* [[h-feed]]
* [[microformats2]]
* [[microformats2-parsing]]
* [[h-geo]]
* [[hCard]]

[[Category:Specifications]]

svg

2025-06-18T20:25:16Z

Tantek: move article to Examples in the wild, SA XML

{{stub}}

The [https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/class class attribute is allowed on SVG elements]. As such, there are rich possibilities for embedding microformats with or in them.

== Examples ==

Here are a couple of examples.

* a simple [[h-card]] using [[microformats2-implied-properties | implied properties]]:

<syntaxhighlight lang=xml>
<svg class="h-card" viewBox="0 0 200 200" height="200" width="200">
<circle cx="50%" cy="50%" r="100" fill="gold"/>
<text x="25" y="110" font-size="30">
Example Co.
</text>
</svg>
</syntaxhighlight>

Parsed JSON:

<syntaxhighlight lang="json">
{
"items": [
{
"type": [
"h-card"
],
"properties": {
"name": [
"Example Co."
]
}
}
],
"rels": {},
"rel-urls": {}
}
}
</syntaxhighlight>

* a slightly more complex example of an [[h-card]] with several specified properties and an embedded [[h-adr]]:

<syntaxhighlight lang=xml>
<svg class="h-card" viewBox="0 0 300 300" height="300" width="300">
<circle cx="100" cy="100" r="100" fill="gold"/>
<text class="p-name" x="25" y="110" font-size="30">
Example Co.
</text>
<g class="p-adr h-adr">
<text class="p-street-address" x="25" y="220" font-size="18">
123 Main St.
</text>
<text x="25" y="240" font-size="18">
<tspan class="p-locality">Pleasantville</tspan>,
<tspan class="p-region">California</tspan>
<tspan class="p-postal-code">90091</tspan>
</text>
</g>
<text class="p-tel" x="25" y="260" font-size="18">
+1-323-555-0100
</text>
</svg>
</syntaxhighlight>

Parsed JSON:

<syntaxhighlight lang="json">
{
"items": [
{
"type": [
"h-card"
],
"properties": {
"name": [
"Example Co."
],
"adr": [
{
"type": [
"h-adr"
],
"properties": {
"street-address": [
"123 Main St."
],
"locality": [
"Pleasantville"
],
"region": [
"California"
],
"postal-code": [
"90091"
]
},
"value": "123 Main St. Pleasantville, California 90091"
}
],
"tel": [
"+1-323-555-0100"
]
}
}
],
"rels": {},
"rel-urls": {}
}
</syntaxhighlight>

== Examples in the wild ==
* https://btrem.com/2021/04-svg-microformats — also a great how to with code examples!

== See also ==
* [[XML]]

SVG

2025-06-18T20:17:10Z

Tantek: r

#redirect:[[svg]]

plain-xml

2025-06-18T20:16:45Z

Tantek: see also

= Plain XML =

== Reference ==
W3C XML home page: <abbr title="eXtensible Markup Language">[http://www.w3.org/XML/ W3C XML]</abbr>

== Tools==

* https://codebeautify.org/xmlviewer - Tool to edit, format, and validate XML.
* https://jsonformatter.org/xml-formatter - XML Formatter - to format xml data.

== Criticism ==
A collection of critical thoughts on "plain" or "generic" XML, why it can be considered harmful etc.

* [[plain-old-xml-considered-harmful]] - feel free to add to this specific page from the below resources.
* 2003-09-09 [http://ln.hixie.ch/?start=1064828134&count=1 Never send content in proprietary (XML) formats over the wire] by Ian Hickson
* 2004-07-21 [http://www.xml.com/pub/a/2004/07/21/dive.html XML on the Web Has Failed] by Mark Pilgrim
* 2005 [http://blog.davidjanes.com/mtarchives/2005_10.html#003410 David Janes on the failure of *plain XML* approaches]
* 2006-01-08 [http://www.tbray.org/ongoing/When/200x/2006/01/08/No-New-XML-Languages Don’t Invent XML Languages] by Tim Bray
* 2006-01-31 [http://www.artima.com/weblogs/viewpost.jsp?thread=146647 Which Part of "No XML" Don't You Understand?] by Guido van Rossum
* 2006-11-23 [http://adactio.com/journal/1212/ More thoughts on portable social networks] by Jeremy Keith. In particular: <blockquote style="margin:0;padding:0"><ol><li>Publishing XML is hard, certainly harder than publishing HTML.</li><li>Out of sight is out of mind.</li></ol></blockquote>

== Doomed ==

Back when I saw Douglas Crockford speak on [http://www.json.org/ JSON] at the [http://www.siliconvalley-codecamp.com/ Silicon Valley Code Camp] on 2006-10-07, I realized that with HTML+microformats for document content (user authored data), and JSON for API data (machine generated data), where did that leave XML? Nowhere it seems. I asked Douglas Crockford after his session, and have been mentioning it informally to a few people since, partially to get critical feedback on my reasoning, and partially to pass on a general questioning of the XML religion. It seems that this meme has been propagating quite well. [[User:Tantek|Tantek]] 16:46, 31 Jan 2007 (PST)

* [http://blog.360.yahoo.com/blog-TBPekxc1dLNy5DOloPfzVvFIVOWMB0li?p=602 XML on the Web is Dead] by Douglas Crockford
* [http://www.oreillynet.com/xml/blog/2006/12/xml_and_the_next_web_and_the_p_1.html XML and the Next Web (and the Previous...)] by Simon St. Laurent: <blockquote>XML was originally “SGML on the Web”, planned as a drastic change. Instead of tag soup HTML and just-implemented CSS, XML would provide a solid base format for information, XLink would offer much improved hypertext capabilities, and XSL would render all that information into something much prettier and more controllable.XML pretty completely missed its original target market. SGML culture and web developer culture seemed like a poor fit on many levels, and I can’t say I even remember a concerted effort to explain what XML might mean to web developers, or to ask them whether this new vision of the Web had much relationship to what they were doing or what they had planned. SGML/XML culture and web culture never really meshed.Instead, XML took over much of SGML’s role in the publishing world, offered itself as a common format for data interchange, and became the foundation for a whole set of projects mistakenly called ‘web services’. That work on web services has proven to be about as successful on the Web as the original “SGML for the Web” vision.Once again, no one paused to asked the web folk what they might actually want, and programmers’ visions yielded a replacement for CORBA and mainframe messaging rather than lightweight tools that web developers might find useful. No matter, though - those web developers eventually figured out that HTTP could carry bits of XML well enough to solve many of their problems, without requiring them to dive deeply into either XML or protocol design.</blockquote>
* ...

== See Also ==
* [[SVG]]
* [[WML]]

wml

2025-06-18T20:15:41Z

Tantek: no longer theoretical

{{DISPLAYTITLE:microformats in WML}}
{{stub}}

<abbr>WML</abbr> stands for [[Wikipedia:Wireless Markup Language|Wireless Markup Language]], an [[plain-xml|XML]] dialect, with elements that have <code>class</code> attributes so it can be enhanced with microformats.

== Examples in the wild ==
* [https://lab.artlung.com/wml/ ArtLung's WAP / WML Microformats Demo Page] demonstrates a valid WML page with valid microformats.
* ...

== See Also ==
* [[HTML3]]
* [[XML]]

new

2025-06-18T19:20:03Z

Tantek: notified, use IRC, reframe extra credit as next step

{{DISPLAYTITLE:new microformats}}

If you want to create a new microformat, follow the microformats [[process]].

To be notified when new microformats are discussed, join the #microformats [[IRC]] channel.

Document a new proprietary format on the respective *-formats wiki page.

E.g. if "ACME" company proposes a "ACME widget format", then:
* document it on a "widget-formats" wiki page, linking to their proprietary specification, and listing the properties/values defined therein.
Next step:
* create a "widget" wiki-page that lists wiki links to "widget-examples", "widget-formats", and "widget-brainstorming" per the [[process]].

wml

2025-06-18T18:58:22Z

Tantek: displaytitle, Examples in the wild

{{DISPLAYTITLE:microformats in WML}}
{{stub}}

<abbr>WML</abbr> stands for [[Wikipedia:Wireless Markup Language|Wireless Markup Language]], which has <code>class</code> attributes on its elements so it can theoretically be enhanced with microformats.

== Examples in the wild ==
* ...

== See Also ==
* [[HTML3]]

wml

2025-06-18T18:57:39Z

Tantek: sa caps

{{stub}}

<abbr>WML</abbr> stands for [[Wikipedia:Wireless Markup Language|Wireless Markup Language]], which has <code>class</code> attributes on its elements so it can theoretically be enhanced with microformats.

== See Also ==
* [[HTML3]]

html3

2025-06-18T18:57:18Z

Tantek: see also WML

{{DISPLAYTITLE:microformats in HTML 3.0}}

This page documents use of microformats in [http://www.w3.org/MarkUp/html3/Contents.html HTML 3.0].

As HTML 3.0 has been [http://www.w3.org/MarkUp/html3/CoverPage.html superceded] by [http://www.w3.org/TR/REC-html32.html HTML 3.2] (which itself [http://www.w3.org/MarkUp/Wilbur/ was superceded] by [http://www.w3.org/TR/REC-html40 HTML 4.0] (which itself has been revised with [http://www.w3.org/TR/html401/ HTML 4.01])), it is unlikely that any new content will be developed with HTML 3.0 (or 3.2 for that matter).

However, existing HTML 3.0 sites can be updated to use microformats without having to do the extra work to also update them to HTML 3.2 (or 4.0, or 4.01).

== features in HTML 3 ==
Most features in HTML 3 survived into 3.2 and 4. However, a few elements did not make it past 3.0 (or were renamed) which deserve special consideration due to their potential semantic interaction and overlap with microformats.

=== AU ===
From [http://www.w3.org/MarkUp/html3/logical.html HTML 3.0: Information Type Elements]:
<blockquote cite="http://www.w3.org/MarkUp/html3/logical.html">The <code><AU></code> element indicates the name of an author.</blockquote>
The AU element could be used for better conveyance of semantics with:
* [[hReview]]: reviewer
* [[hAtom]]: author

=== PERSON ===
Also from [http://www.w3.org/MarkUp/html3/logical.html HTML 3.0: Information Type Elements]:
<blockquote cite="http://www.w3.org/MarkUp/html3/logical.html">The <code><PERSON></code> element is used for names of people to allow these to be extracted automatically by indexing programs. </blockquote >
The PERSON element should be used for nearly every use of [[hCard]] to represent a person (except, when representing an author, use the more semantically specific AU element noted above instead).

=== ABBREV ===
Also from [http://www.w3.org/MarkUp/html3/logical.html HTML 3.0: Information Type Elements]:
<blockquote cite="http://www.w3.org/MarkUp/html3/logical.html">The <code><ABBREV></code> element is used to markup abbreviations.</blockquote>
The ABBREV element was subsequently shortened to ABBR. Thus any patterns (e.g. [[abbr-design-pattern]]) or parsing rules (e.g. [[hcard-parsing]]) that apply to the ABBR element for HTML 4 and later, should also be applied to the ABBREV element in HTML 3.0

== Current microformat compatibility ==
There seems to be no issue with current implementation of the following microformats in HTML 3.0:
* [[hCard]]
** http://otvstudios.com/ - has examples of hCards for people and for an organization.

== see also ==
* [[POSH]]
* [[HTML5]]
* [[WML]]

wml

2025-06-18T18:56:56Z

Tantek: see also html3

WML

2025-06-18T18:56:26Z

Tantek: Tantek moved page WML to wml: mf wiki convention

#REDIRECT [[wml]]

wml

2025-06-18T18:56:26Z

Tantek: Tantek moved page WML to wml: mf wiki convention

wml

2025-06-18T18:55:42Z

Tantek: stub with Wikipedia link

web-sign-in

2025-06-04T00:00:52Z

Tantek: /* example implementations */ relmeauth demo needs an update, prefer IndieLogin as a service to IndieAuth, link to indieweb-org

{{DISPLAYTITLE:Web sign-in}}

Use the (Web sign-in) button on a site to sign-in with your personal web address.

When you click a (Web sign-in) button, the site will ask you for your web address, e.g.:

<blockquote style="border:1px solid gray; float:left; clear; left; padding:1em">
Web address: [........................] (Sign-in)
</blockquote>
<div style="clear:both">or:</div>

<blockquote style="border:1px solid gray; float:left; clear; left; padding:1em">
Web address: 
[........................] 
(Sign-in)
</blockquote>
<div style="clear:both"> </div>

Enter your personal web address and press return / click (Sign-in).

== set up ==

Your personal site must be set up for web sign-in.

# Link from your personal site to your other profiles. Add <code>rel="me"</code> to those hyperlinks. E.g.: <blockquote style="white-space:nowrap"><code><a rel="me" <nowiki>href="https://github.com/your_github_alias">...</nowiki></code></blockquote>
# Edit your other profiles, e.g. your [https://github.com/ GitHub] profile, and set link (🔗) text field to your personal web address. E.g. <blockquote style="white-space:nowrap">🔗 <nowiki>https://yoursite.example.com/</nowiki></blockquote>
# When you use your personal site with web sign-in the first time[[#subsequent|*]], your browser will redirect you to to your online profile, e.g. GitHub, and ask you to:
#* Sign-in with your account on that profile (e.g. sign in to GitHub) if you're not already signed-in.
#* Authorize the site to use your account, e.g. your GitHub account: <blockquote>Authorize Site to use your account?

<nowiki>*</nowiki> Subsequent sign-ins to the same web sign-in form should be pre-filled with your domain name (e.g. via a cookie from the site) so all you have to do is click (Sign-in). In addition, if the site is properly using HTML5 <code><input type=url></code>, browsers will help you auto-complete your personal web address for you across all sites that do web sign-in.

== developers ==
=== user interface ===
For the Web sign-in UI, see the text mockups at the top of this page as a design starting point.

Important details:
* The web address input "[........................]" MUST accept
** a "plain domain" e.g. tantek.com and canonicalize that to https://tantek.com/
** an https domain without a path e.g. https://sixtwothree.org and canonicalize to https://sixtwothree.org/

=== protocol ===
See the [[RelMeAuth]] page for documentation on how to support Web sign-in protocol on your site.

=== example implementations ===

* [https://indielogin.com IndieLogin] not only uses Web sign-in but also provides a [https://indielogin.com/api web sign-in authentication API]!
** IndieWeb: Try out IndieLogin by signing-in to [https://indieweb.org IndieWeb.org].

== why ==
See [http://indiewebcamp.com/Why_web_sign-in Why web sign-in] on the IndieWebCamp site.

web-sign-in

2025-06-03T23:58:06Z

Tantek: /* user interface */ canonicalize require https

{{DISPLAYTITLE:Web sign-in}}

Use the (Web sign-in) button on a site to sign-in with your personal web address.

When you click a (Web sign-in) button, the site will ask you for your web address, e.g.:

<blockquote style="border:1px solid gray; float:left; clear; left; padding:1em">
Web address: [........................] (Sign-in)
</blockquote>
<div style="clear:both">or:</div>

<blockquote style="border:1px solid gray; float:left; clear; left; padding:1em">
Web address: 
[........................] 
(Sign-in)
</blockquote>
<div style="clear:both"> </div>

Enter your personal web address and press return / click (Sign-in).

== set up ==

Your personal site must be set up for web sign-in.

# Link from your personal site to your other profiles. Add <code>rel="me"</code> to those hyperlinks. E.g.: <blockquote style="white-space:nowrap"><code><a rel="me" <nowiki>href="https://github.com/your_github_alias">...</nowiki></code></blockquote>
# Edit your other profiles, e.g. your [https://github.com/ GitHub] profile, and set link (🔗) text field to your personal web address. E.g. <blockquote style="white-space:nowrap">🔗 <nowiki>https://yoursite.example.com/</nowiki></blockquote>
# When you use your personal site with web sign-in the first time[[#subsequent|*]], your browser will redirect you to to your online profile, e.g. GitHub, and ask you to:
#* Sign-in with your account on that profile (e.g. sign in to GitHub) if you're not already signed-in.
#* Authorize the site to use your account, e.g. your GitHub account: <blockquote>Authorize Site to use your account?

<nowiki>*</nowiki> Subsequent sign-ins to the same web sign-in form should be pre-filled with your domain name (e.g. via a cookie from the site) so all you have to do is click (Sign-in). In addition, if the site is properly using HTML5 <code><input type=url></code>, browsers will help you auto-complete your personal web address for you across all sites that do web sign-in.

== developers ==
=== user interface ===
For the Web sign-in UI, see the text mockups at the top of this page as a design starting point.

Important details:
* The web address input "[........................]" MUST accept
** a "plain domain" e.g. tantek.com and canonicalize that to https://tantek.com/
** an https domain without a path e.g. https://sixtwothree.org and canonicalize to https://sixtwothree.org/

=== protocol ===
See the [[RelMeAuth]] page for documentation on how to support Web sign-in protocol on your site.

=== example implementations ===
* [http://tantek.com/relmeauth/ RelMeAuth prototype] demonstrates Web sign-in for both read-only/read-write permissions, and provides a simple interface for Tweeting when read-write permissions are provided.
* [http://indieauth.com IndieAuth] not only uses Web sign-in but also provides a web sign-in authentication API!
** IndieWebCamp: Try out IndieAuth by signing-in to [http://IndieWebCamp.com IndieWebCamp.com].

== why ==
See [http://indiewebcamp.com/Why_web_sign-in Why web sign-in] on the IndieWebCamp site.

web-sign-in

2025-06-03T23:56:48Z

Tantek: /* set up */ your https

{{DISPLAYTITLE:Web sign-in}}

Use the (Web sign-in) button on a site to sign-in with your personal web address.

When you click a (Web sign-in) button, the site will ask you for your web address, e.g.:

<blockquote style="border:1px solid gray; float:left; clear; left; padding:1em">
Web address: [........................] (Sign-in)
</blockquote>
<div style="clear:both">or:</div>

<blockquote style="border:1px solid gray; float:left; clear; left; padding:1em">
Web address: 
[........................] 
(Sign-in)
</blockquote>
<div style="clear:both"> </div>

Enter your personal web address and press return / click (Sign-in).

== set up ==

Your personal site must be set up for web sign-in.

# Link from your personal site to your other profiles. Add <code>rel="me"</code> to those hyperlinks. E.g.: <blockquote style="white-space:nowrap"><code><a rel="me" <nowiki>href="https://github.com/your_github_alias">...</nowiki></code></blockquote>
# Edit your other profiles, e.g. your [https://github.com/ GitHub] profile, and set link (🔗) text field to your personal web address. E.g. <blockquote style="white-space:nowrap">🔗 <nowiki>https://yoursite.example.com/</nowiki></blockquote>
# When you use your personal site with web sign-in the first time[[#subsequent|*]], your browser will redirect you to to your online profile, e.g. GitHub, and ask you to:
#* Sign-in with your account on that profile (e.g. sign in to GitHub) if you're not already signed-in.
#* Authorize the site to use your account, e.g. your GitHub account: <blockquote>Authorize Site to use your account?

<nowiki>*</nowiki> Subsequent sign-ins to the same web sign-in form should be pre-filled with your domain name (e.g. via a cookie from the site) so all you have to do is click (Sign-in). In addition, if the site is properly using HTML5 <code><input type=url></code>, browsers will help you auto-complete your personal web address for you across all sites that do web sign-in.

== developers ==
=== user interface ===
For the Web sign-in UI, see the text mockups at the top of this page as a design starting point.

Important details:
* The web address input "[........................]" MUST accept
** a "plain domain" e.g. tantek.com and canonicalize that to http://tantek.com/ or preferably to https://tantek.com/
** an http(s) domain without a path e.g. http://sixtwothree.org or https://sixtwothree.org and canonicalize http://sixtwothree.org/ or https://sixtwothree.org/ respectively

=== protocol ===
See the [[RelMeAuth]] page for documentation on how to support Web sign-in protocol on your site.

=== example implementations ===
* [http://tantek.com/relmeauth/ RelMeAuth prototype] demonstrates Web sign-in for both read-only/read-write permissions, and provides a simple interface for Tweeting when read-write permissions are provided.
* [http://indieauth.com IndieAuth] not only uses Web sign-in but also provides a web sign-in authentication API!
** IndieWebCamp: Try out IndieAuth by signing-in to [http://IndieWebCamp.com IndieWebCamp.com].

== why ==
See [http://indiewebcamp.com/Why_web_sign-in Why web sign-in] on the IndieWebCamp site.

web-sign-in

2025-06-03T23:56:32Z

Tantek: /* set up */ https

{{DISPLAYTITLE:Web sign-in}}

Use the (Web sign-in) button on a site to sign-in with your personal web address.

When you click a (Web sign-in) button, the site will ask you for your web address, e.g.:

<blockquote style="border:1px solid gray; float:left; clear; left; padding:1em">
Web address: [........................] (Sign-in)
</blockquote>
<div style="clear:both">or:</div>

<blockquote style="border:1px solid gray; float:left; clear; left; padding:1em">
Web address: 
[........................] 
(Sign-in)
</blockquote>
<div style="clear:both"> </div>

Enter your personal web address and press return / click (Sign-in).

== set up ==

Your personal site must be set up for web sign-in.

# Link from your personal site to your other profiles. Add <code>rel="me"</code> to those hyperlinks. E.g.: <blockquote style="white-space:nowrap"><code><a rel="me" <nowiki>href="https://github.com/your_github_alias">...</nowiki></code></blockquote>
# Edit your other profiles, e.g. your [https://github.com/ GitHub] profile, and set link (🔗) text field to your personal web address. E.g. <blockquote style="white-space:nowrap">🔗 <nowiki>http://yoursite.example.com/</nowiki></blockquote>
# When you use your personal site with web sign-in the first time[[#subsequent|*]], your browser will redirect you to to your online profile, e.g. GitHub, and ask you to:
#* Sign-in with your account on that profile (e.g. sign in to GitHub) if you're not already signed-in.
#* Authorize the site to use your account, e.g. your GitHub account: <blockquote>Authorize Site to use your account?

<nowiki>*</nowiki> Subsequent sign-ins to the same web sign-in form should be pre-filled with your domain name (e.g. via a cookie from the site) so all you have to do is click (Sign-in). In addition, if the site is properly using HTML5 <code><input type=url></code>, browsers will help you auto-complete your personal web address for you across all sites that do web sign-in.

== developers ==
=== user interface ===
For the Web sign-in UI, see the text mockups at the top of this page as a design starting point.

Important details:
* The web address input "[........................]" MUST accept
** a "plain domain" e.g. tantek.com and canonicalize that to http://tantek.com/ or preferably to https://tantek.com/
** an http(s) domain without a path e.g. http://sixtwothree.org or https://sixtwothree.org and canonicalize http://sixtwothree.org/ or https://sixtwothree.org/ respectively

=== protocol ===
See the [[RelMeAuth]] page for documentation on how to support Web sign-in protocol on your site.

=== example implementations ===
* [http://tantek.com/relmeauth/ RelMeAuth prototype] demonstrates Web sign-in for both read-only/read-write permissions, and provides a simple interface for Tweeting when read-write permissions are provided.
* [http://indieauth.com IndieAuth] not only uses Web sign-in but also provides a web sign-in authentication API!
** IndieWebCamp: Try out IndieAuth by signing-in to [http://IndieWebCamp.com IndieWebCamp.com].

== why ==
See [http://indiewebcamp.com/Why_web_sign-in Why web sign-in] on the IndieWebCamp site.

web-sign-in

2025-06-03T23:19:36Z

Tantek: update to use GitHub in examples rather than Twitter

{{DISPLAYTITLE:Web sign-in}}

Use the (Web sign-in) button on a site to sign-in with your personal web address.

When you click a (Web sign-in) button, the site will ask you for your web address, e.g.:

<blockquote style="border:1px solid gray; float:left; clear; left; padding:1em">
Web address: [........................] (Sign-in)
</blockquote>
<div style="clear:both">or:</div>

<blockquote style="border:1px solid gray; float:left; clear; left; padding:1em">
Web address: 
[........................] 
(Sign-in)
</blockquote>
<div style="clear:both"> </div>

Enter your personal web address and press return / click (Sign-in).

== set up ==

Your personal site must be set up for web sign-in.

# Link from your personal site to your other profiles. Add <code>rel="me"</code> to those hyperlinks. E.g.: <blockquote style="white-space:nowrap"><code><a rel="me" <nowiki>href="http://github.com/your_github_alias">...</nowiki></code></blockquote>
# Edit your other profiles, e.g. your [https://github.com/ GitHub] profile, and set link (🔗) text field to your personal web address. E.g. <blockquote style="white-space:nowrap">🔗 <nowiki>http://yoursite.example.com/</nowiki></blockquote>
# When you use your personal site with web sign-in the first time[[#subsequent|*]], your browser will redirect you to to your online profile, e.g. GitHub, and ask you to:
#* Sign-in with your account on that profile (e.g. sign in to GitHub) if you're not already signed-in.
#* Authorize the site to use your account, e.g. your GitHub account: <blockquote>Authorize Site to use your account?

<nowiki>*</nowiki> Subsequent sign-ins to the same web sign-in form should be pre-filled with your domain name (e.g. via a cookie from the site) so all you have to do is click (Sign-in). In addition, if the site is properly using HTML5 <code><input type=url></code>, browsers will help you auto-complete your personal web address for you across all sites that do web sign-in.

== developers ==
=== user interface ===
For the Web sign-in UI, see the text mockups at the top of this page as a design starting point.

Important details:
* The web address input "[........................]" MUST accept
** a "plain domain" e.g. tantek.com and canonicalize that to http://tantek.com/ or preferably to https://tantek.com/
** an http(s) domain without a path e.g. http://sixtwothree.org or https://sixtwothree.org and canonicalize http://sixtwothree.org/ or https://sixtwothree.org/ respectively

=== protocol ===
See the [[RelMeAuth]] page for documentation on how to support Web sign-in protocol on your site.

=== example implementations ===
* [http://tantek.com/relmeauth/ RelMeAuth prototype] demonstrates Web sign-in for both read-only/read-write permissions, and provides a simple interface for Tweeting when read-write permissions are provided.
* [http://indieauth.com IndieAuth] not only uses Web sign-in but also provides a web sign-in authentication API!
** IndieWebCamp: Try out IndieAuth by signing-in to [http://IndieWebCamp.com IndieWebCamp.com].

== why ==
See [http://indiewebcamp.com/Why_web_sign-in Why web sign-in] on the IndieWebCamp site.

source-code-brainstorming

2025-05-26T23:51:08Z

Tantek: /* Alternatives */ add some brainstorms from yesterday with indieweb dev chat citations

rel-edit

2025-05-26T23:15:36Z

Tantek: /* Publishers */ CSSWG wiki

{{stub}}

'''<dfn>rel=edit</dfn>''' is for linking to a page to a URL that a browser can load for the user to edit that page.

== Definition ==

rel=edit can be applied to <code>link</code> or <code>a</code> tags, like so:

<pre>
<link rel="edit" href="https://example.com/edit/page-name" />
<a rel="edit" href="https://example.com/edit/page-name">Edit this page</a>
</pre>

A rel=edit parser should look for rel=edit links on the page and take the first one found.

The following query selector could be used to identify a candidate rel=edit link per the above description:

<pre>
document.querySelector("link[rel=edit], a[rel=edit]")
</pre>

== When to add a rel=edit relation to a link ==

rel=edit must only be published on a page if the user can access the edit page without additional authentication. This is important so that rel=edit links take a user directly to an editing interface.

A rel=edit relation could be added to a page if the page is editable:

* Publicly (i.e. a page on an open wiki), or;
* To the user viewing the page because they are signed in (i.e. a blog post on a private site where the user is signed in as admin).

== Use Cases ==

rel=edit offers a standard way to indicate a page is editable by the user.

This relation then be identified by a browser, browser extension, or a bookmarklet and used to both infer that a page is editable and autodiscover the page to link to for the user to edit the page.

== Publishers ==
Websites supporting rel=edit:
* Supabase documentation ([https://supabase.com/docs/guides/database/overview example article])
* [https://airportpianos.org airportpianos.org]
* https://wiki.csswg.org/

== Tools ==
Tools that users can use to edit pages marked up with rel=edit:
* [https://github.com/splitbrain/universaleditbutton Universal Edit Button]
* [https://jamesg.blog/2025/05/09/extending-my-edit-web-page-bookmarklet Blog post describing rel=edit parsing in a bookmarklet]
* [https://github.com/capjamesg/edit-button-extension Edit button extension] (browser add-on)

== Libraries ==
Libraries developers or extensions can use to detect rel=edit:
* The Python indieweb-utils package implements a <code>discover_edit_links</code> function to autodiscover the rel=edit for a page.
** Implementation: https://github.com/capjamesg/indieweb-utils/blob/main/src/indieweb_utils/utils/rel_edit.py#L7
* [https://github.com/splitbrain/universaleditbutton/blob/master/content.js#L6 The Universal Edit Button extension searches for rel=edit.]

== Prior Art ==
=== Earlier proposal ===
rel=edit was raised in Bug 19068 “[https://www.w3.org/Bugs/Public/show_bug.cgi?id=19068 Add rel="edit" to list of defined types]” in the W3C public Bugzilla to the WHAT WG:

<blockquote>
rel="edit" indicates a link that can be used to edit the current resource, e.g., if it's a wiki. It's been proposed by the Universal Edit Button project <http://universaleditbutton.org/>. That documents a number of sites using either rel="edit", or the older poorly-conceived <link rel="alternate" type="application/x-wiki">:

http://universaleditbutton.org/Universal_Edit_Button#Sites_with_Universal_Editing_Button

Users of rel="edit" include MediaWiki, and therefore Wikipedia. As far as implementation goes, there are extensions written for Firefox, Opera, and Chrome. It seems like potentially useful semantics, although only for a fairly narrow class of sites (wikis and CMSes). I'm pretty sure the level of implementation and deployment exceeds some currently specced rel values, like tag, so I don't see why this shouldn't be in the spec. Are there any specific standards you'd like to see that this doesn't meet?
</blockquote>

As of May 10th, 2025, Wikipedia does not publish a rel=edit on the main Edit link on pages, but still publishes the `application/x-wiki` syntax.

=== rel=alternate type=application/x-wiki ===
MediaWiki supports the following syntax to indicate that the linked resource lets you edit the current page:

<pre>
<link rel="alternate"
type="application/x-wiki"
title="Welcome to edit this page!"
href="wiki?edit=myEditLink"/>
</pre>

This syntax is parsed by the [https://github.com/splitbrain/universaleditbutton/blob/master/content.js Universal Edit Button].

Because of its support in the MediaWiki engine, this markup is on Wikipedia pages.

With that said, this syntax does not extend to anchor links, unlike the proposed rel=edit. The rel=alternate syntax means you have to add another tag instead of marking up existing, human-clickable link on the page via a rel=edit on an anchor.

=== rel=edit in Atom ===

[https://datatracker.ietf.org/doc/html/rfc5023 RFC 5023 - The Atom Publishing Protocol] describes a rel=edit relation in 11.1 as:

<blockquote>
This specification adds the value "edit" to the Atom Registry of Link
Relations (see Section 7.1 of [RFC4287]). The value of "edit"
specifies that the value of the href attribute is the IRI of an
editable Member Entry. When appearing within an atom:entry, the href
IRI can be used to retrieve, update, and delete the Resource
represented by that Entry. An atom:entry MUST NOT contain more than
one "edit" link relation.
</blockquote>

=== rel=EditURI in WordPress ===

WordPress has support for rel=EditURI. The microformats wiki defines the relation in [[rel-edituri]] as:

<blockquote>
This relationship is used in Wordpress to denote the location of the xml-rpc gateway that allows external editors to be used.
</blockquote>

Here is an example of the syntax:

<pre>
<link rel="EditURI" type="application/rsd+xml" title="RSD" href="https://example.com">
</pre>

== Background ==

Many sites offer public editing capabilities for web pages, often for authenticated users, with an approval process, or moderation to review edits. Such editing capabilities are common for wikis and technical documentation websites. For example, Wikipedia pages can be edited.

Every site has its own way of indicating that a page is editable. Among the sites that allow editing there is inconsistency in where edit links are placed and the language used. For example, Wikipedia uses “Edit” whereas the GitHub documentation uses “Make a contribution”.

== Open questions ==

=== Public vs. private distinction ===

rel=edit should only be applied to links that the current user can use to edit a page.

If rel=edit is applied to a link on a public page, it means anyone can contribute to the page. This may be the case for a wiki or a documentation site, for example. If rel=edit is applied to a link on a private page, it means that anyone viewing that page can edit it.

rel=edit implies a page is editable. Users should not encounter a rel=edit link that they have no means to access.

A good guideline is:
* if a page has an existing human interface element like a clickable <samp>Edit</samp> link or pencil (✏️) icon or emoji, then that link should be marked up with rel=edit. Otherwise if a page does not show any visual indicator that it can be edited, avoid using rel=edit.

== See Also ==

* [[User:Tantek]]'s [https://indieweb.org/wiki-projects brainstorm of a wiki based on static pages and HTTP headers notes]: <blockquote>a page could link to its editing interface/version/query parameter with a rel link as well, e.g. '''<code>rel=edit</code>''', which has been previously proposed as part of Universal Edit Button: links for AJAX-driven edits but could be used for server-based editing state as well. E.g. <code>href="?edit=1"</code>. Again this might be best sent as an HTTP Link Header.</blockquote>'''Emphasis''' added.

source-code-brainstorming

2025-05-26T05:12:38Z

Tantek: add summary of brainstorm alternatives from before this year

source-code-examples

2025-05-25T22:34:52Z

Tantek: re-order example sections more specific / direct to less

{{stub}}
__TOC__
Examples of pages that link to their [[source-code]] and or a repository for such code.

== guide to adding examples ==
If you add an example, please explicitly note the:
* '''from URL''': the URL of a visible page on the web that has a link on it to its source code and or repository
* '''link text''': the text (or icon) and perhaps some nearby contextual text that is hyperlinked
* '''to URL''': the URL of the destination that is being linked to

Please do your best to put the example into ONE of the following subsections (only one should make sense, if it "fits" in multiple, only put it in the first one that fits.)

== directly to source file ==
Sites and or pages that link '''directly to their source code''' (in a repository)
* https://huggingface.co/docs/transformers/en/model_doc/blip-2 has an "< > Update on GitHub" link at the very bottom of their docs pages which links to the markdown text file (<samp>.md</samp>) associated with the document.
* ...

== to specific repo directory ==
Sites and or pages that link to the '''specific directory that contains the source''' (code) for the page
* https://w3c.github.io/png/Implementation_Report_3e/ has the text "This implementation report is on GitHub. " where GitHub links to https://github.com/w3c/png/tree/main/Implementation_Report_3e which is the directory containing the <samp>index.html</samp> source code file of the original page
* ...

== to repo home ==
Sites and or pages that link to their '''top level repository''' or '''repository home page''':
* https://docusaurus.io/docs/docs-introduction links to the project GitHub in the footer (link anchor text is "GitHub")
* Sites built with the mkdocs-material theme (a popular Python documentation theme) have a feature to add a repository link in the top left corner of the site (example on https://squidfunk.github.io/mkdocs-material/plugins/).
* ...

== other ==
Other examples that do not fit into the above categories / descriptions:
* A site that links to a repository homepage that is not the repo for the site the page is on, with the anchor text "Find the source code for the example application on GitHub."
** https://atproto.com/guides/applications

== See Also ==
* [[source-code]]
* [[source-code-formats]]
* [[source-code-brainstorming]]

source-code-examples

2025-05-25T22:34:13Z

Tantek: example

{{stub}}
__TOC__
Examples of pages that link to their [[source-code]] and or a repository for such code.

== guide to adding examples ==
If you add an example, please explicitly note the:
* '''from URL''': the URL of a visible page on the web that has a link on it to its source code and or repository
* '''link text''': the text (or icon) and perhaps some nearby contextual text that is hyperlinked
* '''to URL''': the URL of the destination that is being linked to

Please do your best to put the example into ONE of the following subsections (only one should make sense, if it "fits" in multiple, only put it in the first)

== to repo home ==
Sites and or pages that link to their '''top level repository''' or '''repository home page''':
* https://docusaurus.io/docs/docs-introduction links to the project GitHub in the footer (link anchor text is "GitHub")
* Sites built with the mkdocs-material theme (a popular Python documentation theme) have a feature to add a repository link in the top left corner of the site (example on https://squidfunk.github.io/mkdocs-material/plugins/).
* ...

== to specific repo directory ==
Sites and or pages that link to the '''specific directory that contains the source''' (code) for the page
* https://w3c.github.io/png/Implementation_Report_3e/ has the text "This implementation report is on GitHub. " where GitHub links to https://github.com/w3c/png/tree/main/Implementation_Report_3e which is the directory containing the <samp>index.html</samp> source code file of the original page
* ...

== directly to source file ==
Sites and or pages that link '''directly to their source code''' (in a repository)
* https://huggingface.co/docs/transformers/en/model_doc/blip-2 has an "< > Update on GitHub" link at the very bottom of their docs pages which links to the markdown text file (<samp>.md</samp>) associated with the document.
* ...

== other ==
Other examples that do not fit into the above categories / descriptions:
* A site that links to a repository homepage that is not the repo for the site the page is on, with the anchor text "Find the source code for the example application on GitHub."
** https://atproto.com/guides/applications

== See Also ==
* [[source-code]]
* [[source-code-formats]]
* [[source-code-brainstorming]]

source-code-examples

2025-05-25T22:33:52Z

Tantek: guide

{{stub}}
__TOC__
Examples of pages that link to their [[source-code]] and or a repository for such code.

== guide to adding examples ==
If you add an example, please explicitly note the:
* '''from URL''': the URL of a visible page on the web that has a link on it to its source code and or repository
* '''link text''': the text (or icon) and perhaps some nearby contextual text that is hyperlinked
* '''to URL''': the URL of the destination that is being linked to

Please do your best to put the link into ONE of the following subsections (only one should make sense, if it "fits" in multiple, only put it in the first)

== to repo home ==
Sites and or pages that link to their '''top level repository''' or '''repository home page''':
* https://docusaurus.io/docs/docs-introduction links to the project GitHub in the footer (link anchor text is "GitHub")
* Sites built with the mkdocs-material theme (a popular Python documentation theme) have a feature to add a repository link in the top left corner of the site (example on https://squidfunk.github.io/mkdocs-material/plugins/).
* ...

== to specific repo directory ==
Sites and or pages that link to the '''specific directory that contains the source''' (code) for the page
* https://w3c.github.io/png/Implementation_Report_3e/ has the text "This implementation report is on GitHub. " where GitHub links to https://github.com/w3c/png/tree/main/Implementation_Report_3e which is the directory containing the <samp>index.html</samp> source code file of the original page
* ...

== directly to source file ==
Sites and or pages that link '''directly to their source code''' (in a repository)
* https://huggingface.co/docs/transformers/en/model_doc/blip-2 has an "< > Update on GitHub" link at the very bottom of their docs pages which links to the markdown text file (<samp>.md</samp>) associated with the document.
* ...

== other ==
Other examples that do not fit into the above categories / descriptions:
* A site that links to a repository homepage that is not the repo for the site the page is on, with the anchor text "Find the source code for the example application on GitHub."
** https://atproto.com/guides/applications

== See Also ==
* [[source-code]]
* [[source-code-formats]]
* [[source-code-brainstorming]]

source-code-examples

2025-05-25T22:33:37Z

Tantek: float toc

{{stub}}
__TOC__
Examples of pages that link to their [[source-code]] and or a repository for such code.

If you add an example, please explicitly note the:
* '''from URL''': the URL of a visible page on the web that has a link on it to its source code and or repository
* '''link text''': the text (or icon) and perhaps some nearby contextual text that is hyperlinked
* '''to URL''': the URL of the destination that is being linked to

Please do your best to put the link into ONE of the following subsections (only one should make sense, if it "fits" in multiple, only put it in the first)

== to repo home ==
Sites and or pages that link to their '''top level repository''' or '''repository home page''':
* https://docusaurus.io/docs/docs-introduction links to the project GitHub in the footer (link anchor text is "GitHub")
* Sites built with the mkdocs-material theme (a popular Python documentation theme) have a feature to add a repository link in the top left corner of the site (example on https://squidfunk.github.io/mkdocs-material/plugins/).
* ...

== to specific repo directory ==
Sites and or pages that link to the '''specific directory that contains the source''' (code) for the page
* https://w3c.github.io/png/Implementation_Report_3e/ has the text "This implementation report is on GitHub. " where GitHub links to https://github.com/w3c/png/tree/main/Implementation_Report_3e which is the directory containing the <samp>index.html</samp> source code file of the original page
* ...

== directly to source file ==
Sites and or pages that link '''directly to their source code''' (in a repository)
* https://huggingface.co/docs/transformers/en/model_doc/blip-2 has an "< > Update on GitHub" link at the very bottom of their docs pages which links to the markdown text file (<samp>.md</samp>) associated with the document.
* ...

== other ==
Other examples that do not fit into the above categories / descriptions:
* A site that links to a repository homepage that is not the repo for the site the page is on, with the anchor text "Find the source code for the example application on GitHub."
** https://atproto.com/guides/applications

== See Also ==
* [[source-code]]
* [[source-code-formats]]
* [[source-code-brainstorming]]

source-code-examples

2025-05-25T22:33:09Z

Tantek: subsections for examples

{{stub}}

Examples of pages that link to their [[source-code]] and or a repository for such code.

If you add an example, please explicitly note the:
* '''from URL''': the URL of a visible page on the web that has a link on it to its source code and or repository
* '''link text''': the text (or icon) and perhaps some nearby contextual text that is hyperlinked
* '''to URL''': the URL of the destination that is being linked to

Please do your best to put the link into ONE of the following subsections (only one should make sense, if it "fits" in multiple, only put it in the first)

== to repo home ==
Sites and or pages that link to their '''top level repository''' or '''repository home page''':
* https://docusaurus.io/docs/docs-introduction links to the project GitHub in the footer (link anchor text is "GitHub")
* Sites built with the mkdocs-material theme (a popular Python documentation theme) have a feature to add a repository link in the top left corner of the site (example on https://squidfunk.github.io/mkdocs-material/plugins/).
* ...

== to specific repo directory ==
Sites and or pages that link to the '''specific directory that contains the source''' (code) for the page
* https://w3c.github.io/png/Implementation_Report_3e/ has the text "This implementation report is on GitHub. " where GitHub links to https://github.com/w3c/png/tree/main/Implementation_Report_3e which is the directory containing the <samp>index.html</samp> source code file of the original page
* ...

== directly to source file ==
Sites and or pages that link '''directly to their source code''' (in a repository)
* https://huggingface.co/docs/transformers/en/model_doc/blip-2 has an "< > Update on GitHub" link at the very bottom of their docs pages which links to the markdown text file (<samp>.md</samp>) associated with the document.
* ...

== other ==
Other examples that do not fit into the above categories / descriptions:
* A site that links to a repository homepage that is not the repo for the site the page is on, with the anchor text "Find the source code for the example application on GitHub."
** https://atproto.com/guides/applications

== See Also ==
* [[source-code]]
* [[source-code-formats]]
* [[source-code-brainstorming]]

source-code-examples

2025-05-25T22:31:29Z

Tantek: guidance for examples

{{stub}}

Examples of pages that link to their [[source-code]] and or a repository for such code.

If you add an example, please explicitly note the:
* '''from URL''': the URL of a visible page on the web that has a link on it to its source code and or repository
* '''link text''': the text (or icon) and perhaps some nearby contextual text that is hyperlinked
* '''to URL''': the URL of the destination that is being linked to

Sites and or pages that link to their '''top level repository''':
* https://docusaurus.io/docs/docs-introduction links to the project GitHub in the footer (link anchor text is "GitHub")
* Sites built with the mkdocs-material theme (a popular Python documentation theme) have a feature to add a repository link in the top left corner of the site (example on https://squidfunk.github.io/mkdocs-material/plugins/).
* ...

Sites and or pages that link to the '''specific directory that contains the source''' (code) for the page
* https://w3c.github.io/png/Implementation_Report_3e/ has the text "This implementation report is on GitHub. " where GitHub links to https://github.com/w3c/png/tree/main/Implementation_Report_3e which is the directory containing the <samp>index.html</samp> source code file of the original page
* ...

Sites and or pages that link '''directly to their source code''' (in a repository)
* https://huggingface.co/docs/transformers/en/model_doc/blip-2 has an "< > Update on GitHub" link at the very bottom of their docs pages which links to the markdown text file (<samp>.md</samp>) associated with the document.
* ...

Other examples:
* A site that links to a repository homepage that is not the repo for the site the page is on, with the anchor text "Find the source code for the example application on GitHub."
** https://atproto.com/guides/applications

== See Also ==
* [[source-code]]
* [[source-code-formats]]
* [[source-code-brainstorming]]

source-code-examples

2025-05-25T22:23:25Z

Tantek: note .md

{{stub}}

Examples of pages that link to their [[source-code]] and or a repository for such code.

Sites and or pages that link to their '''top level repository''':
* https://docusaurus.io/docs/docs-introduction links to the project GitHub in the footer (link anchor text is "GitHub")
* Sites built with the mkdocs-material theme (a popular Python documentation theme) have a feature to add a repository link in the top left corner of the site (example on https://squidfunk.github.io/mkdocs-material/plugins/).
* ...

Sites and or pages that link to the '''specific directory that contains the source''' (code) for the page
* https://w3c.github.io/png/Implementation_Report_3e/ has the text "This implementation report is on GitHub. " where GitHub links to https://github.com/w3c/png/tree/main/Implementation_Report_3e which is the directory containing the <samp>index.html</samp> source code file of the original page
* ...

Sites and or pages that link '''directly to their source code''' (in a repository)
* https://huggingface.co/docs/transformers/en/model_doc/blip-2 has an "< > Update on GitHub" link at the very bottom of their docs pages which links to the markdown text file (<samp>.md</samp>) associated with the document.
* ...

Other examples:
* A site that links to a repository homepage that is not the repo for the site the page is on, with the anchor text "Find the source code for the example application on GitHub."
** https://atproto.com/guides/applications

== See Also ==
* [[source-code]]
* [[source-code-formats]]
* [[source-code-brainstorming]]