> What I was thinking of doing is creating a directory where the
> package xdocs
> lived like this:
>
> xdocs/packages/
> org-apache-avalon-excalibur-datasources.xml
> ...
sounds good =)
> > Why?
> > Looking at the java setup, it seems to be more the reverse: the
> > API is academic in tone, while the tutorial series document how
> > to use the API.
>
> Take a look at the SimpleDateFormatter and the Calendar objects. I
> am refering to the JavaDocs in Excalibur taking after that format.
> IOW, describing the different options available, and the different
> Components that can be instantiated.
>
> Each of the Excalibur components do need the general overview, and
> the more detailed hand walking tutorial (i.e. for the beginners).
>
> > I think I like that one better: good programmers are interested
> > in high-level overviews and have no prob reading api docs; new
> > programmers need a tutorial and more down-to-earth docs.
>
> I like this approach. Keeping the high level docs in the javadocs
> is good--just be sure to include the configuration info. The
> site can have a general overview ("what is it") and a more detailed
> tutorial ("what does it do?" and "walk me through it").
yup..
> > LSD, who is working on a "Getting Started with the
> > Avalon Framework" tutorial.
>
> I am working on my paper for the Avalon presentation I am preparing
> for at ApacheCon. That will be my basis for the "Getting Started"
> tutorial.
>
> > PS: anyone know a good paper about COP to refer to?
>
> :) I'm writing it. Really though, I am writing a three part paper
> that I am going to donate to the Avalon project--I just need a word
> processor to write it at the beginning.
Good you repeated that. I think I'll go and work on the phoenix
design documentation and javadoc then (I am assuming you are just
doing a 'hands-on' for your presentation?)
gr,
LSD
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
