From 629f2c959658c50ec2f4790b80bfe5ff30e3cd82 Mon Sep 17 00:00:00 2001
From: rojanu <aliustek@gmail.com>
Date: Thu, 17 May 2012 01:22:41 +0200
Subject: Bug 728138: Custom fields should have a "Long Description" attribute
 to better understand what they are used for r/a=LpSolit

---
 .../default/admin/custom_fields/create.html.tmpl   | 34 +++++++++------
 .../en/default/admin/custom_fields/edit.html.tmpl  | 48 ++++++++++++++--------
 template/en/default/bug/field-help.none.tmpl       | 18 ++++----
 template/en/default/global/user-error.html.tmpl    |  5 +++
 4 files changed, 68 insertions(+), 37 deletions(-)

(limited to 'template')

diff --git a/template/en/default/admin/custom_fields/create.html.tmpl b/template/en/default/admin/custom_fields/create.html.tmpl
index fe4a1df77..fb7f06f86 100644
--- a/template/en/default/admin/custom_fields/create.html.tmpl
+++ b/template/en/default/admin/custom_fields/create.html.tmpl
@@ -96,18 +96,16 @@ YAHOO.util.Event.onDOMReady(function() {onChangeType(document.getElementById('ty
     </tr>
 
     <tr>
-      <th class="narrow_label">
-        <label for="reverse_desc">Reverse Relationship Description:</label>
-      </th>
+      <th class="narrow_label">Long Description:</th>
       <td>
-        <input type="text" id="reverse_desc" name="reverse_desc" value="" size="40" disabled="disabled">
-        <br/>
-        Use this label for the list of [% terms.bugs %] that link to
-        [%+ terms.abug %] with this 
-        [%+ field_types.${constants.FIELD_TYPE_BUG_ID} FILTER html %]
-        field. For example, if the description is "Is a duplicate of",
-        the reverse description would be "Duplicates of this [% terms.bug %]".
-        Leave blank to disable the list for this field.
+         [% INCLUDE global/textarea.html.tmpl
+          name           = 'long_desc'
+          id             = 'long_desc'
+          minrows        = 3
+          maxrows        = 5
+          cols           = 46
+          defaultcontent = defaultcontent
+        %]
       </td>
       <th>
         <label for="visibility_field_id">Field only appears when:</label>
@@ -134,7 +132,19 @@ YAHOO.util.Event.onDOMReady(function() {onChangeType(document.getElementById('ty
     </tr>
 
     <tr>
-      <td colspan="2">&nbsp;</td>
+      <th class="narrow_label">
+        <label for="reverse_desc">Reverse Relationship Description:</label>
+      </th>
+      <td>
+        <input type="text" id="reverse_desc" name="reverse_desc" value="" size="40" disabled="disabled">
+        <br/>
+        Use this label for the list of [% terms.bugs %] that link to
+        [%+ terms.abug %] with this 
+        [%+ field_types.${constants.FIELD_TYPE_BUG_ID} FILTER html %]
+        field. For example, if the description is "Is a duplicate of",
+        the reverse description would be "Duplicates of this [% terms.bug %]".
+        Leave blank to disable the list for this field.
+      </td>
       <th>
         <label for="value_field_id">
           Field that controls the values<br>
diff --git a/template/en/default/admin/custom_fields/edit.html.tmpl b/template/en/default/admin/custom_fields/edit.html.tmpl
index 55863f2ec..a1d739365 100644
--- a/template/en/default/admin/custom_fields/edit.html.tmpl
+++ b/template/en/default/admin/custom_fields/edit.html.tmpl
@@ -76,24 +76,17 @@
                  [%- ' checked="checked"' IF field.is_mandatory %]></td>
     </tr>
     <tr>
-      [% IF field.type == constants.FIELD_TYPE_BUG_ID %]
-        <th class="narrow_label">
-          <label for="reverse_desc">Reverse Relationship Description:</label>
-        </th>
-        <td>
-          <input type="text" id="reverse_desc" name="reverse_desc" size="40"
-                 value="[% field.reverse_desc FILTER html %]">
-          <br/>
-          Use this label for the list of [% terms.bugs %] that link to
-          [%+ terms.abug %] with this 
-          [%+ field_types.${constants.FIELD_TYPE_BUG_ID} FILTER html %] field.
-          For example, if the description is "Is a duplicate of",
-          the reverse description would be "Duplicates of this [% terms.bug %]".
-          Leave blank to disable the list for this field.
-        </td>
-      [% ELSE %]
-        <td colspan="2">&nbsp;</td>
-      [% END %]
+      <th class="narrow_label">Long Description:</th>
+      <td>
+        [% INCLUDE global/textarea.html.tmpl
+         name           = 'long_desc'
+         id             = 'long_desc'
+         minrows        = 3
+         maxrows        = 5
+         cols           = 46
+         defaultcontent = field.long_desc
+       %]
+      </td>
       <th>
         <label for="visibility_field_id">Field only appears when:</label>
       </th>
@@ -128,6 +121,25 @@
         </select>
       </td>
     </tr>
+    [% IF field.type == constants.FIELD_TYPE_BUG_ID %]
+      <tr>
+        <th class="narrow_label">
+          <label for="reverse_desc">Reverse Relationship Description:</label>
+        </th>
+        <td>
+          <input type="text" id="reverse_desc" name="reverse_desc" size="40"
+                 value="[% field.reverse_desc FILTER html %]">
+          <br/>
+          Use this label for the list of [% terms.bugs %] that link to
+          [%+ terms.abug %] with this 
+          [%+ field_types.${constants.FIELD_TYPE_BUG_ID} FILTER html %] field.
+          For example, if the description is "Is a duplicate of",
+          the reverse description would be "Duplicates of this [% terms.bug %]".
+          Leave blank to disable the list for this field.
+        </td>
+        <td colspan="2">&nbsp;</td>
+      </tr>
+    [% END %]
     [% IF field.is_select %]
       <tr>
         <th>&nbsp;</th>
diff --git a/template/en/default/bug/field-help.none.tmpl b/template/en/default/bug/field-help.none.tmpl
index f76fa9639..4b32410cd 100644
--- a/template/en/default/bug/field-help.none.tmpl
+++ b/template/en/default/bug/field-help.none.tmpl
@@ -214,13 +214,17 @@ email1 =>
 
   [%# Add help for custom fields. %]
   [% IF !vars.help_html.${help_field}.defined %]
-    [% SET field_type = bug_fields.${help_field}.type %]
-    [% field_type_desc = BLOCK -%]
-      [% field_types.$field_type FILTER html %]
-    [%- END %]
-    [% vars.help_html.${help_field} = 
-      "A custom $field_type_desc field in this installation"
-      _ " of ${terms.Bugzilla}." %]
+    [% IF bug_fields.${help_field}.long_desc %]
+      [% vars.help_html.${help_field} = bug_fields.${help_field}.long_desc %]
+    [% ELSE %]
+      [% SET field_type = bug_fields.${help_field}.type %]
+      [% field_type_desc = BLOCK -%]
+        [% field_types.$field_type FILTER html %]
+      [%- END %]
+      [% vars.help_html.${help_field} = 
+        "A custom $field_type_desc field in this installation"
+        _ " of ${terms.Bugzilla}." %]
+    [% END %]
   [% END %]
 
   [%# Add help for the search types, for query.cgi. %]
diff --git a/template/en/default/global/user-error.html.tmpl b/template/en/default/global/user-error.html.tmpl
index eb77420f0..5d862aa9f 100644
--- a/template/en/default/global/user-error.html.tmpl
+++ b/template/en/default/global/user-error.html.tmpl
@@ -491,6 +491,11 @@
     [% title = "Missing Description for Field" %]
     You must enter a description for this field.
 
+  [% ELSIF error == "field_long_desc_too_long" %]
+    [% title = "Long Description for Field too long" %]
+    The long description you have provided for this field is longer than 
+    [% constants.MAX_FIELD_LONG_DESC_LENGTH FILTER html %] characters.
+
   [% ELSIF error == "field_missing_name" %]
     [% title = "Missing Name for Field" %]
     You must enter a name for this field.
-- 
cgit v1.2.3-24-g4f1b