mozilla

Compare Revisions

Supporting search suggestions in search plugins

Change Revisions

Revision 182693:

Revision 182693 by Sheppy on

Revision 182694:

Revision 182694 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 182693
Revision 182694
n50      Your server should then decide upon the suggestions to offen50      Your server should then decide upon the suggestions to offe
>r using whatever means it sees fit, and construct a JSON result, >r using whatever means it sees fit, and construct a JSON that con
>which is formatted like this:>sists of at least two, and as many as four, elements:
51    </p>
52    <dl>
53      <dt>
54        <b>query string</b>
55      </dt>
56      <dd>
57        The first element in the JSON is the original query strin
 >g. This allows Firefox to verify that the suggestions match the c
 >urrent search term.
58      </dd>
59    </dl>
60    <dl>
61      <dt>
62        <b>completion list</b>
63      </dt>
64      <dd>
65        An array of suggested search terms. The array should be e
 >nclosed in square brackets. For example: <tt>{{mediawiki.external
 >('\"term 1\", \"term 2\", \"term 3\", \"term 4\"')}}</tt>
66      </dd>
67    </dl>
68    <dl>
69      <dt>
70        <b>descriptions</b>
71      </dt>
72      <dd>
73        This optional element is an array of descriptions for eac
 >h of the suggestions in the <i>completion list</i>. These can be 
 >any additional information the search engine might want to return
 > to be displayed by the browser.
74      </dd>
75    </dl>
76    <div class="note">
77      Descriptions are not supported in Firefox 2, and are ignore
 >d if any are specified.
78    </div>
79    <dl>
80      <dt>
81        <b>query URLs</b>
82      </dt>
83      <dd>
84        This optional element is an array of alternate URLs for e
 >ach of the suggestiosn in the <i>completion list</i>. For example
 >, if you want to offer a map link instead of just a search result
 > page for a given suggestion, you can return an URL to a map in t
 >his array.
85      </dd>
86    </dl>
87    <div class="note">
88      Query URLs are not supported in Firefox 2, and are ignored.
89    </div>
90    <p>
91      For example, if the search term is "fir", and you don't nee
 >d to return descriptions or alternate query URLs, you might retur
 >n the following JSON:
n53["<i>search term</i>", [<i>match list</i>]]n94["fir", ["firefox", "first choice", "mozilla firefox"]]
n56      <i>search term</i> is the search term that was queried, andn97      Note that in this example, only the query string and comple
> the <i>match list</i> is a comma-deliniated, quoted list of sugg>tion array are specified, leaving out the optional elements.
>ested terms. For example, if the search term is "fir", you might  
>return the following JSON: 
n58    <pre class="eval">n
59["fir",["firefox","first choice","mozilla firefox"]]
60</pre>
t62      You can return however many suggestions you like, although t100      Your completion list can include as many suggestions as you
>keeping it to a manageable number is recommended.> like, although it should be kept manageable, given that the disp
 >lay will be updating live while the user is typing their search s
 >tring.

Back to History