408177 - Documentation of Template Customization outdated

Status: RESOLVED DUPLICATE of bug 347072

(Bugzilla :: Documentation, defect)

Description

[Tom Green]

User-Agent:       Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.8.1.8) Gecko/20071004 Iceweasel/2.0.0.8 (Debian-2.0.0.6+2.0.0.8-0etch1)
Build Identifier: 

Chapter 6.2.5. Particular Templates

has a section explaining how to create custom comments. It reads:

Then, create a template like custom/bug/create/comment.txt.tmpl, and call it comment-<formatname>.txt.tmpl. This template should reference the form fields you have created using the syntax [% form.<fieldname> %]. When a bug report is submitted, the initial comment attached to the bug report will be formatted according to the layout of this template.


Unfortunately the reference a la: [% form.<fieldname> %] doesn't seem to work in BZ 3.0.2 anymore.

According to the file: comment-guided.txt.tmpl the documentation should read something like:

Then, create a template like custom/bug/create/comment.txt.tmpl, and call it comment-<formatname>.txt.tmpl. Put the following two statemens:
[% USE Bugzilla %] 
[% cgi = Bugzilla.CGI %]
at top of the file. The form fields you have created can now be referenced using the syntax [% cgi.param("<fieldname>") %]. When a bug report is submitted, the initial comment attached to the bug report will be formatted according to the layout of this template.


Or did I miss something?

Reproducible: Always

Steps to Reproduce:
1. Visit http://www.bugzilla.org/docs/3.0/html/cust-templates.html#template-specific
2. Read section 6.2.5
Actual Results:  
Then, create a template like custom/bug/create/comment.txt.tmpl, and call it comment-<formatname>.txt.tmpl. This template should reference the form fields you have created using the syntax [% form.<fieldname> %]. When a bug report is submitted, the initial comment attached to the bug report will be formatted according to the layout of this template.


Expected Results:  
Something like:

Then, create a template like custom/bug/create/comment.txt.tmpl, and call it comment-<formatname>.txt.tmpl. Put the following two statemens:
[% USE Bugzilla %] 
[% cgi = Bugzilla.CGI %]
at top of the file. The form fields you have created can now be referenced using the syntax [% cgi.param("<fieldname>") %]. When a bug report is submitted, the initial comment attached to the bug report will be formatted according to the layout of this template.

Comment 1

[Tom Green]

Desk broken :-)