Kurze Einführung in Firefox Search Plugin Programmierung

PTC · 19.01.2008, 16:53

Ich habe eine kurze Einführung zum Thema Firefox Search Plugin Programmierung geschrieben.
Für weitgehendere Informationen verweise ich auf diese Seite:http://http://mycroft.mozdev.org/deepdocs/deepdocs.html

1. Was ist das Firefox(FF) Search Plugin

Dies ist ein Plugin, welches dem FF Nutzer ermöglicht eine direkte Suche auf der gewünschten
Seite aufzurufen.
Es ist zu finden standarmäßig oben rechts im FF.
Die Syntax entspricht der HTML-Sprache

2. Wie 'programmiere' ich es

2.1 Kommentare

Zeichen: #
Dies ist ein einzeiliger Kommentar.

2.2 SEARCH - Element

Zeichen: <search>(anfang) </search>(ende)
Dies ist das wichtigste Element hier werden alle Definitionen eingegeben.
Vergleichbar mit den Elementen <html> und </html>
In diesem Element gibt es noch 'Zusätze', die weiteren Informationen beinhalten.
Zusätze: name - ein beliebiger Name des Plugins
description - kurze Beschreibung des Plugins
method - welche Sendemethode(POST oder GET)
action - URL an die die Daten gesendet werden sollen
update - wo das aktuelle Plugin liegt zum updaten(*.src)(-s. u. bei 2.4-)
updateIcon - s. o. nur für das Icon(*.png)(-s. u. bei 2.4-)
updateCheckDays - alle wieviel Tage nach Updates gesucht werden soll(-s. u. bei 2.4-)
queryEncoding - Um-Kodierung der Nutzereingaben(UTF-8 oder ISO-blabla)

2.3 INPUT - Element(Unterelement von SEARCH)
Zeichen: <input>
In diesem werden die Eingaben des Nutzers oder ihre vordefinierten Eingaben an das Suchskript
gesendet.
Zusätze: name - (muss angegeben werden) ist der Identifikator für das Skript, welches die
Suchanfrage bearbeitet
user - (ohne '=' Zeichen schreiben) damit werden die Nutzereingaben gesendet
value - Angaben die man uabhängig von Nutzereingaben denden möchte

2.4 BROWSE - Element
Zeichen: <browse>
Dies ist die zweite Möglichkeit Updateinformationen für den Browser zu speichern.
Zusätze: update - wo das aktuelle Plugin liegt zum updaten(*.src)
updateIcon - s. o. nur für das Icon(*.png)
updateCheckDays - alle wieviel Tage nach Updates gesucht werden soll

3. Installation
Die Installation funktioniert über JavaScript, welche ich nicht ganz verstehe, denn ich kann
kein JS!

4.1 Beispiel - Plugin

Code:

# Mozilla Firefox Searchplugin

<search 
   name="MyWebsite"
   description="MyWebsite Search"
   method="GET"
   action="http://www.MyWebsite.com/search.php"
   update="http://www.MyWebsite.com/FF-SEARCH-Plugin/MyWebsite.src"
   updateIcon="http://www.MyWebsite.com/FF-SEARCH-Plugin/MyWebsite.png"
   updateCheckDays="30"
   queryEncoding="utf-8"
   queryCharset="utf-8"
>

<input name="search_for" user>
<input name="FF_PLUGIN-USER" value="true">

</search>



<browser
   update="http://www.MyWebsite.com/FF-SEARCH-Plugin/MyWebsite.src"
   updateIcon="http://www.MyWebsite.com/FF-SEARCH-Plugin/MyWebsite.png"
   updateCheckDays="30"
>

4.2 Beispiel - Installation JS

Original Installation von Mozilla

Code:

 <script type="text/javascript">
<!--
function errorMsg()
{
  alert("Netscape 6 or Mozilla is needed to install a sherlock plugin");
}
function addEngine(name,ext,cat,type)
{
  if ((typeof window.sidebar == "object") && (typeof
  window.sidebar.addSearchEngine == "function"))
  {
    //cat="Web";
    //cat=prompt('In what category should this engine be installed?','Web')
    window.sidebar.addSearchEngine(
      "http://localhost.localdomain/plugins directory/"+name+".src",
      "http://localhost.localdomain/plugins directory/"+name+"."+ext,
      name,
      cat );
  }
  else
  {
    errorMsg();
  }
}
//-->
</script>

Code:

 <a href="javascript:addEngine('File name','image extension','Category name',0)">Name of Plugin</a>

PTC · 06.07.2008, 15:59

*Kommentar:

1. Die im Beitrag genannte URL ist falsch, dies ist der korrekte Link:

Mycroft Project: Search Engine Plugins - Firefox & IE7

2. Das Element in 2.4 heißt BROWSER (nicht BROWSE).

PTC · 07.09.2008, 15:31

Der angegebene Link zur Dokumentation ruft eine Seite auf mit der Fehlermeldung "Page not found".

Werde mich baldmöglichst um eine neue Dokumentation bemühen.

PTC · 09.02.2009, 00:41

Ich habe eine neue Referenz gefunden, sie ist in englischer Sprache: https://developer.mozilla.org/En/Cre...ns_for_Firefox

Manko10 · 09.02.2009, 16:18

Vor längerer Zeit habe ich hier auch mal eine Einführung geschrieben: OpenWebBoard / Tutorials / Sonstiges / Suchmaschinendienst fr Firefox und IE erstellen

PTC · 10.02.2009, 01:31

Wer sich genauer in die Materie einarbeiten will, dem sei dieser Link ans Herz gelegt. Die Seite ist auch in englischer Sprache.

Themen-Optionen
Druckbare Version zeigen Jemanden per E-Mail auf dieses Thema hinweisen
Thema bewerten
Thema bewerten:

LinkBacks (?) LinkBack to this Thread: http://www.php.de/tutorials/431-kurze-einfuehrung-firefox-search-plugin-programmierung.html
Erstellt von	For	Type	Datum
Untitled document	This thread	Refback	23.09.2011 15:19
Narzissmusverdacht Quicklinks	This thread	Refback	03.11.2009 13:52
Thema anzeigen - Hilfe !! Plugin Installationsscript selbst erstellen	This thread	Refback	24.09.2008 16:22
Übersetzungsbüro Elisabeth John ::: Suchleiste erweitern	This thread	Refback	17.06.2008 12:46
Thema anzeigen - Hilfe !! Plugin Installationsscript selbst erstellen	This thread	Refback	27.05.2008 18:19

Ähnliche Themen
Thema	Autor	Forum	Antworten	Letzter Beitrag
Search Plugin für Firefox	Zergling-new	Off-Topic Diskussionen	15	10.08.2006 11:58

19.01.2008, 16:53
PTC Erfahrener Benutzer Registriert seit: 27.10.2007 Beiträge: 1.708 PHP-Kenntnisse: Anfänger	Kurze Einführung in Firefox Search Plugin Programmierung Ich habe eine kurze Einführung zum Thema Firefox Search Plugin Programmierung geschrieben. Für weitgehendere Informationen verweise ich auf diese Seite:http://http://mycroft.mozdev.org/deepdocs/deepdocs.html 1. Was ist das Firefox(FF) Search Plugin Dies ist ein Plugin, welches dem FF Nutzer ermöglicht eine direkte Suche auf der gewünschten Seite aufzurufen. Es ist zu finden standarmäßig oben rechts im FF. Die Syntax entspricht der HTML-Sprache 2. Wie 'programmiere' ich es 2.1 Kommentare Zeichen: # Dies ist ein einzeiliger Kommentar. 2.2 SEARCH - Element Zeichen: <search>(anfang) </search>(ende) Dies ist das wichtigste Element hier werden alle Definitionen eingegeben. Vergleichbar mit den Elementen <html> und </html> In diesem Element gibt es noch 'Zusätze', die weiteren Informationen beinhalten. Zusätze: name - ein beliebiger Name des Plugins description - kurze Beschreibung des Plugins method - welche Sendemethode(POST oder GET) action - URL an die die Daten gesendet werden sollen update - wo das aktuelle Plugin liegt zum updaten(.src)(-s. u. bei 2.4-) updateIcon - s. o. nur für das Icon(.png)(-s. u. bei 2.4-) updateCheckDays - alle wieviel Tage nach Updates gesucht werden soll(-s. u. bei 2.4-) queryEncoding - Um-Kodierung der Nutzereingaben(UTF-8 oder ISO-blabla) 2.3 INPUT - Element(Unterelement von SEARCH) Zeichen: <input> In diesem werden die Eingaben des Nutzers oder ihre vordefinierten Eingaben an das Suchskript gesendet. Zusätze: name - (muss angegeben werden) ist der Identifikator für das Skript, welches die Suchanfrage bearbeitet user - (ohne '=' Zeichen schreiben) damit werden die Nutzereingaben gesendet value - Angaben die man uabhängig von Nutzereingaben denden möchte 2.4 BROWSE - Element Zeichen: <browse> Dies ist die zweite Möglichkeit Updateinformationen für den Browser zu speichern. Zusätze: update - wo das aktuelle Plugin liegt zum updaten(.src) updateIcon - s. o. nur für das Icon(.png) updateCheckDays - alle wieviel Tage nach Updates gesucht werden soll 3. Installation Die Installation funktioniert über JavaScript, welche ich nicht ganz verstehe, denn ich kann kein JS! 4.1 Beispiel - Plugin Code: # Mozilla Firefox Searchplugin <search name="MyWebsite" description="MyWebsite Search" method="GET" action="http://www.MyWebsite.com/search.php" update="http://www.MyWebsite.com/FF-SEARCH-Plugin/MyWebsite.src" updateIcon="http://www.MyWebsite.com/FF-SEARCH-Plugin/MyWebsite.png" updateCheckDays="30" queryEncoding="utf-8" queryCharset="utf-8" > <input name="search_for" user> <input name="FF_PLUGIN-USER" value="true"> </search> <browser update="http://www.MyWebsite.com/FF-SEARCH-Plugin/MyWebsite.src" updateIcon="http://www.MyWebsite.com/FF-SEARCH-Plugin/MyWebsite.png" updateCheckDays="30" > 4.2 Beispiel - Installation JS Original Installation von Mozilla Code: <script type="text/javascript"> <!-- function errorMsg() { alert("Netscape 6 or Mozilla is needed to install a sherlock plugin"); } function addEngine(name,ext,cat,type) { if ((typeof window.sidebar == "object") && (typeof window.sidebar.addSearchEngine == "function")) { //cat="Web"; //cat=prompt('In what category should this engine be installed?','Web') window.sidebar.addSearchEngine( "http://localhost.localdomain/plugins directory/"+name+".src", "http://localhost.localdomain/plugins directory/"+name+"."+ext, name, cat ); } else { errorMsg(); } } //--> </script> Code: <a href="javascript:addEngine('File name','image extension','Category name',0)">Name of Plugin</a> Geändert von PTC (17.05.2008 um 10:46 Uhr). Grund: Code-Tags


Mister Ad PHP Code Flüsterer Registriert seit: 21.08.2005 Beiträge: 4682 PHP-Kenntnisse: Fortgeschritten

06.07.2008, 15:59
PTC Erfahrener Benutzer Registriert seit: 27.10.2007 Beiträge: 1.708 PHP-Kenntnisse: Anfänger	*Kommentar: 1. Die im Beitrag genannte URL ist falsch, dies ist der korrekte Link: Mycroft Project: Search Engine Plugins - Firefox & IE7 2. Das Element in 2.4 heißt BROWSER (nicht BROWSE).

07.09.2008, 15:31
PTC Erfahrener Benutzer Registriert seit: 27.10.2007 Beiträge: 1.708 PHP-Kenntnisse: Anfänger	Der angegebene Link zur Dokumentation ruft eine Seite auf mit der Fehlermeldung "Page not found". Werde mich baldmöglichst um eine neue Dokumentation bemühen.

09.02.2009, 00:41
PTC Erfahrener Benutzer Registriert seit: 27.10.2007 Beiträge: 1.708 PHP-Kenntnisse: Anfänger	Ich habe eine neue Referenz gefunden, sie ist in englischer Sprache: https://developer.mozilla.org/En/Cre...ns_for_Firefox

09.02.2009, 16:18
Manko10 Supermoderator HD Registriert seit: 16.03.2008 Beiträge: 8.401 PHP-Kenntnisse: Fortgeschritten	Vor längerer Zeit habe ich hier auch mal eine Einführung geschrieben: OpenWebBoard / Tutorials / Sonstiges / Suchmaschinendienst fr Firefox und IE erstellen __________________ Refining Linux Advent Calendar series “24 Outstanding ZSH Gems”

10.02.2009, 01:31
PTC Erfahrener Benutzer Registriert seit: 27.10.2007 Beiträge: 1.708 PHP-Kenntnisse: Anfänger	Wer sich genauer in die Materie einarbeiten will, dem sei dieser Link ans Herz gelegt. Die Seite ist auch in englischer Sprache.