rel-tag: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(→‎Draft Specification 2005-01-10: Removing "draft" from section headers for specs defined as "specifications" on the main page)
m (Reverted edit of Evan, changed back to last version by Kevin Marks)
Line 3: Line 3:
__TOC__
__TOC__


== Specification 2005-01-10 ==
== Draft Specification 2005-01-10 ==
=== Editor/Author ===
=== Editor/Author ===
[http://tantek.com/ Tantek Çelik]
[http://tantek.com/ Tantek Çelik]
Line 83: Line 83:
<pre><nowiki>  http://technorati.com/tag/Technology </nowiki></pre>
<pre><nowiki>  http://technorati.com/tag/Technology </nowiki></pre>


== Encodin
== Encoding issues ==
Spaces can be encoded either as <code>+</code> or <code>%20</code>. Unicode characters are encoded as specified in [http://www.ietf.org/rfc/rfc3986.txt RFC 3986]. For example:
 
<pre><nowiki><a href=&quot;http://technorati.com/tag/Sant%C3%A9+et+bien-%C3%AAtre&quot; rel=&quot;tag&quot;>Santé et bien-être</a> </nowiki></pre>
 
Note that if using Wikipedia as a tagspace, as discussed above, you should use <code>%20</code> as they remap '+' to <code>%2B</code>, causing  a page with a plus sign in the title (which usually does not exist) to appear.
 
== Tags Are Visible Metadata ==
<code>rel=&quot;tag&quot;</code> hyperlinks are intended to be visible links on pages and posts.  This is in stark contrast to meta keywords (which were invisible and typically never revealed to readers), and thus is at least somewhat more resilient to the problems which plagued meta keywords.
 
Making tag hyperlinks visible has the additional benefit of making it more obvious to readers if a page is abusing tag links, and thus providing more peer pressure for better behavior.  It also makes it more obvious to authors, who may not always be aware what invisible metadata is being generated on their behalf.
 
As a result the invisible tag link syntax variant: <code><link rel=&quot;tag&quot; href=&quot;...&quot; /></code> SHOULD NOT be supported by implementations.
 
== Implementations ==
This section is '''informative'''.
 
The following implementations have been developed which either generate or parse rel-tag links. If you have a rel-tag implementation, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.
 
* Nutch has a [[rel-tag]] parser [http://www.mail-archive.com/nutch-commits@lucene.apache.org/msg01014.html committed to their svn repository].
* [http://www.webstandards.org/action/dwtf/microformats/ Dreamweaver Extension suite] from the [http://webstandards.org/ Web Standards Project] enables rel-tagging from within Dreamweaver 8.
* [http://scooch.gr0w.com/ Scooch] slide show creator allows authors to generate rel-tags and group slide shows by rel-tag via a list or cloud with tag usage count.
* The Freetag plugin for the [http://www.s9y.org Serendipity] blog software supports rel-tags on a per-entry basis, as well as inside of its tag clouds.  (The Freetag plugin is available inside of SPARTACUS)
* [http://placenamehere.com/TXP/pnh_mf/ pnh_mf] is a plugin for [http://textpattern.com/ Textpattern] that supports embedding rel-tags and other microformats in templates and blog posts. Written by [http://placenamehere.com/ Chris Casciano].
* [http://news.livejournal.com/86492.html?thread=24881884 LiveJournal] - see also [http://www.livejournal.com/support/faq.bml?cat=tags their FAQ regarding their tags support]
* [http://trac.labnotes.org/cgi-bin/trac.cgi/wiki/TagsLinks TagsLinks] Turn each tag into links that let you find related content on tagging services.
* [http://odeo.com ODEO] [http://odeo.com/blog/2005/07/adding-microformats-to-odeo.html publishes] rel-tags for user entered tags.
* [http://evdb.com EVDB] publishes rel-tags for user entered tags.
* [http://dev.wp-plugins.org/wiki/BunnysTechnoratiTags Tag plugin for WordPress]
* [http://noone.org/blog/tags/Tagging Tag plugin for Blosxom]
* Technorati first implemented rel-tag in its [http://technorati.com/tag/ Technorati Tags] service.  Technorati indexes rel-tag tags.
* [http://consumingexperience.blogspot.com/2005/12/updated-multiple-word-technorati-tag.html Greasemonkey script for Firefox that generates tags for Blogger]
 
== References ==
=== Normative References ===
* [http://www.w3.org/TR/REC-html40/ HTML 4]
* [http://www.w3.org/TR/xhtml1/ XHTML 1]
* [http://gmpg.org/xmdp/ XMDP]
* RFC 3986 specifies URL syntax.  Section 3.3 specifies URL paths and path segments.
 
=== Informative References ===
* [[hreview|hReview]] uses rel-tag for tags and scalar tags
* [[xfolk|xFolk]] uses rel-tag to build a distributed remote resource tagging construct
* [http://developers.technorati.com/wiki/attentionxml Attention.XML] uses rel-tag for reader tagging of pages, posts, feeds
* [[hcard|hCard]] can use rel-tag for categories
* [[hcalendar|hCalendar]] can use rel-tag for categories
* [http://technorati.com/help/tags.html Using Technorati Tags]
* Contributed from http://developers.technorati.com/wiki/RelTag
 
== Discussions ==
* Feedback is encouraged on the [[rel-tag-feedback]] page.
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].
* History: [http://www.powazek.com/2005/07/000532.html How Tags Happened at Technorati] by [http://www.powazek.com/ Derek Powazek]
 
=== Q&A ===
* If you have any questions about rel-tag, check the [[rel-faq|rel FAQ]] first for general rel attribute questions, then check the [[rel-tag-faq|rel-tag FAQ]], and then if you don't find answers, ask your question on the [http://microformats.org/discuss microformats-discuss] mailing list.
 
=== Issues ===
* Please add any issues with the specification to the separate [[rel-tag-issues|rel-tag issues]] document.

Revision as of 01:12, 14 June 2006

rel-tag

Draft Specification 2005-01-10

Editor/Author

Tantek Çelik

Concept

Derek Powazek Kevin Marks

Copyright

This specification is (C) 2004-2024 by the authors. However, the authors intend to submit (or already have submitted, see details in the spec) this specification to a standards body with a liberal copyright/licensing policy such as the GMPG, IETF, and/or W3C. Anyone wishing to contribute should read their copyright principles, policies and licenses (e.g. the GMPG Principles) and agree to them, including licensing of all contributions under all required licenses (e.g. CC-by 1.0 and later), before contributing.

Patents

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

Abstract

Rel-Tag is one of several MicroFormats. By adding rel="tag" to a hyperlink, a page indicates that the destination of that hyperlink is an author-designated "tag" (or keyword/subject) of the current page. Note that a tag may just refer to a major portion of the current page (i.e. a blog post). e.g. by placing this link on a page,

<a href="http://technorati.com/tag/tech" rel="tag">tech</a>

the author indicates that the page (or some portion of the page) has the tag "tech".

The linked page SHOULD exist, and it is the linked page, rather than the link text, that defines the tag. The last path component of the URL is the text of the tag, so

<a href="http://technorati.com/tag/tech" rel="tag">fish</a>

would indicate the tag "tech" rather than "fish".

Scope

rel="tag" is specifically designed for "tagging" content, typically web pages (or portions thereof, like blog posts).

rel="tag" is NOT designed for "tagging" arbitrary URLs or external content. There is demand for a general decentralized syntax for tagging URLs, and that is certainly something to think about, but this is not meant for that. See xFolk and hReview for ways to tag arbitrary URLs.

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="tag">tag</dt>
   <dd>Indicates that the referred resource serves as a "tag", 
       or keyword/subject, for the referring page.</dd>
  </dl>
 </dd>
</dl>

Tag Spaces

Tags are embedded in HTTP URIs in a well-defined manner so that the tag embedded in an HTTP URI can be mechanically extracted from that URI. Specifically, the last segment of the path portion of the URI (after the final "/" character) contains the tag value. For example, the URI

http://www.example.com/tags/foo

contains the tag "foo".

Thus, for the purposes of comparing two HTTP URIs as tags, the last segment of the path portion should be extracted and only that value (that value of the tag) should be compared.

Need more formal language about comparison and extraction process.

The destination of a rel="tag" hyperlink is required to be a tag space (a place that collates or defines tags), where the last segment of the path of the URL is the tag, e.g.

http://technorati.com/tag/tech 

is a URL for the tag "tech".

Tags may only be placed in the URL path, and only in the last segment of the path. Tags may not be placed in query parameters or fragment identifiers. e.g.

http://technorati.com/tag/tech?tag=fish#emu 

is still a URL for the tag "tech", not "fish" or "emu".

Since the only part of a tag space URL of which any structure is required is the last path segment, a tag space URL can be hosted at any domain. Authors may choose to link to a tag at a particular tag space in order to provide a specific meaning. E.g. a tag for technology could link to:

  http://en.wikipedia.org/wiki/Technology 

Trailing slashes in tag URLs are ignored, that is:

  http://technorati.com/tag/Technology/ 

as a rel-tag URL is treated as:

  http://technorati.com/tag/Technology 

Encoding issues

Spaces can be encoded either as + or %20. Unicode characters are encoded as specified in RFC 3986. For example:

<a href="http://technorati.com/tag/Sant%C3%A9+et+bien-%C3%AAtre" rel="tag">Santé et bien-être</a> 

Note that if using Wikipedia as a tagspace, as discussed above, you should use %20 as they remap '+' to %2B, causing a page with a plus sign in the title (which usually does not exist) to appear.

Tags Are Visible Metadata

rel="tag" hyperlinks are intended to be visible links on pages and posts. This is in stark contrast to meta keywords (which were invisible and typically never revealed to readers), and thus is at least somewhat more resilient to the problems which plagued meta keywords.

Making tag hyperlinks visible has the additional benefit of making it more obvious to readers if a page is abusing tag links, and thus providing more peer pressure for better behavior. It also makes it more obvious to authors, who may not always be aware what invisible metadata is being generated on their behalf.

As a result the invisible tag link syntax variant: <link rel="tag" href="..." /> SHOULD NOT be supported by implementations.

Implementations

This section is informative.

The following implementations have been developed which either generate or parse rel-tag links. If you have a rel-tag implementation, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

References

Normative References

  • HTML 4
  • XHTML 1
  • XMDP
  • RFC 3986 specifies URL syntax. Section 3.3 specifies URL paths and path segments.

Informative References

Discussions

Q&A

  • If you have any questions about rel-tag, check the rel FAQ first for general rel attribute questions, then check the rel-tag FAQ, and then if you don't find answers, ask your question on the microformats-discuss mailing list.

Issues

  • Please add any issues with the specification to the separate rel-tag issues document.