Webboard - Wtyczka OpenSearch dla twojego forum (FireFox)

Cześć ! W dzisiejszym poradniku, pokażę Wam jak stworzyć prostą wtyczkę do firefoxa, przeszukującą Twoje forum.

1. Tworzenie wtyczki
Zacznijmy od utworzenia nowego pliku tekstowego (.txt)
Otwieramy notatnik, i zapisujemy plik jako

Kod:
nazwatwojegoforum.xml

Następnie otwórz przed chwilą utworzony plik .xml i Wklej poniższy kod do niego :

Kod:
<SearchPlugin xmlns="http://www.mozilla.org/2006/browser/search/">

<ShortName>Nazwa twojego forum</ShortName>

<Description>Wyszukiwarka</Description>

<InputEncoding>UTF-8</InputEncoding>

<Image width="16" height="16">data:image/gif;base64,R0lGODlhEAAQAMZeAJNbEZdfGJpiG51lH51nIqVtK6hwMLF5PLV9QYqToryNVZKUnXaczXufzXug0MWXZMeZZn%2Bl04Wp1pGox4aq18yidYqu2c6kdoyw25O239Wuhpa44Zy635273921iZ%2FA56LD6KjI7K7J6OTBnavL7q7O8K%2FP8bXP7LfQ7bTT9OjLq73V8LjW9rvW87nX97vX873X873Y87vZ%2Bb7Z88Da9MHa9L3b%2Br7b%2BsLb9L%2Fc%2BsPc9MTc9MXd9cbd9cjd88fe9cje9cne88jf9cnf9crg9cvh9szh9s3h9czi%2BM7i9s3i%2BdDi9dDj9tLk99Hl99Pl99Pm%2BNbn99bn%2BNfn99no%2BNrp%2BN3q%2Bd7r%2Bd7s%2Bt%2Fs%2BeHt%2BeLt%2BeLu%2BePu%2Bv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FyH%2BEUNyZWF0ZWQgd2l0aCBHSU1QACH5BAEKAH8ALAAAAAAQABAAAAeGgH%2BCg4SFhDkyLCkmJIaDN0pYXFtVKx%2BONkhdUUlFTFYnGYYuV1FGREA8RUsYhilaRkM%2FOzg0UhSGJVlCPTo1MzBQEYYhU0a1MS84QQ2GIChUQDEtOE0dC44bIkdPTj4cExoIjhYSEQ4MCRUqFwaOhQcPIxAD74QFCh4B9oQCBAD8Agr8EwgAOw%3D%3D</Image>

<Url type="text/html" method="POST" template="http://adrestwojegoforum.pl/search.php">

<Param name="action" value="do_search" />

<Param name="postthread" value="1" />

<Param name="forums" value="all" />

<Param name="showresult" value="threads" />

<Param name="keywords" value="{searchTerms}" />

</Url>

<SearchForm>http://adrestwojegoforum.pl/search.php</SearchForm>

</SearchPlugin>

Ok, zacznijmy od pierwszych lini kodu :

Kod:
<ShortName>Nazwa twojego forum</ShortName>

<Description>Wyszukiwarka</Description>

<InputEncoding>UTF-8</InputEncoding>

ShortName
to krótka nazwa wyszukiwarki.

Description
To zwięzły opis wyszukiwarki.

InputEncoding
to kodowanie znaków stosowane przy wprowadzaniu danych do wyszukiwarki.

Następnie zajmijmy się

Kod:
<Image width="16" height="16">data:image/gif;base64,R0lGODlhEAAQAMZeAJNbEZdfGJpiG51lH51nIqVtK6hwMLF5PLV9QYqToryNVZKUnXaczXufzXug0MWXZMeZZn%2Bl04Wp1pGox4aq18yidYqu2c6kdoyw25O239Wuhpa44Zy635273921iZ%2FA56LD6KjI7K7J6OTBnavL7q7O8K%2FP8bXP7LfQ7bTT9OjLq73V8LjW9rvW87nX97vX873X873Y87vZ%2Bb7Z88Da9MHa9L3b%2Br7b%2BsLb9L%2Fc%2BsPc9MTc9MXd9cbd9cjd88fe9cje9cne88jf9cnf9crg9cvh9szh9s3h9czi%2BM7i9s3i%2BdDi9dDj9tLk99Hl99Pl99Pm%2BNbn99bn%2BNfn99no%2BNrp%2BN3q%2Bd7r%2Bd7s%2Bt%2Fs%2BeHt%2BeLt%2BeLu%2BePu%2Bv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FyH%2BEUNyZWF0ZWQgd2l0aCBHSU1QACH5BAEKAH8ALAAAAAAQABAAAAeGgH%2BCg4SFhDkyLCkmJIaDN0pYXFtVKx%2BONkhdUUlFTFYnGYYuV1FGREA8RUsYhilaRkM%2FOzg0UhSGJVlCPTo1MzBQEYYhU0a1MS84QQ2GIChUQDEtOE0dC44bIkdPTj4cExoIjhYSEQ4MCRUqFwaOhQcPIxAD74QFCh4B9oQCBAD8Agr8EwgAOw%3D%3D</Image>

Jest to kod obrazka wyszukiwarki (ten po lewej obok pola wyszukiwania w FireFoxie)
W tym przykładzie będzie wyświetlany taki obrazek :

Jeśli chcemy stworzyć swój to skorzystajmy z generatora :
The data: URI kitchen

Wygenerowany kod w pasku adresu kopiujemy i wklejamy w miejsce starego.

Kod:
<Url type="text/html" method="POST" template="http://adrestwojegoforum.pl/search.php">

<Param name="action" value="do_search" />

<Param name="postthread" value="1" />

<Param name="forums" value="all" />

<Param name="showresult" value="threads" />

<Param name="keywords" value="{searchTerms}" />

</Url>

<SearchForm>http://adrestwojegoforum.pl/search.php</SearchForm>

</SearchPlugin>

Tutaj zmieniamy

Kod:
http://adrestwojegoforum.pl/search.php

na adres swojego forum i tyle.
Pozostała część kodu czyli

Kod:
<Param name="action" value="do_search" />

<Param name="postthread" value="1" />

<Param name="forums" value="all" />

<Param name="showresult" value="threads" />

<Param name="keywords" value="{searchTerms}" />

jest odpowiedzialna za ustawienia wyszukiwania, a te które są w tym przykładzie, wzięte zostały z kodu wyszukiwarki portalu, w skrypcie MyBB.

Teraz zapisujemy zmiany i idziemy do następnego kroku.

2.Umieszczenie wyszukiwarki na stronie

Na początku wrzucamy nasz plik z

Kod:
nazwatwojegoforum.xml

na nasz serwer gdzie stoi forum.

Następnie wchodzimy na nasze forum i :
ACP-Style i szablony-Szablony-Obecnie używany przez Ciebie szablon-Strona główna-index:
Teraz w sekcji head wklejamy kod:

Kod:
<link rel="search" type="application/opensearchdescription+xml" title="tytułWyszukiwarki" href="adresURLWtyczki">

I zmieniamy wszystko według przykładu.
Zapisujemy zmiany.

To by było na tyle, w razie problemów zapraszam na
developer.mozilla.org

Pozdrawiam,
Budziol