GM.getResourceText: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m (→Notes: Neutralized note to work on multiple pages) |
m (→<code>resourceName</code>: Cleaned up mini-description) |
||
| Line 31: | Line 31: | ||
:Usage: <code>'''resourceName''' = "metadata-resource-name<sup>[[#Notes|[1]]]</sup>";</code> | :Usage: <code>'''resourceName''' = "metadata-resource-name<sup>[[#Notes|[1]]]</sup>";</code> | ||
:* This value is used | :* This value is used in retrieval of the same named resource specified in the corresponding [[Metadata_block |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. | ||
[[#top|top]] | [[#Syntax|back]]'' | [[#top|top]] | [[#Syntax|back]]'' | ||
Revision as of 06:00, 12 December 2007
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-resource-name[1]";
- 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 Example GM_getResourceText
// @include http://www.example.com/*
// @resource prototype http://www.prototypejs.org/assets/2007/11/6/prototype.js
// ==/UserScript==
/* some code */
location.href = "javascript:void(" + GM_getResourceText("prototype") + ")";
Notes
[1] While the variable names here are non-semantic, it is assumed that it should be compatible with JavaScript variable naming conventions and XML/CSS naming conventions to help keep things consistent.
