mozilla

Compare Revisions

Supporting search suggestions in search plugins

Change Revisions

Revision 182692:

Revision 182692 by Sheppy on

Revision 182693:

Revision 182693 by Sheppy on

Title:
Supporting search suggestions in search plugins
Supporting search suggestions in search plugins
Slug:
Supporting_search_suggestions_in_search_plugins
Supporting_search_suggestions_in_search_plugins
Tags:
Add-ons, OpenSearch, Search, "Search plugins"
Add-ons, OpenSearch, Search, "Search plugins"
Content:

Revision 182692
Revision 182693
n16    <h2 name="The_SuggestionUrl">n16    <h2 name="Implementing_suggestion_support_in_the_search_plugi
 >n">
17      The SuggestionUrl17      Implementing suggestion support in the search plugin
t20      The search plugin specifies the URL to query for a list of t20      The search plugin specifies the <code>&lt;SuggestionUrl&gt;
>search suggestions. The search term is appended to this URL, then></code> to query for a list of search suggestions. The search ter
> queried using an HTTP <code>GET</code> request.>m is appended to this URL, then queried using an HTTP <code>GET</
 >code> request.
21    </p>
22    <p>
23      For example, the Yahoo search plugin has this <code>&lt;Sug
 >gestionUrl&gt;</code>:
24    </p>
25    <pre>
26&lt;SuggestionUrl&gt;http://ff.search.yahoo.com/gossip?output=fxj
 >son&amp;command=&lt;/SuggestionUrl&gt;
27</pre>
28    <p>
29      If the user types "fir" into the search bar, then pauses, F
 >irefox appends "fir" to the <code>&lt;SuggestionUrl&gt;</code>, t
 >hen queries that URL:
30    </p>
31    <pre>
32&lt;SuggestionUrl&gt;http://ff.search.yahoo.com/gossip?output=fxj
 >son&amp;command=fir&lt;/SuggestionUrl&gt;
33</pre>
34    <p>
35      The results are used to construct the suggestion list box.
36    </p>
37    <p>
38      See <a href="en/Creating_MozSearch_plugins">Creating MozSea
 >rch plugins</a> to learn more about how to implement a search plu
 >gin.
39    </p>
40    <h2 name="Implementing_search_suggestion_support_on_the_serve
 >r">
41      Implementing search suggestion support on the server
42    </h2>
43    <p>
44      The majority of the work in handling search suggestions is 
 >actually implemented on the server side. If you're a web site des
 >igner, and want to support search suggestions, you need to implem
 >ent support for returning the suggestions in JavaScript Object No
 >tation (JSON) given a search term.
45    </p>
46    <p>
47      When the browser wants to fetch possible matches for a sear
 >ch term, it appends the search term to the <code>&lt;SuggestionUr
 >l&gt;</code> then sends an HTTP <code>GET</code> request to that 
 >URL.
48    </p>
49    <p>
50      Your server should then decide upon the suggestions to offe
 >r using whatever means it sees fit, and construct a JSON result, 
 >which is formatted like this:
51    </p>
52    <pre class="eval">
53["<i>search term</i>", [<i>match list</i>]]
54</pre>
55    <p>
56      <i>search term</i> is the search term that was queried, and
 > the <i>match list</i> is a comma-deliniated, quoted list of sugg
 >ested terms. For example, if the search term is "fir", you might 
 >return the following JSON:
57    </p>
58    <pre class="eval">
59["fir",["firefox","first choice","mozilla firefox"]]
60</pre>
61    <p>
62      You can return however many suggestions you like, although 
 >keeping it to a manageable number is recommended.

Back to History