233246 - 4.1.4: format name for comment template must match the parent template

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[Dave Miller [:justdave]]

The description here does not mention that the format name for the
comment.txt.tmpl needs to match the format name of the parent create.html.tmpl,
and the examples seem to indicate it shouldn't.  This is potentially confusing.

Also in this section, the guided bug submission example should probably link to
product=Browser so they don't have to choose a product to get the demo, since
the directly-linked page doesn't actually show anything relevant.

Comment 1

[Gervase Markham [:gerv]]

Attachment: Patch v.1

This improves the wording of that section, and makes it clear how the comment
and template relate.

Gerv

Comment 2

[Gervase Markham [:gerv]]

Comment on attachment 144474 [details] [diff] [review]
Patch v.1

Dave: are we getting docs patches reviewed, or are we just checking them in and
waiting for someone to scream if they don't like them?

Gerv

Comment 3

[Dave Miller [:justdave]]

Comment on attachment 144474 [details] [diff] [review]
Patch v.1

Normally I'd say check it in until someone screams. :)	I have comments on this
though...

>+      <para>  
>+        An example of this is the mozilla.org 
>+        <ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?format=guided">guided 
>+        bug submission form</ulink>. The code for this comes with the Bugzilla

We should link this to
http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi?product=WorldControl&fo
rmat=guided
instead.  Linking to bugzilla.mozilla.org from here is probably responsible for
a lot of the "test bugs" we get on mozilla.org :)

>+        <filename>custom/bug/create/comment.txt.tmpl</filename>, and call it 
>+        <filename>comment-&lt;formatname&gt;.html.tmpl</filename>. This 

This needs to be .txt.tmpl, doesn't it?

The rest of this looks good.

Comment 4

[Gervase Markham [:gerv]]

Fixed, with updates from dave.

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

Gerv