summaryrefslogtreecommitdiffstats
path: root/docs/en/xml
diff options
context:
space:
mode:
authorFrédéric Buclin <LpSolit@gmail.com>2011-12-08 23:44:35 +0100
committerFrédéric Buclin <LpSolit@gmail.com>2011-12-08 23:44:35 +0100
commit2b3d59beabaa45698effb6f72ccb5ee8201df044 (patch)
tree6ff4eedb4c4aafe37b3419d89c833bc2d964a9f4 /docs/en/xml
parent62410084926e1473c903c43b53d09c99311746c2 (diff)
downloadbugzilla-2b3d59beabaa45698effb6f72ccb5ee8201df044.tar.gz
bugzilla-2b3d59beabaa45698effb6f72ccb5ee8201df044.tar.xz
Bug 707170: Several features about custom fields are missing in the documentation
r=dkl a=LpSolit
Diffstat (limited to 'docs/en/xml')
-rw-r--r--docs/en/xml/administration.xml57
1 files changed, 50 insertions, 7 deletions
diff --git a/docs/en/xml/administration.xml b/docs/en/xml/administration.xml
index cabb772d2..1630e2e45 100644
--- a/docs/en/xml/administration.xml
+++ b/docs/en/xml/administration.xml
@@ -2408,6 +2408,16 @@ ReadOnly: ENTRY, NA/NA, CANEDIT
<listitem>
<para>
+ <emphasis>Reverse Relationship Description:</emphasis>
+ When the custom field is of type <quote>Bug ID</quote>, you can
+ enter text here which will be used as label in the referenced
+ bug to list bugs which point to it. This gives you the ability
+ to have a mutual relationship between two bugs.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
<emphasis>Can be set on bug creation:</emphasis>
Boolean that determines whether this field can be set on
bug creation. If not selected, then a bug must be created
@@ -2442,6 +2452,35 @@ ReadOnly: ENTRY, NA/NA, CANEDIT
must be entered.
</para>
</listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Field only appears when:</emphasis>
+ A custom field can be made visible when some criteria is met.
+ For instance, when the bug belongs to one or more products,
+ or when the bug is of some given severity. If left empty, then
+ the custom field will always be visible, in all bugs.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Field that controls the values that appear in this field:</emphasis>
+ When the custom field is of type <quote>Drop Down</quote> or
+ <quote>Multiple-Selection Box</quote>, you can restrict the
+ availability of the values of the custom field based on the
+ value of another field. This criteria is independent of the
+ criteria used in the <quote>Field only appears when</quote>
+ setting. For instance, you may decide that some given value
+ <quote>valueY</quote> is only available when the bug status
+ is RESOLVED while the value <quote>valueX</quote> should
+ always be listed.
+ Once you have selected the field which should control the
+ availability of the values of this custom field, you can
+ edit values of this custom field to set the criteria, see
+ <xref linkend="edit-values-list" />.
+ </para>
+ </listitem>
</itemizedlist>
</para>
</section>
@@ -2476,13 +2515,12 @@ ReadOnly: ENTRY, NA/NA, CANEDIT
<title>Legal Values</title>
<para>
- Since Bugzilla 2.20 RC1, legal values for Operating Systems, platforms,
- bug priorities and severities can be edited from the User Interface
- directly. This means that it is no longer required to manually edit
- <filename>localconfig</filename>. Starting with Bugzilla 2.23.3,
- the list of valid resolutions can be customized from the same interface.
- Since Bugzilla 3.1.1 the list of valid bug statuses can be customized
- as well.
+ Legal values for the operating system, platform, bug priority and
+ severity, custom fields of type <quote>Drop Down</quote> and
+ <quote>Multiple-Selection Box</quote> (see <xref linkend="custom-fields" />),
+ as well as the list of valid bug statuses and resolutions can be
+ customized from the same interface. You can add, edit, disable and
+ remove values which can be used with these fields.
</para>
<section id="edit-values-list">
@@ -2498,6 +2536,11 @@ ReadOnly: ENTRY, NA/NA, CANEDIT
must be unique to that field. The sortkey is important to display these
values in the desired order.
</para>
+ <para>
+ When the availability of the values of a custom field is controlled
+ by another field, you can select from here which value of the other field
+ must be set for the value of the custom field to appear.
+ </para>
</section>
<section id="edit-values-delete">