DO NOT REPLY [Bug 25026] New: - Documentation and examples do not work and are misleading

[bu...@apache.org]

DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG 
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://nagoya.apache.org/bugzilla/show_bug.cgi?id=25026>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND 
INSERTED IN THE BUG DATABASE.

http://nagoya.apache.org/bugzilla/show_bug.cgi?id=25026

Documentation and examples do not work and are misleading

           Summary: Documentation and examples do not work and are
                    misleading
           Product: Velocity
           Version: 1.3.1
          Platform: Other
        OS/Version: Other
            Status: NEW
          Severity: Major
          Priority: Other
         Component: Documentation
        AssignedTo: velocity-dev@jakarta.apache.org
        ReportedBy: jparsons@paradigm-therapeutics.com
                CC: jparsons@paradigm-therapeutics.com


In the documentation that comes with Velocity 1.3.1
(developer-guide.html#Using%20Velocity%20In%20Servlets) there is an  Appendix 1
: called "Deploying the Example Servlet" which has a number of flaws:
1) Deployment is not simple and error messages in the Catalina log are useless
2) There is no mention of web.xml so deployment will never work in Tomcat
3) The velocity documentation has no side by side examples of the code in the
HTML template file and the Java servlet code that loads it. These two pieces
talk to each other and are dependent on each other but the examples never make
that link.
4) The Velocity documentation is almost completely devoid of examples of
database access which is surely from where the greatest need for dynamic HTML
pages comes.

---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org