Confirmed users
61
edits
Microsummaries: Difference between revisions
→Microsummary Definitions
| Line 29: | Line 29: | ||
A microsummary definition is a set of instructions for generating microsummaries. Definitions are expressed via an XML dialect with the namespace '''http://www.mozilla.org/microsummaries/0.1'''. A definition consists of a <definition> tag containing the following attributes and child elements: | A microsummary definition is a set of instructions for generating microsummaries. Definitions are expressed via an XML dialect with the namespace '''http://www.mozilla.org/microsummaries/0.1'''. A definition consists of a <definition> tag containing the following attributes and child elements: | ||
* an '''id''' attribute that uniquely identifies the definition | * an '''id''' attribute that uniquely identifies the definition; the recommended format for the attribute is @[author]/[site]/[name], where [author] identifies the developer of the definition, [site] identifies the site to which the definition applies, and [name] describes the definition, for example: '''@mozilla.org/bbc.co.uk/latest-headline'''; | ||
* a '''name''' attribute that identifies the definition to users, f.e. '''Latest BBC Headline'''; | * a '''name''' attribute that identifies the definition to users, f.e. '''Latest BBC Headline'''; | ||
* a '''<pages>''' child element with one or more <include>/<exclude> child elements containing regular expressions that identify the URIs to which the definition applies | * a '''<pages>''' child element with one or more <include>/<exclude> child elements containing regular expressions that identify the URIs to which the definition applies; URIs are excluded by default and must be explicitly included for a definition to apply to them; | ||
* a '''<template>''' element containing an XSLT stylesheet which generates a microsummary from a page. The stylesheet can generate not only text but also HTML, graphics, and other rich content. | * a '''<template>''' element containing an XSLT stylesheet which generates a microsummary from a page. The stylesheet can generate not only text but also HTML, graphics, and other rich content. | ||