Difference between revisions of "page-summary-formats"

From Microformats Wiki
Jump to navigation Jump to search
(make link texts unique)
(Firefox 6 dropped support for proprietary microsummary format)
 
(9 intermediate revisions by 8 users not shown)
Line 13: Line 13:
 
Google search results display the value of the meta description element for a page when that page is listed in Google search results.
 
Google search results display the value of the meta description element for a page when that page is listed in Google search results.
  
===Product Support Issues===
+
===Issues===
  
 
* '''Invisible.''' meta description is invisible metadata on the page and therefore violates microformats principles.
 
* '''Invisible.''' meta description is invisible metadata on the page and therefore violates microformats principles.
Line 20: Line 20:
  
 
== Microsummary ==
 
== Microsummary ==
 +
'''Obsolete'''
  
Mozilla has introduced a proprietary format called "microsummary", which is used in Firefox 2.0's support for bookmarks.
+
Mozilla introduced a proprietary format called "microsummary", which was used in Firefox 2.0-5.0's support for bookmarks.
 +
 
 +
'''Firefox 6.0 has [https://bugzilla.mozilla.org/show_bug.cgi?id=524091 removed support for microsummary].'''
  
 
Note:
 
Note:
  
#that microsummaries are not intended simply to deliver a summary of a page; they may be used, for example, for a "deal of the day", "last updated" date or time, a new headline, or other timely and dynamic information.
+
#that microsummaries were not intended simply to deliver a summary of a page; they may be used, for example, for a "deal of the day", "last updated" date or time, a new headline, or other timely and dynamic information.
 
#a "microformat" consisting of a <code>class="microsummary"</code> attribute would allow a piece of content (a span including a "last updated date", for example), to be extracted from a page, by software.
 
#a "microformat" consisting of a <code>class="microsummary"</code> attribute would allow a piece of content (a span including a "last updated date", for example), to be extracted from a page, by software.
 
#if multiple tags included <code>class="microsummary"</code>, we'd need to decide whether they each represent different microsummaries or they all represent a single microsummary whose value is the concatenation of each tag's content.  The former seems saner, but sometimes microsummary content is scattered around the page (f.e. an eBay auction item microsummary might contain the name of the item, the auction end date, and the current high bid, but that information appears in three separate places in the page).
 
#if multiple tags included <code>class="microsummary"</code>, we'd need to decide whether they each represent different microsummaries or they all represent a single microsummary whose value is the concatenation of each tag's content.  The former seems saner, but sometimes microsummary content is scattered around the page (f.e. an eBay auction item microsummary might contain the name of the item, the auction end date, and the current high bid, but that information appears in three separate places in the page).
Line 34: Line 37:
 
===Code===
 
===Code===
 
* [http://www.xs4all.nl/~jlpoutre/BoT/WP/microsummary/ WP-Microsummary plugin for WordPress]
 
* [http://www.xs4all.nl/~jlpoutre/BoT/WP/microsummary/ WP-Microsummary plugin for WordPress]
 +
* [http://squio.nl/blog/2006/12/04/microsummary-generator-wizard-extension/ Microsummary Generator Wizard for Firefox]
  
 
===Examples of discussion===
 
===Examples of discussion===
Line 45: Line 49:
 
**[http://www.westmidlandbirdclub.com/new.htm What's New]
 
**[http://www.westmidlandbirdclub.com/new.htm What's New]
 
**[http://www.westmidlandbirdclub.com/ladywalk/latest.htm Ladywalk News]
 
**[http://www.westmidlandbirdclub.com/ladywalk/latest.htm Ladywalk News]
 +
*[http://userstyles.org/livetitle third-party generated microsummaries for a range of specific pages]
  
===Microsummary Issues===
+
===Issues===
  
 
* '''Invisible.''' Though different from meta description in that the <code>link</code> tag is used to relate to a summary at another URL - this doesn't actually markup the summary content itself. Since the content is not necessarily visible on the page itself, an author could easily change the page content without noticing or even knowing to bother to change the referenced "summary" page/ resource (except, of course, where the microsummary is automatically generated, such as by extracting the first "H2", or the content of a div or span with a specific ID, or the last-updated date). Thus this method has all the same potential flaws of typical invisible metadata publishing, which is that overtime it may rot, become out of date, unreliable and untrustworthy in general.
 
* '''Invisible.''' Though different from meta description in that the <code>link</code> tag is used to relate to a summary at another URL - this doesn't actually markup the summary content itself. Since the content is not necessarily visible on the page itself, an author could easily change the page content without noticing or even knowing to bother to change the referenced "summary" page/ resource (except, of course, where the microsummary is automatically generated, such as by extracting the first "H2", or the content of a div or span with a specific ID, or the last-updated date). Thus this method has all the same potential flaws of typical invisible metadata publishing, which is that overtime it may rot, become out of date, unreliable and untrustworthy in general.
Line 53: Line 58:
  
 
* Haven't we already solved 99% of this problem with RSS and the <code>title</code> element? [[User:Ianloic|Ianloic]] 17:11, 10 Dec 2006 (PST)
 
* Haven't we already solved 99% of this problem with RSS and the <code>title</code> element? [[User:Ianloic|Ianloic]] 17:11, 10 Dec 2006 (PST)
**No. [[User:AndyMabbett|Andy Mabbett]] 03:56, 11 Dec 2006 (PST)
+
** No, that's not the case. [[User:AndyMabbett|Andy Mabbett]] 10:29, 11 Dec 2006 (PST)
 +
** The <code>title</code> element doesn't solve this problem, because it can only contain plaintext, whereas microsummaries are intended to ultimately contain rich content (HTML, images, etc.), and also because the <code>title</code> element lives inside the document, so web clients have to load the much larger document to get access to the much smaller summary inside it (which is fine in some cases, but not in others). [[User:MykMelez|Myk Melez]]
 +
** RSS/Atom, on the other hand, would be a great delivery mechanism for microsummaries.  Support for feed-based microsummaries (using profiles of RSS/Atom with heuristics to determine summaries even for web sites that don't provide a specialized summary feed) was part of the original plan for Firefox 2.  After some discussion, however, we decided that it would make the most sense for Firefox's Live Bookmarks feature to handle all feed-based bookmark updates and to focus the microsummaries feature specifically on client-side and server-side generated summaries (i.e. those extracted by XSLT-based microsummary generators) as well as simple server-side content summaries. [[User:MykMelez|Myk Melez]]
 +
** In retrospect, I think not supporting feed-based microsummaries was a mistake, and microsummaries should indeed extract summaries from feeds, where available.  I plan to make this happen for Firefox 3.  Nevertheless, I do think there's a place for the kind of simple server-side content summaries currently available in Firefox 2, despite their limitations, in some cases of authors building sites with content that is a better candidate for summarization than syndication.  And there's also a place for microsummary generators, which address a problem solved by neither feeds nor server-side content summaries. [[User:MykMelez|Myk Melez]]

Latest revision as of 15:18, 4 August 2011

Page Summary Formats

This page describes existing formats that enable an author to publish a summary description for a page. Whether or not this is worthy of doing research (e.g. page-summary-examples, page-summary-brainstorming) for a microformat is open to debate. Nonetheless, it doesn't hurt to at least have a place to document existing formats.

Meta description

HTML4.01 provides meta description as an example in Appendix B: Performance, Implementation, and Design Notes of the HTML 4.01 spec. E.g.

<META name="description" content="Idyllic European vacations">

Product Support

Google search results display the value of the meta description element for a page when that page is listed in Google search results.

Issues

  • Invisible. meta description is invisible metadata on the page and therefore violates microformats principles.
  • Depends on head element. This summary format depends on the author having access to the head element which in many (most?) web authoring/ publishing scenarios the content author has no access.

Microsummary

Obsolete

Mozilla introduced a proprietary format called "microsummary", which was used in Firefox 2.0-5.0's support for bookmarks.

Firefox 6.0 has removed support for microsummary.

Note:

  1. that microsummaries were not intended simply to deliver a summary of a page; they may be used, for example, for a "deal of the day", "last updated" date or time, a new headline, or other timely and dynamic information.
  2. a "microformat" consisting of a class="microsummary" attribute would allow a piece of content (a span including a "last updated date", for example), to be extracted from a page, by software.
  3. if multiple tags included class="microsummary", we'd need to decide whether they each represent different microsummaries or they all represent a single microsummary whose value is the concatenation of each tag's content. The former seems saner, but sometimes microsummary content is scattered around the page (f.e. an eBay auction item microsummary might contain the name of the item, the auction end date, and the current high bid, but that information appears in three separate places in the page).

Documentation

Code

Examples of discussion

Firefox extension

Examples

Issues

  • Invisible. Though different from meta description in that the link tag is used to relate to a summary at another URL - this doesn't actually markup the summary content itself. Since the content is not necessarily visible on the page itself, an author could easily change the page content without noticing or even knowing to bother to change the referenced "summary" page/ resource (except, of course, where the microsummary is automatically generated, such as by extracting the first "H2", or the content of a div or span with a specific ID, or the last-updated date). Thus this method has all the same potential flaws of typical invisible metadata publishing, which is that overtime it may rot, become out of date, unreliable and untrustworthy in general.
  • Depends on head element. This summary format may depend on the author having access to the head element which in many (most?) web authoring/ publishing scenarios the content author has no access.
  • Haven't we already solved 99% of this problem with RSS and the title element? Ianloic 17:11, 10 Dec 2006 (PST)
    • No, that's not the case. Andy Mabbett 10:29, 11 Dec 2006 (PST)
    • The title element doesn't solve this problem, because it can only contain plaintext, whereas microsummaries are intended to ultimately contain rich content (HTML, images, etc.), and also because the title element lives inside the document, so web clients have to load the much larger document to get access to the much smaller summary inside it (which is fine in some cases, but not in others). Myk Melez
    • RSS/Atom, on the other hand, would be a great delivery mechanism for microsummaries. Support for feed-based microsummaries (using profiles of RSS/Atom with heuristics to determine summaries even for web sites that don't provide a specialized summary feed) was part of the original plan for Firefox 2. After some discussion, however, we decided that it would make the most sense for Firefox's Live Bookmarks feature to handle all feed-based bookmark updates and to focus the microsummaries feature specifically on client-side and server-side generated summaries (i.e. those extracted by XSLT-based microsummary generators) as well as simple server-side content summaries. Myk Melez
    • In retrospect, I think not supporting feed-based microsummaries was a mistake, and microsummaries should indeed extract summaries from feeds, where available. I plan to make this happen for Firefox 3. Nevertheless, I do think there's a place for the kind of simple server-side content summaries currently available in Firefox 2, despite their limitations, in some cases of authors building sites with content that is a better candidate for summarization than syndication. And there's also a place for microsummary generators, which address a problem solved by neither feeds nor server-side content summaries. Myk Melez