xfolk-brainstorming: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(→‎xFolk Brainstorming: deprecate in favour of hreview)
 
(15 intermediate revisions by 5 users not shown)
Line 1: Line 1:
= xFolk Brainstorming =
= xFolk Brainstorming =


xFolk is a bare bones microformat for describing and tagging things represented by a URL.  This definition, although simple, is pretty broad.  xFolk brainstorming is a set of fairly free-flowing ideas about the future directions of xFolk.  Are there functional issues you feel xFolk should address?  Other issues or ideas?  Put them here.
[[xfolk|xFolk]] is a bare bones microformat for describing and tagging things represented by a URL.  This definition, although simple, is pretty broad.  xFolk brainstorming is a set of fairly free-flowing ideas about the future directions of xFolk.  Are there functional issues you feel xFolk should address?  Other issues or ideas?  Do you have implementation ideas you would like to discuss?  Put them here.
 
__TOC__


== Authors ==
== Authors ==
Line 45: Line 47:


Which works very well for images but might not work so well for other media types (video, text snippets, etc.)  
Which works very well for images but might not work so well for other media types (video, text snippets, etc.)  
</blocquote>
<p><cite>Eran</cite></p>
</blockquote>
 
 
----
 
<pre>
<span class="xfolkentry">
  <span class="taggedresource">This is my note</span>
  <a rel="tag" href="http://example.com/tag/foo">foo</a>
</span>
</pre>
 
Here's an option.  I gave it the class "taggedlink" and the class "inline".  Style inline not to show as a link and not to change the cursor if you want.
 
<pre>
<span class="package">
<span class="xfolkentry">
  <span><a href="URLofSomeSort" class="taggedlink inline">This is my note</a></span>
  <a rel="tag" href="http://example.com/tag/foo">foo</a>
</span>
</pre>
 
more complete usecase:
<pre>
<ul class="aPackage">
  <ul>
  <li class="xfolkentry">
    <a class="taggedresource" href="someurl">url's title</a>
    <a rel="tag" href="http://example.com/tag/foo">foo</a>
    <span class="comment">this is a comment about my link</span>
  </li>
 
  <li class="xfolkentry">
    <span class="taggedresource">This is my note</span>
    <a rel="tag" href="http://example.com/tag/footoo">footoo</a>
    <span class="comment">this is a comment about my note</span>
  </li
 
  <li class="xfolkentry">
    <img class="taggedresource" src="someurl.jpeg">
    <a rel="tag" href="http://example.com/tag/foobar">foobar</a>
  </li>
</ul>
</pre>
 
== Deprecate xFolk ==
 
We should deprecate [[xFolk]] in favour of [[hReview]]. Having two such similar microformats seems pointless. xFolk emerged more or less as a fully formed idea from a single contributor over a two day wiki-editing spree; hReview has more evidence of having followed a sensible, iterative design process with multiple contributors. Any xFolk entry can be re-expressed in hReview pretty trivially:
 
<pre>
<div class="xfolkentry">
  <h2><a class="taggedlink" href="http://example.com/">Example</a></h2>
  <p class="description">This is an example page for use in documentation.</p>
  tagged: <a rel="tag" href="http://en.wiktionary.org/wiki/example">example</a>
</div>
</pre>
 
becomes, in hReview:
 
<pre>
<div class="hreview">
  <h2 class="item"><a class="fn url" href="http://example.com/">Example</a></h2>
  <p class="description">This is an example page for use in documentation.</p>
  tagged: <a rel="tag" href="http://en.wiktionary.org/wiki/example">example</a>
</div>
</pre>
 
== Implementation Ideas ==
 
==See also==
*[[xfolk-delirious]]
 
==Related pages==
{{template:xfolk-related-pages}}

Latest revision as of 13:32, 24 March 2010

xFolk Brainstorming

xFolk is a bare bones microformat for describing and tagging things represented by a URL. This definition, although simple, is pretty broad. xFolk brainstorming is a set of fairly free-flowing ideas about the future directions of xFolk. Are there functional issues you feel xFolk should address? Other issues or ideas? Do you have implementation ideas you would like to discuss? Put them here.

Authors

Bud Gibson

Add your name to the end of the list if you contribute an idea.

Functional Extensions

  • We will be adding the ability to tag any visible element that has an href attribute. This includes <img> and <object> elements. It is likely that there will be more specialized, domain-specific microformats for some of these items in the future.

Attribute Value Naming

  • Should we change the name of taggedlink, used to represent the item to be tagged to a more neutral name such as tagged or taggedresource?

The editor's current thinking is that taggedlink represents well the fact that people are identifying things represented by a URL. However, as some discussants have pointed out, the name may be too narrow. The editor is waiting to collect further data and use cases.

Here is one use case recently presented by Eran on the discussion list:

For simplicity let's assume I'm using xFolk for my photo tagging service. Following the microformat philosophy, I would like to present the information in a way that's meaningful both to people and machines. For a machine, a URL is enough to identify a a resource so something like the following is enough:

<span class="xfolkentry">
<a class="taggedlink" href="http://example.com/image.png">my image</a>
<a rel="tag" href="http://example.com/tag/foo">foo</a>
</span>

But to a human browing this page this makes little sense. The following alternative representation might work better:

<span class="xfolkentry">
<img class="taggedresource" src="http://example.com/image.png" alt="my
image">
<a rel="tag" href="http://example.com/tag/foo">foo</a>
</span>

Using class="taggedlink" on an IMG element doesn't seem right. Of course, we can combine the two:

<span class="xfolkentry">
<a class="taggedlink" href="http://example.com/image.png">
	<img src="http://example.com/image.png" alt="my image">
</a>
<a rel="tag" href="http://example.com/tag/foo">foo</a>
</span>

Which works very well for images but might not work so well for other media types (video, text snippets, etc.)

Eran



<span class="xfolkentry">
  <span class="taggedresource">This is my note</span>
  <a rel="tag" href="http://example.com/tag/foo">foo</a>
</span>

Here's an option. I gave it the class "taggedlink" and the class "inline". Style inline not to show as a link and not to change the cursor if you want.

<span class="package">
<span class="xfolkentry">
  <span><a href="URLofSomeSort" class="taggedlink inline">This is my note</a></span>
  <a rel="tag" href="http://example.com/tag/foo">foo</a>
</span>

more complete usecase:

<ul class="aPackage">
  <ul>
  <li class="xfolkentry">
    <a class="taggedresource" href="someurl">url's title</a>
    <a rel="tag" href="http://example.com/tag/foo">foo</a>
    <span class="comment">this is a comment about my link</span>
  </li>

  <li class="xfolkentry">
    <span class="taggedresource">This is my note</span>
    <a rel="tag" href="http://example.com/tag/footoo">footoo</a>
    <span class="comment">this is a comment about my note</span>
  </li

  <li class="xfolkentry">
    <img class="taggedresource" src="someurl.jpeg">
    <a rel="tag" href="http://example.com/tag/foobar">foobar</a>
  </li>
</ul>

Deprecate xFolk

We should deprecate xFolk in favour of hReview. Having two such similar microformats seems pointless. xFolk emerged more or less as a fully formed idea from a single contributor over a two day wiki-editing spree; hReview has more evidence of having followed a sensible, iterative design process with multiple contributors. Any xFolk entry can be re-expressed in hReview pretty trivially:

 <div class="xfolkentry">
  <h2><a class="taggedlink" href="http://example.com/">Example</a></h2>
  <p class="description">This is an example page for use in documentation.</p>
  tagged: <a rel="tag" href="http://en.wiktionary.org/wiki/example">example</a>
 </div>

becomes, in hReview:

 <div class="hreview">
  <h2 class="item"><a class="fn url" href="http://example.com/">Example</a></h2>
  <p class="description">This is an example page for use in documentation.</p>
  tagged: <a rel="tag" href="http://en.wiktionary.org/wiki/example">example</a>
 </div>

Implementation Ideas

See also

Related pages