Skip to main content

Writing your first UserScript, Template as a beginner's tutorial

UserScripts are fun, useful and often productive. A lot of sites have small improvements you think could add a lot of value. And just because you are not the author of the site, you need not give up. With some basic javascript skills, you could write a userscript, install it on your browser, and make the site behave.

Step 1. Build a script from the template

Start with the following template and modify what you want
// ==UserScript==
//
//Displayable Name of your script 
// @name           My First Script 
//
// brief description
// @description    Alerts Hello   
//
//URI (preferably your own site, so browser can avert naming collisions
// @namespace      http://www.sarathonline.com/dyn/userscripts/hello/
//
// Your name, userscript userid link (optional)   
// @author         sarathonline (http://userscripts.org/users/****) 
//
// If you want to license out
// @license        GNU GPL v3 (http://www.gnu.org/copyleft/gpl.html) 
//
//(optional) may be used by browsers to display an about link
// @homepage       http://www.sarathonline.com/dyn/userscripts/hello/ 
//
//Version Number
// @version        1.0
//
// Urls process this user script on
// @include        http://*
//
// Add any library dependencies here, so they are loaded before your script is loaded.
//
// @require        https://ajax.googleapis.com/ajax/libs/jquery/1.6.0/jquery.min.js
//
// @history        1.0 first version
// @history        1.0b first beta version, who knew!!
//
// ==/UserScript==


//And of course your code!!
$(function(){
window.alert("Hello.. My Extension processed you..");
});

Thats it, You have your first userscript. By convention user scripts are

Step 2. Host your UserScript on web.

You have by now authored yourscript.user.js file. Now you need to distribute this as an extension. To do that you need to find a home for this file on the web. If can host a js file, on your own website. You could. However, if you do that on www.userscripts.org, your script is instantly available to a much larger audience. userscripts.org is a free user script hosting site, that also doubles as a market place. userscripts.org also provides an easier way to edit the code online, in case you need to update.

Step 3. Share and Install (coming)

Labels:

Popular posts from this blog

Powered By

As it goes, We ought to give thanks to people who power us. This page will be updated, like the version page , to show all the tools, and people this site is Powered By! Ubuntu GIMP Firebug Blogger Google [AppEngine, Ajax and other Apis] AddtoAny Project Fondue jQuery
Read More >>

Decorator for Memcache Get/Set in python

I have suggested some time back that you could modularize and stitch together fragments of js and css to spit out in one HTTP connection. That makes the page load faster. I also indicated that there ways to tune them by adding cache-control headers. On the server-side however, you could have a memcache layer on the stitching operation. This saves a lot of Resources (CPU) on your server. I will demonstrate this using a python script I use currently on my site to generate the combined js and css fragments. So My stitching method is like this @memize(region="jscss") def joinAndPut(files, ext): res = files.split("/") o = StringIO.StringIO() for f in res: writeFileTo(o, ext + "/" + f + "." + ext) #writes file out ret = o.getvalue() o.close() return ret; The method joinAndPut is * decorated * by memize. What this means is, all calls to joinAndPut are now wrapped (at runtime) with the logic in memize. All you wa...
Read More >>

Faster webpages with fewer CSS and JS

Its easy, have lesser images, css and js files. I will cover reducing number of images in another post. But If you are like me, You always write js and css in a modular fashion. Grouping functions and classes into smaller files (and Following the DRY rule, Strictly!). But what happens is, when you start writing a page to have these css and js files, you are putting them in muliple link rel=style-sheet or script tags. Your server is being hit by (same) number of HTTP Requests for each page call. At this point, its not the size of files but the number server roundtrips on a page that slows your page down. Yslow shows how many server roundtrips happen for css and js. If you have more than one css call and one js call, You are not using your server well. How do you achieve this? By concatinating them and spitting out the content as one stream. So Lets say I have util.js, blog.js and so.js. If I have a blog template that depends on these three, I would call them in three script tags. Wh...
Read More >>