canmove, Confirmed users
2,675
edits
Microsummaries: Difference between revisions
Firefox 6 dropped support for proprietary microsummary format, now obsolete
(Firefox 6 dropped support for proprietary microsummary format, now obsolete) |
|||
| (12 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
== OBSOLETE == | |||
'''As of Firefox 6, [https://bugzilla.mozilla.org/show_bug.cgi?id=524091 support for microsummaries has been removed].''' | |||
Microsummaries are obsolete and not recommended for use. Some [http://microformats.org/wiki/page-summary-formats#Issues_2 issues with microsummary] have been documented. | |||
Legacy documentation follows: | |||
== Introduction == | == Introduction == | ||
| Line 65: | Line 72: | ||
When Firefox encounters a <code><link></code> tag whose <code>rel</code> attribute is set to <code>microsummary</code>, it loads the URL in the <code>href</code> attribute and uses its content as the microsummary for the page. If the content is plain text, Firefox uses it as-is. If the content is HTML, however, Firefox first converts it to plain text (Firefox supports only plain text microsummaries at this time). | When Firefox encounters a <code><link></code> tag whose <code>rel</code> attribute is set to <code>microsummary</code>, it loads the URL in the <code>href</code> attribute and uses its content as the microsummary for the page. If the content is plain text, Firefox uses it as-is. If the content is HTML, however, Firefox first converts it to plain text (Firefox supports only plain text microsummaries at this time). | ||
Note: if the content at the URL is a microsummary generator, Firefox will use the generator to extract the microsummary from the contents of the page itself, so you can write code to generate the microsummary on the client instead of the server. But generating microsummaries on the server-side is generally simpler and more efficient, so we recommend you take that approach. If you do want to write a client-side generator, however, see the [http://developer.mozilla.org/en/docs/Creating_a_Microsummary Creating a Microsummary tutorial]. | Note: if the content at the URL is a microsummary generator, Firefox will use the generator to extract the microsummary from the contents of the page itself, so you can write code to generate the microsummary on the client instead of the server. But generating microsummaries on the server-side is generally simpler and more efficient, so we recommend you take that approach. If you do want to write a client-side generator, however, see the [http://developer.mozilla.org/en/docs/Creating_a_Microsummary Creating a Microsummary tutorial] and the [http://developer.mozilla.org/en/docs/Microsummary_XML_grammar_reference Microsummary XML grammar reference]. | ||
Note the additional information available in [http://developer.mozilla.org/en/docs/Microsummary_topics Microsummary topics]. | |||
== Writing Microsummary Generator Add-ons == | == Writing Microsummary Generator Add-ons == | ||
| Line 74: | Line 82: | ||
To learn how to create generator add-ons and make them available to Firefox users, see the [http://developer.mozilla.org/en/docs/Creating_a_Microsummary Creating a Microsummary tutorial]. Also see the [http://developer.mozilla.org/en/docs/Creating_regular_expressions_for_a_microsummary_generator Creating regular expressions for a microsummary generator tutorial] for a step-by-step guide to writing regular expressions that specify the pages to which your generators should apply. | To learn how to create generator add-ons and make them available to Firefox users, see the [http://developer.mozilla.org/en/docs/Creating_a_Microsummary Creating a Microsummary tutorial]. Also see the [http://developer.mozilla.org/en/docs/Creating_regular_expressions_for_a_microsummary_generator Creating regular expressions for a microsummary generator tutorial] for a step-by-step guide to writing regular expressions that specify the pages to which your generators should apply. | ||
Refer to the [http://developer.mozilla.org/en/docs/Microsummary_XML_grammar_reference Microsummary XML grammar reference] for the details of the Microsummary XML grammar, and note the additional information available in [http://developer.mozilla.org/en/docs/Microsummary_topics Microsummary topics]. | |||
== Technical Details == | == Technical Details == | ||
| Line 116: | Line 125: | ||
=== Tutorials === | === Tutorials === | ||
* [http://developer.mozilla.org/en/docs/Creating_a_Microsummary Creating a Microsummary] | |||
* [http://developer.mozilla.org/en/docs/Creating_regular_expressions_for_a_microsummary_generator Creating regular expressions for a microsummary generator] | |||
=== Examples === | |||
==== Generators ==== | |||
[http:// | * [http://people.mozilla.com/~myk/microsummaries/generators/ microsummary generators] | ||
[http:// | * [http://www.etf.cuni.cz/~tomasek/pub/microsummaries/install.html generators for Czech sites] | ||
* [http://userstyles.org/livetitle/ Live Titles] - microsummary generators repository | |||
=== | ==== Sites ==== | ||
[ | See examples of sites that provide microsummaries at [[Microsummaries/Sites]]. | ||
=== Other Docs === | === Other Docs === | ||
* [[Microsummaries/Using|Using Microsummaries]] | |||
* [http://developer.mozilla.org/en/docs/Microsummary_XML_grammar_reference Microsummary XML grammar reference] | |||
* [http://developer.mozilla.org/en/docs/Microsummary_topics Microsummary topics] | |||
== Tools == | |||
[ | === Extensions === | ||
[ | * [https://addons.mozilla.org/firefox/3639/ Microsummary Buddy] - display an icon in the location bar when a microsummary is available for a page | ||
[ | * [https://addons.mozilla.org/firefox/3741/ Microsummary Generator Builder] - build a Microsummary Generator, based on a selection on the current web page | ||
* [https://addons.mozilla.org/firefox/4248/ Microsummary Manager] - shows installed Microsummaries in the Add-ons manager and provides UI for deleting them | |||