O documento discute plugins de busca para o navegador Firefox, descrevendo seus formatos principais (Sherlock, MozSearch, OpenSearch), exemplos de plugins desenvolvidos e instruções sobre instalação e uso.
1. Search Plugins para o Firefox
Rogério Aparecido Gonçalves
rag@ime.usp.br
By Rogério Aparecido Gonçalves. It is licensed under a 1
Creative Commons Atribuição 2.5 Brasil License
2. Roteiro
● O que são?
● Formatos de descrição
● Exemplos
● Instalação e uso.
2
3. O que são Search Plugins?
● São plugins de busca disponíveis na barra
de busca do navegador.
Adicionam ao navegador a
capacidade de acessar o
motor de busca de um site,
sem ter que acessá-lo
primeiro.
3
4. Formatos
● Existem 3 formatos para descrição:
• Sherlock
• MozSearch
• OpenSearch
4
5. Sherlock
● Formato de plugin
utilizado no Sherlock.
● Buscas em arquivos
e na web.
● Introduzido no Mac
OS 8.5, como
extensão do Finder.
● Removido no Mac Desenvolvido pela Apple.
OS X v10.5.
5
6. Sherlock
● O projeto mycroft, 2000 → (mozdev.org).
● Modificações no formato → tag <browser>
<search ccsl.src
version="1.0"
name="CCSL Search"
description="CCSL - Centro de Competência em Software Livre"
action="http://ccsl.ime.usp.br/{language}/search/node/{searchTerms}"
searchForm="http://ccsl.ime.usp.br/{moz:language}/search"
method="POST">
<input name="edit-keys" user/>
<input name="language" value="{moz:language}"/>
</search>
<browser
update="http://ccsl.ime.usp.br/ccsl.src"
updateIcon="http://ccsl.ime.usp.br/sites/ccsl.ime.usp.br/themes/ccsl/img/favicon.ico"
updateCheckDays="7">
6
7. MozSearch
● Não é destinado ao uso na web.
● Para uso interno em projetos da Mozilla.
● Trouxe características específicas
● sugestões de pesquisa, entre outros.
● Plugins distribuídos com o Firefox: Google
...
<Url type="application/x-suggestions+json" method="GET" template="http://suggestqueries.google.com/complete/search?
output=firefox&client=firefox&hl={moz:locale}&q={searchTerms}"/>
<Url type="text/html" method="GET" template="http://www.google.com/search">
<Param name="client" value="ubuntu"/>
<Param name="channel" value="fs"/>
<Param name="q" value="{searchTerms}"/>
<Param name="ie" value="utf-8"/>
<Param name="oe" value="utf-8"/>
</Url>
... client=firefox
7
8. MozSearch
● Outros plugins embutidos no Firefox:
● Bing
– <Param name="form" value="MOZSBR"/>
● Wikipedia e Amazon
– <Param name="sourceid" value="Mozilla-search"/>
● Twitter
– <Param name="partner" value="Firefox"/>
8
9. MozSearch
● Formato em XML
ccsl.xml
<SearchPlugin xmlns="http://www.mozilla.org/2006/browser/search/">
<ShortName>CCSL Search</ShortName>
<Description>CCSL - Centro de Competência em Software Livre</Description>
<InputEncoding>UTF-8</InputEncoding>
<OutputEncoding>UTF-8</OutputEncoding>
<Image width="16" height="16">data:image/x-icon;base64,iVB...Jggg==</Image>
<Url type="text/html" method="POST"
template="http://ccsl.ime.usp.br/search/node/{searchTerms}">
<Param name="edit-keys" value="{searchTerms}"/>
</Url>
<Language>*</Language>
<SearchForm>http://ccsl.ime.usp.br/search</SearchForm>
</SearchPlugin>
9
10. OpenSearch
● Extensão da MozSearch.
● Desenvolvida pela A9.com subsidiária da
Amazon.com
● OpenSearch 1.0 (Março de 2005).
● OpenSearch 1.1 (draft) lançada em
Setembro/Dezembro de 2005.
● A especificação é licenciada pela A9 sob a
Creative Commons Attribution-ShareAlike
2.5 License.
10
11. OpenSearch
● Padrão suportado a partir do Firefox 2.
● Muda o elemento root e o namespace.
ccsl.xml
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
<ShortName>CCSL Search</ShortName>
<Description>CCSL - Centro de Competência em Software Livre</Description>
<InputEncoding>UTF-8</InputEncoding>
<OutputEncoding>UTF-8</OutputEncoding>
<Image width="16" height="16">data:image/x-icon;base64,iVB...Jggg==</Image>
<Url type="text/html" method="POST"
template="http://ccsl.ime.usp.br/search/node/{searchTerms}">
<Param name="edit-keys" value="{searchTerms}"/>
</Url>
<Language>*</Language>
<SearchForm>http://ccsl.ime.usp.br/search</SearchForm>
</OpenSearchDescription>
11
12. Como instalar?
● Podem ser adicionados diretamente da
página addons.mozilla.org
CCSL Search: https://addons.mozilla.org/pt-BR/firefox/addon/ccsl-search/
12
13. Como instalar?
● Link de referência em seu site
Detecção automática
pelo Firefox!
13
14. Como instalar?
● Link de referência em seu site
<head>
<!-- Descritores das buscas auto detectáveis -->
<link rel="search" type="application/opensearchdescription+xml"
title="CCSL Search"
href="https://addons.mozilla.org/firefox/downloads/file/141831/">
</head>
14
15. Como instalar?
● Via função javascript.
Botão ou link chamam
função de instalação.
15
16. Como instalar?
● Link em seu site ou via função javascript.
function installSearchEngine (openSearchUrl) {
if (window.external && ("AddSearchProvider" in window.external)) {
window.external.AddSearchProvider(openSearchUrl)
} else {
alert("No search engine support");
}
}
function askDialog(){
if (confirm('Deseja instalar o plugin CCSL na barra de pesquisa do navegador?'))
installSearchEngine ("https://addons.mozilla.org/firefox/downloads/file/141831/");
}
16