blog-description-format: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(→‎Examples: Added an example)
m (Reverted edits by C4ttrPascn (Talk) to last version by Tantek)
 
(40 intermediate revisions by 10 users not shown)
Line 1: Line 1:
= Blog description format =
= Blog description format (background research)=
 
'''Note: this page has been rewritten/refactored out to other pages to better fit in with the microformats [[process]]. E.g. the following pages have been added to or created:'''
 
* [[blog-post-examples]]
* [[blog-description-examples]]
* [[blog-description-brainstorming]] (perhaps simply rename [[blog-description-format-brainstorming]])
 
 
__TOC__
__TOC__


Line 5: Line 13:


=== Editors ===
=== Editors ===
* [http://bs-markup.de Björn Seibert], [http://rbach.priv.at/ Robert Bachmann]
* [http://bs-markup.de Björn Seibert]
* [http://rbach.priv.at/ Robert Bachmann]
* [http://tantek.com/ Tantek Çelik]


=== Authors ===
=== Authors ===
* [http://bs-markup.de Björn Seibert], [http://rbach.priv.at/ Robert Bachmann]
* [http://bs-markup.de Björn Seibert]
* [http://rbach.priv.at/ Robert Bachmann]
* [http://tantek.com/ Tantek Çelik]
 
=== Contributors ===
* [http://maetl.coretxt.net.nz Mark Rickerby]


== Purpose ==
== 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.
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.


== Examples ==
Here are some of examples for information that might be provided:
Example 1:
 
<pre><nowiki>
* Details about the blog
<div class="blogformat" xml:lang="de">
* Blog name (e.g: "John Doe's Blog")
  <img class="logo" src="http://example.org/logo.gif" alt="" />
** Blog URI (e.g: http://example.org/ )
  <a class="bookmark" href="http://example.org/blog" title="Blog title">Blog name</a>
** Lanuage used for the blog, read-able by machines (e.g: "en-US" or "de")
  <!-- Topics covered by the blog -->
** Topics covered by the blog
  <ul class="categories">
** A short description
    <li><a rel="tag" href="http://technorati.com/tags/Webstandards">Webstandards</a></li>
** Available feeds (RSS, Atom, etc.)
    <li><a rel="tag" href="http://technorati.com/tags/css">CSS</a></li>
** A small logo image
    <li><a rel="tag" href="http://technorati.com/tags/xhtml">XHTML</a></li>
* Details about the author(s)
  </ul>
** Name (e.g: "John Doe")
  <ul class="feeds"><!-- List of available news feeds -->
** Organisation
    <li><a rel="alternate" type="application/atom+xml" href="URL">Atom1.0</a></li>
** Contact details
    <li><a rel="alternate" type="application/rss+xml" href="http://example.org/rss-2.0">RSS 2.0</a></li>
** Geographical Location
  </ul>
 
  <!-- Describes the topics of the blog -->
== Existing practice ==
  <p class="description">Webstandards, CSS, XHTML and topics releated to web development.</p>
 
</div>
=== Blog Posts ===
</nowiki></pre>
 
Example 2:
Moved to [http://microformats.org/wiki/blog-post-examples#Rough_Examples blog-post-examples].
<pre><nowiki>
 
<div class="blogformat" xml:lang="en">
=== Blog description ===
  <p><img class="logo" alt=""
        src="http://rbach.priv.at/Misc/2005/Smiley.gif" />
  <a class="author" href="http://example.org/jdoe">My</a>
  <a class="bookmark" href="http://example.org/blog" title="John Doe's Blog">blog</a>
  about
  <span class="description">
  <a rel="tag" href="http://technorati.com/tags/web+standards">Web standards</a>,
  <a rel="tag" href="http://technorati.com/tags/css">CSS</a>,
  <a rel="tag" href="http://technorati.com/tags/xhtml">XHTML</a>
  and topics releated to web development.</span></p>
  <p>There are
  <a rel="alternate" type="application/atom+xml" href="http://example.org/feeds/atom">Atom</a> and
  <a rel="alternate" type="application/rss+xml" href="http://example.org/feeds/rss">RSS 2.0</a>
  feeds available.</p>
</div>
</nowiki></pre>


Note: Other code examples can be found [http://rbach.priv.at/Misc/2005/BlogDescriptionMicroformat/ExamplesForBrainstorming.html| here]. These examples include both a code listing and a rendered version.
Moved to [[blog-description-examples]].


Additional description and code examples (in German language) can be found [http://www.bs-markup.de/ex/microformats_blogformat.php here].
== See also ==
* [[blog-description-format-brainstorming]] for examples on how things ''could'' be done.

Latest revision as of 22:34, 5 January 2009

Blog description format (background research)

Note: this page has been rewritten/refactored out to other pages to better fit in with the microformats process. E.g. the following pages have been added to or created:


Discussion Participants

Editors

Authors

Contributors

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

Existing practice

Blog Posts

Moved to blog-post-examples.

Blog description

Moved to blog-description-examples.

See also