很多現代瀏覽器在網址列右側都有一個搜尋框,預設可能裝了 Google 搜尋等。這其實就是 OpenSearch 的一項應用——只要撰寫一份對應的微格式 XML 檔,就能自訂這個搜尋框。
參考 OpenSearch 的定義文件,一份典型的搜尋 XML 大致如下:
<?XML version="1.0" encoding="UTF-8"?>
<OpenSearchDescription XMLns="https://a9.com/-/spec/opensearch/1.1/">
<InputEncoding>utf-8</InputEncoding>
<ShortName>ShortName</ShortName>
<Description>Description</Description>
<Image type="image/vnd.microsoft.icon">favicon</Image>
<Url type="text/html" template="https://who.am.i/search?Word={searchTerms}"/>
</OpenSearchDescription>
各欄位從字面上就不難理解:InputEncoding 指定搜尋編碼;ShortName 是搜尋的短名稱;Description 是描述文字;Image 類似網頁的 favicon,用於標識搜尋;Url 是最重要的參數,指定搜尋位址,一般以 {searchTerms} 代表搜尋詞,type=text/html 表示返回的是網頁。
加入方式大致分兩種。第一種是在頁面的 head 中插入 link 標記(類似 RSS 的做法):
link rel="search" type="application/opensearchdescription+xml"
href="https://who.am.i/search.xml" title="ShortName"/
其中 rel 與 type 是固定的,我們主要指定 href(XML 的路徑,建議用絕對路徑)與 title。如此一來,在 IE 與 Firefox 中打開這個頁面,就能看到相應的選單。
第二種是透過 JavaScript 觸發。IE 使用 window.external.AddSearchProvider,Firefox 則用 window.sidebar.addSearchEngine。為了相容性,可以這樣撰寫:
function addEngine(){
if (window.external && window.external.AddSearchProvider) {
window.external.AddSearchProvider('https://who.am.i/search.xml');
} else if (window.sidebar && window.sidebar.addSearchEngine) {
window.sidebar.addSearchEngine(
'https://who.am.i/search.xml', 'favicon.ico', 'ShortName', 'Description');
}
}
把這個函式綁到某個按鈕或連結的事件上,使用者點擊後會跳出確認框,確認後搜尋引擎就加入瀏覽器搜尋框了。值得注意的是,Firefox 2 之後已相容 IE 的 AddSearchProvider 呼叫方式。