274220 - Provide additional documentation about creating custom templates

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[agrieco]

User-Agent:       Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.7.5) Gecko/20041107 Firefox/1.0
Build Identifier: Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.7.5) Gecko/20041107 Firefox/1.0

I am having a problem with my first attempt to customize templates in
2.18rc3.  The custom-guided example seems to work, but clearly I am
missing something in the process of doing my own.

I started with the en/custom/bugs/create/create.html.tmpl and
comment.txt.tmpl files and copyed them to create-cust.html.tmpl and
comment-cust.html.tmpl (same path).  From there, I made the following
changes:

/srv/www/htdocs/bugz/template/en/custom/bug/create # diff
comment.txt.tmpl comment-cust.txt.tmpl
26a27
> Buildtest [% form.buildtest %]
/srv/www/htdocs/bugz/template/en/custom/bug/create # diff
create.html.tmpl create-cust.html.tmpl
139c139,144
<
---
> <tr>
>       <td></td>
>       <td colspan="3">
>       BuildTest <input type="text" name="buildtest" size="30">
>       </td>
> </tr>

I see the fields in the HTML on enter_bug.cgi,  but the data in the
field named buildtest is never displayed again.

I am using the convetion of enter_bug.cgi?format=cust&ctype=html

Reproducible: Always
Steps to Reproduce:
1. Edit the templates as described above in details
2. run check perl script..everything passes
3. Enter a new bug, with the new form fields and submit

Actual Results:  
Only the data from the 'traditional' fields is seen in the bug after submission

Comment 1

[Dave Miller [:justdave]]

I can reproduce this on landfill, with a template named comment-cust.txt.tmpl.
However, comment-guided.txt.tmpl seems to work just fine.  What's in a name???

Comment 2

[Dave Miller [:justdave]]

Doh, here's the difference....

create-guided.html.tmpl has this in it:

  <input type="hidden" name="format" value="guided">

Since I copied create.html.tmpl as the starting point, and it uses the default
format, it doesn't have a format field in the form.  Adding
  <input type="hidden" name="format" value="cust">
to create-cust.html.tmpl makes it work.

The documentation in section 5.1.4 seems to be missing this important little
tidbit...

Comment 3

[agrieco]

Viola!  That did it.  You guys rock.  thanks for the quick response and timely
workaround.  I see you have changed this to a docs bug.  Sounds great.  Probably
impacts most previous releases (although I have not looked at their docs).

Thanks
Anthony

Comment 4

[Vlad Dascalu]

Attachment: v1

Comment 5

[Vlad Dascalu]

Comment on attachment 168525 [details] [diff] [review]
v1

Jake, this is a 2.18 release blocker, can you take a look at it? Thanks!

Comment 6

[Jacob Steenhagen]

Comment on attachment 168525 [details] [diff] [review]
v1

>+        <code><input type="hidden" name="format" value="cust"></code>

Need to html_quote() this <input> tag. Also, <code/> is not a DocBook tag.

Comment 7

[Vlad Dascalu]

Travis: if you have time for this 2.18 blocker, feel free to dig in :-)

Comment 8

[Shane H. W. Travis]

Attachment: Doc changes for tip

Ask, and ye shall receive. Here is a cleaned-up patch for the tip. Does not
apply against 2.18, for reasons I shall explain in the next attachment.

Comment 9

[Shane H. W. Travis]

Attachment: Doc changes for 2.18

I was surprised when my tip patch did not apply cleanly against 2.18. I was
more surprised to find the reason: that being that a cleaned-up version of
Vlad's original patch had *already* been applied to the docs!

Checking
http://bonsai.mozilla.org/cvsblame.cgi?file=mozilla/webtools/bugzilla/docs/xml/customization.xml&rev=1.12.2.5
to see whose fault it was, I see that Jake checked it in... but that the patch
notes are for bug 253720, which is not right at all! Jake, you wanna 'splain?

So, I cleaned up the one diff between the two patches, and here's another patch
for 2.18 to make it identical to the tip patch. The only difference is that
mine uses <programlisting> whereas this bastard patch uses <computeroutput>. I
made my choice based on what has been done elsewhere in customization.xml to
show HTML code (and that 'programlisting' seems more correct in this context),
but there really doesn't seem to be much difference between them. It may be
worth making things consistent someday... but not as part of this bug.

Comment 10

[Shane H. W. Travis]

Attachment: Doc changes for 2.18, take2

Helps when you don't do the patch backwards... Argh.

Comment 11

[Vlad Dascalu]

Comment on attachment 169745 [details] [diff] [review]
Doc changes for 2.18, take2

According to
http://www.oreilly.com/catalog/docbook/chapter/book/programlisting.html and
http://www.oreilly.com/catalog/docbook/chapter/book/computeroutput.html , the
right thing to use here is <programlisting>, since we're writing that code
inside a template; it's kind of a program that we're writing, not a thing
generated by a computer.

Comment 12

[Vlad Dascalu]

Checking in docs/xml/customization.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/customization.xml,v  <-- 
customization.xml
new revision: 1.18; previous revision: 1.17
done

Checking in docs/xml/customization.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/customization.xml,v  <-- 
customization.xml
new revision: 1.12.2.6; previous revision: 1.12.2.5
done

Comment 13

[Jacob Steenhagen]

(In reply to comment #9)
> Jake, you wanna 'splain?

My explination follows:

Oops.

OK, seriously, most likely what happened is that I was reviewing the patch for
this bug on 2.18 and when I checked in bug 253720 I failed to run my
cvs -q update -dPC command to make sure I was running a clean version prior to
applying the patch.

Comment 14

[Shane H. W. Travis]

> (In reply to comment #9)
> My explination follows:
> 
> Oops.

Jake, you owe me a new keyboard; this one has coffee all over it. :)