From a3a5e56b29b21b12fe71a707f7309cb204be71f1 Mon Sep 17 00:00:00 2001
From: Spoike <acceptthis@users.sourceforge.net>
Date: Sat, 1 Oct 2011 02:53:19 +0000
Subject: [PATCH] Basic example to serve as browser plugin documentation.

git-svn-id: https://svn.code.sf.net/p/fteqw/code/trunk@3904 fc73d0e0-1445-4013-8a0c-d673dee63da5
---
 specs/browserexample.html | 58 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 specs/browserexample.html

diff --git a/specs/browserexample.html b/specs/browserexample.html
new file mode 100644
index 00000000..decdc1b5
--- /dev/null
+++ b/specs/browserexample.html
@@ -0,0 +1,58 @@
+
+<!-- embedding example 
+Note the two separate objects. This is to cope with IE and Firefox incompatibilities.
+
+dataDownload specifies a zip file to download and extract pak and pk3 files. If the prefixed pak/pk3 file already exists, the download will be skipped (the contents are presumed to already be available). The zip must contain at least a "[foo/]id1/pak0.pak" file in this example, but you could also include a pak1.pak (ignoring copyright issues) if you wished.
+
+game specifies which game you are trying to target. Explicitly supported values are: q1, q2, q3, h2. Unrecognised values load that mod directory _only_, which is useful for total conversions.
+-->
+
+<object name="axfte"
+ type="text/x-quaketvident"
+ classid="clsid:7d676c9f-fb84-40b6-b3ff-e10831557eeb"
+ width=100%
+ height=100%
+>
+	<param name="splash" value="http://www.fteqw.com/images/phocagallery/fteqw/new_bloom_stuff/fte00076.jpg">
+	<param name="availver" value="10000">
+	<param name="game" value="q1">
+	<param name="dataDownload" value='id1/pak0.pak:http://example.com/examplequake1demo.zip'>
+
+	<object name="npfte"
+	 type="text/x-quaketvident"
+	 width=100%
+	 height=100%
+	>
+		<param name="splash" value="http://www.fteqw.com/images/phocagallery/fteqw/new_bloom_stuff/fte00076.jpg">
+		<param name="availver" value="10000">
+		<param name="game" value="q1">
+		<param name="dataDownload" value='id1/pak0.pak:http://example.com/examplequake1demo.zip'>
+
+		This text is displayed if the plugin isn't installed or is disabled.
+
+	</object>
+</object>
+
+
+<!-- scripting example follows -->
+
+
+<script>
+	/*cover the fact that firefox won't load a plugin if it has a classid, and IE won't load a plugin if it does not. Other browsers may follow other behaviours and 	may load the npapi using the object intended for iefte, but the params are all the same.*/
+	var fte;
+	if (axfte.plugver == null)
+		fte = npfte;
+	else
+		fte = axfte;
+
+	/*set the image for when the plugin isn't loaded (also used when it isn't maximized). The url is already specified above, so this is totally redundant, but this is 	an example after all.*/
+	fte.splash = "http://www.fteqw.com/images/phocagallery/fteqw/new_bloom_stuff/fte00076.jpg";
+
+	/*set it to some qtv stream*/
+	fte.stream = "file:foo@192.168.0.1";
+	/*set it to some server*/
+	fte.server = "192.168.0.1:27500";
+	/*explicitly activate it without requiring the user to click on it. only one plugin instance can be active at once. use with caution, or at least not on more than 	one plugin object on page site.*/
+	fte.running = 1;
+	document.write(fte.plugver);
+</script>
\ No newline at end of file