Greasemonkey, čo to je a jeho metadata

V prvom rade si poďme napísať čo to vlastne Greasemonkey je. Greasemonkey je rozšírenie pre prehliadač Firefox, ktoré vám umožní spúšťať používateľské skripty založené na Javascripte. Tieto skripty vám umožnia zmeniť stránku a to či už sa jedná o vzhľad či funkcie.

Metadata

Metadata je časť užívateľského kódu, ktorého úlohou nieje spúštať kód ale opísat script. Napríklad názov scriptu, namespace, popis, include a exclude pravidla.
Metadata blok sa v tomto kóde reprezentuje cez podmienky Javascriptu. Môžu byť vpodstate kdekoľvek v Greasemonkey uživateľskom kóde ale zvyčajne sú na vrchu kódu.

Začinajú: // ==UserScript==
Končia: // ==/UserScript==
Všetko medzi týmito 2 riadkami je vo formáte // @key value

V prípade, že metadata blok obsahuje nejaký kľúč, ktorému Greasemonkey nerozumie, jednoducho ho bude ignorovať.

Syntax

// ==UserScript== // == @key value // ==/UserScript==

Vlastnosti

• @name
• @include
• @resource
• @unwrap
• @namespace
• @exclude
• @require
• @description

@name

Hodnota: reťazec
Pouzitie: // @name Moj Script
Názov scriptu. Tento názov sa objaví v scipt manager a greasemonkey menu, tiež ale slúži na určenie toho či sa má prepísať verzia s rovnakým názvom alebo sa nainštaluje ako nový script pod iným názvom. Názov povoľuje len 24 znakov, v prípade, že je dlhší, Greasemonkey si ho skráti bez medzier a špeciálnych znakov.

@namespace

Hodnota: reťazec
Pouzitie: // @namespace http://www.example.com/gmscripts
Namespace spolu s názvom scriptu určujú či má prepísať starú verziu scriptu alebo nainštalovať nový script. Autor zvyčajne svoje scripty umiestňuje v rámci jedného spoločného priečinku a potom priraďuje tento namespace každému svojmu scruptu. Ak 2 scripty majú rovnaký názov ale odlišný namespace, môžu tieto 2 script navzájom koexistovat. V prípade, že 2 scripty majú rovnaké mená aj namespace predpokladá sa, že ide o novú verziu scripru a prepíšu sa.

@description

Hodnota: reťazec Pouzitie: // @description This script even does the laundry! Stručný opis toho čo script robí.

@include

Hodnota: reťazec Pouzitie: // @ include http://www.example.com/* Stránky, v ktorých bude Greasemonkey script zahrnutý. Metadata blok môže obsahovať ľubovoľný počet @include pravidiel.

@exclude

Hodnota: Reťazec Pouzitie: // @ exclude http://www.example.com/foo/* Stránky, v ktorých nebude Greasemonkey script zahrnutý. Metadata blok môže obsahovat ľubovoľný počet @exclude pravidiel.

@resource

Hodnota: reťazec Kompatibilita: Greasemonkey 0.8.0+ Pouzitie: // @resource resourceName http://www.example.com/resource.png Slúži na načítanie externého súboru pod jeho resourceName, ktorý neskôr použijete v scripte. Nieje obmedzený počet @resource. Kazdý resourceName musí mať jedinečný názov.

@require

Hodnota: reťazec Kompatibilita: Greasemonkey 0.8.0+ Pouzitie: // @require jQuery.js Táto vlastnosť metadata je zvyčajne využívaná pre načítanie Javascript knižnice, napríklad jQuery. Nieje obmedzený počet @require. Súbor môže byť načítaný z lokálneho alebo externého zdroju.

@require

Hodnota: nedefinované Kompatibilita: Greasemonkey 0.8.1+ Pouzitie: // @unwrap Túto metadata vlastnosť sa doporučuje použiť len pre ladiace účely. Greasemonkey totiž defaultne zapúzdri script do obalu anonymnej funkcie (function(){ /* script source */ })();. Zapúzdrenie scriptu zabraňuje kolíziam pri názvoch premenných a objektov.

Ďalšie Keys

Tieto nepodporované metadata kľúče nespĺňajú žiaden technický účel a sú len z informačného dôvodu, sú pre ľudí, ktorí budú čítať zdrojový kód scriptu.

• @copyright
• @license
• @version

@copyright

Hodnota: nedefinovane Použitie: // @ copyright Rok, Autor (Stranka autora) Tento kľúč sa odporúča použiť na identifikáciu skriptu autorských práv autora a jeho domovskej stranky.

@licencie

Hodnota: nedefinované Pouzitie: // @ license License Type; License Homepage Odporúča sa použiť tento kľúč k opisu licencie. Nieje obmedzený počet @licencie pre viac licencií avšak userscripts.org zobrazí len prvý z nich ako primárny.

@version

Hodnota: nedefinované Pouzitie: // @ version 0.0.1 Označuje verziu progamu, užívateľovi pomôže zistiť či sa jedná ešte len o beta verziu alebo už je to nejaká stable verzia. Tiež sa zaužíva používať čas poslednej aktualizácie scriptu.

zdroj: wiki.greasespot.net