1236365 - Remove references to Sidebar search results from Help

Status: RESOLVED FIXED

(SeaMonkey :: Help Documentation, defect)

Description

[Isaac Schemm]

User Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:42.0) Gecko/20100101 Firefox/42.0 SeaMonkey/2.39
Build ID: 20151103191810

Steps to reproduce:

View the "Browsing the Web" and "Customizing SeaMonkey" sections of Help


Actual results:

1. The "Searching the Web" section refers several times to search results being displayed in the sidebar, which has not been the case since SeaMonkey 2.1 (see bug 673190).
2. The Sidebar description text refers to "the latest news and weather, your address book, stock quotes, a calendar" - most of which are not included in SeaMonkey (my guess is they were originally pages hosted by Netscape.)
3. Sidebar Directory is mentioned, but is not currently functional.


Expected results:

1. The help text should not say that search results will appear in the sidebar.
2. The sidebar description text should only explicitly mention sidebars if they included with SeaMonkey.
3. Sidebar Directory should not be mentioned unless it is brought back.

Comment 1

[Isaac Schemm]

Attachment: help-sidebar.patch

This patch removes mentions of Sidebar Directory and the appearance of search results in the sidebar, updates the description of the Internet Search section of Preferences, and changes the description of Sidebar to only refer explicitly to bookmarks, history, and address book.

Comment 2

[Isaac Schemm]

Comment on attachment 8703438 [details] [diff] [review]
help-sidebar.patch

># HG changeset patch
># User Isaac Schemm <[e-mail]>
># Parent  f139b53668d2ccf9b1aa58deee8d9769802b2815
>Update SeaMonkey help contents to reflect the current sidebar functionality and removal of search results in sidebar (bug 673190)
>
>diff --git a/suite/locales/en-US/chrome/common/help/customize_help.xhtml b/suite/locales/en-US/chrome/common/help/customize_help.xhtml
>--- a/suite/locales/en-US/chrome/common/help/customize_help.xhtml
>+++ b/suite/locales/en-US/chrome/common/help/customize_help.xhtml
>@@ -66,18 +66,18 @@
>     <li><a href="#reorganizing_sidebar_tabs">Reorganizing Sidebar Tabs</a></li>
>     <li><a href="#removing_sidebar_tabs">Removing Sidebar Tabs</a></li>
>   </ul>
> </div>
> 
> <h3 id="what_is_sidebar">What is Sidebar?</h3>
> 
> <p>Sidebar is a customizable area in your browser where you can keep items
>-  that you need to use all the time&mdash;the latest news and weather, your
>-  address book, stock quotes, a calendar&mdash;and many other available
>+  that you need to use all the time, including your bookmarks, browser history,
>+  address book, and other available
>   options. Sidebar presents these items to you in tabs that are continually
>   updated.</p>
> 
> <p>&brandShortName; comes with some Sidebar tabs already set up, but you can
>   customize Sidebar by adding, removing, and rearranging tabs.</p>
> 
> <p>[<a href="#sidebar">Return to beginning of section</a>]</p>
> 
>@@ -158,19 +158,16 @@
>   
> <p><strong>Tips</strong>:</p>
> 
> <ul>
>   <li>To preview a Sidebar tab before adding it, select a tab from the list
>     on the left side of the Customize Sidebar dialog box and click Preview.
>     After a few seconds, the tab displays in the Tab Preview pop-up
>     window.</li>
>-  <li>To view an extensive and categorized list of tabs available for Sidebar,
>-    click <q>Tabs</q> at the top of Sidebar, and select Sidebar
>-    Directory.</li>
> </ul>
> 
> <p>You can also turn Sidebar tabs on and off.</p>
> 
> <ol>
>   <li>Click <q>Tabs</q> at the top of Sidebar. Current tabs are listed in
>     the lower part of the menu.</li>
>   <li>Select the tabs you want displayed in Sidebar. Remove the checkmark
>diff --git a/suite/locales/en-US/chrome/common/help/images/sidebar-advanced.png b/suite/locales/en-US/chrome/common/help/images/sidebar-advanced.png
>deleted file mode 100644
>index 34768e6b0bc2f10a20cb41678832ec363037c1ad..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
>GIT binary patch
>literal 0
>Hc$@<O00001
>
>diff --git a/suite/locales/en-US/chrome/common/help/nav_help.xhtml b/suite/locales/en-US/chrome/common/help/nav_help.xhtml
>--- a/suite/locales/en-US/chrome/common/help/nav_help.xhtml
>+++ b/suite/locales/en-US/chrome/common/help/nav_help.xhtml
>@@ -350,18 +350,18 @@
> <p>[<a href="#navigating_web_pages">Return to beginning of section</a>]</p>
> 
> <h2 id="using_sidebar">Using Sidebar</h2>
> 
> <p>In addition to navigating the Web with the browser, you can let the Web come
>   to you by using Sidebar.</p>
> 
> <p>Sidebar is a customizable frame in your browser where you can keep items
>-  that you need to use all the time&mdash;the latest news and weather, your
>-  address book, stock quotes, a calendar&mdash;and many other available
>+  that you need to use all the time, including your bookmarks, browser history,
>+  address book, and other available
>   options. Sidebar presents these items to you in tabs that it continually
>   updates.</p>
> 
> <p>&brandShortName; comes with some Sidebar tabs already set up, but you can
>   customize Sidebar by adding, removing, and rearranging tabs. For details,
>   see <a href="customize_help.xhtml#sidebar">Sidebar</a>.</p>
> 
> <p>To view an item in Sidebar, click its tab.</p>
>@@ -383,18 +383,16 @@
> 
> <p>[<a href="#navigating_web_pages">Return to beginning of section</a>]</p>
> 
> <h1 id="searching_the_web">Searching the Web</h1>
> 
> <div class="contentsBox">In this section:
>   <ul>
>     <li><a href="#fast_searches">Fast Searches</a></li>
>-    <li><a href="#sidebar_advanced_search_mode">Sidebar Advanced Search
>-      Mode</a></li>
>     <li><a href="#setting_search_preferences">Setting Search
>       Preferences</a></li>
>     <li><a href="#searching_within_a_page">Searching Within a Page</a></li>
>     <li><a href="#using_find_as_you_type">Using Find-as-you-type</a></li>
>     <li><a href="#searching_the_bookmarks_or_history_list">Searching the
>       Bookmarks or History List</a></li>
>   </ul>
> </div>
>@@ -424,72 +422,57 @@
>       <li>Click the Search button.</li>
>       <li>Click <q>Search Google for <q>baby doll</q></q> at the bottom of the
>         drop-down list in the Location Bar. (Your default search engine may be
>         different.)
> 
>         <p>The default search engine you choose in the
>           <a href="cs_nav_prefs_navigator.xhtml#internet_search">Internet
>           Search Preferences</a> is used. Search results for <q>baby doll</q>
>-          appear in both the browser window and in Sidebar. Click the links to
>+          appear in the browser window. Click the links to
>           visit web pages about baby dolls.</p>
>       </li>
>     </ul>
>   </li>
> </ol>
> 
>-<p>After you perform a search, the results are saved in Sidebar&apos;s Search
>-  tab until you do a new search. You don&apos;t have to click the Back button
>-  to retrieve the search results.</p>
>-
> <p><strong>Note</strong>: In the <q>Unknown Locations</q> section of the
>   <a href="cs_nav_prefs_navigator.xhtml#location_bar">Location Bar
>   Preferences</a>, you can set up the Location Bar so a search is automatically
>   performed if the text you have typed is not a web location. Typing a word in
>   the Location Bar and pressing <kbd class="noMac">Enter</kbd><kbd class="mac">
>   Return</kbd> will then perform a search.</p>
> 
> <h3 id="searching_from_sidebar">Searching from Sidebar</h3>
> 
>-<p>The Sidebar Search tab lets you quickly search and bookmark your search
>-  results. For example, if you want to find information about toy cars:</p>
>+<p>The Sidebar Search tab lets you keep a search bar in your sidebar.
>+  For example, if you want to find information about toy cars:</p>
> 
> <ol>
>   <li>If it is not already open, open Sidebar by clicking its handle. If the
>     handle is missing, <span class="noMac">press <kbd>F9</kbd> or </span>open
>     the View menu in the browser, choose Show/Hide, and then Sidebar from the
>     submenu.</li>
>   <li>Click the Search tab in Sidebar.</li>
>-  <li>Open the <q>using</q> drop-down list, and choose a search
>+  <li>Open the drop-down list, and choose a search
>     engine.</li>
>   <li>Type <q>toy car</q> in the search field.</li>
>-  <li>Click Search. Search results for &apos;toy car&apos; appear in both the
>-    browser window and in Sidebar. Click the links to visit web pages about toy
>+  <li>Click Search. Search results for &apos;toy car&apos; appear in the
>+    browser window. Click the links to visit web pages about toy
>     cars.</li>
> </ol>
> 
>-<p><strong>Note</strong>: If the Sidebar Search tab contains a list of search
>-  engines from which to choose, then it is set to search in
>-  <a href ="#sidebar_advanced_search_mode">Advanced mode</a> and you will have
>-  to choose one or more search engines before clicking Search. You can keep it
>-  that way or change to a basic setting in Preferences.</p>
>-
>-<p><strong>Tip</strong>: To display the next or previous page of search results
>-  quickly, click the Next and Previous buttons at the bottom of the Sidebar
>-  Search tab.</p>
>-
> <p>See <a href="customize_help.xhtml#sidebar">Sidebar</a> for more information
>   on how to use Sidebar.</p>
> 
>-<h3 id="searching_from_the_net_search_page">Searching from the Net
>-  Search page</h3>
>+<h3 id="searching_from_the_net_search_page">Searching from your search engine's
>+  home page</h3>
> 
>-<p>The Net Search page lets you type in a Search term or phrase, or explore
>-  several categories (such as Arts &amp; Entertainment, Business, and many
>-  more) that may interest you. To visit the Net Search page, perform one of
>+<p>You can also perform a search from your search engine's home page.
>+  To visit this page, perform one of
>   these steps:</p>
> 
> <ul>
>   <li>Click on the Search button <img src="images/search_personal_toolbar.gif"
>     width="66" height="20" alt="search button"/> on the Navigation Toolbar.</li>
>   <li>Open the Tools menu and choose Search the Web.</li>
> </ul>
> 
>@@ -510,100 +493,35 @@
>   and uses your default search engine to search for your selected words. To
>   learn how to change the search engine used to search for your selected words
>   and the way your search results are displayed, see
>   <a href="cs_nav_prefs_navigator.xhtml#internet_search">Browser Preferences
>   - Internet Search</a>.</p>
> 
> <p>[<a href="#searching_the_web">Return to beginning of section</a>]</p>
> 
>-<h2 id="sidebar_advanced_search_mode">Sidebar Advanced Search Mode</h2>
>-
>-<p>You can set the Sidebar Search tab to Advanced mode, which lets you narrow a
>-  search or choose one or more search engines.</p>
>-
>-<ol>
>-  <li>Open the
>-    <span class="mac">&brandShortName;</span> <span class="noMac">Edit</span>
>-    menu and choose Preferences.</li>
>-  <li>Under the Browser category, click Internet Search. (If no subcategories
>-    are visible, double-click Browser to expand the list.)</li>
>-  <li>Under Sidebar Search Tab Preferences, click Advanced, and then OK.</li>
>-  <li>If it is not already open, open Sidebar by clicking its handle. If the
>-    handle is missing, <span class="noMac">press <kbd>F9</kbd> or</span>open
>-    the View menu in the browser, choose Show/Hide, and then Sidebar from the
>-    submenu.</li>
>-  <li>Click the Search tab in Sidebar.</li>
>-  <li>Open the <q>within</q> drop-down list, and choose a category.</li>
>-  <li>Choose one or more search engines for the selected category (if
>-    available).</li>
>-  <li>In the search field, type the word for which you want to search.</li>
>-  <li>Click Search.</li>
>-</ol>
>-
>-<p><img src="images/sidebar-advanced.png" alt="Sidebar Search"/></p>
>-
>-<h3 id="customizing_search_categories">Customizing Search Categories</h3>
>-
>-<p>You can specify which search engines should be used for different categories
>-  of searches. For example, you can select one set of search engines to search
>-  for travel, and select another set of search engines to search for
>-  software.</p>
>-
>-<ol>
>-  <li>Set Sidebar Search to Advanced Search Mode. See
>-    <a href="#sidebar_advanced_search_mode">Sidebar Advanced Search Mode</a>
>-    for details.</li>
>-  <li>If it is not already open, open Sidebar by clicking its handle. If the
>-    handle is missing, open the View menu in the browser, choose Show/Hide, and
>-    then Sidebar from the submenu.</li>
>-  <li>Click the Search tab in Sidebar.</li>
>-  <li>Open the <q>within</q> drop-down list, click <q>Edit
>-    Categories</q>. You see the Edit Categories dialog box.</li>
>-  <li>From the Categories drop-down list, choose the category you want to
>-    customize.<br/>
>-    Or<br/>
>-    To create a new category, click New and type a name for the category in the
>-    dialog box. The drop-down list now displays the name of the selected
>-    category.</li>
>-  <li>Do one of the following:
>-    <ul>
>-      <li>To add a search engine for the selected category, highlight the
>-        search engine in the list on the left, and click Add.</li>
>-      <li>To remove a search engine for the selected category, highlight the
>-        engine in the list on the right, and click Remove.</li>
>-      <li>To rename the selected category, click Rename and type a new
>-        name.</li>
>-      <li>To delete the selected category, click Delete.</li>
>-    </ul>
>-  </li>
>-  <li>Click OK when you are finished customizing.</li>
>-</ol>
>-
>-<p>[<a href="#searching_the_web">Return to beginning of section</a>]</p>
>-
> <h2 id="setting_search_preferences">Setting Search Preferences</h2>
> 
> <p>You can choose a different search engine as the default. You can also
>-  specify how you want search results displayed in Sidebar.</p>
>+  specify how you want search results displayed.</p>
> 
> <ol>
>   <li>Open the
>     <span class="mac">&brandShortName;</span> <span class="noMac">Edit</span>
>     menu and choose Preferences.</li>
>   <li>Under the Browser category, click Internet Search. (If no subcategories
>     are visible, double-click the Browser to expand the list.)</li>
>   <li>Under Default Search Engine, choose a search engine you want to use for
>     web searching.</li>
>   <li>Under Search Results, select <q>Open the Search tab in the Sidebar
>-    when search results are available</q> if you want the Sidebar search tab
>-    to open and show your search results.</li>
>-  <li>Under Sidebar Search Tab Preference, select Basic if you want to search
>-    using a single search engine, or select Advanced to be able to search using
>-    multiple search engines.</li>
>+    when a search is invoked</q> if you want the Sidebar search tab
>+    to open when you perform a search.</li>
>+  <li>Under Search Results, select <q>Open new tabs for sidebar search
>+    results</q> if you want to see the results from Sidebar searches
>+    to open in a new tab instead of the current tab.</li>
> </ol>
> 
> <p>[<a href="#searching_the_web">Return to beginning of section</a>]</p>
> 
> <h2 id="searching_within_a_page">Searching Within a Page</h2>
> 
> <p>To find text within the page you are currently viewing in the browser:</p>
>

Comment 3

[Stefan [:stefanh]]

Thanks for the patch. One thing: Since you're removing the sidebar_advanced_search_mode heading, you'd want to remove it from the .rdf files as well. http://mxr.mozilla.org/comm-central/search?string=sidebar_advanced_search_mode will show you all heading entries in the source tree :-)

Comment 4

[Isaac Schemm]

Attachment: Second patch (also remove references to advanced search from the rdf and index)

Comment 5

[Isaac Schemm]

Attachment: sidebar.png

This is a replacement sidebar.png you oculd use for the suite\locales\en-US\chrome\common\help\images folder, showing the new search sidebar. There's no pointer cursor in the image, though.

Comment 6

[Ian Neal]

Comment on attachment 8704396 [details] [diff] [review]
Second patch (also remove references to advanced search from the rdf and index)

>+++ b/suite/locales/en-US/chrome/common/help/customize_help.xhtml
> <p>Sidebar is a customizable area in your browser where you can keep items
>-  that you need to use all the time&mdash;the latest news and weather, your
>-  address book, stock quotes, a calendar&mdash;and many other available
>+  that you need to use all the time, including your bookmarks, browser history,
>+  address book, and other available
Don't leave empty space at the end, the rest of paragraph should be reformatted too.
>   options. Sidebar presents these items to you in tabs that are continually
>   updated.</p>

> <ul>
>   <li>To preview a Sidebar tab before adding it, select a tab from the list
>     on the left side of the Customize Sidebar dialog box and click Preview.
>     After a few seconds, the tab displays in the Tab Preview pop-up
>     window.</li>
>-  <li>To view an extensive and categorized list of tabs available for Sidebar,
>-    click <q>Tabs</q> at the top of Sidebar, and select Sidebar
>-    Directory.</li>
Any removal of Sidebar Directory in help should be spun off into a separate bug (please raise) dealing with the removal/fixing of Sidebar Directory within SeaMonkey. The url used by Sidebar Directory is no longer correct but that might be other things to fix too. 


>+++ b/suite/locales/en-US/chrome/common/help/nav_help.xhtml

> <p>Sidebar is a customizable frame in your browser where you can keep items
>-  that you need to use all the time&mdash;the latest news and weather, your
>-  address book, stock quotes, a calendar&mdash;and many other available
>+  that you need to use all the time, including your bookmarks, browser history,
>+  address book, and other available
Don't leave empty space at the end, the rest of paragraph should be reformatted too.
>   options. Sidebar presents these items to you in tabs that it continually
>   updates.</p>

>         <p>The default search engine you choose in the
>           <a href="cs_nav_prefs_navigator.xhtml#internet_search">Internet
>           Search Preferences</a> is used. Search results for <q>baby doll</q>
>-          appear in both the browser window and in Sidebar. Click the links to
>+          appear in the browser window. Click the links to
Don't leave empty space at the end, the rest of paragraph should be reformatted too.
>           visit web pages about baby dolls.</p>

>   <li>Click the Search tab in Sidebar.</li>
>-  <li>Open the <q>using</q> drop-down list, and choose a search
>+  <li>Open the drop-down list, and choose a search
>     engine.</li>
This line can be concatenated onto the previous line.


>+<p>You can also perform a search from your search engine's home page.
>+  To visit this page, perform one of
>   these steps:</p>
This line can be concatenated onto the previous line.

>   <li>Under Search Results, select <q>Open the Search tab in the Sidebar
>-    when search results are available</q> if you want the Sidebar search tab
>-    to open and show your search results.</li>
>-  <li>Under Sidebar Search Tab Preference, select Basic if you want to search
>-    using a single search engine, or select Advanced to be able to search using
>-    multiple search engines.</li>
>+    when a search is invoked</q> if you want the Sidebar search tab
>+    to open when you perform a search.</li>
Formatting is incorrect, plenty of space on the line before to have more of the text.

Thank you for the patch f+ for the moment as I would like to review the new patch.

Comment 7

[Isaac Schemm]

Attachment: help-sidebar.patch

Here's the next patch. I took out the removal of the Sidebar Directory (so it's still in there) - I'll file another bug for that.

Comment 8

[Isaac Schemm]

Anything I should do at the moment for this bug? I'm still getting familiar with the mozilla bug review process.

Comment 9

[Ian Neal]

Comment on attachment 8709137 [details] [diff] [review]
help-sidebar.patch

>         <p>The default search engine you choose in the
>           <a href="cs_nav_prefs_navigator.xhtml#internet_search">Internet
>           Search Preferences</a> is used. Search results for <q>baby doll</q>
>-          appear in both the browser window and in Sidebar. Click the links to
>-          visit web pages about baby dolls.</p>
>+          appear in the browser window. Click the links to visit web pages
>+		  about baby dolls.</p>
Tabs need removing.

>   <li>Under Search Results, select <q>Open the Search tab in the Sidebar
>+    when a search is invoked</q> if you want the Sidebar search tab to open
>+	when you perform a search.</li>
Tab needs removing.

>+  <li>Under Search Results, select <q>Open new tabs for sidebar search
>+    results</q> if you want to see the results from Sidebar searches to open in
>+	a new tab instead of the current tab.</li>
Tab needs removing.

r=me with those fixed.

Comment 10

[Isaac Schemm]

Attachment: help-sidebar.patch

Comment 11

[Ian Neal]

Comment on attachment 8716809 [details] [diff] [review]
help-sidebar.patch

Great, thanks, r=me

Comment 12

[Rainer Bielefeld]

Fix for this one means that "Bug 673190 - Seamonkey 2.1+ no sidebar search results, no advanced multi-engine search" is WONTFIX?

Comment 13

[Rainer Bielefeld]

Comment on attachment 8716809 [details] [diff] [review]
help-sidebar.patch

The paragraph "-<p><strong>Tip</strong>: To display the next" and so on in the patch also refers to Search results in sidebar (and related buttons, which also do no longer exist)

After deletion of that Paragraph fix would be ok.

Comment 14

[Stefan [:stefanh]]

(In reply to Rainer Bielefeld from comment #13)
> Comment on attachment 8716809 [details] [diff] [review]
> help-sidebar.patch
> 
> The paragraph "-<p><strong>Tip</strong>: To display the next" and so on in
> the patch also refers to Search results in sidebar (and related buttons,
> which also do no longer exist)

Yes, and that is removed in the patch.

Comment 15

[Stefan [:stefanh]]

Isac, the patch fails to apply - mind updating it so it can be checked in? Can you also include sidebar.png in the patch?

Comment 16

[Stefan [:stefanh]]

I now see that there's another sidebar.png in bug 1278619, so I assume the image attached to this bug shouldn't be checked in.

Comment 17

[Isaac Schemm]

Attachment: help-sidebar-v2

Here's a new patch with the same changes.

The sidebar.png here would be OK, but bug 1278619 (I forgot about this one when I made that one) has a screenshot of the bookmarks panel instead, which I think makes more sense to use.

Comment 18

[Isaac Schemm]

Attachment: help-sidebar-v3

Whoops, forgot to remove sidebar-advanced.png from the jar.mn after deleting it.

Comment 19

[Edmund Wong (:ewong)]

(In reply to Rainer Bielefeld from comment #13)
> Comment on attachment 8716809 [details] [diff] [review]
> help-sidebar.patch
> 
> The paragraph "-<p><strong>Tip</strong>: To display the next" and so on in
> the patch also refers to Search results in sidebar (and related buttons,
> which also do no longer exist)
> 
> After deletion of that Paragraph fix would be ok.

pmji, but looking at the list of peers for this module, and unless something
has changed that wasn't announced, the only thing you can set is the
Feedback flag and not the review flag, since only peers or module owners
can do that.

Please do look at this page:
http://www.seamonkey-project.org/dev/review-and-flags

Comment 20

[Stefan [:stefanh]]

Comment on attachment 8762436 [details] [diff] [review]
help-sidebar-v3

I did an interdiff of this one and the original patch that Ian reviewed and it looks ok with the new changes.

Comment 21

[Stefan [:stefanh]]

https://hg.mozilla.org/comm-central/rev/6b8514a38d06