You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wookie.apache.org by bu...@apache.org on 2012/11/27 10:54:47 UTC
svn commit: r839743 [2/6] - in /websites/staging/wookie/trunk/content: ./
css/ docs/ docs/developer/ docs/developer/features/ docs/releases/
docs/tutorial/ docs/tutorial/lib/ docs/tutorial/lib/s5/
docs/tutorial/lib/s5/ui/ docs/tutorial/lib/s5/ui/defaul...
Added: websites/staging/wookie/trunk/content/docs/demo.html
==============================================================================
--- websites/staging/wookie/trunk/content/docs/demo.html (added)
+++ websites/staging/wookie/trunk/content/docs/demo.html Tue Nov 27 09:54:44 2012
@@ -0,0 +1,118 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/wookie/css/wookie.css" rel="stylesheet" type="text/css">
+ <link href="/wookie/css/code.css" rel="stylesheet" type="text/css">
+ <title>Apache Wookie (Incubating) - </title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
+<body>
+ <div id="banner">
+ <img alt="Apache Wookie (Incubating)" src="/wookie/images/logo.png"/>
+ <h1 class="title"></h1>
+ </div>
+
+ <div id="navigation">
+ <h1 id="general">General</h1>
+<ul>
+<li><a href="/wookie/index.html">Home</a></li>
+<li><a href="/wookie/news.html">News</a></li>
+<li><a href="/wookie/docs/download.html">Download</a></li>
+<li><a href="http://incubator.apache.org/projects/wookie.html">Incubator page</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="documentation">Documentation</h1>
+<ul>
+<li><a href="/wookie/docs/download.html">Download and Quickstart</a></li>
+<li><a href="/wookie/docs/admin.html">Server Admin</a></li>
+<li><a href="/wookie/docs/embedding.html">Embedding</a></li>
+<li><a href="/wookie/docs/shindig.html">Integrating with Shindig</a></li>
+<li><a href="/wookie/docs/widgets.html">Building widgets</a></li>
+<li><a href="/wookie/docs/faq.html">FAQ</a></li>
+<li><a href="/wookie/docs/api.html">API Reference</a></li>
+</ul>
+<h1 id="community">Community</h1>
+<ul>
+<li><a href="/wookie/get-involved.html">Get Involved</a></li>
+<li><a href="/wookie/mailing-lists.html">Mailing Lists</a></li>
+<li><a href="/wookie/people.html">People</a></li>
+</ul>
+<h1 id="development">Development</h1>
+<ul>
+<li><a href="/wookie/docs/source.html">Getting Started</a></li>
+<li><a href="/wookie/docs/developer/running.html">Running</a></li>
+<li><a href="/wookie/docs/templates.html">Widget Templates</a></li>
+<li><a href="/wookie/docs/developer/features.html">Extension Features</a></li>
+<li><a href="/wookie/docs/developer/widgets.html">Deploying Widgets</a></li>
+<li><a href="/wookie/docs/develop.html">Environment</a></li>
+<li><a href="/wookie/docs/developer/release-management.html">Release Management</a></li>
+<li><a href="/wookie/docs/developer/issues.html">Issue Tracker</a></li>
+<li><a href="/wookie/docs/developer/index.html">Management</a></li>
+<li><a href="/wookie/docs/developer/parser.html">W3C Widget Parser</a></li>
+</ul>
+<h1 id="asf">ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <p>This page demonstrates a few widgets running on our test servers.</p>
+<p>To see multi-user functionality you will need to open the page on to separate computers or in two browsers tabs/instances.</p>
+<p><em>NOTE: Widgets in this page are embedded using a simple iFrame representation. This means we don't support multiple registered users in this demo.</em></p>
+<p><em>NOTE: The test servers are not run on mission critical machines and therefore may occasionally be offline.</em></p>
+<p>To see a complete demo, including multi-user demonstrations see our <a href="http://wookie-vm.apache.org:8080/wookie">Demonstration Server</a></p>
+<h2 id="natter">Natter</h2>
+<p>A simple chat widget.</p>
+<iframe src="http://wookie-vm.apache.org:8080/wookie/wservices/www.getwookie.org/widgets/natter/index.htm?idkey=iuWUsgtvqSvCmxq6UD5yEVqNSAg.eq.&proxy=http://wookie-vm.apache.org:8080/wookie/proxy&st=testuser%3Atestuser%3Ahttp%253A%252F%252Fwww.getwookie.org%252Fwidgets%252Fnatter%3Awookie%3A%252Fwookie%252Fwservices%252Fwww.getwookie.org%252Fwidgets%252Fnatter%252Findex.htm%3A0%3AiuWUsgtvqSvCmxq6UD5yEVqNSAg.eq. iuWUsgtvqSvCmxq6UD5yEVqNSAg.eq." width="255" height="383" frameborder="0">
+ <p>Your browser does not support iframes.</p>
+</iframe>
+
+<h2 id="sharedraw">ShareDraw</h2>
+<p>This widget allows multiple users to draw on a shared canvas.</p>
+<iframe src="http://wookie-vm.apache.org:8080/wookie/wservices/wookie.apache.org/widgets/sharedraw/index.html?idkey=wv.sl.AVMFP2BueIb8UPDnusBZu7gA.eq.&proxy=http://wookie-vm.apache.org:8080/wookie/proxy&st=testuser%3Atestuser%3Ahttp%253A%252F%252Fwookie.apache.org%252Fwidgets%252Fsharedraw%3Awookie%3A%252Fwookie%252Fwservices%252Fwookie.apache.org%252Fwidgets%252Fsharedraw%252Findex.html%3A0%3Awv.sl.AVMFP2BueIb8UPDnusBZu7gA.eq. wv.sl.AVMFP2BueIb8UPDnusBZu7gA.eq." width="420" height="320" frameborder="0">
+ <p>Your browser does not support iframes.</p>
+</iframe>
+
+<h2 id="bubbles">Bubbles</h2>
+<p>A simple game widget.</p>
+<iframe src="http://wookie-vm.apache.org:8080/wookie/wservices/www.opera.com/widgets/bubbles/index.html?idkey=j.sl.8trVRZzbvYyfO2XBBcJaI.pl.IIk.eq.&proxy=http://wookie-vm.apache.org:8080/wookie/proxy&st=testuser%3Atestuser%3Ahttp%253A%252F%252Fwww.opera.com%252Fwidgets%252Fbubbles%3Awookie%3A%252Fwookie%252Fwservices%252Fwww.opera.com%252Fwidgets%252Fbubbles%252Findex.html%3A0%3Aj.sl.8trVRZzbvYyfO2XBBcJaI.pl.IIk.eq. j.sl.8trVRZzbvYyfO2XBBcJaI.pl.IIk.eq" height="300" width="240" frameborder="0">
+ <p>Your browser does not support iframes.</p>
+</iframe>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2011-2012 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/wookie/trunk/content/docs/demoadmin.html
==============================================================================
--- websites/staging/wookie/trunk/content/docs/demoadmin.html (added)
+++ websites/staging/wookie/trunk/content/docs/demoadmin.html Tue Nov 27 09:54:44 2012
@@ -0,0 +1,201 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/wookie/css/wookie.css" rel="stylesheet" type="text/css">
+ <link href="/wookie/css/code.css" rel="stylesheet" type="text/css">
+ <title>Apache Wookie (Incubating) - </title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
+<body>
+ <div id="banner">
+ <img alt="Apache Wookie (Incubating)" src="/wookie/images/logo.png"/>
+ <h1 class="title"></h1>
+ </div>
+
+ <div id="navigation">
+ <h1 id="general">General</h1>
+<ul>
+<li><a href="/wookie/index.html">Home</a></li>
+<li><a href="/wookie/news.html">News</a></li>
+<li><a href="/wookie/docs/download.html">Download</a></li>
+<li><a href="http://incubator.apache.org/projects/wookie.html">Incubator page</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="documentation">Documentation</h1>
+<ul>
+<li><a href="/wookie/docs/download.html">Download and Quickstart</a></li>
+<li><a href="/wookie/docs/admin.html">Server Admin</a></li>
+<li><a href="/wookie/docs/embedding.html">Embedding</a></li>
+<li><a href="/wookie/docs/shindig.html">Integrating with Shindig</a></li>
+<li><a href="/wookie/docs/widgets.html">Building widgets</a></li>
+<li><a href="/wookie/docs/faq.html">FAQ</a></li>
+<li><a href="/wookie/docs/api.html">API Reference</a></li>
+</ul>
+<h1 id="community">Community</h1>
+<ul>
+<li><a href="/wookie/get-involved.html">Get Involved</a></li>
+<li><a href="/wookie/mailing-lists.html">Mailing Lists</a></li>
+<li><a href="/wookie/people.html">People</a></li>
+</ul>
+<h1 id="development">Development</h1>
+<ul>
+<li><a href="/wookie/docs/source.html">Getting Started</a></li>
+<li><a href="/wookie/docs/developer/running.html">Running</a></li>
+<li><a href="/wookie/docs/templates.html">Widget Templates</a></li>
+<li><a href="/wookie/docs/developer/features.html">Extension Features</a></li>
+<li><a href="/wookie/docs/developer/widgets.html">Deploying Widgets</a></li>
+<li><a href="/wookie/docs/develop.html">Environment</a></li>
+<li><a href="/wookie/docs/developer/release-management.html">Release Management</a></li>
+<li><a href="/wookie/docs/developer/issues.html">Issue Tracker</a></li>
+<li><a href="/wookie/docs/developer/index.html">Management</a></li>
+<li><a href="/wookie/docs/developer/parser.html">W3C Widget Parser</a></li>
+</ul>
+<h1 id="asf">ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h2 id="introduction">Introduction</h2>
+<p>This page is aimed at Wookie Committers who administer or are interested in administering the Wookie Demo Server. (Some of this info may or may not be helpful to others)</p>
+<p>We have two running demos at <a href="http://wookie-vm.apache.org:8080/wookie">http://wookie-vm.apache.org:8080/wookie</a> and <a href="http://wookie-vm.apache.org:8090/wookie">http://wookie-vm.apache.org:8090/wookie</a> . The first is your default standalone jetty/derby configuration The second has an altered configuation to run as a Tomcat Webapp and also using the external MySQL database.</p>
+<h2 id="starting-the-demos">Starting the Demos</h2>
+<p>Note that the code for one demo is checked out into /home/wookie/trunk whilst the other (tomcat/mysql demo) is checked out into /home/wookie/trunk-tc.</p>
+<p>Assuming you are logged in to wookie-vm.apache.org via ssh and have a shell:</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">screen</span> <span class="p">(</span><span class="ow">or</span> <span class="n">screen</span> <span class="o">-</span><span class="n">r</span> <span class="n">to</span> <span class="n">resume</span> <span class="ow">or</span> <span class="n">screen</span> <span class="o">-</span><span class="n">x</span> <span class="nv">$pid</span> <span class="n">to</span> <span class="nb">join</span> <span class="n">another</span> <span class="n">users</span> <span class="n">screen</span><span class="p">)</span>
+<span class="nv">$</span> <span class="nv">cd</span> <span class="sr">/home/</span><span class="n">wookie</span><span class="o">/</span>
+<span class="nv">$</span> <span class="nv">sudo</span> <span class="o">./</span><span class="n">start</span><span class="o">-</span><span class="n">trunk</span><span class="o">.</span><span class="n">sh</span>
+</pre></div>
+
+
+<p>Once running, hitting '<ctrl-a> d' will exit the screen leaving it running. You are then back to a normal shell prompt where you can start the tomcat/mysql version of the demo:</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">sudo</span> <span class="o">./</span><span class="n">start</span><span class="o">-</span><span class="n">trunk</span><span class="o">-</span><span class="n">tc</span><span class="o">.</span><span class="n">sh</span>
+</pre></div>
+
+
+<p>It could be the case that Tomcat is not running, in which case the tomcat/mysql demo will still fail, so start Tomcat:</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">cd</span> <span class="sr">/usr/</span><span class="nb">local</span><span class="sr">/apache-tomcat-6.0.26/</span><span class="n">bin</span>
+<span class="nv">$</span> <span class="nv">sudo</span> <span class="o">./</span><span class="n">startup</span><span class="o">.</span><span class="n">sh</span> <span class="o">&</span>
+</pre></div>
+
+
+<h2 id="updating-the-demos">Updating the Demos</h2>
+<p>For the demo servers to continue to be relevent and useful, they should be updated to use the latest code from trunk. Normally this is fairly straight forward and can be a mostly automatic process. In our case we are running two of the same demo on the same server, one of them using code not standard to what is considered the default configuration.</p>
+<p>So, until things change, updating from trunk is a manual process, made slightly easier with a script that alters our code for us. (Can I suggest someone check and update the checkouts at least once a month)</p>
+<h3 id="updating-the-standard-jettyderby-port-8080-demo">Updating the standard jetty/derby port 8080 demo.</h3>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">screen</span> <span class="o">-</span><span class="n">r</span> <span class="p">(</span><span class="ow">or</span> <span class="s">'screen -x $pid'</span> <span class="n">to</span> <span class="nb">join</span> <span class="n">another</span> <span class="n">users</span> <span class="n">already</span> <span class="n">running</span> <span class="n">screen</span> <span class="n">session</span><span class="p">)</span>
+<span class="nv">$</span> <span class="err"><</span><span class="nv">ctrl</span><span class="o">-</span><span class="n">c</span><span class="o">></span> <span class="p">(</span><span class="n">to</span> <span class="n">stop</span> <span class="n">the</span> <span class="n">current</span> <span class="n">running</span> <span class="n">demo</span><span class="p">)</span>
+<span class="nv">$</span> <span class="nv">sudo</span> <span class="n">su</span> <span class="o">-</span><span class="n">l</span> <span class="n">wookie</span> <span class="o">-</span><span class="n">p</span> <span class="p">(</span><span class="nb">log</span> <span class="n">in</span> <span class="n">as</span> <span class="n">the</span> <span class="s">'wookie'</span> <span class="n">user</span> <span class="k">for</span> <span class="n">updating</span> <span class="n">svn</span><span class="p">)</span>
+<span class="nv">$</span> <span class="nv">cd</span> <span class="sr">/home/</span><span class="n">wookie</span><span class="o">/</span><span class="n">trunk</span>
+<span class="nv">$</span> <span class="nv">svn</span> <span class="n">up</span>
+<span class="nv">$</span> <span class="nv">exit</span> <span class="p">(</span><span class="n">to</span> <span class="nb">exit</span> <span class="n">the</span> <span class="n">wookie</span> <span class="n">user</span> <span class="ow">and</span> <span class="k">return</span> <span class="n">to</span> <span class="n">your</span> <span class="n">normal</span> <span class="n">shell</span><span class="p">)</span>
+<span class="nv">$</span> <span class="nv">cd</span> <span class="sr">/home/</span><span class="n">wookie</span>
+<span class="nv">$</span> <span class="nv">sudo</span> <span class="o">./</span><span class="n">start</span><span class="o">-</span><span class="n">trunk</span><span class="o">.</span><span class="n">sh</span>
+<span class="nv">$</span> <span class="err"><</span><span class="nv">ctrl</span><span class="o">-</span><span class="n">a</span><span class="o">></span> <span class="n">d</span> <span class="p">(</span><span class="n">to</span> <span class="nb">exit</span> <span class="n">screen</span> <span class="n">session</span> <span class="n">with</span> <span class="n">demo</span> <span class="n">now</span> <span class="n">running</span> <span class="n">using</span> <span class="n">latest</span> <span class="n">svn</span> <span class="n">code</span><span class="p">)</span>
+</pre></div>
+
+
+<h3 id="updating-the-altered-tomcat6mysql5-port-8090-demo">Updating the altered Tomcat6/MySQL5 port 8090 demo.</h3>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">cd</span> <span class="sr">/usr/</span><span class="nb">local</span><span class="sr">/apache-tomcat-6.0.26/</span><span class="n">bin</span>
+<span class="nv">$</span> <span class="nv">sudo</span> <span class="o">./</span><span class="nb">shutdown</span><span class="o">.</span><span class="n">sh</span> <span class="p">(</span><span class="n">stop</span> <span class="n">the</span> <span class="n">current</span> <span class="n">running</span> <span class="n">deployed</span> <span class="n">demo</span><span class="p">)</span>
+<span class="nv">$</span> <span class="nv">sudo</span> <span class="n">su</span> <span class="o">-</span><span class="n">l</span> <span class="n">wookie</span> <span class="o">-</span><span class="n">p</span> <span class="p">(</span><span class="nb">log</span> <span class="n">in</span> <span class="n">as</span> <span class="n">the</span> <span class="s">'wookie'</span> <span class="n">user</span> <span class="k">for</span> <span class="n">updating</span> <span class="n">svn</span><span class="p">)</span>
+<span class="nv">$</span> <span class="nv">cd</span> <span class="sr">/home/</span><span class="n">wookie</span><span class="o">/</span><span class="n">trunk</span><span class="o">-</span><span class="n">tc</span>
+<span class="nv">$</span> <span class="nv">svn</span> <span class="n">up</span>
+<span class="nv">$</span> <span class="nv">exit</span> <span class="p">(</span><span class="n">to</span> <span class="nb">exit</span> <span class="n">the</span> <span class="n">wookie</span> <span class="n">user</span> <span class="ow">and</span> <span class="k">return</span> <span class="n">to</span> <span class="n">your</span> <span class="n">normal</span> <span class="n">shell</span><span class="p">)</span>
+<span class="nv">$</span> <span class="nv">cd</span> <span class="sr">/home/</span><span class="n">wookie</span>
+<span class="nv">$</span> <span class="nv">sudo</span> <span class="o">./</span><span class="n">trunk</span><span class="o">-</span><span class="n">tc</span><span class="o">-</span><span class="n">prepare</span><span class="o">.</span><span class="n">sh</span> <span class="p">(</span><span class="n">See</span> <span class="n">Enabling</span> <span class="n">MySQL</span> <span class="n">section</span> <span class="n">below</span> <span class="k">for</span> <span class="n">more</span><span class="p">)</span>
+<span class="nv">$</span> <span class="nv">sudo</span> <span class="o">./</span><span class="n">start</span><span class="o">-</span><span class="n">trunk</span><span class="o">-</span><span class="n">tc</span><span class="o">.</span><span class="n">sh</span> <span class="p">(</span><span class="n">Runs</span> <span class="n">the</span> <span class="n">deploy</span><span class="o">-</span><span class="n">webapp</span> <span class="n">target</span> <span class="n">ready</span> <span class="k">for</span> <span class="n">Tomcat</span><span class="p">)</span>
+<span class="nv">$</span> <span class="nv">cd</span> <span class="sr">/usr/</span><span class="nb">local</span><span class="sr">/apache-tomcat-6.0.26/</span><span class="n">bin</span>
+<span class="nv">$</span> <span class="nv">sudo</span> <span class="o">./</span><span class="n">startup</span><span class="o">.</span><span class="n">sh</span> <span class="o">&</span> <span class="p">(</span><span class="n">Start</span> <span class="n">Tomcat6</span><span class="p">,</span> <span class="n">demo</span> <span class="n">should</span> <span class="n">now</span> <span class="n">be</span> <span class="n">available</span> <span class="n">at</span> <span class="n">port</span> <span class="mi">8090</span><span class="p">)</span>
+</pre></div>
+
+
+<h2 id="enabling-mysql-for-the-tomcatmysql-demo">Enabling MySQL for the Tomcat/MySQL Demo</h2>
+<p>There is a database already configured for the demo, it uses the default database name of 'widgetdb' but it does not use the default username/password pairs provided in the trunk code. The trunk code also has the MySQL lines commented out by default, so we need to enable them.</p>
+<p>We have a script in /home/wookie/trunk-tc-prepare.sh that does this for us , you should only run this script after doing an 'svn up' on the trunk. It alters the file 'build.properties' - if for some reason this file itself has changed and an 'svn up' is performed there may be svn conflicts to cure, best thing to do is just delete the file, run svn up again and then run the trunk-tc-prepare.sh script to get the values we need. (If you know the file is untouched then no need to run the script!)</p>
+<p>For informational purposes the lines changed in 'build.properties' are</p>
+<p>from:</p>
+<div class="codehilite"><pre><span class="c1">#wookie.persistence.manager.type=jpa</span>
+<span class="c1">#wookie.db.user=java</span>
+<span class="c1">#wookie.db.password=java</span>
+<span class="c1">#wookie.db.driver=com.mysql.jdbc.Driver</span>
+<span class="c1">#wookie.db.uri=jdbc:mysql://localhost:3306/widgetdb</span>
+<span class="c1">#wookie.db.type=mysql</span>
+<span class="c1">#jdbc.driver.path=../mysql-connector-java-5.1.7.jar</span>
+<span class="o">...</span>
+<span class="n">run</span><span class="o">.</span><span class="n">args</span><span class="o">=</span><span class="s">"port=8080"</span>
+</pre></div>
+
+
+<p>to this:</p>
+<div class="codehilite"><pre><span class="n">wookie</span><span class="o">.</span><span class="n">persistence</span><span class="o">.</span><span class="n">manager</span><span class="o">.</span><span class="n">type</span><span class="o">=</span><span class="n">jpa</span>
+<span class="n">wookie</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">user</span><span class="o">=</span><span class="n">notthedefaultusername</span>
+<span class="n">wookie</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">password</span><span class="o">=</span><span class="n">notthedefaultpassword</span>
+<span class="n">wookie</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">driver</span><span class="o">=</span><span class="n">com</span><span class="o">.</span><span class="n">mysql</span><span class="o">.</span><span class="n">jdbc</span><span class="o">.</span><span class="n">Driver</span>
+<span class="n">wookie</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">uri</span><span class="o">=</span><span class="n">jdbc:mysql:</span><span class="sr">//</span><span class="n">localhost:3306</span><span class="o">/</span><span class="n">widgetdb</span>
+<span class="n">wookie</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">type</span><span class="o">=</span><span class="n">mysql</span>
+<span class="n">jdbc</span><span class="o">.</span><span class="n">driver</span><span class="o">.</span><span class="n">path</span><span class="o">=../</span><span class="n">mysql</span><span class="o">-</span><span class="n">connector</span><span class="o">-</span><span class="n">java</span><span class="o">-</span><span class="mf">5.1.13</span><span class="o">.</span><span class="n">jar</span>
+<span class="o">...</span>
+<span class="n">run</span><span class="o">.</span><span class="n">args</span><span class="o">=</span><span class="s">"port=8090"</span>
+</pre></div>
+
+
+<p>There is of course a nice /home/wookie/trunk/readme.txt which details some of this already, if things do not work as expected after updating the checkouts is perhaps to look there and see if things have changed. I fully expect at some point my start and update scripts will become out of date at some point in the future (they have already before).</p>
+<p>Wookie committers - if you see this demo admin instruction page start to become outdated, please feel free to update it. Also, any Wookie committers that would like to help maintain the demo server, please file an INFRA jira issue and request an account and you will get one.</p>
+<h2 id="updatingmaintaining-the-server">Updating/Maintaining the Server.</h2>
+<p>The server itself is a Virtual Machine (VM) housed on Nyx our main VMWare Server. The VM, like any other machine, needs to be maintained to keep up to date with the latest software and security fixes. This is left to the PMC to handle (in the case of VMs) so please try and perform checks at least once a month. (You can always open a Jira INFRA issue if you run into problems or you would like a snapshot of the VM taken first so you can rollback in case of trouble.)</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">update</span>
+<span class="nv">$</span> <span class="nv">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">upgrade</span>
+</pre></div>
+
+
+<p>When new kernel versions etc come out, update with:</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">dist</span><span class="o">-</span><span class="n">upgrade</span>
+<span class="nv">$</span> <span class="nv">sudo</span> <span class="n">reboot</span>
+</pre></div>
+
+
+<p>When a new Ubuntu release comes out (usually October and April)</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">sudo</span> <span class="k">do</span><span class="o">-</span><span class="n">release</span><span class="o">-</span><span class="n">upgrade</span>
+</pre></div>
+
+
+<p>Contribs Welcome.</p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2011-2012 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/wookie/trunk/content/docs/develop.html
==============================================================================
--- websites/staging/wookie/trunk/content/docs/develop.html (added)
+++ websites/staging/wookie/trunk/content/docs/develop.html Tue Nov 27 09:54:44 2012
@@ -0,0 +1,176 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/wookie/css/wookie.css" rel="stylesheet" type="text/css">
+ <link href="/wookie/css/code.css" rel="stylesheet" type="text/css">
+ <title>Apache Wookie (Incubating) - Developing Apache Wookie</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
+<body>
+ <div id="banner">
+ <img alt="Apache Wookie (Incubating)" src="/wookie/images/logo.png"/>
+ <h1 class="title">Developing Apache Wookie</h1>
+ </div>
+
+ <div id="navigation">
+ <h1 id="general">General</h1>
+<ul>
+<li><a href="/wookie/index.html">Home</a></li>
+<li><a href="/wookie/news.html">News</a></li>
+<li><a href="/wookie/docs/download.html">Download</a></li>
+<li><a href="http://incubator.apache.org/projects/wookie.html">Incubator page</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="documentation">Documentation</h1>
+<ul>
+<li><a href="/wookie/docs/download.html">Download and Quickstart</a></li>
+<li><a href="/wookie/docs/admin.html">Server Admin</a></li>
+<li><a href="/wookie/docs/embedding.html">Embedding</a></li>
+<li><a href="/wookie/docs/shindig.html">Integrating with Shindig</a></li>
+<li><a href="/wookie/docs/widgets.html">Building widgets</a></li>
+<li><a href="/wookie/docs/faq.html">FAQ</a></li>
+<li><a href="/wookie/docs/api.html">API Reference</a></li>
+</ul>
+<h1 id="community">Community</h1>
+<ul>
+<li><a href="/wookie/get-involved.html">Get Involved</a></li>
+<li><a href="/wookie/mailing-lists.html">Mailing Lists</a></li>
+<li><a href="/wookie/people.html">People</a></li>
+</ul>
+<h1 id="development">Development</h1>
+<ul>
+<li><a href="/wookie/docs/source.html">Getting Started</a></li>
+<li><a href="/wookie/docs/developer/running.html">Running</a></li>
+<li><a href="/wookie/docs/templates.html">Widget Templates</a></li>
+<li><a href="/wookie/docs/developer/features.html">Extension Features</a></li>
+<li><a href="/wookie/docs/developer/widgets.html">Deploying Widgets</a></li>
+<li><a href="/wookie/docs/develop.html">Environment</a></li>
+<li><a href="/wookie/docs/developer/release-management.html">Release Management</a></li>
+<li><a href="/wookie/docs/developer/issues.html">Issue Tracker</a></li>
+<li><a href="/wookie/docs/developer/index.html">Management</a></li>
+<li><a href="/wookie/docs/developer/parser.html">W3C Widget Parser</a></li>
+</ul>
+<h1 id="asf">ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <p>We strongly encourage you to participate in the development of Apache Wookie. We need help
+in all areas, not just code development, so don't be afraid to join our mailing list and
+get busy. This page describes some the common workflows for developers, hopefully you are not a
+developer and will help us document workflows for non-developer contributors.</p>
+<h1 id="code-development">Code Development</h1>
+<p>The first thing you need to do is get a copy of the <a href="source.html">source code</a>, once you have the
+code this page will help you set up your development environment.</p>
+<p>Since you will be working as part of a heterogeneous development community we need to ensure that all of us
+the code in our repositories is formatted in a consistent and manageable way. You are free to use whatever
+development environment you prefer but please configure it as follows.</p>
+<h2 id="subversion-eol-style">Subversion EOL Style</h2>
+<p>We provide a configuration file for <a href="http://www.apache.org/dev/svn-eol-style.txt">SVN EOL Style</a>.</p>
+<p>The contents of this file need to be added to the bottom of your Subversion config file.</p>
+<p>On Linux based systems this is in ~/.subversion/config</p>
+<p>On Windows this is normally found at C:\Documents and Settings{username}\Application Data\Subversion\config</p>
+<h2 id="debugging">Debugging</h2>
+<p>You can start Wookie in debug mode using JDSPA with the following command:</p>
+<div class="codehilite"><pre><span class="n">ant</span> <span class="o">-</span><span class="n">Djvmargs</span><span class="o">=</span><span class="s">"-Xdebug -Xrunjdwp:transport=dt_socket,address=8001,server=y,suspend=n"</span> <span class="n">run</span>
+</pre></div>
+
+
+<p>Once Wookie is running in debug mode you need to connect to it using your chosen debugger.</p>
+<h2 id="eclipse">Eclipse</h2>
+<p>This section describes specific configuration for using Eclipse to develop Wookie.</p>
+<h3 id="subclipse">Subclipse</h3>
+<p>Subclipse is an Eclipse plugin that allows you to use Subversoin easily. Install it from the Subclipse <a href="http://subclipse.tigris.org/update_1.6.x">update site</a>.</p>
+<h3 id="ivyde">IvyDE</h3>
+<p>We use Apache Ivy for dependency management. In order to compile Wookie in eclipse you need to install IvyDE which you can get from its <a href="http://www.apache.org/dist/ant/ivyde/updatesite">update site</a>.</p>
+<p>Once installed you will need to set the correct ivysettings path for Wookie:</p>
+<ul>
+<li>Right click on wookie project</li>
+<li>Select "Build Path -> COnfigur Build Path..."</li>
+<li>Select "Libraries" tab</li>
+<li>Select "ivy.xml"</li>
+<li>Click "Edit"</li>
+<li>Select "Settings" tab</li>
+<li>Click "Enable project specific settings"</li>
+<li>Under "Ivy settings path" click "Workspace..."</li>
+<li>Select "wookie -> ant -> ivysettings.xml"</li>
+<li>Under "Properties file" click "Workspace..."</li>
+<li>Select "wookie -> build.properties"</li>
+<li>Click "Finish"</li>
+<li>Cick "Ok"</li>
+</ul>
+<h3 id="code-style-and-templates">Code Style and Templates</h3>
+<p>In Eclipse:</p>
+<ul>
+<li>choose Window -> Preferences -> Java -> Code Style -> Formatter. Select "Import" and choose the file in
+/etc/eclipse/code_style.xml</li>
+<li>choose Window -> Preferences -> Java -> Code Style -> Templates. Select "Import" and choose the file in
+/etc/eclipse/code_templates.xml</li>
+</ul>
+<h3 id="debugging-in-eclipse">Debugging in Eclipse</h3>
+<p>To connect Eclipse to Wookie running in debug mode on your local machine you would:</p>
+<div class="codehilite"><pre><span class="n">Run</span> <span class="o">-></span> <span class="n">Debug</span> <span class="n">Configurations</span><span class="o">...</span>
+</pre></div>
+
+
+<p>Select "Remote Java Application"</p>
+<p>Click "New Launch Configuration"</p>
+<p>Set as follows:</p>
+<div class="codehilite"><pre><span class="err">Name:</span> <span class="err">Wookie</span> <span class="err">Debug</span> <span class="err">(Localhost)</span>
+<span class="err">Project:</span> <span class="err">Click</span> <span class="err">"Browse"</span> <span class="err">and</span> <span class="err">select</span> <span class="err">your</span> <span class="err">Wookie</span> <span class="err">project</span>
+<span class="err">PORT:</span> <span class="err">8001</span>
+</pre></div>
+
+
+<p>Now click the "Debug" button (note you must be running Wookie in debug mode,
+see above, first).</p>
+<p>You can now set breakpoints etc. as if you were running from within Eclipse.</p>
+<p>Once you have set up this "debug configuration" you can quickly access it from
+your debug menu.</p>
+<p>For more on remote debugging with Eclipse see the <a href="http://www.eclipsezone.com/eclipse/forums/t53459.html">Eclipse documentation</a></p>
+<h2 id="miscellaneous">Miscellaneous</h2>
+<p>This section includes some additional notes that might be useful to some developers.</p>
+<h3 id="bug-in-subversion-16-on-gnome">Bug in Subversion 1.6 on GNOME</h3>
+<p>There is currently a bug in the new support for GNOME keyring in Subversion 1.6. It works OK when using the
+command line, but not when other users of the libraries use it, such as Subclipse. You can
+find more information on the <a href="http://subclipse.tigris.org/wiki/JavaHL#head-3a1d2d3c54791d2d751794e5d6645f1d77d95b32">Subclipse</a>
+site, which also documents a workaround.</p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2011-2012 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/wookie/trunk/content/docs/developer/features.html
==============================================================================
--- websites/staging/wookie/trunk/content/docs/developer/features.html (added)
+++ websites/staging/wookie/trunk/content/docs/developer/features.html Tue Nov 27 09:54:44 2012
@@ -0,0 +1,151 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/wookie/css/wookie.css" rel="stylesheet" type="text/css">
+ <link href="/wookie/css/code.css" rel="stylesheet" type="text/css">
+ <title>Apache Wookie (Incubating) - Features</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
+<body>
+ <div id="banner">
+ <img alt="Apache Wookie (Incubating)" src="/wookie/images/logo.png"/>
+ <h1 class="title">Features</h1>
+ </div>
+
+ <div id="navigation">
+ <h1 id="general">General</h1>
+<ul>
+<li><a href="/wookie/index.html">Home</a></li>
+<li><a href="/wookie/news.html">News</a></li>
+<li><a href="/wookie/docs/download.html">Download</a></li>
+<li><a href="http://incubator.apache.org/projects/wookie.html">Incubator page</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="documentation">Documentation</h1>
+<ul>
+<li><a href="/wookie/docs/download.html">Download and Quickstart</a></li>
+<li><a href="/wookie/docs/admin.html">Server Admin</a></li>
+<li><a href="/wookie/docs/embedding.html">Embedding</a></li>
+<li><a href="/wookie/docs/shindig.html">Integrating with Shindig</a></li>
+<li><a href="/wookie/docs/widgets.html">Building widgets</a></li>
+<li><a href="/wookie/docs/faq.html">FAQ</a></li>
+<li><a href="/wookie/docs/api.html">API Reference</a></li>
+</ul>
+<h1 id="community">Community</h1>
+<ul>
+<li><a href="/wookie/get-involved.html">Get Involved</a></li>
+<li><a href="/wookie/mailing-lists.html">Mailing Lists</a></li>
+<li><a href="/wookie/people.html">People</a></li>
+</ul>
+<h1 id="development">Development</h1>
+<ul>
+<li><a href="/wookie/docs/source.html">Getting Started</a></li>
+<li><a href="/wookie/docs/developer/running.html">Running</a></li>
+<li><a href="/wookie/docs/templates.html">Widget Templates</a></li>
+<li><a href="/wookie/docs/developer/features.html">Extension Features</a></li>
+<li><a href="/wookie/docs/developer/widgets.html">Deploying Widgets</a></li>
+<li><a href="/wookie/docs/develop.html">Environment</a></li>
+<li><a href="/wookie/docs/developer/release-management.html">Release Management</a></li>
+<li><a href="/wookie/docs/developer/issues.html">Issue Tracker</a></li>
+<li><a href="/wookie/docs/developer/index.html">Management</a></li>
+<li><a href="/wookie/docs/developer/parser.html">W3C Widget Parser</a></li>
+</ul>
+<h1 id="asf">ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <p>Features are used to add extra capability to Wookie widgets at runtime.
+Features typically inject scripts and stylesheets into widgets when they are
+viewed in the browser, for example to give access to a particular API or
+feature. Using features in your widgets will make them less portable across
+different platforms, so use them with care and, wherever possible, ensure your
+widgets degrade gracefully when an optional feature is not available.</p>
+<h1 id="using-features">Using features</h1>
+<p>A feature is enabled in a widget by adding a <a href="http://www.w3.org/TR/widgets/#the-feature-element-and-its-attributes"><feature...></a> element to the
+widgets config.xml file.</p>
+<h1 id="available-features">Available features</h1>
+<p>Wookie provides a number of features out of the box. These include:</p>
+<ul>
+<li>camera - provides basic BONDI API access to a camera (<a href="http://svn.apache.org/repos/asf/incubator/wookie/trunk/widgets/camera/">camera</a> example)</li>
+<li>jqmobile - provides JQuery Mobile (<a href="http://svn.apache.org/repos/asf/incubator/wookie/trunk/widgets/widget-template/jqueryMobile/">seed-widget</a> example)</li>
+<li><a href="features/oauth.html">oauth</a> - provides an OAuth library (<a href="http://svn.apache.org/repos/asf/incubator/wookie/trunk/scratchpad/widgets/fbfriend/">Facebook</a> example, <a href="features/oauth.html">documentation</a>)</li>
+<li>polling</li>
+<li>wave - an implementation of the <a href="http://svn.apache.org/repos/asf/incubator/wookie/trunk/features/wave/README">Wave Gadget API</a> (<a href="http://svn.apache.org/repos/asf/incubator/wookie/trunk/widgets/natter/">Chat widget</a> example)</li>
+<li>wookie-ext - Wookie Extensions API</li>
+</ul>
+<h1 id="create-a-feature">Create a feature</h1>
+<ol>
+<li>Create a new directory in the Wookie /features directory for your feature</li>
+<li>Create any JavaScript (.js) or Stylesheet (.css) files you need in this directory</li>
+<li>Create a file called features.xml with the structure defined below.</li>
+</ol>
+<h2 id="featuresxml">Features.xml</h2>
+<p>A features.xml file must have <code><feature></code> as its root element, must contain a single <code><name></code> child element, and can have any number of <code><script></code> and <code><stylesheet></code> child elements.</p>
+<p>The <code><name></code> element should contain an IRI identifying the feature - this is used to match against the <code><feature></code> element found in a widget's config.xml file.</p>
+<p>The <code><script></code> and <code><stylesheet></code> elements should contain a <code>src</code> attribute with the filename to load. This must be relative to the folder for the feature - typically this is just the filename but you can also store CSS and JS files in subfolders within your feature directory if you wish.</p>
+<h3 id="example-featuresxml">Example features.xml</h3>
+<div class="codehilite"><pre><span class="nt"><feature></span>
+ <span class="nt"><name></span>http://jquerymobile.com<span class="nt"></name></span>
+ <span class="nt"><script</span> <span class="na">src=</span><span class="s">"shared/jquery-1.5.min.js"</span><span class="nt">/></span>
+ <span class="nt"><script</span> <span class="na">src=</span><span class="s">"shared/jquery.mobile-1.0a4-patched.min.js"</span><span class="nt">/></span>
+ <span class="nt"><stylesheet</span> <span class="na">src=</span><span class="s">"shared/jquery.mobile-1.0a4.min.css"</span><span class="nt">/></span>
+<span class="nt"></feature></span>
+</pre></div>
+
+
+<h2 id="installing-features">Installing features</h2>
+<p>By default Wookie will look in its /features directory on launch and load any features it finds.</p>
+<p>(There is currently no way to dynamically load a feature while Wookie is still running)</p>
+<h2 id="configuring-feature-deployment">Configuring feature deployment</h2>
+<p>When you build and deploy Wookie using Ant, the features that are deployed are determined by two properties set in your build.properties file.</p>
+<p>The default configuration looks like this:</p>
+<div class="codehilite"><pre><span class="c1"># Uncomment to include Extra features</span>
+<span class="n">include</span><span class="o">.</span><span class="n">extra</span><span class="o">.</span><span class="n">features</span>
+<span class="c1"># Uncomment to include Scratchpad features</span>
+<span class="c1">#include.scratchpad.features</span>
+</pre></div>
+
+
+<p>If <code>include.extra.features</code> is not commented out, any features in the <code>features</code> directory of the working directory will be deployed. </p>
+<p>If <code>include.scratchpad.features</code> is not commented out, any features in the <code>scratchpad/features</code> directory of the working directory will be deployed. </p>
+<p>If both properties are commented out in build.properties then only the Google Wave Gadget API feature will be installed.</p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2011-2012 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/wookie/trunk/content/docs/developer/features/oauth.html
==============================================================================
--- websites/staging/wookie/trunk/content/docs/developer/features/oauth.html (added)
+++ websites/staging/wookie/trunk/content/docs/developer/features/oauth.html Tue Nov 27 09:54:44 2012
@@ -0,0 +1,119 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/wookie/css/wookie.css" rel="stylesheet" type="text/css">
+ <link href="/wookie/css/code.css" rel="stylesheet" type="text/css">
+ <title>Apache Wookie (Incubating) - OAuth Feature</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
+<body>
+ <div id="banner">
+ <img alt="Apache Wookie (Incubating)" src="/wookie/images/logo.png"/>
+ <h1 class="title">OAuth Feature</h1>
+ </div>
+
+ <div id="navigation">
+ <h1 id="general">General</h1>
+<ul>
+<li><a href="/wookie/index.html">Home</a></li>
+<li><a href="/wookie/news.html">News</a></li>
+<li><a href="/wookie/docs/download.html">Download</a></li>
+<li><a href="http://incubator.apache.org/projects/wookie.html">Incubator page</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="documentation">Documentation</h1>
+<ul>
+<li><a href="/wookie/docs/download.html">Download and Quickstart</a></li>
+<li><a href="/wookie/docs/admin.html">Server Admin</a></li>
+<li><a href="/wookie/docs/embedding.html">Embedding</a></li>
+<li><a href="/wookie/docs/shindig.html">Integrating with Shindig</a></li>
+<li><a href="/wookie/docs/widgets.html">Building widgets</a></li>
+<li><a href="/wookie/docs/faq.html">FAQ</a></li>
+<li><a href="/wookie/docs/api.html">API Reference</a></li>
+</ul>
+<h1 id="community">Community</h1>
+<ul>
+<li><a href="/wookie/get-involved.html">Get Involved</a></li>
+<li><a href="/wookie/mailing-lists.html">Mailing Lists</a></li>
+<li><a href="/wookie/people.html">People</a></li>
+</ul>
+<h1 id="development">Development</h1>
+<ul>
+<li><a href="/wookie/docs/source.html">Getting Started</a></li>
+<li><a href="/wookie/docs/developer/running.html">Running</a></li>
+<li><a href="/wookie/docs/templates.html">Widget Templates</a></li>
+<li><a href="/wookie/docs/developer/features.html">Extension Features</a></li>
+<li><a href="/wookie/docs/developer/widgets.html">Deploying Widgets</a></li>
+<li><a href="/wookie/docs/develop.html">Environment</a></li>
+<li><a href="/wookie/docs/developer/release-management.html">Release Management</a></li>
+<li><a href="/wookie/docs/developer/issues.html">Issue Tracker</a></li>
+<li><a href="/wookie/docs/developer/index.html">Management</a></li>
+<li><a href="/wookie/docs/developer/parser.html">W3C Widget Parser</a></li>
+</ul>
+<h1 id="asf">ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <p>The OAuth feature provides an OAuth library for use in your widgets.</p>
+<p>You can see an example of it in action in the fbfriend widget which
+connects to <a href="http://svn.apache.org/repos/asf/incubator/wookie/trunk/scratchpad/widgets/fbfriend/">Facebook</a>.</p>
+<p>Steps to create a widget connecting to oauthed services: </p>
+<ul>
+<li>Create a widget (for example with "ant seed-widget")</li>
+<li>Add the oauth feature into widget config.xml (<a href="http://svn.apache.org/repos/asf/incubator/wookie/trunk/scratchpad/widgets/fbfriend/config.xml">example</a>)
+ with the following parameters: <ul>
+<li>clientId: your client id issued by authorization endpoint from oauthed service side </li>
+<li>authzServer: url of authorization endpoint </li>
+<li>scope: scope of token issued </li>
+<li>e.g. </li>
+</ul>
+</li>
+<li>To make call to oauthed service, <ol>
+<li>We obtain an access token by calling to oauth.authenticate() </li>
+<li>Then using calling oauth.proxify(service_url) in which url
+ is the url of the oauthed service, by calling this function,
+ access token will be automatically added to the request. </li>
+</ol>
+</li>
+<li>To remove token from database, make call to oauth.invalidateToken()</li>
+</ul>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2011-2012 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/wookie/trunk/content/docs/developer/index.html
==============================================================================
--- websites/staging/wookie/trunk/content/docs/developer/index.html (added)
+++ websites/staging/wookie/trunk/content/docs/developer/index.html Tue Nov 27 09:54:44 2012
@@ -0,0 +1,102 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/wookie/css/wookie.css" rel="stylesheet" type="text/css">
+ <link href="/wookie/css/code.css" rel="stylesheet" type="text/css">
+ <title>Apache Wookie (Incubating) - Developer Documentation Index</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
+<body>
+ <div id="banner">
+ <img alt="Apache Wookie (Incubating)" src="/wookie/images/logo.png"/>
+ <h1 class="title">Developer Documentation Index</h1>
+ </div>
+
+ <div id="navigation">
+ <h1 id="general">General</h1>
+<ul>
+<li><a href="/wookie/index.html">Home</a></li>
+<li><a href="/wookie/news.html">News</a></li>
+<li><a href="/wookie/docs/download.html">Download</a></li>
+<li><a href="http://incubator.apache.org/projects/wookie.html">Incubator page</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="documentation">Documentation</h1>
+<ul>
+<li><a href="/wookie/docs/download.html">Download and Quickstart</a></li>
+<li><a href="/wookie/docs/admin.html">Server Admin</a></li>
+<li><a href="/wookie/docs/embedding.html">Embedding</a></li>
+<li><a href="/wookie/docs/shindig.html">Integrating with Shindig</a></li>
+<li><a href="/wookie/docs/widgets.html">Building widgets</a></li>
+<li><a href="/wookie/docs/faq.html">FAQ</a></li>
+<li><a href="/wookie/docs/api.html">API Reference</a></li>
+</ul>
+<h1 id="community">Community</h1>
+<ul>
+<li><a href="/wookie/get-involved.html">Get Involved</a></li>
+<li><a href="/wookie/mailing-lists.html">Mailing Lists</a></li>
+<li><a href="/wookie/people.html">People</a></li>
+</ul>
+<h1 id="development">Development</h1>
+<ul>
+<li><a href="/wookie/docs/source.html">Getting Started</a></li>
+<li><a href="/wookie/docs/developer/running.html">Running</a></li>
+<li><a href="/wookie/docs/templates.html">Widget Templates</a></li>
+<li><a href="/wookie/docs/developer/features.html">Extension Features</a></li>
+<li><a href="/wookie/docs/developer/widgets.html">Deploying Widgets</a></li>
+<li><a href="/wookie/docs/develop.html">Environment</a></li>
+<li><a href="/wookie/docs/developer/release-management.html">Release Management</a></li>
+<li><a href="/wookie/docs/developer/issues.html">Issue Tracker</a></li>
+<li><a href="/wookie/docs/developer/index.html">Management</a></li>
+<li><a href="/wookie/docs/developer/parser.html">W3C Widget Parser</a></li>
+</ul>
+<h1 id="asf">ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <p>This section of the site contains documentation specifically for the development team of Apache Wookie (Incubating).</p>
+<ul>
+<li><a href="/wookie/docs/download.html">Source Code</a></li>
+<li><a href="https://issues.apache.org/jira/browse/WOOKIE">Issue Tracker</a></li>
+<li><a href="release-management.html">Release processes</a>. This describes how to go about making a release</li>
+</ul>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2011-2012 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/wookie/trunk/content/docs/developer/issues.html
==============================================================================
--- websites/staging/wookie/trunk/content/docs/developer/issues.html (added)
+++ websites/staging/wookie/trunk/content/docs/developer/issues.html Tue Nov 27 09:54:44 2012
@@ -0,0 +1,153 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/wookie/css/wookie.css" rel="stylesheet" type="text/css">
+ <link href="/wookie/css/code.css" rel="stylesheet" type="text/css">
+ <title>Apache Wookie (Incubating) - Issue Tracking</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
+<body>
+ <div id="banner">
+ <img alt="Apache Wookie (Incubating)" src="/wookie/images/logo.png"/>
+ <h1 class="title">Issue Tracking</h1>
+ </div>
+
+ <div id="navigation">
+ <h1 id="general">General</h1>
+<ul>
+<li><a href="/wookie/index.html">Home</a></li>
+<li><a href="/wookie/news.html">News</a></li>
+<li><a href="/wookie/docs/download.html">Download</a></li>
+<li><a href="http://incubator.apache.org/projects/wookie.html">Incubator page</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="documentation">Documentation</h1>
+<ul>
+<li><a href="/wookie/docs/download.html">Download and Quickstart</a></li>
+<li><a href="/wookie/docs/admin.html">Server Admin</a></li>
+<li><a href="/wookie/docs/embedding.html">Embedding</a></li>
+<li><a href="/wookie/docs/shindig.html">Integrating with Shindig</a></li>
+<li><a href="/wookie/docs/widgets.html">Building widgets</a></li>
+<li><a href="/wookie/docs/faq.html">FAQ</a></li>
+<li><a href="/wookie/docs/api.html">API Reference</a></li>
+</ul>
+<h1 id="community">Community</h1>
+<ul>
+<li><a href="/wookie/get-involved.html">Get Involved</a></li>
+<li><a href="/wookie/mailing-lists.html">Mailing Lists</a></li>
+<li><a href="/wookie/people.html">People</a></li>
+</ul>
+<h1 id="development">Development</h1>
+<ul>
+<li><a href="/wookie/docs/source.html">Getting Started</a></li>
+<li><a href="/wookie/docs/developer/running.html">Running</a></li>
+<li><a href="/wookie/docs/templates.html">Widget Templates</a></li>
+<li><a href="/wookie/docs/developer/features.html">Extension Features</a></li>
+<li><a href="/wookie/docs/developer/widgets.html">Deploying Widgets</a></li>
+<li><a href="/wookie/docs/develop.html">Environment</a></li>
+<li><a href="/wookie/docs/developer/release-management.html">Release Management</a></li>
+<li><a href="/wookie/docs/developer/issues.html">Issue Tracker</a></li>
+<li><a href="/wookie/docs/developer/index.html">Management</a></li>
+<li><a href="/wookie/docs/developer/parser.html">W3C Widget Parser</a></li>
+</ul>
+<h1 id="asf">ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <p>We welcome feature requests and bug reports via our <a href="http://issues.apache.org/jira/browse/WOOKIE">issue tracker</a>.</p>
+<h1 id="issue-planning-status">Issue Planning Status</h1>
+<p>We use JIRA for tracking our issues. Here are some useful views on the current status of the project:</p>
+<ul>
+<li><a href="https://issues.apache.org/jira/browse/WOOKIE">Issues home</a></li>
+<li><a href="https://issues.apache.org/jira/browse/WOOKIE?report=com.atlassian.jira.plugin.system.project:roadmap-panel">Roadmap</a></li>
+</ul>
+<h1 id="issue-tracking-workflow">Issue Tracking Workflow</h1>
+<p>For most issues we follow the following general workflow:</p>
+<ol>
+<li>Reported</li>
+<li>Reviewed</li>
+<li>In Progress<ol>
+<li>Review-Then-Commit patch reviews (non-committers)</li>
+<li>Commit-Then-Review patch reviews (committers)</li>
+</ol>
+</li>
+<li>Closed</li>
+<li>Resolved (Verified)</li>
+</ol>
+<p>In each of these states various actions are possible, such as submitting patches for review, providing comment, logging work or editing fix versions</p>
+<h1 id="detailed-workflow">Detailed Workflow</h1>
+<p>More specifically the possible transitions between states are:</p>
+<ul>
+<li>Issue is reported by user</li>
+<li>Issue is reviewed by a committer, with one of the following outcomes:<ul>
+<li>Issue is accepted</li>
+<li>Accepted issues will usually be scheduled for a fix version, although some issues may be accepted as valid issues, but still be deemed out of scope for the current development team. In which case the fix version will be left as "Unknown".</li>
+<li>More information is requested</li>
+<li>If the comitter is not able to understand the full issue they will add a comment and ask the submitter for more information</li>
+<li>Reject the issue</li>
+</ul>
+</li>
+<li>If the issue is deemed as invalid for some reason the reviewer will indicate this to be the case and will close the issue</li>
+<li>Issues that have been accepted can have one of the following actions on them:<ul>
+<li>work may be started by a contributor</li>
+<li>a patch can be marked for review</li>
+<li>they may be closed</li>
+</ul>
+</li>
+<li>An issue in which work has started has the following actions:<ul>
+<li>a patch can be marked for review</li>
+<li>more details can be requested from the submitter</li>
+<li>the issue can be closed</li>
+</ul>
+</li>
+<li>An issue awaiting a patch review can have one of the follwing actions:<ul>
+<li>a modification for the patch can be requested</li>
+<li>the patch can be applied, and the issue closed</li>
+</ul>
+</li>
+<li>A closed issue can be either:<ul>
+<li>verified by another committer, thus marking it resolved, or</li>
+<li>rejected by a committer, thus moving it back to the "In Progress" stage</li>
+</ul>
+</li>
+</ul>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2011-2012 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/wookie/trunk/content/docs/developer/parser.html
==============================================================================
--- websites/staging/wookie/trunk/content/docs/developer/parser.html (added)
+++ websites/staging/wookie/trunk/content/docs/developer/parser.html Tue Nov 27 09:54:44 2012
@@ -0,0 +1,186 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/wookie/css/wookie.css" rel="stylesheet" type="text/css">
+ <link href="/wookie/css/code.css" rel="stylesheet" type="text/css">
+ <title>Apache Wookie (Incubating) - Using Wookie's W3C Widget Parser in other Applications</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
+<body>
+ <div id="banner">
+ <img alt="Apache Wookie (Incubating)" src="/wookie/images/logo.png"/>
+ <h1 class="title">Using Wookie's W3C Widget Parser in other Applications</h1>
+ </div>
+
+ <div id="navigation">
+ <h1 id="general">General</h1>
+<ul>
+<li><a href="/wookie/index.html">Home</a></li>
+<li><a href="/wookie/news.html">News</a></li>
+<li><a href="/wookie/docs/download.html">Download</a></li>
+<li><a href="http://incubator.apache.org/projects/wookie.html">Incubator page</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="documentation">Documentation</h1>
+<ul>
+<li><a href="/wookie/docs/download.html">Download and Quickstart</a></li>
+<li><a href="/wookie/docs/admin.html">Server Admin</a></li>
+<li><a href="/wookie/docs/embedding.html">Embedding</a></li>
+<li><a href="/wookie/docs/shindig.html">Integrating with Shindig</a></li>
+<li><a href="/wookie/docs/widgets.html">Building widgets</a></li>
+<li><a href="/wookie/docs/faq.html">FAQ</a></li>
+<li><a href="/wookie/docs/api.html">API Reference</a></li>
+</ul>
+<h1 id="community">Community</h1>
+<ul>
+<li><a href="/wookie/get-involved.html">Get Involved</a></li>
+<li><a href="/wookie/mailing-lists.html">Mailing Lists</a></li>
+<li><a href="/wookie/people.html">People</a></li>
+</ul>
+<h1 id="development">Development</h1>
+<ul>
+<li><a href="/wookie/docs/source.html">Getting Started</a></li>
+<li><a href="/wookie/docs/developer/running.html">Running</a></li>
+<li><a href="/wookie/docs/templates.html">Widget Templates</a></li>
+<li><a href="/wookie/docs/developer/features.html">Extension Features</a></li>
+<li><a href="/wookie/docs/developer/widgets.html">Deploying Widgets</a></li>
+<li><a href="/wookie/docs/develop.html">Environment</a></li>
+<li><a href="/wookie/docs/developer/release-management.html">Release Management</a></li>
+<li><a href="/wookie/docs/developer/issues.html">Issue Tracker</a></li>
+<li><a href="/wookie/docs/developer/index.html">Management</a></li>
+<li><a href="/wookie/docs/developer/parser.html">W3C Widget Parser</a></li>
+</ul>
+<h1 id="asf">ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <p>The code that Wookie uses to parse and unpack W3C Widgets can also be used in other applications and projects as a standalone library. The parser can be found as a sub-project within the "parser/java/" folder in the main Wookie source tree.</p>
+<h1 id="using-the-parser-in-a-maven-project">Using the parser in a Maven project</h1>
+<p>To use the parser with a Maven project, include the following dependency configuration in your project:</p>
+<div class="codehilite"><pre><span class="nt"><dependency></span>
+ <span class="nt"><groupId></span>org.apache.wookie<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>wookie-parser<span class="nt"></artifactId></span>
+ <span class="nt"><type></span>jar<span class="nt"></type></span>
+ <span class="nt"><scope></span>compile<span class="nt"></scope></span>
+ <span class="nt"><version></span>0.10.0-incubating<span class="nt"></version></span>
+<span class="nt"></dependency></span>
+</pre></div>
+
+
+<h1 id="using-the-parser-as-a-jar-download">Using the parser as a jar download</h1>
+<p>If you don't want to use Maven, you can <a href="https://repository.apache.org/content/groups/snapshots/org/apache/wookie/wookie-parser/">download the jar from the Apache repository</a> or use a copy that is distributed in the latest <a href="http://incubator.apache.org/wookie/docs/download.html">Wookie release</a>. Just make sure you also include its dependencies (Jdom, icu4j, slf4j, commons-httpclient, commons-logging, commons-compress, commons-io and commons-lang).</p>
+<h1 id="building-the-parser">Building the parser</h1>
+<p>To build the parser as a standalone .jar, run <code>ant publish-local</code> from within the parser folder; the jar will be saved in <code>parser/dist</code>. Dependencies are described in the ivy.xml file that can also be found in the <code>parser/dist</code> folder.</p>
+<h1 id="using-the-parser">Using the parser</h1>
+<p>The parser is invoked using a <code>W3CWidgetFactory</code> object. This has a number of configuration properties that can be set, and these are described at the bottom of this page. While most of these are optional, to use the factory to parse .wgt files you MUST supply a valid output directory into which the <code>W3CWidgetFactory</code> will unpack the widget.</p>
+<p>For example, a simple program to unpack a .wgt file, and write the name of the widget to the console looks like this:</p>
+<div class="codehilite"><pre><span class="n">public</span> <span class="n">static</span> <span class="n">void</span> <span class="n">main</span><span class="p">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="p">)</span> <span class="p">{</span>
+ <span class="n">File</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="n">File</span><span class="p">(</span><span class="s">"out"</span><span class="p">);</span>
+ <span class="n">File</span> <span class="n">zipFile</span> <span class="o">=</span> <span class="k">new</span> <span class="n">File</span><span class="p">(</span><span class="s">"in/butterfly.wgt"</span><span class="p">);</span>
+
+ <span class="n">W3CWidgetFactory</span> <span class="n">fac</span> <span class="o">=</span> <span class="k">new</span> <span class="n">W3CWidgetFactory</span><span class="p">();</span>
+ <span class="n">fac</span><span class="o">.</span><span class="n">setOutputDirectory</span><span class="p">(</span><span class="n">out</span><span class="o">.</span><span class="n">getAbsolutePath</span><span class="p">());</span>
+ <span class="n">fac</span><span class="o">.</span><span class="n">setLocalPath</span><span class="p">(</span><span class="s">"/out"</span><span class="p">);</span>
+ <span class="n">try</span> <span class="p">{</span>
+ <span class="n">W3CWidget</span> <span class="n">widget</span> <span class="o">=</span> <span class="n">fac</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">zipFile</span><span class="p">);</span>
+ <span class="n">System</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">println</span><span class="p">(</span><span class="n">widget</span><span class="o">.</span><span class="n">getLocalName</span><span class="p">(</span><span class="s">"en"</span><span class="p">));</span>
+ <span class="p">}</span> <span class="n">catch</span> <span class="p">(</span><span class="n">BadWidgetZipFileException</span> <span class="n">e</span><span class="p">)</span> <span class="p">{</span>
+ <span class="n">e</span><span class="o">.</span><span class="n">printStackTrace</span><span class="p">();</span>
+ <span class="p">}</span> <span class="n">catch</span> <span class="p">(</span><span class="n">BadManifestException</span> <span class="n">e</span><span class="p">)</span> <span class="p">{</span>
+ <span class="n">e</span><span class="o">.</span><span class="n">printStackTrace</span><span class="p">();</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>The W3CWidgetFactory can also download and install widgets directly from a URL as well as locally from the file system:</p>
+<div class="codehilite"><pre><span class="n">W3CWidget</span> <span class="n">widget</span> <span class="o">=</span> <span class="n">fac</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="k">new</span> <span class="n">URL</span><span class="p">(</span><span class="s">"http://foo.com/bar.wgt"</span><span class="p">));</span>
+</pre></div>
+
+
+<p>Note that if the widget does not use the application/widget content-type, you should set "ignore content type" to true:</p>
+<div class="codehilite"><pre><span class="n">W3CWidget</span> <span class="n">widget</span> <span class="o">=</span> <span class="n">fac</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="k">new</span> <span class="n">URL</span><span class="p">(</span><span class="s">"http://foo.com/bar.wgt"</span><span class="p">),</span> <span class="n">true</span><span class="p">);</span>
+</pre></div>
+
+
+<h1 id="localized-elements">Localized elements</h1>
+<p>Many of the elements of a W3CWidget object are localized; these elements all implement the <code>ILocalizedElement</code> interface. These elements can be processed using the <code>LocalizationUtils</code> class, which has methods to process these elements based on lists of preferred locales. E.g., to extract the single most preferred Name element for the "fr" locale:</p>
+<div class="codehilite"><pre> <span class="n">INameEntity</span><span class="o">[]</span> <span class="n">names</span> <span class="o">=</span> <span class="n">widget</span><span class="o">.</span><span class="n">getNames</span><span class="p">()</span><span class="o">.</span><span class="n">toArray</span><span class="p">(</span><span class="k">new</span> <span class="n">INameEntity</span><span class="p">[</span><span class="n">widget</span><span class="o">.</span><span class="n">getNames</span><span class="p">()</span><span class="o">.</span><span class="n">size</span><span class="p">()]);</span>
+ <span class="n">String</span><span class="o">[]</span> <span class="n">locales</span> <span class="o">=</span> <span class="k">new</span> <span class="n">String</span><span class="o">[]</span><span class="p">{</span><span class="s">"fr"</span><span class="p">};</span>
+ <span class="n">INameEntity</span> <span class="n">name</span> <span class="o">=</span> <span class="p">(</span><span class="n">INameEntity</span><span class="p">)</span><span class="n">LocalizationUtils</span><span class="o">.</span><span class="n">getLocalizedElement</span><span class="p">(</span><span class="n">names</span><span class="p">,</span> <span class="n">locales</span><span class="p">,</span><span class="n">widget</span><span class="o">.</span><span class="n">getDefaultLocale</span><span class="p">());</span>
+</pre></div>
+
+
+<p><code>LocalizationUtils</code> uses icu4j to process elements using appropriate fallback strategies based on language variants and extensions.</p>
+<h1 id="outputter">Outputter</h1>
+<p>As well as a parser, the parser library also has a <code>WidgetOutputter</code> class that can be used to export config.xml files that conform to the W3C Widgets: Packaging and Configuration specification. </p>
+<p>To export a config.xml for a W3CWidget object as a String :</p>
+<div class="codehilite"><pre> <span class="n">W3CWidget</span> <span class="n">widget</span> <span class="o">=</span> <span class="n">myWidget</span><span class="p">;</span>
+ <span class="n">WidgetOutputter</span> <span class="n">outputter</span> <span class="o">=</span> <span class="k">new</span> <span class="n">WidgetOutputter</span><span class="p">();</span>
+ <span class="n">outputter</span><span class="o">.</span><span class="n">setWidgetFolder</span><span class="p">(</span><span class="s">"/widgets"</span><span class="p">);</span>
+ <span class="n">String</span> <span class="n">configXml</span> <span class="o">=</span> <span class="n">outputter</span><span class="o">.</span><span class="n">outputXMLString</span><span class="p">(</span><span class="n">widget</span><span class="p">);</span>
+</pre></div>
+
+
+<p>To export a config.xml to an OutputStream use:</p>
+<div class="codehilite"><pre> <span class="n">W3CWidget</span> <span class="n">widget</span> <span class="o">=</span> <span class="n">myWidget</span><span class="p">;</span>
+ <span class="n">WidgetOutputter</span> <span class="n">outputter</span> <span class="o">=</span> <span class="k">new</span> <span class="n">WidgetOutputter</span><span class="p">();</span>
+ <span class="n">outputter</span><span class="o">.</span><span class="n">setWidgetFolder</span><span class="p">(</span><span class="s">"/widgets"</span><span class="p">);</span>
+ <span class="n">FileOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="n">FileOutputStream</span><span class="p">(</span><span class="k">new</span> <span class="n">File</span><span class="p">(</span><span class="s">"config.xml"</span><span class="p">));</span>
+ <span class="n">outputter</span><span class="o">.</span><span class="n">outputXML</span><span class="p">(</span><span class="n">widget</span><span class="p">,</span> <span class="n">out</span><span class="p">);</span>
+</pre></div>
+
+
+<h1 id="factory-properties-reference">Factory properties reference</h1>
+<h2 id="outputdirectory">outputDirectory</h2>
+<p>The directory where the widget will be saved. The factory will expand the widget archive into this directory, using the widget's identifier to generate a directory name and structure in which to place it</dd></p>
+<h2 id="startpageprocessor">startPageProcessor</h2>
+<p>An implementation of the <code>IStartPageProcessor</code> interface. Setting this property allows you to inject a class that can pre-process start pages for the widget; for example to inject javascript, tidy up HTML, insert template code etc. If this is not set, no pre-processing is done by the factory.</p>
+<h2 id="locales">locales</h2>
+<p>The supported locales (as BCP47 language-tags) to be processed for the widget. This determines which start files, icons, and other localized elements will be processed and expanded. This is set to "en" by default</p>
+<h2 id="encodings">encodings</h2>
+<p>The supported encodings to be processed for the widget. This determines which custom encodings will be allowed for start files. This is set to UTF-8 by default.</p>
+<h2 id="localpath">localPath</h2>
+<p>The base URL from which unpacked widgets will be served, e.g. "/myapp/widgets". The URLs of start files will be appended to this base URL to create the widget URL. The default value of this property is "/widgets"</p>
+<h2 id="features">features</h2>
+<p>The features supported by the implementation; this should be supplied as IRIs e.g. "http://wave.google.com". The features are matched against features requested by the widget; if the widget requires features that are unsupported, an Exception will be thrown when parsing the widget package. The default value of this property is an empty String array.</p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2011-2012 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>