Beispiel: Hello World Meta-Daten
// ==UserScript== // @name Hello World // @namespace http://diveintogreasemonkey.org/download/ // @description Gibt auf jeder Seite die Meldung "Hello World" aus // @include * // @exclude http://diveintogreasemonkey.org/* // @exclude http://www.diveintogreasemonkey.org/* // ==/UserScript==
In dem Scriptausschnitt befinden sich sechs einzelne kleine Stücken Meta-Daten, geschrieben in Greasemonkey-spezifischen Kommentaren. Lassen Sie uns diese nun nach der Reihe durchgehen.
// ==UserScript== // // ==/UserScript==
Diese Kommentare sind typisch für Greasemonkey, und müssen unbedingt genau so im Benutzerscript enthalten sein. Sie sind das Signal für Greasemonkey, wo das Script beginnt und wo es endet. Meistens befindet sich die Zone, die das eigentliche Script enthält, vergleichsweise weit oben.
Im Greasemonkey-Meta-Daten-Abschnitt ist die erste Information der Name.
// @name Hello World
Dies ist der Name des Benutzerscript. Er wird im installationsdialog angezeigt, wenn Sie das Script installieren und später im “Benutzerscript-Verwalten-Dialog”. Der Name sollte kurz und pregnant sein.
@name
ist optional. Wenn er vorhanden ist, wird vermutlich nur der Name erscheinen. Wenn es keinen Namen gibt, wird der Name der Datei genommen, allerdings ohne den Namen des Dateityps
.user.js
.
Als nächstes kommt der Namespace.
// @namespace http://diveintogreasemonkey.org/download/
Das ist eine URL, und Greasemonkey benutzt Sie, um Benutzerscripte zu unterscheiden, die den selben Namen haben, aber von verschiedenen Autoren stammen. Wenn Sie eine eigene Domain (oder Subdomain bzw. ein Unterverzeichnis) haben, können Sie sie als ihren Namespace benutzen. Sonst können Sie eine tag:
URI verwenden.
Auch @namespace
ist optional. Wenn dieser Tag vorhanden ist, so wird er eventuell einmal angezeigt. Sonst wird Greasemonkey die Domain verwenden, von der der User das Script heruntergeladen hat.
(Anmerkung des Übersetzers: Sie müssen nicht unbedingt ein URL angeben, es funktioniert auch, wenn Sie stattdessen einen Namen eingeben, also am besten einen Internet-Kurznamen, unter dem Sie bekannt sind.)