Bug 299974: adjust Help docs to the new Help Viewer. r=jeff, a=asa

2005-07-09 07:03:53 +00:00 · 2005-07-09 07:03:53 +00:00 · fda4bfd03f
--- a/browser/locales/en-US/chrome/help/firebird-toc.rdf
+++ b/browser/locales/en-US/chrome/help/firebird-toc.rdf
@ -11,7 +11,7 @@
  <rdf:Description about="urn:root">
    <nc:subheadings>
      <rdf:Seq>
-        <rdf:li> <rdf:Description ID="firefox-help" nc:name="&brandFullName; Help" nc:link="firefox_welcome.xhtml"/> </rdf:li>
+        <rdf:li> <rdf:Description ID="firefox-help" nc:name="Welcome to &brandFullName; Help" nc:link="firefox_welcome.xhtml"/> </rdf:li>
        <rdf:li> <rdf:Description ID="using-firebird" nc:name="Using &brandFullName;" nc:link="using_firebird.xhtml"/> </rdf:li>
        <rdf:li> <rdf:Description ID="using-download-manager" nc:name="Using the Download Manager" nc:link="download_manager.xhtml"/> </rdf:li>
        <rdf:li> <rdf:Description ID="customize-firebird" nc:name="Customization" nc:link="customization.xhtml"/> </rdf:li>
--- a/browser/locales/en-US/chrome/help/firefox_welcome.xhtml
+++ b/browser/locales/en-US/chrome/help/firefox_welcome.xhtml
@ -5,6 +5,12 @@
    %brandDTD;
    %regionDTD;
 ]>
+<!--
+Contributors:
+  R.J. Keller <rlk@trfenv.com> (original author)
+  Jeff Walden <jwalden+code@mit.edu>
+  Steffen Wilberg <steffen.wilberg@web.de>
+-->

 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
@ -14,17 +20,11 @@
 <body>

 <h1>Welcome to &brandFullName; Help</h1>
-<p>To display information about &brandFullName; in this window, <strong>click
-  tabs or topics in the sidebar</strong>:</p>
+<p>To display information about &brandFullName; in this window, click topics in
+  the <em>Contents</em> sidebar. Click the <span class="noMac">plus icon</span>
+  <span class="mac">triangle</span> next to a topic to see its subtopics.</p>

-<ul>
-  <li><strong>Contents</strong> shows main topics and subtopics.</li>
-  <li><strong>Index</strong> lists all help topics alphabetically.</li>
-  <li><strong>Glossary</strong> defines key terms used throughout
-    &brandShortName; Help.</li>
-</ul>
-
-<p>You can also use <strong>Search</strong> to find specific
+<p>You can also use the <em>Search</em> bar to find specific
  information within &brandShortName; Help.  For more information on using
  &brandFullName; Help, see <a href="chrome://help/locale/welcome.xhtml">Using
  the Help Window</a>.</p>
@ -33,7 +33,7 @@
  find more help and support options online at <a
  href="http://www.mozilla.org/support/firefox/" target="_blank">&brandShortName; Help</a>.</p>

-<div class="contentsBox"><em>26 April 2005</em></div>
+<div class="contentsBox"><em>09 July 2005</em></div>
 <p>Copyright &copy; 2003-2005 Contributors to the Mozilla Help Viewer Project.</p>

 </body>
--- a/toolkit/locales/en-US/chrome/mozapps/help/help-toc.rdf
+++ b/toolkit/locales/en-US/chrome/mozapps/help/help-toc.rdf
@ -5,7 +5,7 @@
  <rdf:Description about="urn:root">
    <nc:subheadings>
      <rdf:Seq>
-        <rdf:li> <rdf:Description ID="use-help" nc:name="How to Use Help"
+        <rdf:li> <rdf:Description ID="use-help" nc:name="Using the Help Window"
                  nc:link="chrome://help/locale/welcome.xhtml"/> </rdf:li>
      </rdf:Seq>
    </nc:subheadings>
--- a/toolkit/locales/en-US/chrome/mozapps/help/welcome.xhtml
+++ b/toolkit/locales/en-US/chrome/mozapps/help/welcome.xhtml
@ -4,6 +4,12 @@
    %brandDTD;
 ]
 >
+<!--
+Contributors:
+  R.J. Keller <rlk@trfenv.com> (original author)
+  Jeff Walden <jwalden+code@mit.edu>
+  Steffen Wilberg <steffen.wilberg@web.de>
+-->

 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
@ -15,9 +21,6 @@

 <h1 id="help_window_top">Using the Help Window</h1>

-<p>This section describes how to use the Help window (the entire window in
-  which this text and the Sidebar on the left are displayed).</p>
-
 <div class="contentsBox">In this section:
  <ul>
    <li><a href="#finding_the_topic_you_want">Finding the Topic You Want</a></li>
@ -27,21 +30,17 @@

 <h2 id="finding_the_topic_you_want">Finding the Topic You Want</h2>

-<p>When you're viewing the Help window, click the tabs in the left frame to view
-  the Help contents in different ways:</p>
+<p>To display help information in this window, click a topic in the
+  <em>Contents</em> sidebar. Click the <span class="noMac">plus icon</span>
+  <span class="mac">triangle</span> next to a topic to see its subtopics.</p>

-<ul>
-  <li><strong>Contents</strong> shows the list of main topics.<br/>
-    Click a topic to read about it. Double-click to see its subtopics.</li>
-  <li><strong>Search</strong> lets you search the Help files.<br/>
-    Type a word or phrase to see related topics. Then click the topic you want
-    to read about.  If your search doesn't return any topics, try typing fewer
-    words or a different combination of words.</li>
-  <li><strong>Index</strong> lists topics alphabetically.<br/>
-    Click an index entry to view information on that topic.</li>
-  <li><strong>Glossary</strong> lists definitions alphabetically.<br/>
-    Click a glossary term to see its definition.</li>
-</ul>
+<p>To search for a help topic, type a word or phrase in the <em>Search</em> bar
+  to see related topics. Click on a topic to read about it. If your search
+  doesn't return any topics, try typing fewer words or a different combination
+  of words. The results will be displayed in the <em>Search</em> sidebar as you
+  type. To display the contents in the sidebar again, click the close button on
+  the <em>Search</em> sidebar, clear the <em>Search</em> bar, or press
+  <kbd>Esc</kbd>.</p>

 <p>To see information related to the Help topic you are reading, click links in
  the Help window just as you would in a regular web page.  You can also move
@ -61,7 +60,7 @@
    &quot;page&quot; will likely return more topics than you want.</li>
 </ul>

-<div class="contentsBox"><em>24 May 2005</em></div>
+<div class="contentsBox"><em>09 July 2005</em></div>
 <p>Copyright &copy; 2003-2005 Contributors to the Mozilla Help Viewer Project.</p>

 </body>