OpenSearch plugin for inapp

How to add an OpenSearch to your website

OpenSearch is a standard way to make a webbrowser know that your page is actually a search engine. Mozilla [1] and Microsoft [2] explain you how to do it, but a quicker tutorial is found there [3].

My own OpenSearch configuration file for inapp looks like this:

<?xml version="1.0" encoding="UTF-8"?>

<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
    <ShortName>inasearch</ShortName>
    <Description>inapp search</Description>
    <Tags>ina</Tags>
    <Url type="text/html" template="http://192.168.10.10/search.html?{searchTerms}" />
</OpenSearchDescription>

The browser will find your XML settings by following the link in the <head> section of the page:

<link rel="search" href="search.xml" type="application/opensearchdescription+xml" title="inasearch" />

Using inasearch in context-search with Firefox

On the inasearch page, the little magnifying glass of the search bar in the top right corner of the browser changes and gets a "plus". This means that a new search engine can be added to Firefox.

Click on the search bar and see Add "inasearch" at the bottom of the drop down menu.

Now you can search doxygen symbols in the search bar of Firefox... but this is not very usefull. Add a plugin like context-search [4] to Firefox and you can search with inasearch directly on a webpage.

For example CommonAPI::Address is in the CommonAPI doxygen documentation. Let's search for it...

This result is not the most interesting since google would have probably found the same, but it gets more interesting with your own private project which you may not want google to know about.