rel-shortlink: Difference between revisions

From Microformats Wiki
rel-shortlink
Jump to navigation Jump to search
(: Added Media UK (and changed a typo on CMS Market))
(added more detailed steps to better follow microformats process, examples for HTML and HTTP)
Line 19: Line 19:


== Abstract ==
== Abstract ==
<p class="entry-summary">RelShortLink is a brainstorm proposal with the goal of becoming an [[elemental-microformat|elemental microformat]]. '''The problem-space that rel-shortlink is attempting to solve must be first taken through the microformats [[process]] before any specific brainstorm can be properly evaluated, and potentially added as a microformat.''' Proposed usage: by adding <code>rel="shortlink"</code> to a [hyper]link, a page indicates that the hyperlink may be used for space constrained and/or manual entry (e.g. printed or spoken) applications and that the destination of that hyperlink carries the same meaning (even if formatting such as sort order and hightlighting is lost). Typical use cases include pasting links into microblogging services such as Twitter and anywhere manual entry is required (e.g. printed or spoken URLs).</p>
<div class="entry-summary">RelShortLink is a brainstorm proposal with the goal of becoming an [[elemental-microformat|elemental microformat]].
<p>
'''The problem-space that rel-shortlink is attempting to solve must be first taken through the microformats [[process]] before any specific brainstorm can be properly evaluated, and potentially added as a microformat.''' Necessary pages:
</p>
* [[shortlink-examples]] - to document existing uses of pages publishing short links for themselves, whether or not they actually use rel="shortlink" (e.g. Flickr.com, various wiki pages like http://tantek.pbworks.com/CommunicationProtocols [[hcard-supporting-user-profiles]])
* [[shortlink-formats]] - documentation of previous (or subsequent) attempts at shorlink formats (e.g. formats listed in the "inferior alternatives" section at the end of this page could be moved to this separate page)
* [[shortlink-brainstorming]] - documentation of why/how rel="shortlink" was developed/proposed, along with reasoning of why other shortlink formats may be inadequate (extract that from the "inferior alternatives" section at the end of this page)
 
Proposed usage: by adding <code>rel="shortlink"</code> to a [hyper]link, a page indicates that the hyperlink may be used for space constrained and/or manual entry (e.g. printed or spoken) applications and that the destination of that hyperlink carries the same meaning (even if formatting such as sort order and hightlighting is lost). Typical use cases include pasting links into microblogging services such as Twitter and anywhere manual entry is required (e.g. printed or spoken URLs).</div>
 
== Examples ==
=== HTML ===
On a page like http://www.flickr.com/photos/tantek/3909804165/ it could have HTML to indicate a shortlink in one of two ways:
<source lang=html4strict>
<link rel="shortlink" type="text/html" href="http://flic.kr/p/6XuLyD">
</source>
and/or
<source lang=html4strict>
shortlink:
<a rel="shortlink" type="text/html" href="http://flic.kr/p/6XuLyD">
http://flic.kr/p/6XuLyD
</a>
</source>
=== HTTP ===
In addition, a request for a page like http://www.flickr.com/photos/tantek/3909804165/ should return as part of the HTTP headers:
<source lang=text>
Link: <http://flic.kr/p/6XuLyD>; rel="shortlink"
</source>


== XMDP profile ==
== XMDP profile ==

Revision as of 23:36, 25 September 2009

<entry-title>rel="shortlink"</entry-title>

Specification 2009-05-04

Editors

Concept

Copyright

Public Domain Contribution Requirement. Since the author(s) released this work into the public domain, in order to maintain this work's public domain status, all contributors to this page agree to release their contributions to this page to the public domain as well. Contributors may indicate their agreement by adding the public domain release template to their user page per the Voluntary Public Domain Declarations instructions. Unreleased contributions may be reverted/removed.

Patents

This specification is subject to a royalty free patent policy, e.g. per the W3C Patent Policy, and IETF RFC3667 & RFC3668.

Abstract

RelShortLink is a brainstorm proposal with the goal of becoming an elemental microformat.

The problem-space that rel-shortlink is attempting to solve must be first taken through the microformats The microformats process before any specific brainstorm can be properly evaluated, and potentially added as a microformat. Necessary pages:

  • shortlink examples - to document existing uses of pages publishing short links for themselves, whether or not they actually use rel="shortlink" (e.g. Flickr.com, various wiki pages like http://tantek.pbworks.com/CommunicationProtocols hCard supporting user profiles)
  • shortlink formats - documentation of previous (or subsequent) attempts at shorlink formats (e.g. formats listed in the "inferior alternatives" section at the end of this page could be moved to this separate page)
  • shortlink brainstorming - documentation of why/how rel="shortlink" was developed/proposed, along with reasoning of why other shortlink formats may be inadequate (extract that from the "inferior alternatives" section at the end of this page)
Proposed usage: by adding rel="shortlink" to a [hyper]link, a page indicates that the hyperlink may be used for space constrained and/or manual entry (e.g. printed or spoken) applications and that the destination of that hyperlink carries the same meaning (even if formatting such as sort order and hightlighting is lost). Typical use cases include pasting links into microblogging services such as Twitter and anywhere manual entry is required (e.g. printed or spoken URLs).

Examples

HTML

On a page like http://www.flickr.com/photos/tantek/3909804165/ it could have HTML to indicate a shortlink in one of two ways:

<link rel="shortlink" type="text/html" href="http://flic.kr/p/6XuLyD">

and/or

shortlink: 
<a rel="shortlink" type="text/html" href="http://flic.kr/p/6XuLyD">
 http://flic.kr/p/6XuLyD
</a>

HTTP

In addition, a request for a page like http://www.flickr.com/photos/tantek/3909804165/ should return as part of the HTTP headers:

Link: <http://flic.kr/p/6XuLyD>; rel="shortlink"

XMDP profile

<dl class="profile">
 <dt id="rel">rel</dt>
 <dd><p>
   <a rel="help" href="http://www.w3.org/TR/html401/struct/links.html#adef-rel">
     HTML4 definition of the 'rel' attribute.</a>  
   Here is an additional value.</p>
  <dl>
   <dt id="shortlink">shortlink</dt>
   <dd>Indicates that the referred resource carries the same meaning as the
       referring page (even if formatting such as sort order and highlighting
       is lost) and that the link may be used for space constrained and/or
       manual entry (e.g. printed or spoken) applications.</dd>
  </dl>
 </dd>
</dl>

examples in the wild

This section is informative. Note: There are numerous uses of rel-shortlink in the wild, this is very much an incomplete list. If your site marked up with rel-shortlink, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page (rel-shortlink-examples-in-wild).

normative references

informative references

inferior alternatives

  • RevCanonical
    • rev= deprecated in HTML 5
    • rev= is easily confused with rel=, thus creating extreme danger for clueless webmasters
    • implies that referring URL is the canonical URL, thus should only be used for the canonical URL itself
    • implies that a complete list of referring URLs is offered, when in fact there are infinite possibilities
    • See also mnot's Counting the ways that rev="canonical" hurts the Web
  • RelShortcut
    • Scorched earth thanks to "shortcut icon" (now just "icon" in HTML 5) - rel is a space separated list for HTML at least
  • RelShort[er]
    • Ambiguous as to whether it refers to the URL or the content itself (e.g. abstract).
  • RelShorturl
    • Too many possible permutations: short[_- ]?ur[il] -> shorturl, short_url, short-url, "short url", short_uri, short-uri, "short uri", etc. leads to implementations supporting multiple variations.
    • Intellectual property issues:
      • Trademark status claimed by shorturl.com (shortlink infringes no known common law or registered trademarks)
      • Copyright protected specification (shortlink specification is public domain)
      • Patent status unknown (shortlink carries a patent pledge and has no known patents)
    • No effort to standardise via the usual processes (shortlink was submitted to IETF/W3C for discussion)