On 3/26/06, Henning P. Schmiedehausen <[EMAIL PROTECTED]> wrote:
> "Nathan Bubna" <[EMAIL PROTECTED]> writes:
>
> >perhaps we should rename the guides on the website to prevent such
> >confusion.  essentially, the "User Guide" teaches people how to write
> >templates in VTL.  the "Developer Guide" teaches people how to develop
> >applications that use Velocity.
>
> >i haven't thought long about better names, but perhaps something along
> >the lines of:
>
> >User Guide -> How to Write Templates
> >Developer Guide -> How to Use Velocity
>
> >better name ideas are welcome...
>
> Nathan,
>
> these are excellent ideas. One of the first things that I did was to
> take stock of the existing docs and put them into a mind mapping
> tool. I can really recommend Freemind (freemind.sf.net) which is open
> source and free.

i'll have to check it out...

> >and as a bonus thought: you could probably break the Developer Guide
> >into two guides, one more focused on using Velocity and another on the
> >configuration minutia (which is not even fully documented).  then we
> >could have guides on:  Writing Templates, Using Velocity,
> >Configuration Options.
>
> Hm. I'd think that the developers guide should focus on "programming
> with Velocity" and the "how to configure Velocity" is basically an
> Appendix to it. One of the problems with many xdoc driven sites is,
> that documentation is spread out too thin over many pages.

yeah, i like the idea of the configuration section being an appendix. 
it really is more of a reference/lookup-table then a tutorial-type
section.  now, if i could only find some time to do this.... :)

>         Best regards
>                 Henning
>
> --
> Dipl.-Inf. (Univ.) Henning P. Schmiedehausen          INTERMETA GmbH
> [EMAIL PROTECTED]        +49 9131 50 654 0   http://www.intermeta.de/
>
> RedHat Certified Engineer -- Jakarta Turbine Development  -- hero for hire
>    Linux, Java, perl, Solaris -- Consulting, Training, Development
>
> Social behaviour: Bavarians can be extremely egalitarian and folksy.
>                                     -- http://en.wikipedia.org/wiki/Bavaria
> Most Franconians do not like to be called Bavarians.
>                                     -- http://en.wikipedia.org/wiki/Franconia
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: [EMAIL PROTECTED]
> For additional commands, e-mail: [EMAIL PROTECTED]
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to