Revision as of 06:47, 23 July 2005 by Tantek (Talk | contribs)
(diff) ←Older revision | Current revision (diff) | Newer revision→ (diff)

Jump to: navigation, search

Blog description format


Discussion Participants




A microformat to describe the contents of a (we)blog. It provides a specific set of information to categorize a (we)blog. Enables easier search for humans and efficient collection of information by machines.


NOTE: Background research for a format should use *real* examples found on the Web, rather than hypothetical examples (note URLs) - Tantek

Example 1:

<div class="blogformat" xml:lang="de">
   <img class="logo" src="" alt="" />
   <a class="bookmark" href="" title="Blog title">Blog name</a>
   <!-- Topics covered by the blog -->
   <ul class="categories">
     <li><a rel="tag" href="">Webstandards</a></li>
     <li><a rel="tag" href="">CSS</a></li>
     <li><a rel="tag" href="">XHTML</a></li>
   <ul class="feeds"><!-- List of available news feeds -->
     <li><a rel="alternate" type="application/atom+xml" href="URL">Atom1.0</a></li>
     <li><a rel="alternate" type="application/rss+xml" href="">RSS 2.0</a></li>
   <!-- Describes the topics of the blog -->
   <p class="description">Webstandards, CSS, XHTML and topics releated to web development.</p>

Example 2:

<div class="blogformat" xml:lang="en">
   <p><img class="logo" alt="" 
        src="" />
   <a class="author" href="">My</a> 
   <a class="bookmark" href="" title="John Doe's Blog">blog</a>
   <span class="description">
   <a rel="tag" href="">Web standards</a>,
   <a rel="tag" href="">CSS</a>,
   <a rel="tag" href="">XHTML</a>
   and topics releated to web development.</span></p>
   <p>There are 
   <a rel="alternate" type="application/atom+xml" href="">Atom</a> and 
   <a rel="alternate" type="application/rss+xml" href="">RSS 2.0</a>
   feeds available.</p>

Note: Other code examples can be found here. These examples include both a code listing and a rendered version.

Additional description and code examples (in German language) can be found here.


It is premature and unwise to write a draft proposal a microformat without first performing the requisite backround research. Please see the process document. The background research page (e.g. "blog-description-format") is also an inappropriate place to begin a draft proposal. -Tantek

Early draft

A very early draft featuring some of the used tags an attributes and their meaning.

Text in italics is used as reference to the comments below.

Blog information container


The blog information container element contains all other elements of the blog description.

It must have a class attribute which includes the value blogformat.


Status: REQUIRED (langmust)

The blog information container element or an ancestor element (langanc) of it must include a language code using the xml:lang attribute to indicate the language used for the blog.

If the document type used by the author allows the usage of the lang attribute, it must be used to specify the language code. The value must be equal to the one used for xml:lang. (langequ)

Example 1:

<!-- A blog written in English as spoken in the US -->
<div class="blogformat" lang="en-US" xml:lang="en-US">
    <!-- child elements -->

Example 2:

<!-- A blog written in French -->
<div class="blogformat" lang="fr" xml:lang="fr">
    <!-- child elements -->

Blog URI


The blog URI element must be an <a> element and must contain a rel attribute which includes the value bookmark.

It must link to the blog's mainpage using an absolute URI (absuri).

This element should provide the name of the blog in its title attribute.

If no title attribute is provided agents (agents) must use the text value of the blog URI element (meta).

Blog description and topics


It contains the main categories covered by the blog.

The categories are marked up within anchors (cat) that (may) refer to technorati-tags.


<a rel="tag" href="">XHTML</a>

In addition authors can write up a short introduction.

Author information


Information about the author should be provided.

The author information element must have a class attribute which includes the value author. This element should provide the name of the author in its title attribute.


<span class="author" title="John Doe">John's</span> Blog.

If no title attribute is provided agents (agents) must use the text value of the author information element (meta).

The author information element may be an <a> element which links to the author's page using an absolute URI (absuri).


<a class="author" title="John Doe"
   href="">John's</a> Blog.



It's essential as every (we)blog provides at least one feed (e.g. RSS). Machines could readout headlines and excerpts.

It's possible to provide more than one feed.



To be done.




Area of application

"blog description format" is targeted on blogs. But could't we use it for other online media? Instead of "blog author" we could say "publisher".

For example the fictitious online web magazine "LA Dog Magazine" may also be described using "blog description format". --RobertBachmann

blog-description-format was last modified: Wednesday, December 31st, 1969