thoughts

1 files changed, 20 insertions, 0 deletions

diff --git a/doc/todo/OpenSearch.mdwn b/doc/todo/OpenSearch.mdwn
index e63ded688..c35da54e1 100644
--- a/doc/todo/OpenSearch.mdwn
+++ b/doc/todo/OpenSearch.mdwn
@@ -15,4 +15,24 @@ contain the wiki title from `ikiwiki.setup`.
 
 --[[JoshTriplett]]
 
+> I support adding this. I think all that is needed, beyond the simple task
+> of adding the link header, is to make the search plugin write out
+> the xml file, probably based on a template.
+> 
+> One problem is that the 
+> [specification](http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_description_document)
+> for the XML file contains a number of silly limits to field lenghs. 
+> For example, it wants a "ShortName" that identifies the search engine,
+> to be 16 characters or less. The Description is limited to 1024,
+> the LongName to 48. This limits what existing config settings can be
+> reused for those. 
+> 
+> Another semi-problem is that the specification saz: 
+> 
+>> OpenSearch description documents should include at least one Query element of role="example" that is expected to return search results. Search clients may use this example query to validate that the search engine is working properly.
+> 
+> How should ikiwiki know what example query will return actual results?
+> (How would a client know if a HTML page contains results or not, anyway?)
+> Sillyness. Ignore this? --[[Joey]]
+
 [[wishlist]]