1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
---
title: Criando plugins OpenSearch para o Firefox
slug: Web/OpenSearch
tags:
- Search plugins
translation_of: Web/OpenSearch
original_slug: Criando_plugins_OpenSearch_para_o_Firefox
---
<h2 id="OpenSearch" name="OpenSearch">OpenSearch</h2>
<p><a href="pt/Firefox_2">Firefox 2</a> suporta o formato de descrição <a class="external" href="http://opensearch.org/">OpenSearch</a> para plugins de busca. Plugins que usam a <a class="external" href="http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_description_document">OpenSearch description syntax</a> são compativeis com IE 7 e Firefox. Por causa disso, ele é o formato recomendado para uso na web.</p>
<p>Firefox também suporta capacidades adicionais de busca não incluidos na <a class="external" href="http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_description_document">OpenSearch description syntax</a>, tais como as sugestões de busca e o elemento <code>SearchForm</code>. Este artigo terá fóco na criação de plugins de busca compativeis com a sintaxe OpenSearch e com suporte a essas caracteristicas específicas do Firefox.</p>
<p>O arquivo de descrição OpenSearch também pode ser reconhecido automaticamente pelo browser como descrito em <a href="#Autodiscovery_of_search_plugins">Autodiscovery of search plugins</a>, e pode ser instalado atravéz de programação como descrito em <a href="pt/Adding_search_engines_from_web_pages">Adding search engines from web pages</a>.</p>
<h2 id="Arquivo_de_descri.C3.A7.C3.A3o_OpenSearch" name="Arquivo_de_descri.C3.A7.C3.A3o_OpenSearch">Arquivo de descrição OpenSearch</h2>
<p>O arquivo XML descrevendo um motor de busca é, na verdade, muito simples, sequindo o template abaixo. As seções em negrito devem ser customizadas de acordo com as necessidades específicas para o plugin do motor de busca que você está escrevendo.</p>
<pre class="eval"><OpenSearchDescription xmlns="<span class="nowiki">http://a9.com/-/spec/opensearch/1.1/</span>"
xmlns:moz="<span class="nowiki">http://www.mozilla.org/2006/browser/search/</span>">
<ShortName><b>Nome do motor</b></ShortName>
<Description><b>Descrição do motor</b></Description>
<InputEncoding><b>Codificação de entrada</b></InputEncoding>
<Image width="16" height="16">data:image/x-icon;base64,<b>Dados da imagem</b></Image>
<Url type="text/html" method="<b>método</b>" template="<b>URL de busca</b>">
<Param name="<b>Nome do parametro 1</b>" value="<b>Valor do parametro 1</b>"/>
...
<Param name="<b>Nome do parametro N</b>" value="<b>Valor do parametro N</b>"/>
</Url>
<Url type="application/x-suggestions+json" template="<b>URL de Sugestões</b>"/>
<moz:SearchForm><b>URL do form de procura</b></moz:SearchForm>
</OpenSearchDescription>
</pre>
<dl>
<dt>
<b>Nome do motor</b></dt>
<dd>
Um nome curto para o motor de busca.</dd>
</dl>
<dl>
<dt>
<b>Descrição do motor</b></dt>
<dd>
Uma breve descrição do motor de busca.</dd>
</dl>
<dl>
<dt>
<b>Codificação de entrada</b></dt>
<dd>
A codificação que será usada na entrada de dados do motor de busca. Ex:UTF8</dd>
</dl>
<dl>
<dt>
<b>Dados da imagem</b></dt>
<dd>
Um icone de representação para o motor de busca de tamanho 16x16 e codificado em Base-64. Uma ferramente muito boa que você pode usar para construir os dados para colocar aqui pode ser encontrado aqui: <a class="external" href="http://software.hixie.ch/utilities/cgi/data/data">The data: URI kitchen</a>.</dd>
</dl>
<dl>
<dt>
<b>Url</b></dt>
<dd>
Descreve a URL ou URLs para usar na busca. O atributo <code>method</code> indica quando usar requisição <code>GET</code> ou <code>POST</code> para buscar os resultados. O atributo <code>template</code> indica a URL base para a pesquisa.</dd>
<dd>
<div class="note">
<b>Nota:</b> Internet Explorer 7 não suporta requisições via <code>POST</code>.</div>
</dd>
</dl>
<dl>
<dd>
Existem dois tipos de URL que o Firefox suporta:</dd>
</dl>
<ul>
<li><code>type="text/html"</code> é usado para especificar a URL da pesquisa atual em si.</li>
<li><code>type="application/x-suggestions+json"</code> é usado para especiicar a URL em pesquisas com sugestões.</li>
</ul>
<dl>
<dd>
Para qualquer um desses tipos de URL, você pode usar o <code>{searchTerms}</code> para substituir os termos de busca colocados pelo usuário na barra de busca. Outros parâmetros dinâmicos de busca suportados estão descritos em <a class="external" href="http://www.opensearch.org/Specifications/OpenSearch/1.1/Draft_3#OpenSearch_1.1_parameters">OpenSearch 1.1 parameters</a>.</dd>
</dl>
<dl>
<dd>
Para buscas com sugestões, o template de URL especificado é usado para trazer uma lista de sugestões no formato JavaScript Object Notation (JSON). Para detalhes de como implementear o suporte a sugestões de busca no servidor, olhe <a href="pt/Supporting_search_suggestions_in_search_plugins">Supporting search suggestions in search plugins</a>.</dd>
</dl>
<p><img alt="Image:SearchSuggestionSample.png"></p>
<dl>
<dt>
<b>Parametros</b></dt>
<dd>
São os parametros que precisam ser passados juntamente com os dados da consulta, em pares Chave/Valor. Quando especificar valores, você pode usar o <code>{searchTerms}</code> para inserir os termos de busca colocados pelo usuário na barra de busca.</dd>
<dd>
<div class="note">
<b>Nota:</b> Internet Explorer 7 não suporta este elemento.</div>
</dd>
</dl>
<dl>
<dt>
<b>Forme de Busca</b></dt>
<dd>
É a URL da pagina de busca do site para qual o plugin de busca foi desenvolvido. Esta pagina será aberta quanda não forem informados termos na barra de busca. Isso provê um caminho para que os usuarios do firefox visitem o site diretamente.</dd>
<dd>
<div class="note">
<b>Nota:</b> Sendo um elemento específico do Firefox, e não parte da especificação OpenSearch, nós usaremos o prefixo de nome XML "<code>moz:</code>" como no exemplo acima, para assegurar que outros navegadores que não suportam este elemento possam ignora-lo com segurança.</div>
</dd>
</dl>
<h2 id="Descobrimento_automatico_de_plugins_de_busca" name="Descobrimento_automatico_de_plugins_de_busca">Descobrimento automatico de plugins de busca</h2>
<p>Um site que oferece um plugin de busca pode anuncia-lo de forma que os usuarios do Firefox possam facilmente baixar e instalar o plugin.</p>
<p>Para prover o Descobrimento automatico, você deve simplesmete adicionar uma linha de codigo na seção <code><head></code> de sua pagina web:</p>
<pre class="eval"><link rel="search" type="application/opensearchdescription+xml" title="<i>Titulo do buscador</i>" href="<i>URL do plugin</i>">
</pre>
<p>Substitua os itens em italico como explicado abaixo:</p>
<dl>
<dt>
<b>Titulo do buscador</b></dt>
<dd>
O nome do buscador, como "Search MDC" ou "Yahoo! Search". Este valor deve corresponder ao nome do motor contido no arquivo do plugin.</dd>
</dl>
<dl>
<dt>
<b>URL do plugin</b></dt>
<dd>
A URL para o arquivo XML do plugin de busca, de onde o browser poderá baixa-lo.</dd>
</dl>
<p>Se o seu site oferece multiplos plugins de busca, você poderá dar suporte ao descobrimento automatico a todos eles. Por exemplo:</p>
<pre class="eval"><link rel="search" type="application/opensearchdescription+xml" title="Meu Site: Por Autor" href="<a class="external" href="http://www.meusite.com/meusiteautor.xml" rel="freelink">http://www.meusite.com/meusiteautor.xml</a>">
<link rel="search" type="application/opensearchdescription+xml" title="Meu Site: Por Titulo" href="<a class="external" href="http://www.meusite.com/meusitetitulo.xml" rel="freelink">http://www.meusite.com/meusitetitulo.xml</a>">
</pre>
<p>Desta maneira, seu site pode oferecer plugins de busca tanto para autores quanto para titulos como entidades separadas.</p>
<h2 id="Solucionando_Problemas" name="Solucionando_Problemas">Solucionando Problemas</h2>
<p>Se existe um erro em seu código XML do plugin de busca, você pode acessar os erros quando estiver adicionando um plugin descoberto no Firefox 2. A mensagem de erro pode não lhe ajudar completamente, mas, seguir as dicas abaixo deve ajudar você a encontrar o problema.</p>
<ul>
<li>Certifique-se que o XML do seu Plugin de Busca está bem formatado. Você pode checar isto carregando o arquivo diretamente no Firefox. & no template URL deve ser usado como &amp; e tags devem ser fechadas com uma barra ou tag final correspondente..</li>
</ul>
<pre class="eval"><shortName <strong>/</strong>>
<shortName>Google search<<strong>/</strong>shortName>
</pre>
<ul>
<li>O atributo <code>xmlns</code> é importante, sem ele você pode obter uma mensagem de erro indicando que "O Firefox não pôde baixar o plugin de busca de: (URL)".</li>
<li>Note que você <strong>deve</strong> incluir uma URL <code>text/html</code> — plugins de busca incluindo somente os tipos de URL Atom ou <a href="/pt/RSS" title="pt/RSS">RSS</a> (que são válidos, mas o Firefox não suporta) também gerarão o erro "não foi possível baixar o plugin de busca".</li>
<li>Favicons buscados remotamente não devem ser maiores do que 10KB (veja {{ Bug(361923) }}).</li>
</ul>
<p>Além disso, o serviço de plugin de busca proporciona um mecanismo de log que pode ser útil para desenvolvedores de plugins. Use <em>about:config</em> para configurar a preferência '<code>browser.search.log</code>' para <code>true</code> (verdadeira). Informações do log aparecerão no Console de Erros do Firefox (<a href="/pt/Error_Console" title="pt/Error_Console">Error Console</a>)(Ferramentas -> Console de Erros) quando os plugins de busca forem adicionados.</p>
<h2 id="Material_de_Referencia" name="Material_de_Referencia">Material de Referência</h2>
<ul>
<li><a class="external" href="http://rodrigok.890m.com/firefox/">Plugins de busca adicionais</a>, instalação e codigo fonte.</li>
<li><a class="external" href="http://opensearch.org/">OpenSearch Documentation</a>, <a class="external" href="http://www.opensearch.org/Specifications/OpenSearch/Extensions/Parameter/1.0">OpenSearch Documentation about the Url and Param element</a></li>
<li>Technorati.com has a <a class="external" href="http://technorati.com/osd.xml">working osd.xml</a></li>
<li>More on Autodiscovery difficulties at bugzilla {{ Bug(340208) }}</li>
<li><a class="external" href="http://en.wikipedia.org/wiki/Data:_URI_scheme"><code>data:</code> URI scheme</a></li>
<li><a class="external" href="http://www.searchplugins.net">searchplugins.net</a> - create OpenSearch plugins for use with Firefox 2. <a class="external" href="http://www.searchplugins.net/pluginlist.aspx">List of generated search plugins</a></li>
<li><a class="external" href="http://keijisaito.info/ready2search/e/">Ready2Search</a> - create OpenSearch plugins. <a class="external" href="http://keijisaito.info/arc/search/en_make_plugin.htm">Customized Search through Ready2Search</a></li>
</ul>
<p><span class="comment">Interwiki link</span></p>
<p>{{ languages( { "ca": "ca/Creaci\u00f3_de_connectors_OpenSearch_per_al_Firefox", "en": "en/Creating_OpenSearch_plugins_for_Firefox", "es": "es/Creaci\u00f3n_de_plugins_OpenSearch_para_Firefox", "fr": "fr/Cr\u00e9ation_de_plugins_OpenSearch_pour_Firefox", "ja": "ja/Creating_OpenSearch_plugins_for_Firefox", "pl": "pl/Tworzenie_wtyczek_OpenSearch_dla_Firefoksa" } ) }}</p>
|
