GM.getResourceText: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m Added Greasemonkey Manual TOC widget |
m →<code>resourceName</code>: Updated wiki link to actual key |
||
| Line 32: | Line 32: | ||
:Usage: <code>'''resourceName''' = "metadata_block_resourceName";</code> | :Usage: <code>'''resourceName''' = "metadata_block_resourceName";</code> | ||
:* While the resourceName is non-semantic, it is suggested that it should be compatible with JavaScript variable naming conventions and XML/CSS naming conventions to help keep things consistent. | :* While the resourceName is non-semantic, it is suggested that it should be compatible with JavaScript variable naming conventions and XML/CSS naming conventions to help keep things consistent. | ||
:* This value is used in retrieval of the same-named resource specified in the corresponding [[Metadata_block | | :* This value is used in retrieval of the same-named resource specified in the corresponding metadata block [[Metadata_block#.40resource |@resource]] key. After it is retrieved, no formatting on the resource will occur, and it will be returned upon completion of this API method. | ||
[[#top|top]] | [[#Syntax|back]]'' | [[#top|top]] | [[#Syntax|back]]'' | ||
Revision as of 04:19, 30 March 2009
 Greasemonkey Manual |
| Using Greasemonkey |
|---|
| Installing Scripts |
| Monkey Menu |
| Getting Help |
| User Script Authoring |
| Editing |
| Environment |
| API |
Description
This API method loads an external resource, such as an external JavaScript routine, and returns the string for use in the DOM.
Syntax
GM_getResourceText( resourceName )
- Value: Function
- Returns: String
- Compatibility: Greasemonkey 0.8.0+
Parameters Properties resourceName
- All properties are optional except resourceName.
Properties
resourceName
- Value: String
- Usage:
resourceName = "metadata_block_resourceName";- While the resourceName is non-semantic, it is suggested that it should be compatible with JavaScript variable naming conventions and XML/CSS naming conventions to help keep things consistent.
- This value is used in retrieval of the same-named resource specified in the corresponding metadata block @resource key. After it is retrieved, no formatting on the resource will occur, and it will be returned upon completion of this API method.
Examples
// ==UserScript==
// @name My Script
// @namespace http://www.example.com/gmscripts/
// @description Scripting is fun
// @include http://www.example.com/*
// @resource prototype http://www.example.com/prototype.js
// ==/UserScript==
(function()
{
// some code
var myPrototype = GM_getResourceText("prototype");
// some code
})();
