svn commit: r1170553 - /incubator/wookie/site/trunk/content/wookie/docs/widgets.mdtext

[rg...@apache.org]

Author: rgardler
Date: Wed Sep 14 12:06:23 2011
New Revision: 1170553

URL: http://svn.apache.org/viewvc?rev=1170553&view=rev
Log:
Some clarifications to accomodate the release (possibly duplicated, network dropped)

Modified:
    incubator/wookie/site/trunk/content/wookie/docs/widgets.mdtext

Modified: 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=1170553&r1=1170552&r2=1170553&view=diff
==============================================================================
--- incubator/wookie/site/trunk/content/wookie/docs/widgets.mdtext (original)
+++ incubator/wookie/site/trunk/content/wookie/docs/widgets.mdtext Wed Sep 14 12:06:23 2011
@@ -24,10 +24,22 @@ You will probably want to look at the tu
 More specifically the slides in [this open office presentation][2] will walk you through the creation of your first widget.
 
 #Widget source directory
-Widgets should be developed in trunk/widgets/WIDGET_NAME, where WIDGET_NAME is the name of the widget being developed.
+
+For ease of development you will probably want to build widgets using the src
+version of Wookie as this provides a number of tools for working with Widgets.
+This is not required, but this document assumes this to be the case.
+
+If you have checked out the source from SVN then you will be working in 
+"trunk/widgets/WIDGET_NAME", where WIDGET_NAME is the name of the widget 
+being developed. If you have downloaded a source release then you will work in
+the "/widgets" directory. 
 
 This directory contains widget sourcecode and build files.
 
+In the examples below we use "$WOOKIE_HOME" to indicate the directory you are
+using. There is no requirement to set this environment variable, but you 
+might find it useful to do so.
+
 #Create a widget
 To create a widget:
 
@@ -53,15 +65,14 @@ resource and javascript files.
 
 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).
+You will be asked the name of the widget to deploy. 
+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.