A9 OpenSearch Extensions

A9 supports extensions to the OpenSearch specification. The following extensions are available under the namespace http://a9.com/-/opensearch/extensions. OpenSearch Descriptions and feeds that use these extensions should include:

xmlns:a9="http://a9.com/-/opensearch/extensions/"

• a9:counted
  • Purpose: Indicates that an item or entry contains supplemental material to the search results and should not be counted in the total count of results returned.
  • Appears: In the OpenSearch Response. In an RSS feed, it appears as an attribute of the item tag. In an Atom feed, it appears as an attribute of the entry tag.
  • Usage: To indicate that an item or entry should not be counted, set a9:counted to false.
  • Default: If this extension is not used, or is any value other than false, the item or entry is counted normally.
  • Examples:
    RSS:

    <item a9:counted="false">...</item>
    Atom:

    <entry a9:counted="false">...</entry>
  • Status: Experimental.
  • Notes: Search aggregators that support the a9:counted extension should indicate this support by supporting the a9:supports-counted extension.
• a9:supports-counted
  • Purpose: Indicates that a search aggregator supports the a9:counted extension.
  • Appears: In the search parameters of the OpenSearch Query Syntax template.
  • Usage: Search aggregators that support the a9:counted extension should indicate so by replacing {a9:supports-counted?} in the url template with true. Clients that wish to tailor their output may include {a9:supports-counted?} in their url templates.
  • Example:
    <Url type="application/rss+xml"
template="http://example.com/?q={searchTerms}&amp;p={startPage}&amp;counted={a9:supports-counted?}"/>
  • Status: Experimental.
  • Notes: As with all extension Search parameters, the parameter should be followed by a question mark.