Enhance chrome://omnibox Presentation

chrome/browser/resources/omnibox/omnibox.js

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 /**
  * Javascript for omnibox.html, served from chrome://omnibox/
  * This is used to debug omnibox ranking.  The user enters some text
  * into a box, submits it, and then sees lots of debug information
  * from the autocompleter that shows what omnibox would do with that
  * input.
@@ skipping 45 matching lines @@
   /**
    * Returns a simple object with information about how to display an
    * autocomplete result data field.
    * @param {string} header the label for the top of the column/table.
    * @param {string} urlLabelForHeader the URL that the header should point
    *     to (if non-empty).
    * @param {string} propertyName the name of the property in the autocomplete
    *     result record that we lookup.
    * @param {boolean} displayAlways whether the property should be displayed
    *     regardless of whether we're in detailed more.
+   * @param {string} tooltip a description of the property that will be
+   *     presented as a tooltip when the mouse is hovered over the column title.
    * @constructor
    */
-  function PresentationInfoRecord(header, url, propertyName, displayAlways) {
+  function PresentationInfoRecord(header, url, propertyName, displayAlways,
+                                  tooltip) {
     this.header = header;
     this.urlLabelForHeader = url;
     this.propertyName = propertyName;
     this.displayAlways = displayAlways;
+    this.tooltip = tooltip;
   }
 
   /**
    * A constant that's used to decide what autocomplete result
    * properties to output in what order.  This is an array of
    * PresentationInfoRecord() objects; for details see that
    * function.
    * @type {Array.<Object>}
    * @const
    */
   var PROPERTY_OUTPUT_ORDER = [
-    new PresentationInfoRecord('Provider', '', 'provider_name', true),
-    new PresentationInfoRecord('Type', '', 'type', true),
-    new PresentationInfoRecord('Relevance', '', 'relevance', true),
-    new PresentationInfoRecord('Contents', '', 'contents', true),
-    new PresentationInfoRecord('Starred', '', 'starred', false),
+    new PresentationInfoRecord('Provider', '', 'provider_name', true,
+        'The AutocompleteProvider suggesting this result.'),
+    new PresentationInfoRecord('Type', '', 'type', true,
+        'The type of the result.'),
+    new PresentationInfoRecord('Relevance', '', 'relevance', true,
+        'The result score. Higher is more relevant.'),
+    new PresentationInfoRecord('Contents', '', 'contents', true,
+        'The text that is presented identifying the result.'),
+    new PresentationInfoRecord('Starred', '', 'starred', false,
+        'If checked the result has been bookmarked.'),

[Mark P, 2012/07/10 19:41:12]

Optional nit: sometimes below the tooltips are
If checked ...
and some are
Checked when ...
and one is
A green checkmark indicates ...

Consider making all these read similarly unless they read better in different
versions.

[mrossetti, 2012/07/14 02:34:06]

Done.

     new PresentationInfoRecord(
-        'Is History What You Typed Match', '',
-        'is_history_what_you_typed_match', false),
-    new PresentationInfoRecord('Description', '', 'description', false),
-    new PresentationInfoRecord('URL', '', 'destination_url', true),
-    new PresentationInfoRecord('Fill Into Edit', '', 'fill_into_edit', false),
+        'HWYT', '', 'is_history_what_you_typed_match', false,
+        'If checked the result is an History What You Typed Match'),
+    new PresentationInfoRecord('Description', '', 'description', false,
+        'The page title or suggestion provider name.'),

[Mark P, 2012/07/10 19:41:12]

This doesn't seem accurate.

[mrossetti, 2012/07/14 02:34:06]

Fixed.

+    new PresentationInfoRecord('URL', '', 'destination_url', true,
+        'The URL for the result.'),
+    new PresentationInfoRecord('Fill Into Edit', '', 'fill_into_edit', false,
+        'The text shown in the omnibox when the suggestion is selected.'),
     new PresentationInfoRecord(
-        'Inline Autocomplete Offset', '', 'inline_autocomplete_offset', false),
-    new PresentationInfoRecord('Deletable', '', 'deletable', false),
-    new PresentationInfoRecord('From Previous', '', 'from_previous', false),
+        'IAO', '', 'inline_autocomplete_offset', false,
+        'The Inline Autocomplete Offset.'),
+    new PresentationInfoRecord('Del', '', 'deletable', false,
+        'Checked when the results can be deleted from the visit history.'),
+    new PresentationInfoRecord('Prev', '', 'from_previous', false,
+        'A green checkmkark indicates that the result was'),

[Mark P, 2012/07/10 19:41:12]

This doesn't actually say much of anything.

[mrossetti, 2012/07/14 02:34:06]

I actually don't know what this column means so I cleared it for now.

     new PresentationInfoRecord(
-        'Transition Type',
+        'Tran',
         'http://code.google.com/codesearch#OAMlx_jo-ck/src/content/public/' +
         'common/page_transition_types.h&exact_package=chromium&l=24',
-        'transition', false),
+        'transition', false,
+        'How the user got to the result.'),
     new PresentationInfoRecord(
-        'Is This Provider Done', '', 'provider_done', false),
+        'Done', '', 'provider_done', false,
+        'Checked when the provider is done looking for more suggestions.'),
     new PresentationInfoRecord(
-        'Template URL', '', 'template_url', false)
+        'Template URL', '', 'template_url', false, ''),
+    new PresentationInfoRecord(
+        'Diagnostics', '', 'diagnostics', false,
+        'Provider-specific information about each suggestion.')

[Mark P, 2012/07/10 19:41:12]

I'd prefer result instead of suggestion here.

Actually, in general we're sometimes saying suggestion in this tooltips and
sometimes saying result.  Consider making these consistent.

[mrossetti, 2012/07/14 02:34:06]

Done.

   ];
 
   /**
    * Returns an HTML Element of type table row that contains the
    * headers we'll use for labeling the columns.  If we're in
    * detailed_mode, we use all the headers.  If not, we only use ones
    * marked displayAlways.
    */
   function createAutocompleteResultTableHeader() {
     var row = document.createElement('tr');
     var inDetailedMode = $('show-details').checked;
     for (var i = 0; i < PROPERTY_OUTPUT_ORDER.length; i++) {
       if (inDetailedMode || PROPERTY_OUTPUT_ORDER[i].displayAlways) {
         var headerCell = document.createElement('th');
         if (PROPERTY_OUTPUT_ORDER[i].urlLabelForHeader != '') {
           // Wrap header text in URL.
           var linkNode = document.createElement('a');
           linkNode.href = PROPERTY_OUTPUT_ORDER[i].urlLabelForHeader;
           linkNode.textContent = PROPERTY_OUTPUT_ORDER[i].header;
           headerCell.appendChild(linkNode);
         } else {
           // Output header text without a URL.
           headerCell.textContent = PROPERTY_OUTPUT_ORDER[i].header;
           headerCell.className = 'table-header';
+          headerCell.title = PROPERTY_OUTPUT_ORDER[i].tooltip;
         }
         row.appendChild(headerCell);
       }
     }
     return row;
   }
 
   /**
    * @param {Object} autocompleteSuggestion the particular autocomplete
    *     suggestion we're in the process of displaying.
    * @param {string} propertyName the particular property of the autocomplete
    *     suggestion that should go in this cell.
    * @return {HTMLTableCellElement} that contains the value within this
    *     autocompleteSuggestion associated with propertyName.
    */
   function createCellForPropertyAndRemoveProperty(autocompleteSuggestion,
                                                   propertyName) {
     var cell = document.createElement('td');
     if (propertyName in autocompleteSuggestion) {
-      if (typeof autocompleteSuggestion[propertyName] == 'boolean') {
+      if (propertyName == 'diagnostics') {
+        // |diagnostics| presents a two-column table of provider-specific data.

[Mark P, 2012/07/10 19:41:12]

Perhaps:
presents -> embeds
and append:
within this cell.

[mrossetti, 2012/07/14 02:34:06]

Done.

+        var diagnostic_table = document.createElement('table');
+        for (var diagnostic_key in autocompleteSuggestion[propertyName]) {
+          var diagnostic_row = document.createElement('tr');
+          var property_cell = document.createElement('td');
+          property_cell.textContent = diagnostic_key + ':';

[Mark P, 2012/07/10 19:41:12]

Does the ':' add to readability of the table?

[mrossetti, 2012/07/14 02:34:06]

Yes.

+          property_cell.className = 'diagnostic-property';
+          diagnostic_row.appendChild(property_cell);
+          var value_cell = document.createElement('td');
+          value_cell.textContent =
+              autocompleteSuggestion[propertyName][diagnostic_key];
+          value_cell.className = 'diagnostic-value';
+          diagnostic_row.appendChild(value_cell);
+          diagnostic_table.appendChild(diagnostic_row);
+        }
+        cell.appendChild(diagnostic_table);
+      } else if (typeof autocompleteSuggestion[propertyName] == 'boolean') {
         // If this is a boolean, display a checkmark or an X instead of
         // the strings true or false.
         if (autocompleteSuggestion[propertyName]) {
           cell.className = 'check-mark';
           cell.textContent = '✔';
         } else {
           cell.className = 'x-mark';
           cell.textContent = '✗';
         }
       } else {
@@ skipping 201 matching lines @@
   }
 
   return {
     initialize: initialize,
     startOmniboxQuery: startOmniboxQuery,
     handleNewAutocompleteResult: handleNewAutocompleteResult
   };
 });
 
 document.addEventListener('DOMContentLoaded', omniboxDebug.initialize);