Re: [xwiki-devs] Help: Xwiki Watch Documentation

The java documentation can be easily generated using the javadoc tool, distributed with the standard JDK and available from most java IDEs. As for the overall idea, you should know that: - XWiki Watch uses the XWiki feed plugin (http://svn.xwiki.org/svnroot/xwiki/xwiki-platform/core/trunk/xwiki-core/src…) to get data from various sources on the web and transform them into XWiki documents - the Watch application is developed mainly using GWT. For this, it uses the xwiki gwt api (http://svn.xwiki.org/svnroot/xwiki/xwiki-platform/web/trunk/gwt/) to interface with the xwiki server. The Watch specific code is in xwiki-product-watch at http://svn.xwiki.org/svnroot/xwiki/xwiki-products/xwiki-watch/trunk/ . As with any GWT Application, you should start your trip into Watch code from the EntryPoint implementing class, specifically the onModuleLoad() function. For Watch, this is the com.xpn.xwiki.watch.client.Watch class, the place where initialization is done and interface is created. The communication between this client code and the xwiki server is based on asynchronous rpc calls (as for all gwt applications), whose implementation in xwiki is done through the XWikiService (see com.xpn.xwiki.gwt.api.client.XWikiService , com.xpn.xwiki.gwt.api.client.XWikiServiceAsync and com.xpn.xwiki.gwt.api.server.XWikiServiceImpl classes in the xwiki gwt api code). The service functions are invoked in Watch through the DataManager class that exposes specific Watch functionality (feed, groups, keywords, etc manipulation). The Watch class acts like a controller between user interface and watch data, handling communication between the two. The gwt application is integrated in xwiki using regular wiki documents: the entry point for the collaborative rss reader is the Watch.Reader document which includes the WatchSheets.WebHomeSheet sheet. There also is a wiki interface for the watch application whose entry point is Watch.WebHome document: it provides regular xwiki access to all feeds and articles fetched from feeds. If you're ever in trouble trying to follow the twisted paths of xwiki watch code don't hesitate to ask for help either on the list or our irc channel. Hope this helps, Happy coding, Anca Luca