Labs/Ubiquity/Ubiquity 0.5 Author Tutorial - Revision history

Satyr: /* TinyURL: Network Calls and jQuery (and the URL noun type) */ arguments -> args

2010-07-29T02:38:39Z

TinyURL: Network Calls and jQuery (and the URL noun type): arguments -> args

← Older revision		Revision as of 02:38, 29 July 2010
Line 560:		Line 560:
	CmdUtils.CreateCommand({		CmdUtils.CreateCommand({
	names: ["tinyurl"],		names: ["tinyurl"],
			description: "Replaces the selected URL with a TinyUrl.",
	arguments: [{role: "object",		arguments: [{role: "object",
	nountype: noun_type_url,		nountype: noun_type_url,
	label: "url to shorten"}],		label: "url to shorten"}],
	~~preview: "Replaces the selected URL with a TinyUrl.",~~		execute: function(args) {
	execute: function( ~~arguments~~ ) {
	var baseUrl = "http://tinyurl.com/api-create.php";		var baseUrl = "http://tinyurl.com/api-create.php";
	var params = {url: ~~arguments~~.object.text};		var params = {url: args.object.text};
	jQuery.get( baseUrl, params, function( tinyUrl ) {		jQuery.get(baseUrl, params, function(tinyUrl) {
	CmdUtils.setSelection( tinyUrl );		CmdUtils.setSelection(tinyUrl);
	})		});
	}		},
	})		})
	</pre>		</pre>
Line 577:		Line 577:

	jQuery is a powerful tool. With it, you can fairly effortlessly cherry-pick the data you need from RSS feeds, XML, and all sorts of other data formats. It also makes doing in-preview animations a breeze.		jQuery is a powerful tool. With it, you can fairly effortlessly cherry-pick the data you need from RSS feeds, XML, and all sorts of other data formats. It also makes doing in-preview animations a breeze.







	= Twitter: Putting It All Together =		= Twitter: Putting It All Together =

Satyr: /* Insert Email: the Contact noun type */ args -> arguments | text -> html

2010-07-29T02:35:16Z

Insert Email: the Contact noun type: args -> arguments | text -> html

← Older revision		Revision as of 02:35, 29 July 2010
Line 496:		Line 496:
	<pre>		<pre>
	CmdUtils.CreateCommand({		CmdUtils.CreateCommand({
	~~names~~: ["insert email"],		name: "insert email",
	arguments: {modifier: noun_type_contact},		arguments: {modifier: noun_type_contact},
	preview: "Inserts someone's email address by name.",		preview: "Inserts someone's email address by name.",
	execute: function( ~~arguments~~ ) {		execute: function(args) {
	CmdUtils.setSelection( ~~arguments~~.modifier.~~text~~ );		CmdUtils.setSelection(args.modifier.html);
	}		},
	});		});
	</pre>		</pre>

Satyr: /* Echo */ arguments -> args

2010-07-29T02:27:46Z

Echo: arguments -> args

← Older revision		Revision as of 02:27, 29 July 2010
Line 325:		Line 325:
	nountype: noun_arb_text,		nountype: noun_arb_text,
	label: "your shout"}],		label: "your shout"}],
	preview: function( pblock, ~~arguments~~ ) {		preview: function previewEcho(pblock, args) {
	pblock.innerHTML = _("Will echo: ") + ~~arguments~~.object.text;		pblock.innerHTML = _("Will echo: ") + args.object.text;
			},
			execute: function executeEcho(args) {
			var msg = args.object.text + "... " + args.object.text + "......";
			displayMessage(msg);
	},		},
	~~execute: function( arguments ) {~~
	~~var msg = arguments.object.text + "... " + arguments.object.text + "......";~~
	~~displayMessage( msg );~~
	}
	});		});
	</pre>		</pre>
Line 399:		Line 399:
	When your preview method is called, it is passed this object, too.		When your preview method is called, it is passed this object, too.

	The object has one attribute corresponding to each role. In our example above, the command accepts only an object-role argument, so the preview and execute methods get passed an argument with an ~~"arguments~~.object" attribute.		The object has one attribute corresponding to each role. In our example above, the command accepts only an object-role argument, so the preview and execute methods get passed an argument with an <code>args.object</code> attribute.

	If we made a command, like email, that takes an object-role argument and a goal-role argument, its preview and execute methods would get passed an argument with ~~"arguments~~.object" and ~~"arguments~~.goal".		If we made a command, like email, that takes an object-role argument and a goal-role argument, its preview and execute methods would get passed an argument with <code>args.object</code> and <code>args.goal</code>.

	~~arguments~~.object (or ~~arguments~~.goal) has several attributes of its own:		<code>args.object</code> (or <code>args.goal</code>) has several attributes of its own:

	<pre>		<pre>
	~~arguments~~.object.text // a string of the input in plain text, without formatting		args.object.text // a string of the input in plain text, without formatting
	~~arguments~~.object.html // a string of the input in formatted ~~html~~, including tags		args.object.html // a string of the input in formatted HTML, including tags
	~~arguments~~.object.data // for non-text input types, an arbitrary data object		args.object.data // for non-text input types, an arbitrary data object
	~~arguments~~.object.summary // ~~for very long inputs~~, an abbreviated ~~display string~~		args.object.summary // the HTML string displayed in the suggestion list, abbreviated if long
	</pre>		</pre>

Satyr: /* Persistent Storage */ for -> for each

2009-11-16T17:17:23Z

Persistent Storage: for -> for each

← Older revision		Revision as of 17:17, 16 November 2009
Line 1,050:		Line 1,050:
	execute: function list_memos_execute() {		execute: function list_memos_execute() {
	var htm = +Bin + " page(s)<dl>", {escapeHtml} = Utils;		var htm = +Bin + " page(s)<dl>", {escapeHtml} = Utils;
	for (var [url, memos] in Bin) {		for each (var [url, memos] in Bin) {
	htm += "<dt>" + escapeHtml(url) + "</dt><dd><ol>";		htm += "<dt>" + escapeHtml(url) + "</dt><dd><ol>";
	for each (var memo in memos) htm += "<li>" + memo + "</li>";		for each (var memo in memos) htm += "<li>" + memo + "</li>";

Satyr: more for arguments

2009-09-01T13:52:24Z

more for arguments

← Older revision		Revision as of 13:52, 1 September 2009
Line 517:		Line 517:
	</pre>		</pre>

	but if we don't care about specifying ~~a label~~ for the argument, we can get away with using a single object for "arguments", with the roles as the property names, and the nountypes as the property values:		but if we don't care about specifying extra parameters for the argument, we can get away with using a single object for "arguments", with the roles as the property names, and the nountypes as the property values:

	<pre>		<pre>
Line 523:		Line 523:
	</pre>		</pre>

	If we had several arguments~~, and none of them needed labels~~, we could say:		or with label using <code>"_"</code> (or <code>" "</code>) as separator:

			<pre>
			arguments: {modifier_contact: noun_type_contact}
			</pre>

			If we had several arguments, we could say:

	<pre>		<pre>
Line 529:		Line 535:
	</pre>		</pre>

	and ~~so on~~.		Finally, if you only have "object" and don't need to specify a label...:

			<pre>
			argument: noun_arb_text
			</pre>

	Aza writes:		Aza writes:

Satyr: s/state/storage/

2009-09-01T13:31:17Z

s/state/storage/

← Older revision		Revision as of 13:31, 1 September 2009
Line 998:		Line 998:
	In the future, Ubiquity is also likely to have the ability to convert your Ubiquity commands into proper Firefox extensions. Look [http://labs.toolness.com/trac/ticket/3 here] to check on the progress of this functionality.		In the future, Ubiquity is also likely to have the ability to convert your Ubiquity commands into proper Firefox extensions. Look [http://labs.toolness.com/trac/ticket/3 here] to check on the progress of this functionality.

	== Persistent ~~State~~ ==		== Persistent Storage ==
	Some commands may want to store data that persist even after closing Firefox.		Some commands may want to store data that persist even after closing Firefox.
	Meet <code>Bin</code>:		Meet <code>Bin</code>:

Tat.wright: /* Persistent State (Bin) */

2009-08-30T12:26:15Z

Persistent State (Bin)

← Older revision		Revision as of 12:26, 30 August 2009
Line 998:		Line 998:
	In the future, Ubiquity is also likely to have the ability to convert your Ubiquity commands into proper Firefox extensions. Look [http://labs.toolness.com/trac/ticket/3 here] to check on the progress of this functionality.		In the future, Ubiquity is also likely to have the ability to convert your Ubiquity commands into proper Firefox extensions. Look [http://labs.toolness.com/trac/ticket/3 here] to check on the progress of this functionality.

	== Persistent State ~~(Bin)~~ ==		== Persistent State ==
	Some commands may want to store data that persist even after closing Firefox.		Some commands may want to store data that persist even after closing Firefox.
	Meet <code>Bin</code>:		Meet <code>Bin</code>:

Tat.wright: /* Using Bin */ Changed title to be slightly clearer, and so that searching for the words persistent or state goes to the appropriate section

2009-08-30T12:25:10Z

Using Bin: Changed title to be slightly clearer, and so that searching for the words persistent or state goes to the appropriate section

← Older revision		Revision as of 12:25, 30 August 2009
Line 998:		Line 998:
	In the future, Ubiquity is also likely to have the ability to convert your Ubiquity commands into proper Firefox extensions. Look [http://labs.toolness.com/trac/ticket/3 here] to check on the progress of this functionality.		In the future, Ubiquity is also likely to have the ability to convert your Ubiquity commands into proper Firefox extensions. Look [http://labs.toolness.com/trac/ticket/3 here] to check on the progress of this functionality.

	== ~~Using~~ Bin ==		== Persistent State (Bin) ==
	Some commands may want to store data that persist even after closing Firefox.		Some commands may want to store data that persist even after closing Firefox.
	Meet <code>Bin</code>:		Meet <code>Bin</code>:

Satyr: sample code for Bin

2009-08-30T03:50:02Z

sample code for Bin

← Older revision		Revision as of 03:50, 30 August 2009
Line 997:		Line 997:

	In the future, Ubiquity is also likely to have the ability to convert your Ubiquity commands into proper Firefox extensions. Look [http://labs.toolness.com/trac/ticket/3 here] to check on the progress of this functionality.		In the future, Ubiquity is also likely to have the ability to convert your Ubiquity commands into proper Firefox extensions. Look [http://labs.toolness.com/trac/ticket/3 here] to check on the progress of this functionality.

			== Using Bin ==
			Some commands may want to store data that persist even after closing Firefox.
			Meet <code>Bin</code>:
			<pre>
			var gId = 42; // used for avoiding needless preview updates when typing
			CmdUtils.CreateCommand({
			name: "memo",
			description: "Lets you jot a memo for the page.",
			author: "satyr",
			argument: noun_arb_text,
			execute: function memo_execute({object: {html}}) {
			var {href} = CmdUtils.getDocument().location;
			var list = Bin[href]() \|\| [];
			list.push(html);
			Bin[href](list);
			gId = +new Date;
			},
			preview: function memo_preview(pb) {
			var {href} = CmdUtils.getDocument().location;
			var list = Bin[href]();
			if (!list) {
			pb.innerHTML =
			<>No memos taken for: <small><code>{href}</code></small></>;
			return;
			}
			if (pb.ownerDocument.getElementById(gId)) return;
			var ol = CmdUtils.previewList(pb, list, function deleteMemo(i, ev) {
			$(ev.target).closest("li").slideUp();
			list.splice(i, 1);
			Bin[href](list.length ? list : null);
			gId = +new Date;
			});
			ol.id = gId;
			},
			});

			CmdUtils.CreateCommand({
			name: "list memos",
			description: "Opens all memos you've taken in a new tab.",
			author: "satyr",
			execute: function list_memos_execute() {
			var htm = +Bin + " page(s)<dl>", {escapeHtml} = Utils;
			for (var [url, memos] in Bin) {
			htm += "<dt>" + escapeHtml(url) + "</dt><dd><ol>";
			for each (var memo in memos) htm += "<li>" + memo + "</li>";
			htm += "</ol></dd>";
			}
			Utils.openUrlInBrowser("data:text/html," + encodeURI(htm + "</dl>"));
			},
			});
			</pre>
			For details, see the bottom of [https://ubiquity.mozilla.com/hg/ubiquity-firefox/raw-file/tip/ubiquity/index.html#modules/feedmanager.js FeedManager] documentation.

	== Firebug ==		== Firebug ==

Satyr: h1 => h2

2009-08-30T00:17:27Z

h1 => h2

← Older revision		Revision as of 00:17, 30 August 2009
Line 29:		Line 29:
	For now, just make sure this drop-down is set to "Regular". We'll tell you more about what this means later.		For now, just make sure this drop-down is set to "Regular". We'll tell you more about what this means later.

	= Hello World: The First Command =		== Hello World: The First Command ==

	== Just a Message: As Simple as it Gets ==		=== Just a Message: As Simple as it Gets ===

	Let's start with the standard programing trope: printing "Hello, World!".		Let's start with the standard programing trope: printing "Hello, World!".
Line 40:		Line 40:
	CmdUtils.CreateCommand({		CmdUtils.CreateCommand({
	names: ["say hello"],		names: ["say hello"],
	execute: function() {		execute: function hello_execute() {
	displayMessage( "Hello, World!");		displayMessage("Hello, World!");
	}		}
	});		});
Line 63:		Line 63:

	<pre>		<pre>
	{		{
	names: ["say hello"],		names: ["say hello"],
	execute: function() { //etc }		execute: function () { //etc }
	}		}
	</pre>		</pre>

Line 101:		Line 101:
	CmdUtils.CreateCommand({		CmdUtils.CreateCommand({
	names: ["say hello", "greet"],		names: ["say hello", "greet"],
	execute: function() {		execute: function hello_execute() {
	displayMessage( _("Hello, World!") );		displayMessage(_("Hello, World!"));
	}		}
	});		});