Metadata in Script

The metadata is the description part of IEScripts, which is compitable with GreaseMonkey's user script. It describes what the script is and the when to run after loaded.

Metadata in helloworld.ieuser.js: 

// ==UserScript==
// @name          Hello World
// @namespace     http://xxx.com/
// @description   An famous example shows 'Hello World!'
// @injectframes  0
// @include       *
// @exclude       http://*.iescripts.org/*
// @exclude       http://iescripts.org/*
// ==/UserScript==
The description // ==UserScript== is key to the script. The metadata sits between the beginning tag and ending tag. The metadata tells IEPro how to load the script.

As described in the above section, there are usually six kinds of keywords to be specified(injectframes is an IEScripts extension), they are:

// @name
@name is a must. it appears in the user script list in IEPro.
Note: @name is optional in GreaseMonkey.

// @namespace
@namespace is optional for IEScripts. You can specify you blog URL here.

// @description
A short description of the user script. It is displayed in the installation dialog and IEPro configuration window. @description is optional.

// @include *
An important item for all user scripts. It describes which domain(s) to be applied. @include can be multiple items. A value of '*' means the script apply to all pages.

// @exclude http://iescripts.org/
An optional item for a script. It describes which domain(s) to be excluded. @exclude can be multiple items.

// @injectframes 1
An optional item for a script. It describes whether the script takes effect in the frames/iframes of a web page. Two values 0 and 1 can be specified with 0 as the default.