From 779b283127b310bb8676d11fed7a071ef1ce4ceb Mon Sep 17 00:00:00 2001 From: Max Kanat-Alexander Date: Wed, 17 Feb 2010 13:49:23 -0800 Subject: Bug 529201: Add help for every single field to fields.html r=LpSolit, a=LpSolit --- template/en/default/pages/fields.html.tmpl | 349 +++++++++++++---------------- 1 file changed, 150 insertions(+), 199 deletions(-) (limited to 'template/en/default/pages') diff --git a/template/en/default/pages/fields.html.tmpl b/template/en/default/pages/fields.html.tmpl index 5be28cab7..184aef96f 100644 --- a/template/en/default/pages/fields.html.tmpl +++ b/template/en/default/pages/fields.html.tmpl @@ -20,128 +20,142 @@ #%] [% PROCESS "global/field-descs.none.tmpl" %] -[% INCLUDE global/header.html.tmpl title = "A $terms.Bug's Life Cycle" %] +[% PROCESS global/header.html.tmpl + title = "$terms.Bug Fields" + style_urls = ['skins/standard/page.css'] +%] -

-The status and resolution fields define and track the life -cycle of [% terms.abug %]. -

+

This page describes the various fields that you see + on [% terms.abug %].

- - - - - -
-

STATUS

+ + + + - - + + - + + - + + + + + - + + + + + @@ -149,7 +163,7 @@ cycle of [% terms.abug %]. +
+ +

[% field_descs.bug_status FILTER upper FILTER html %]

 -

RESOLUTION

+ +

[% field_descs.resolution FILTER upper FILTER html %]
The status field indicates the general health of a - [% terms.bug %]. Only certain status transitions are allowed.
The [% field_descs.bug_status FILTER html %] field indicates the + current state of a [% terms.bug %]. Only certain status transitions + are allowed.The resolution field indicates what happened to this - [%+ terms.bug %].The [% field_descs.resolution FILTER html %] field indicates what + happened to this [%+ terms.bug %].
Open [% terms.Bugs %]
- [% display_value("bug_status", "UNCONFIRMED") FILTER html %] + [% display_value("bug_status", "UNCONFIRMED") FILTER html %]
This [% terms.bug %] has recently been added to the database. - Nobody has validated that this [% terms.bug %] is true. Users + 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 [% display_value("bug_status", "NEW") FILTER html %]. Or, it may be - directly resolved and marked [% display_value("bug_status", "RESOLVED") FILTER html %]. + this [% terms.bug %], changing its state to + [% display_value("bug_status", "NEW") FILTER html %]. + Or, it may be directly resolved and marked + [% display_value("bug_status", "RESOLVED") FILTER html %].
- [% display_value("bug_status", "NEW") FILTER html %] + [% display_value("bug_status", "NEW") FILTER html %]
- This [% terms.bug %] has recently been added to the assignee's - list of [% terms.bugs %] and must be processed. [% terms.Bugs %] in - this state may be accepted, and become [% display_value("bug_status", "ASSIGNED") FILTER html %], passed - on to someone else, and remain [% display_value("bug_status", "NEW") FILTER html %], or resolved and marked + This [% terms.bug %] is valid and has recently been filed. + [%+ terms.Bugs %] in this state become + [% display_value("bug_status", "ASSIGNED") FILTER html %] when + somebody is working on them, or become resolved and marked [% display_value("bug_status", "RESOLVED") FILTER html %].
- [% display_value("bug_status", "ASSIGNED") FILTER html %] + [% display_value("bug_status", "ASSIGNED") FILTER html %]
- This [% terms.bug %] is not yet resolved, but is assigned to the - proper person. From here [% terms.bugs %] can be given to another - person and become [% display_value("bug_status", "NEW") FILTER html %], or - resolved and become [% display_value("bug_status", "RESOLVED") FILTER html %]. + 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 + [% display_value("bug_status", "NEW") FILTER html %], or + resolved and become + [% display_value("bug_status", "RESOLVED") FILTER html %].
- [% display_value("bug_status", "REOPENED") FILTER html %] + [% display_value("bug_status", "REOPENED") FILTER html %]
- This [% terms.bug %] was once resolved, but the resolution was - deemed incorrect. For example, a [% display_value("resolution", "WORKSFORME") FILTER html %] [% terms.bug %] is - [% display_value("bug_status", "REOPENED") FILTER html %] when more information shows up and - the [% terms.bug %] is now reproducible. From here [% terms.bugs %] are - either marked [% display_value("bug_status", "ASSIGNED") FILTER html %] or + This [% terms.bug %] was once resolved, but the resolution was + deemed incorrect. For example, a + [% display_value("resolution", "WORKSFORME") FILTER html %] + [%+ terms.bug %] is marked + [% display_value("bug_status", "REOPENED") FILTER html %] when + more information shows up and the [% terms.bug %] is now + reproducible. From here, [% terms.bugs %] are either marked + [% display_value("bug_status", "ASSIGNED") FILTER html %] or [% display_value("bug_status", "RESOLVED") FILTER html %].
-
-
- No resolution yet. All [% terms.bugs %] which are in one of - these "open" states have the resolution set to blank. All - other [% terms.bugs %] will be marked with one of the following - resolutions. -
-
+ No resolution yet. All [% terms.bugs %] which are in one of + these "open" states have no resolution set.
Closed [% terms.Bugs %]
- [% display_value("bug_status", "RESOLVED") FILTER html %] + [% display_value("bug_status", "RESOLVED") FILTER html %]
- A resolution has been taken, and it is awaiting verification by - QA. From here [% terms.bugs %] are either re-opened and become - [% display_value("bug_status", "REOPENED") FILTER html %], are marked - [% display_value("bug_status", "VERIFIED") FILTER html %], or are closed for - good and marked [% display_value("bug_status", "CLOSED") FILTER html %]. + A resolution has been performed, and it is awaiting verification by + QA. From here [% terms.bugs %] are either re-opened and become + [% display_value("bug_status", "REOPENED") FILTER html %], are + marked [% display_value("bug_status", "VERIFIED") FILTER html %], + or are closed for good and marked + [% display_value("bug_status", "CLOSED") FILTER html %].
- [% display_value("bug_status", "VERIFIED") FILTER html %] + [% display_value("bug_status", "VERIFIED") FILTER html %]
- 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 + 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 [% display_value("bug_status", "CLOSED") FILTER html %].
- [% display_value("bug_status", "CLOSED") FILTER html %] + [% display_value("bug_status", "CLOSED") FILTER html %]
- 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 [% display_value("bug_status", "REOPENED") FILTER html %]. + 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 + [% display_value("bug_status", "REOPENED") FILTER html %].
- [% display_value("resolution", "FIXED") FILTER html %] + [% display_value("resolution", "FIXED") FILTER html %]
A fix for this [% terms.bug %] is checked into the tree and @@ -157,14 +171,14 @@ cycle of [% terms.abug %].
- [% display_value("resolution", "INVALID") FILTER html %] + [% display_value("resolution", "INVALID") FILTER html %]
The problem described is not [% terms.abug %].
- [% display_value("resolution", "WONTFIX") FILTER html %] + [% display_value("resolution", "WONTFIX") FILTER html %]
The problem described is [% terms.abug %] which will never be @@ -172,17 +186,18 @@ cycle of [% terms.abug %].
- [% display_value("resolution", "DUPLICATE") FILTER html %] + [% display_value("resolution", "DUPLICATE") FILTER html %]
The problem is a duplicate of an existing [% terms.bug %]. - Marking [% terms.abug %] duplicate requires the [% terms.bug %]# - of the duplicating [% terms.bug %] and will at least put - that [% terms.bug %] number in the description field. + When [% terms.abug %] is marked as a + [% display_value("resolution", "DUPLICATE") FILTER html %], + you will see which [% terms.bug %] it is a duplicate of, + next to the resolution.
- [% display_value("resolution", "WORKSFORME") FILTER html %] + [% display_value("resolution", "WORKSFORME") FILTER html %]
All attempts at reproducing this [% terms.bug %] were futile, @@ -191,141 +206,77 @@ cycle of [% terms.abug %]. the [% terms.bug %] can be reopened.
-
- [% display_value("resolution", "MOVED") FILTER html %] -
-
- 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. -
+ [% IF Param('move-enabled') %] +
+ [% display_value("resolution", "MOVED") FILTER html %] +
+
+ 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. +
+ [% END %]
-

Importance

-The importance of [% terms.abug %] is described as the combination of -its priority and severity, -as described below. - -

Priority

-This field describes the importance and order in which [% terms.abug %] -should be fixed compared to other [% terms.bugs %]. This field is utilized -by the programmers/engineers to prioritize their work to be done. - -

Severity

-This field describes the impact of [% terms.abug %]. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
[% display_value("bug_severity", "blocker") FILTER html %]Blocks development and/or testing work
[% display_value("bug_severity", "critical") FILTER html %]crashes, loss of data, severe memory leak
[% display_value("bug_severity", "major") FILTER html %]major loss of function
[% display_value("bug_severity", "normal") FILTER html %]regular issue, some loss of functionality under specific circumstances
[% display_value("bug_severity", "minor") FILTER html %]minor loss of function, or other problem where easy - workaround is present
[% display_value("bug_severity", "trivial") FILTER html %]cosmetic problem like misspelled words or misaligned - text
[% display_value("bug_severity", "enhancement") FILTER html %]Request for enhancement
- -

Platform

-This is the hardware platform against which the [% terms.bug %] was -reported. Legal platforms include: - -
    -
  • [% display_value("rep_platform", "All") FILTER html %] (happens on all platforms; cross-platform [% terms.bug %])
    • - -
  • [% display_value("rep_platform", "Macintosh") FILTER html %]
    • - -
  • [% display_value("rep_platform", "PC") FILTER html %]
    • -
-Note: When searching, selecting the option -[% display_value("rep_platform", "All") FILTER html %] does not -select [% terms.bugs %] -assigned against any platform. It merely selects [% terms.bugs %] that are -marked as occurring on all platforms, i.e. are designated -[% display_value("rep_platform", "All") FILTER html %]. - -

Operating System

-This is the operating system against which the [% terms.bug %] was -reported. Legal operating systems include: +

Other Fields

-
    -
  • [% display_value("op_sys", "All") FILTER html %] (happens on all operating systems; cross-platform - [% terms.bug %])
    • +[% PROCESS "bug/field-help.none.tmpl" %] -
  • Windows
    • - -
  • Mac OS
    • - -
  • Linux
    • -
-Sometimes the operating system implies the platform, but not -always. For example, Linux can run on PC and Macintosh and -others. - -

Assigned To

- -

-This is the person in charge of resolving the [% terms.bug %]. Every time -this field changes, the status changes to [% display_value("bug_status", "NEW") FILTER html %] to make it -easy to see which new [% terms.bugs %] have appeared on a person's list.

- -

-The default status for queries is set to [% display_value("bug_status", "NEW") FILTER html %], -[%+ display_value("bug_status", "ASSIGNED") FILTER html %] and [% display_value("bug_status", "REOPENED") FILTER html %]. -When searching for [% terms.bugs %] that have been resolved or -verified, remember to set the status field appropriately. -

- -[% IF Param("use_see_also") %] -

See Also

- -

This allows you to refer to [% terms.bugs %] in other installations. - You can enter a URL to a [%+ terms.bug %] in the "Add [% terms.Bug %] URLs" - field to note that that [% terms.bug %] is related to this one. You can - enter multiple URLs at once by separating them with a comma.

+[% 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 %] -

You should normally use this field to refer to [% terms.bugs %] in - other installations. For [% terms.bugs %] in this - installation, it is better to use the "Depends On" and "Blocks" - fields.

+[%# 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', +] %] + +
+[% 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) %] + +
[% field_desc FILTER html %]
+
+ [% SET help_text = field_help_map.${field_desc}.help %] + [% IF help_text %] + [% help_text FILTER none %] + [% ELSE %] + A custom [% field_types.${field_object.type} FILTER html %] field in + this installation of [% terms.Bugzilla %]. + [% END %] +
[% END %] +
-[% INCLUDE global/footer.html.tmpl %] +[% PROCESS global/footer.html.tmpl %] -- cgit v1.2.3-24-g4f1b