Author: scottbw
Date: Mon Jul 11 08:55:44 2011
New Revision: 1145071
URL: http://svn.apache.org/viewvc?rev=1145071&view=rev
Log:
Added "building widgets" page from wiki
Added:
incubator/wookie/site/trunk/content/wookie/docs/widgets.mdtext (with
props)
Added: incubator/wookie/site/trunk/content/wookie/docs/widgets.mdtext
URL:
http://svn.apache.org/viewvc/incubator/wookie/site/trunk/content/wookie/docs/widgets.mdtext?rev=1145071&view=auto
==============================================================================
--- incubator/wookie/site/trunk/content/wookie/docs/widgets.mdtext (added)
+++ incubator/wookie/site/trunk/content/wookie/docs/widgets.mdtext Mon Jul 11
08:55:44 2011
@@ -0,0 +1,85 @@
+Title: Building Widgets
+Notice: 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.
+
+This page contains some notes and guidance on how to build widgets that can be
hosted in the Wookie Server.
+
+#Tutorials
+You will probably want to look at the tutorial found in
h[ttp://svn.apache.org/repos/asf/incubator/wookie/trunk/tutorials/][1]
+
+
+#Widget source directory
+Widgets should be developed in trunk/widgets/WIDGET_NAME, where WIDGET_NAME is
the name of the widget being developed.
+
+This directory contains widget sourcecode and build files.
+
+#Create a widget
+To create a widget:
+
+ cd $WOOKIE_HOME/widgets
+ ant seed-widget
+
+This is an interactive target that will ask you a number of questions
+about the widget you wish to create. The first question asks for a
+short name for your widget. This short name is used as the name of the
+widget directory and other key widget. For the rest of this document
+WIDGET_SHORTNAME will refer to your response to this question.
+
+Once the target has completed your widget skeleton will be available in
+a directory called WIDGET_SHORTNAME.
+
+The default widget will provide a very basic widget with default style
+resource and javascript files.
+
+#Build a Widget
+
+ cd $WOOKIE_HOME
+ ant build-widget
+
+You will be asked the name of te widget to build. After a succesful build your
widget package will be created in the /build/widgets directory.
+
+Note, you can also run ant from the widget directory, in which case you will
+be asked for the shortname of the widget you wish to work with.
+
+#Deploy a widget
+
+ cd $WOOKIE_HOME
+ ant deploy-widget
+
+You will be asked the name of the widget to build. Your widget will be hot
deployed and you can use it immediately (note the server must have hot deploy
turned on for it to see the new widget).
+
+Automatically deploying at build time
+Widgets will automatically be deployed at build time by default. That is, any
widgets found in the widgets directory will be deployed to the webapp when it
is rebuilt. you can configure which widgets will be deployed in your
local.build.properties files.
+
+#Third Party Materials
+This section links to third party materials about building Wookie Widgets.
+
+##Thomas Ullmann
+Thomas has created some screencasts you can follow:
+
+ - [Creating widgets][2] - Note that this screencast demonstrates how
+ to build widgets manually, the presentation above describes how to
+ use the templates to get started faster.
+ - [Uploading widgets][3]-
+ Note that this is made against an older version of Wookie, whilst
+ uploading is correctly documented, the method for previewing widgets
+ is incorrect. To preview a widget click the "demo" link in the
+ widget gallery.
+
+ [1]: http://svn.apache.org/repos/asf/incubator/wookie/trunk/tutorials/
+ [2]: http://people.kmi.open.ac.uk/ullmann/tutorials/wookie/widget.htm
+ [3]:
http://people.kmi.open.ac.uk/ullmann/tutorials/wookie/widgetUploadWookie.htm
\ No newline at end of file
Propchange: incubator/wookie/site/trunk/content/wookie/docs/widgets.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
