Tim said:
...
> It's taken me way too long, but I've finally managed to get some work
> done on the documentation for Velocity Tools.
>
> I mostly just cleaned up from the excellent starting point Gabe created.
> Did a bit of weeding, created a smaller Velocity Tools specific logo,
> and then added some bits that were missing for
> installation/setup/description...and then tried to organize things a bit
> better. (ex. The setup I wrote for the StrutsView really applied mostly
> to the basic ViewServlet, there isn't much extra to do for Struts really
> when you come right down to it.)
>
> I posted the current docs as well as the xdocs directories here:
> http://crufty.happysearch.com/velocity/tools/docs/

and here comes feedback... :-)

why all the renaming?  (e.g. VelocityStruts -> StrutsView?) most of these
names were somewhat informally decided upon in dev list discussions.  i
think it'd be best to stay consistent on naming or at least discuss such
changes.

i know typos are hard to avoid, but a few in there are somewhat critical.
(e.g. http://crufty.happysearch.com/velocity/tools/view/docs/index.html
says the VelocityLayoutServlet's reference for screen content is
$BODY_CONTENT  when it's actually hardcoded as $screen_content)

none of the toolbox configuration snippets (that i noticed) demonstrate
using the <scope> attribute.  yes, it's optional (and "request" is the
default), but i think best practice would always define it explicitly.  the
docs should reflect that.

> I could provide cvs diffs if my arm was twisted, but geez I
> changed/added/renamed quite a few files to make this happen. It would be
> easier to just send a tarball. ;-)

yeah, but easier for who? :-)
diff -u is the standard for altered files, added files can be sent as-is.
i'm not excited about renaming files/libraries without list discussion.

> Also moved the tree inside /velocity/tools/ to make it easier to type
> and/or reference. This of course makes a bit of an issue for the
> velocity/tools/tools directory (it works of course...just seems a bit
> bit redundant redundant.
...

moving trees == renaming.  see previous comments :)

although i've always hated the /tools/tools too.  though it would break
b.c., i admit i'd be willing to support & implement a change to
/tools/library.


Nathan Bubna
[EMAIL PROTECTED]


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

Reply via email to