Difference between revisions of "blog-description-format"

From Microformats Wiki
Jump to navigation Jump to search
(started filling out section on Existing Practice)
Line 35: Line 35:
  
 
== Existing practice ==
 
== Existing practice ==
 +
 +
=== Entry Wrappers ===
 +
 +
<pre><nowiki><div class="entry"></div></nowiki></pre> has widespread usage, but seems to show up in slightly different contexts.
 +
 +
Some blogs (ala Wordpress) use the entry div as a wrapper to the actual post body, and wrap the whole thing in an additional div:
 +
 +
<pre><nowiki><div class="post">
 +
    <div class="entry">
 +
    </div>
 +
</div></nowiki></pre>
 +
 +
=== Metadata ===
 +
 +
Wordpress uses class="postmetadata" to contain meta information, date, others use their own syntax - class="topics", class="description".
 +
<span style="color:green;">
 +
-- need to post better examples here --
 +
</span>
 +
=== Permalinks ===
 +
 +
rel="bookmark" and rel="permalink" are both used in various places to denote a permalink to the specified entry.
 +
  
 
=== Blog description ===
 
=== Blog description ===

Revision as of 10:50, 15 August 2005

Blog description format (background research)

Discussion Participants

Editors

Authors

Purpose

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.

Here are some of examples for information that might be provided:

  • Details about the blog
  • Blog name (e.g: "John Doe's Blog")
    • Blog URI (e.g: http://example.org/ )
    • Lanuage used for the blog, read-able by machines (e.g: "en-US" or "de")
    • Topics covered by the blog
    • A short description
    • Available feeds (RSS, Atom, etc.)
    • A small logo image
  • Details about the author(s)
    • Name (e.g: "John Doe")
    • Organisation
    • Contact details
    • Geographical Location

Examples

Add real world examples here

Existing practice

Entry Wrappers

<div class="entry"></div>

has widespread usage, but seems to show up in slightly different contexts.

Some blogs (ala Wordpress) use the entry div as a wrapper to the actual post body, and wrap the whole thing in an additional div:

<div class="post">
    <div class="entry">
    </div>
</div>

Metadata

Wordpress uses class="postmetadata" to contain meta information, date, others use their own syntax - class="topics", class="description". -- need to post better examples here --

Permalinks

rel="bookmark" and rel="permalink" are both used in various places to denote a permalink to the specified entry.


Blog description

How do blogs include information about themself?

Feeds

Most blogging tools and services provide information about available feeds in <link> elements.

Example: (random blog from LiveJournal.com)

<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.livejournal.com/users/shalom9121/data/rss" />
<link rel="alternate" type="application/atom+xml" title="Atom" href="http://www.livejournal.com/users/shalom9121/data/atom" />

Author information

How do blogs include information about the author?

It seems to be common on blogger.com to include "About me" in the sidebar (see http://www.blogger.com/redirect/next_blog.pyra?navBar=true for a random blog)

See also