Re: Widget reference

On 01/01/2004, at 1:09 PM, Tupshin Harper wrote:
> Tried googling for the exact phrase "api reference" lately?

When Charlie said 'widget reference', I presume he meant a parallel of 
'The XWT Reference', not an API specification. What you call an API 
reference, I would call an API specification, though I suppose both 
words are valid.

In fact, API reference may have more claim to validity, but I spend a 
lot of time around the XWT Reference.

We're just reusing too many ambiguous words here. :)

To quote the mighty document itself:

   This document is a reference. It is not a specification or a
   tutorial.

   This document does not guide the user gently through examples
   (as a tutorial would), and it doesn't provide enough detail
   and formality for a third party to construct a compatible re-
   implementation of the XWT Core (as a specification would).

   Rather, the goal of this document is to completely describe
   every aspect of the environment that the XWT Core provides to
   client applications, from the bottom up.

Does the widget library really need one of those? I would've said we 
need:

- The XWT Reference (duh)
- API specification/reference -- auto generated from inline docs
- Tutorials
   - Starting out with XWT
   - Starting with the widget library
   - Doing funky stuff with specific widgets
   - Writing your own widgets (using the xwt.theme package)
   - Writing your own theme
- Template development guideline -- rules you should follow if
   you want your code to be part of the org.xwt namespace or
   in our tree. Eg. the copyright notice, namespace prefixes,
   etc).

I have the small beginnings of the template dev guidelines here (based 
on things agreed in RFC messages on widgets@ recently). I'll put it up 
as soon as wiki.xwt.org comes back.

d