Page tree
Skip to end of metadata
Go to start of metadata

his is a going to become the draft of the SeeAlso Full Specification that completes the SeeAlso Simple Specification. To begin with, have a look at getting started with SeeAlso. Feedback is welcome!

Version: 0.2Date: 2008-10-15

Introduction

This specification extends the SeeAlso Simple Specification [SA] with a way to self-describe SeeAlso services via OpenSearch Description documents.

Summary

A SeeAlso Full service is an unAPI server [unAPI] that provides at least the following two formats:

  • seealso - a SeeAlso Simple response
  • opensearchdescription - an OpenSearch description document

In addition to SeeAlso Simple the seealso response must always be mime type text/javascript and a callback parameter must be supported.

OpenSearch Description document

To provide information about a webservice that implements SeeAlso Simple, an OpenSearch Description document as defined in the OpenSearch standard [OS] can be used.

URL elements

Url elements with type="text/javascript" must be used by the client to retrieve a SeeAlso Simple response. The Url template must use a HTTP query parameter named id for the search term parameter (id={searchTerms}) and a query parameter named callback for the callback parameter (callback={callback}).

Example

 <?xml version="1.0" encoding="UTF-8"?>
 <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
   <!-- ... -->
   <Url type="text/javascript"
        template="http://example.com/seealso?id={searchTerms}&callback={callback}"/>
   <!-- ... -->
 </OpenSearchDescription>

 

References

Normative

Non-normative

  • ...

Authors

This document was created by Jakob Voss <jakob.voss@gbv.de> based on the OpenSearch Suggestions 1.0 Specification. The OpenSearch Suggestions 1.0 documentation was written up by DeWitt Clinton <dewitt@opensearch.org>, based directly on the work of Joe Hughes' Firefox search suggestions draft documentation and the Google search suggestions format.

License

This document is made available subject to the terms of the Creative Commons Attribution-ShareAlike 2.5 License.

  • No labels