web commit by JoshTriplett: Outline implementation plan.
[ikiwiki.git] / doc / todo / OpenSearch.mdwn
1 [[plugins/search]] could provide [OpenSearch](http://www.opensearch.org/)
2 metadata.  Various software supports OpenSearch (see the Wikipedia article on
3 [[wikipedia OpenSearch]]); in particular, browsers like Firefox and Iceweasel
4 will automatically discover an OpenSearch search and offer it in the search
5 box.
6
7 More specifically, we want to follow the [OpenSearch Description Document
8 standard](http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_description_document),
9 by having a `link` with `rel="search"` and
10 `type="application/opensearchdescription+xml"` in the headers of HTML, RSS,
11 and Atom pages.  The `href` of that `link` should point to an
12 OpenSearchDescription XML file with contents generated based on the
13 information in `ikiwiki.setup`, and the `title` attribute of the `link` should
14 contain the wiki title from `ikiwiki.setup`.
15
16 --[[JoshTriplett]]