Hi, Alexander,

welcome to qooxdoo.  :-)

[EMAIL PROTECTED] wrote:
> "Alexander Trauzzi" <[EMAIL PROTECTED]> writes:
> 
> 
>>After the cross-post of my initial inquiry, I figured it would be a good
>>idea to come on and just say "Hi" to everyone reading.
 >
 >
>>What - in terms of documentation - is qooxdoo needing?  I want to start
>>learning how to work with qooxdoo, but I'm uncertain as to where the lion's
>>share of documentation work is focused.
> 
> 
> Hi Alexander,
> 
> The lion's share of existing documentation is per-class, per-function.  If you
> know what you want to do and what class implements it, you can find the
> documentation for what parameters to pass to the appropriate methods.  The
> problem, currently, is that if you _don't_ know that a widget exists, or what
> widget solves a particular problem, or what layouts are available, or ... (I
> could go on and on), there's no place to look. 

Certainly, more documentation has to be added, existing docs have to be 
updated and corrected. That "there's no place to look" may be an 
over-simplification, though. ;-)

Unfortunately, many existing articles, code snippets, etc. did not make 
their way from the old homepage http://old.qooxdoo.org over to the new 
site http://qooxdoo.org. It would be great if volunteers could go 
through the documentation section of the old homepage and simply 
transfer those documents. It is a pretty straightforward process: 
everyone can easily register himself/herself under http://qooxdoo.org 
for an immediate wiki access. Many users are registered already. Yes, 
the whole homepage _is_ a wiki ("dokuwiki") which any qooxdoo user can 
access, modify and make contributions to. We still hope for the 
communities support here, as it is a good way to get oneself familiar 
with the dokuwiki system.

Of course, many of the existing docs are specific to the current release 
0.5.x. Given the future switch to the contents of the development branch 
"namespaces", some of those information may no longer be relevant for a 
0.6 release. Still, those information will continue to be important for 
any user that integrates qooxdoo 0.5.x in his/her projects (and tries to 
migrate to 0.6 later).

Definitely another place to look is all the demo files that come with 
qooxdoo. They should cover most (if not all) existing widgets. Sure, 
they cannot provide examples for every use case, but should be a good 
start. http://qooxdoo.org/demo

If more detailed info is needed besides browsing the widgets' source 
code, the api reference should be helpful. It already exists for release 
0.5.x, http://old.qooxdoo.org/documentation/api-reference, including a 
complete class tree, but will be way more powerful in 0.6.

There is quite some heavy development in the namespaces branch right 
now, so once that is finished, more articles specific to a future 
release 0.6 and its new/improved features will be available.

Cheers,

Andreas

-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys -- and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
qooxdoo-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/qooxdoo-devel

Reply via email to