[VELOCITY-233] Documentation and examples do not work and are misleading

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.3.1
• Fix Version/s: 1.5
• Component/s: Documentation
• Environment: Operating System: other; Platform: Other
• Bugzilla Id: 25026
• Assignee: Unassigned
• Reporter: Jeremy Parsons
• Created: 27/Nov/03 01:39
• Updated: 08/Mar/07 00:14
• Resolved: 19/Sep/05 06:43

Description

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.