web commit by JoshTriplett: Outline implementation plan.

[ikiwiki.git] / doc / todo / OpenSearch.mdwn

diff --git a/doc/todo/OpenSearch.mdwn b/doc/todo/OpenSearch.mdwn
index bc4da0b8061577a84ced47e69a946eebc46e5d56..513fa3394931c44dd6772ea0de3da2f0f7e41256 100644 (file)
--- a/doc/todo/OpenSearch.mdwn
+++ b/doc/todo/OpenSearch.mdwn
@@ -2,4 +2,15 @@
 metadata.  Various software supports OpenSearch (see the Wikipedia article on
 [[wikipedia OpenSearch]]); in particular, browsers like Firefox and Iceweasel
 will automatically discover an OpenSearch search and offer it in the search
-box. --[[JoshTriplett]]
+box.
+
+More specifically, we want to follow the [OpenSearch Description Document
+standard](http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_description_document),
+by having a `link` with `rel="search"` and
+`type="application/opensearchdescription+xml"` in the headers of HTML, RSS,
+and Atom pages.  The `href` of that `link` should point to an
+OpenSearchDescription XML file with contents generated based on the
+information in `ikiwiki.setup`, and the `title` attribute of the `link` should
+contain the wiki title from `ikiwiki.setup`.
+
+--[[JoshTriplett]]