summaryrefslogtreecommitdiffstats
path: root/template/en/default/pages/fields.html.tmpl
blob: b3583b5686090906fad9dda055c690d4148e124d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
[%# The contents of this file are subject to the Mozilla Public
  # License Version 1.1 (the "License"); you may not use this file
  # except in compliance with the License. You may obtain a copy of
  # the License at http://www.mozilla.org/MPL/
  #
  # Software distributed under the License is distributed on an "AS
  # IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  # implied. See the License for the specific language governing
  # rights and limitations under the License.
  #
  # The Original Code is the Bugzilla Bug Tracking System.
  #
  # The Initial Developer of the Original Code is Netscape Communications
  # Corporation. Portions created by Netscape are
  # Copyright (C) 1998 Netscape Communications Corporation. All
  # Rights Reserved.
  #
  # Contributor(s): Terry Weissman <terry@mozilla.org>
  #                 Gervase Markham <gerv@gerv.net>
  #%]

[% PROCESS "global/field-descs.none.tmpl" %]
[% PROCESS global/header.html.tmpl 
  title = "$terms.Bug Fields" 
  style_urls = ['skins/standard/page.css']
%]

<p>This page describes the various fields that you see 
  on [% terms.abug %].</p>

<table class="field_value_explanation">
  <thead>
  <tr>
    <td id="bug_status">
      <h2>[% field_descs.bug_status FILTER upper FILTER html %]</h2>
    </td>

    <td id="resolution">
      <h2>[% field_descs.resolution FILTER upper FILTER html %]</h2>
    </td>
  </tr>

  <tr>
    <td>The [% field_descs.bug_status FILTER html %] field indicates the 
      current state of a [% terms.bug %]. Only certain status transitions
      are allowed.</td>

    <td>The [% field_descs.resolution FILTER html %] field indicates what
      happened to this [%+ terms.bug %].</td>
  </tr>
  </thead>

  <tbody>
  <tr class="header_row">
    <td colspan="2">Open [% terms.Bugs %]</td>
  </tr>
  <tr>
    <td>
      <dl>
        <dt>
          [% display_value("bug_status", "UNCONFIRMED") FILTER html %]
        </dt>
        <dd>
          This [% terms.bug %] has recently been added to the database. 
          Nobody has confirmed that this [% terms.bug %] is valid. Users
          who have the "canconfirm" permission set may confirm
          this [% terms.bug %], changing its state to 
          <b>[% display_value("bug_status", "NEW") FILTER html %]</b>. 
          Or, it may be directly resolved and marked
          <b>[% display_value("bug_status", "RESOLVED") FILTER html %]</b>.
        </dd>

        <dt>
          [% display_value("bug_status", "NEW") FILTER html %]
        </dt>
        <dd>
          This [% terms.bug %] is valid and has recently been filed.
          [%+ terms.Bugs %] in this state become 
          <b>[% display_value("bug_status", "ASSIGNED") FILTER html %]</b> when
          somebody is working on them, or become resolved and marked
          <b>[% display_value("bug_status", "RESOLVED") FILTER html %]</b>.
        </dd>

        <dt>
          [% display_value("bug_status", "ASSIGNED") FILTER html %]
        </dt>
        <dd>
          This [% terms.bug %] is not yet resolved, but is assigned to the
          proper person who is working on the [% terms.bug %]. From here,
          [%+ terms.bugs %] can be given to another person and become
          <b>[% display_value("bug_status", "NEW") FILTER html %]</b>, or
          resolved and become 
          <b>[% display_value("bug_status", "RESOLVED") FILTER html %]</b>.
        </dd>

        <dt>
          [% display_value("bug_status", "REOPENED") FILTER html %]
        </dt>
        <dd>
          This [% terms.bug %] was once resolved, but the resolution was
          deemed incorrect. For example, a 
          <b>[% display_value("resolution", "WORKSFORME") FILTER html %]</b>
          [%+ terms.bug %] is marked 
          <b>[% display_value("bug_status", "REOPENED") FILTER html %]</b> when
          more information shows up and the [% terms.bug %] is now
          reproducible. From here, [% terms.bugs %] are either marked 
          <b>[% display_value("bug_status", "ASSIGNED") FILTER html %]</b> or
          <b>[% display_value("bug_status", "RESOLVED") FILTER html %]</b>.
        </dd>
      </dl>
    </td>

    <td>
      No resolution yet. All [% terms.bugs %] which are in one of
      these "open" states have no resolution set.
    </td>
  </tr>

  <tr class="header_row">
    <td colspan="2">Closed [% terms.Bugs %]</td>
  </tr>

  <tr>
    <td>
      <dl>
        <dt>
          [% display_value("bug_status", "RESOLVED") FILTER html %]
        </dt>
        <dd>
          A resolution has been performed, and it is awaiting verification by
          QA. From here [% terms.bugs %] are either re-opened and become
          <b>[% display_value("bug_status", "REOPENED") FILTER html %]</b>, are
          marked <b>[% display_value("bug_status", "VERIFIED") FILTER html %]</b>,
          or are closed for good and marked 
          <b>[% display_value("bug_status", "CLOSED") FILTER html %]</b>.
        </dd>

        <dt>
          [% display_value("bug_status", "VERIFIED") FILTER html %]
        </dt>
        <dd>
          QA has looked at the [% terms.bug %] and the resolution and
          agrees that the appropriate resolution has been taken. 
          [%+ terms.Bugs %] remain in this state until the product they were
          reported against actually ships, at which point they become
          <b>[% display_value("bug_status", "CLOSED") FILTER html %]</b>.
        </dd>

        <dt>
          [% display_value("bug_status", "CLOSED") FILTER html %]
        </dt>
        <dd>
          The [% terms.bug %] is considered dead, the resolution is correct.
          Any zombie [% terms.bugs %] who choose to walk the earth again must
          do so by becoming 
          <b>[% display_value("bug_status", "REOPENED") FILTER html %]</b>.
        </dd>
      </dl>
    </td>

    <td>
      <dl>
        <dt>
          [% display_value("resolution", "FIXED") FILTER html %]
        </dt>
        <dd>
          A fix for this [% terms.bug %] is checked into the tree and 
          tested.
        </dd>

        <dt>
          [% display_value("resolution", "INVALID") FILTER html %]
        </dt>
        <dd>
          The problem described is not [% terms.abug %].
        </dd>

        <dt>
          [% display_value("resolution", "WONTFIX") FILTER html %]
        </dt>
        <dd>
          The problem described is [% terms.abug %] which will never be 
          fixed.
        </dd>

        <dt>
         [% display_value("resolution", "DUPLICATE") FILTER html %]
        </dt>
        <dd>
          The problem is a duplicate of an existing [% terms.bug %].
          When [% terms.abug %] is marked as a
          <b>[% display_value("resolution", "DUPLICATE") FILTER html %]</b>,
          you will see which [% terms.bug %] it is a duplicate of,
          next to the resolution.
        </dd>

        <dt>
          [% display_value("resolution", "WORKSFORME") FILTER html %]
        </dt>
        <dd>
          All attempts at reproducing this [% terms.bug %] were futile, 
          and reading the code produces no clues as to why the described
          behavior would occur. If more information appears later,
          the [% terms.bug %] can be reopened.
        </dd>

        [% IF Param('move-enabled') %]
          <dt>
            [% display_value("resolution", "MOVED") FILTER html %]
          </dt>
          <dd>
            The problem was specific to a related product 
            whose [% terms.bugs %] are tracked in
            another [% terms.bug %] database.
            The [% terms.bug %] has been moved to that database.
          </dd>
        [% END %]
      </dl>
    </td>
  </tr>
  </tbody>
</table>

<h2>Other Fields</h2>

[% PROCESS "bug/field-help.none.tmpl" %]

[% SET field_help_map = {} %]
[% FOREACH field = bug_fields.keys %]
  [% SET field_desc = field_descs.$field %]
  [% field_help_map.$field_desc = { help  => help_html.$field, 
                                    field => field } %]
[% END %]

[%# These are fields that don't need to be documented, either because
  # they have docs somewhere else in the UI, or they don't show up on bugs. 
  # %]
[% SET skip_fields = [ 
  'days_elapsed', 
  'everconfirmed',
  'reporter_accessible',
  'cclist_accessible',
  'bug_group',
  'commenter',
  'owner_idle_time',
  'bug_status',
  'resolution',
] %]

<dl class="field_descriptions">
[% FOREACH field_desc = field_help_map.keys.sort %]
  [% SET field = field_help_map.${field_desc}.field %]
  [% SET field_object = bug_fields.$field %]

  [% NEXT IF field_object.obsolete %]
  [% NEXT IF !user.is_timetracker AND field_object.is_timetracking %]

  [% NEXT IF field == 'status_whiteboard' AND !Param('usestatuswhiteboard') %]
  [% NEXT IF field == 'target_milestone' AND !Param('usetargetmilestone') %]
  [% NEXT IF field == 'alias' AND !Param('usebugaliases') %]

  [%# For now we don't have help for attachment fields and so on. %]
  [% NEXT IF field.match('\.') %]

  [% NEXT IF skip_fields.contains(field) %]

  <dt id="[% field FILTER html %]">[% field_desc FILTER html %]</dt>
    <dd>
      [% SET help_text = field_help_map.${field_desc}.help %]
      [% help_text FILTER none %]
    </dd>
[% END %]
</dl>

[% PROCESS global/footer.html.tmpl %]