Widget Protocol - Revision history

Bablakeluke: /* The content path */

2017-03-23T17:55:54Z

‎The content path

Bablakeluke at 16:44, 18 March 2017

2017-03-18T16:44:00Z

Bablakeluke: Bablakeluke moved page Window Protocol to Widget Protocol: Renamed to 'widgets' instead of windows. Note that you can still use window:// too.

2017-03-18T16:38:03Z

Bablakeluke moved page Window Protocol to Widget Protocol: Renamed to 'widgets' instead of windows. Note that you can still use window:// too.

151.229.186.156 at 10:23, 14 January 2017

2017-01-14T10:23:59Z

151.229.186.156 at 09:52, 14 January 2017

2017-01-14T09:52:45Z

151.229.186.156 at 09:51, 14 January 2017

2017-01-14T09:51:02Z

151.229.186.156 at 09:50, 14 January 2017

2017-01-14T09:50:29Z

151.229.186.156 at 09:50, 14 January 2017

2017-01-14T09:50:11Z

151.229.186.156: Created page with "The window:// protocol is used from an anchor (a href='..') element to ''cycle'' a window. If you click the link a second time, it will close the open window. It specifies wha..."

2017-01-14T09:49:34Z

Created page with "The window:// protocol is used from an anchor (a href='..') element to ''cycle'' a window. If you click the link a second time, it will close the open window. It specifies wha..."

New page

The window:// protocol is used from an anchor (a href='..') element to ''cycle'' a window. If you click the link a second time, it will close the open window. It specifies what should be inside the window ''and'' the [[Window template|window template]] to use:

<syntaxhighlight lang="html">

<a href='window://<template name>/<path to content>'>Cycle a window</a>

</syntaxhighlight>

== Floating - the Built in template for a typical window ==

A template called "floating" is included by default. It is essentially a classic draggable, resizable window with a title bar (which will be set from the document.title of your content).

== The content path ==

Your content path is a complete URI which defaults to being relative to resources://. So, for example, let's say you'd like to open up a bank inside a default floating window. Your bank UI is described in Resources/UIs/Bank/index.html. That makes your window URL look like this:

<syntaxhighlight lang="html">

<a href='window://floating/UIs/Bank/index.html'>Open or close the bank!</a>

</syntaxhighlight>

== Opening a window from code ==

The window protocol is one way of opening up a window. If you'd like to open up a window from code, see the [[window manager web API]].

@@ Line 1: / Line 1: @@
-The window:// protocol is used from an anchor (a href='..') element to ''cycle'' a window. That means it opens the window but if you click the link a second time, it will close it. It specifies what should be inside the window ''and'' the [[Window Templates|window template]] to use:
+The widget:// protocol (or window:// - they do the same thing) is used from an anchor (a href='..') element to ''cycle'' a widget. That means it opens the widget but if you click the link a second time, it will close it. It specifies what should be inside the widget ''and'' the [[Widget Templates|widget template]] to use:
 <syntaxhighlight lang="html">
-<a href='window://<template name>/<path to content>'>Cycle a window</a>
+<a href='widget://<template name>/<path to content>'>Cycle a widget</a>
 </syntaxhighlight>
-== Floating - the Built in template for a typical window ==
+== Floating - the Built in template for a window ==
 A template called "floating" is included by default. It is essentially a classic draggable, resizable window with a title bar (which will be set from the document.title of your content).
@@ Line 19: / Line 19: @@
 <syntaxhighlight lang="html">
 <a href='window://floating/UIs/Bank/index.html'>Open or close the bank!</a>
@@ Line 31: / Line 34: @@
 <!-- Maybe we've got some window which asks the user to select something, and we'd like to default it to option #4 -->
-<a href='window://floating/UIs/SomeSelector/index.html?initial=4'>Open a selector</a>
+<a href='widget://floating/UIs/SomeSelector/index.html?initial=4'>Open a selector</a>
 <!-- index.html will end up with a JavaScript variable called initial which it can deal with however it wants -->
@@ Line 37: / Line 40: @@
 </syntaxhighlight>
-== Opening a window from code ==
+== Opening a widget from code ==
-The window protocol is one way of opening up a window. If you'd like to open up a window from code, see the [[Windows (Web API)|window web API]].
+The widget protocol is one way of opening up a widget. If you'd like to open up a widget from code, see the [[Widgets (Web API)|widget web API]].

← Older revision		Revision as of 10:23, 14 January 2017
Line 20:		Line 20:

	<a href='window://floating/UIs/Bank/index.html'>Open or close the bank!</a>		<a href='window://floating/UIs/Bank/index.html'>Open or close the bank!</a>
		+
		+	</syntaxhighlight>
		+
		+	== Parameters ==
		+
		+	You can pass extra parameters to your window via the query string. Both the template and your content will have access to them; they're also set as global JavaScript variables for your content too.
		+
		+	<syntaxhighlight lang="html">
		+
		+	<!-- Maybe we've got some window which asks the user to select something, and we'd like to default it to option #4 -->
		+
		+	<a href='window://floating/UIs/SomeSelector/index.html?initial=4'>Open a selector</a>
		+
		+	<!-- index.html will end up with a JavaScript variable called initial which it can deal with however it wants -->

	</syntaxhighlight>		</syntaxhighlight>

← Older revision		Revision as of 09:52, 14 January 2017
Line 25:		Line 25:
	== Opening a window from code ==		== Opening a window from code ==

−	The window protocol is one way of opening up a window. If you'd like to open up a window from code, see the [[window ~~manager~~ web API]].	+	The window protocol is one way of opening up a window. If you'd like to open up a window from code, see the [[Windows (Web API)\|window web API]].

← Older revision		Revision as of 09:51, 14 January 2017
Line 1:		Line 1:
−	The window:// protocol is used from an anchor (a href='..') element to ''cycle'' a window. If you click the link a second time, it will close ~~the open window~~. It specifies what should be inside the window ''and'' the [[Window Templates\|window template]] to use:	+	The window:// protocol is used from an anchor (a href='..') element to ''cycle'' a window. That means it opens the window but if you click the link a second time, it will close it. It specifies what should be inside the window ''and'' the [[Window Templates\|window template]] to use:

	<syntaxhighlight lang="html">		<syntaxhighlight lang="html">

← Older revision		Revision as of 09:50, 14 January 2017
Line 1:		Line 1:
−	The window:// protocol is used from an anchor (a href='..') element to ''cycle'' a window. If you click the link a second time, it will close the open window. It specifies what should be inside the window ''and'' the [[Window ~~templates~~\|window template]] to use:	+	The window:// protocol is used from an anchor (a href='..') element to ''cycle'' a window. If you click the link a second time, it will close the open window. It specifies what should be inside the window ''and'' the [[Window Templates\|window template]] to use:

	<syntaxhighlight lang="html">		<syntaxhighlight lang="html">

@@ Line 15: / Line 15: @@
 == The content path ==
-Your content path is a complete URI which defaults to being relative to resources://. So, for example, let's say you'd like to open up a bank inside a default floating window. Your bank UI is described in Resources/UIs/Bank/index.html. That makes your window URL look like this:
+Your content path is a complete URI which is relative to your documents basepath (which is resources:// by default). So, for example, let's say you'd like to open up a bank inside a default floating window. Your bank UI is described in Resources/UIs/Bank/index.html and your document.location is 'resources://' (the default). That makes your window URL look like this:
 <syntaxhighlight lang="html">

← Older revision	Revision as of 16:38, 18 March 2017
(No difference)