Author: scottbw
Date: Thu May 26 14:30:52 2011
New Revision: 1127942
URL: http://svn.apache.org/viewvc?rev=1127942&view=rev
Log:
Added representation section for Widget and an explanation of id vs identifier
Modified:
incubator/wookie/site/trunk/content/wookie/docs/api.mdtext
Modified: incubator/wookie/site/trunk/content/wookie/docs/api.mdtext
URL:
http://svn.apache.org/viewvc/incubator/wookie/site/trunk/content/wookie/docs/api.mdtext?rev=1127942&r1=1127941&r2=1127942&view=diff
==============================================================================
--- incubator/wookie/site/trunk/content/wookie/docs/api.mdtext (original)
+++ incubator/wookie/site/trunk/content/wookie/docs/api.mdtext Thu May 26
14:30:52 2011
@@ -69,6 +69,22 @@ Either creates a new instance for the gi
# Widgets
+##Representation
+
+A Widget is currently represented in XML using an abbreviated form of the W3C
Widgets packaging format:
+
+ <?xml version="1.0" encoding="UTF-8"?>
+ <widgets>
+ <widget id="7" identifier="http://wookie.apache.org/widgets/geo";
width="620" height="660" version="0.1">
+ <title short="">geo</title>
+ <description>An example of a HTML 5 geolocation
widget.</description>
+
<icon>http://localhost:8080/wookie/wservices/wookie.apache.org/widgets/geo/icon.svg</icon>
+ <author>Apache Wookie (Incubating) Team</author>
+ </widget>
+ </widgets>
+
+**Note** the "id" attribute is a Wookie-specific identifier that should be
used as the URL parameter for REST API methods; in the above example, requests
relating to this widget would
+be addressed to /widgets/7. The "identifier" attribute corresponds to the W3C
WIdgets "identifier" attribute, and contains the URI of the Widget,
<table border="1"><tbody>
<tr>
