Bug 771534 - Create Help documentation for the Preference Pane for Offline Applications implemented in Bug 758677. r=IanN
authorrsx11m <rsx11m.pub@gmail.com>
Sat, 02 Mar 2013 11:57:25 -0600
changeset 15071 5623e1fd5491c5a3a9664430aab0f11b5638423a
parent 15070 8a14d431ec6d696ad5b1c512fa0eefebed649a7c
child 15072 cc2732963642729313466d4670c1c2373afd06e8
push id898
push userbugzilla@standard8.plus.com
push dateMon, 13 May 2013 17:03:31 +0000
treeherdercomm-beta@3106694b14de [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersIanN
bugs771534, 758677
Bug 771534 - Create Help documentation for the Preference Pane for Offline Applications implemented in Bug 758677. r=IanN
suite/locales/en-US/chrome/common/help/cs_nav_prefs_advanced.xhtml
suite/locales/en-US/chrome/common/help/help-index1.rdf
suite/locales/en-US/chrome/common/help/suite-toc.rdf
--- a/suite/locales/en-US/chrome/common/help/cs_nav_prefs_advanced.xhtml
+++ b/suite/locales/en-US/chrome/common/help/cs_nav_prefs_advanced.xhtml
@@ -31,16 +31,17 @@
 
 <div class="contentsBox">In this section:
   <ul>
     <li><a href="#advanced">Advanced</a></li>
     <li><a href="#scripts_and_plugins">Scripts &amp; Plugins</a></li>
     <li><a href="#keyboard_navigation">Keyboard Navigation</a></li>
     <li><a href="#fayt">Find As You Type</a></li>
     <li><a href="#cache">Cache</a></li>
+    <li><a href="#offline_apps">Offline Apps</a></li>
     <li><a href="#proxies">Proxies</a></li>
     <li><a href="#http_networking">HTTP Networking</a></li>
     <li><a href="#software_installation">Software Installation</a></li>
     <li><a href="#mouse_wheel">Mouse Wheel</a></li>
     <li><a href="#dom_inspector">DOM Inspector</a></li>
   </ul>
 </div>
 
@@ -293,16 +294,86 @@
     page that uses prefetching. For more information about Link Prefetching, see
     the online
     <a href="http://www.mozilla.org/projects/netlib/Link_Prefetching_FAQ.html">Link
     Prefetching FAQ</a>.</li>
 </ul>
 
 <p>[<a href="#advanced_preferences">Return to beginning of section</a>]</p>
 
+<h2 id="offline_apps">Advanced Preferences - Offline Apps</h2>
+
+<p>This section describes how to use the Offline Web Applications preferences
+  panel. If you&apos;re not already viewing it, follow these steps:</p>
+
+<ol>
+  <li>Open the <span class="mac">&brandShortName;</span>
+    <span class="noMac">Edit</span> menu and choose Preferences.</li>
+  <li>Under the Advanced category, click Offline Apps. (If no subcategories are
+    visible, double-click Advanced to expand the list.)</li>
+</ol>
+
+<p>The Offline Web Applications panel allows you to control and monitor how
+  websites use &brandShortName;&apos;s offline storage. In general, websites
+  require you to stay online in order to use them, thus won&apos;t function
+  if you are disconnected from the network. If permitted, websites can store
+  their content and any data you entered locally in &brandShortName;. In this
+  way, they can be used even without a network connection.</p>
+
+<p>The <strong>Offline Web Content and User Data</strong> section provides the
+  following functions:</p>
+
+<ul>
+  <li><strong>Your application cache is currently using [__] of disk
+    space</strong>: This entry is informational and provides you with an
+    estimate of the offline data currently used by all web applications
+    combined.</li>
+  <li><strong>Clear</strong>: Immediately clears data that has been saved
+    by all websites for use when you are offline.</li>
+  <li><strong>Notify me when a website wants to store data for offline
+    use</strong>: Check this box if you want to be notified when a website
+    wants to utilize the offline feature but does not currently have the
+    permissions to do so. An information bar will appear for this site with
+    the following options:
+    <ul>
+      <li><strong>Allow</strong>: Permanently allow this site the use of the
+        offline storage for this and future accesses.</li>
+      <li><strong>Never for This Site</strong>: Permanently deny this site
+        the use of the offline storage for this and future accesses.</li>
+      <li><strong>Not Now</strong>: Deny this site the use of the offline
+        storage for this request but ask again for future accesses.</li>
+    </ul>
+    <p><strong>Note</strong>: If the notification box is <em>not</em> checked,
+      &brandShortName; will proceed as if <q>Not Now</q> was selected.</p>
+  </li>
+  <!-- NOTE: link "Data Manager" below once bug 599097 has been fixed -->
+  <li><strong>Manage Permissions</strong>: Opens the Data Manager in a new
+    tab or window where you can modify the Offline Web Applications permissions
+    for each domain:
+    <ul>
+      <li><strong>Use Default</strong>: Check this box to return to the default
+        behavior, thus presenting the information bar with the next request
+        from a site within each domain if the notification option is chosen
+        (effectively removes the entry from this listing).</li>
+      <li><strong>Allow</strong>: Select this option to allow this site
+        the use of the offline storage for all accesses.</li>
+      <li><strong>Block</strong>: Select this option to deny this site
+        the use of the offline storage for all accesses.</li>
+    </ul>
+  </li>
+  <li><strong>The following websites are allowed to store data for offline
+    use</strong>: Lists the domains of all websites which have stored offline
+    data, along with the amount of data currently used by this domain.</li>
+  <li><strong>Clear data</strong>: Select a website domain and click this
+    button to delete all offline data for the specified domain. Click <q>Remove
+    offline data</q> after being prompted for confirmation to do so.</li>
+</ul>
+       
+<p>[<a href="#advanced_preferences">Return to beginning of section</a>]</p>
+
 <h2 id="proxies">Advanced Preferences - Proxies</h2>
 
 <p>This section describes how to use the Proxies preferences panel. If
   you&apos;re not already viewing it, follow these steps:</p>
 
 <ol>
   <li>Open the <span class="mac">&brandShortName;</span>
     <span class="noMac">Edit</span> menu and choose Preferences.</li>
--- a/suite/locales/en-US/chrome/common/help/help-index1.rdf
+++ b/suite/locales/en-US/chrome/common/help/help-index1.rdf
@@ -1417,16 +1417,21 @@
 <rdf:Description about="#Offline">
    <nc:subheadings>
      <rdf:Seq><rdf:li>
        <rdf:Description ID="Offline:general_preferences"
          nc:name="offline preferences"
          nc:link="mailnews_preferences.xhtml#network_and_storage_preferences"/>
      </rdf:li>
      <rdf:li>
+        <rdf:Description ID="Offline:offline_apps"
+          nc:name="Offline Web Applications"
+          nc:link="cs_nav_prefs_advanced.xhtml#offline_apps"/>
+     </rdf:li>
+     <rdf:li>
        <rdf:Description ID="Offline:Mail_and_Newsgroups"
          nc:name="Offline Mail and News"
          nc:link="mailnews_offline.xhtml#working_offline"/>
      </rdf:li></rdf:Seq>
    </nc:subheadings>
 </rdf:Description>
 
 <rdf:Description about="help-indexAZ.rdf#p">
--- a/suite/locales/en-US/chrome/common/help/suite-toc.rdf
+++ b/suite/locales/en-US/chrome/common/help/suite-toc.rdf
@@ -806,16 +806,17 @@
 
 <rdf:Description about="#advanced_pref_advanced">
     <nc:subheadings>
       <rdf:Seq>
         <rdf:li><rdf:Description ID="advanced_pref_scripts" nc:name="Scripts &amp; Plugins" nc:link="cs_nav_prefs_advanced.xhtml#scripts_and_plugins"/> </rdf:li>
         <rdf:li><rdf:Description ID="advanced_pref_keyboard_nav" nc:name="Keyboard Navigation" nc:link="cs_nav_prefs_advanced.xhtml#keyboard_navigation"/> </rdf:li>
         <rdf:li><rdf:Description ID="advanced_pref_find_as_you_type" nc:name="Find As You Type" nc:link="cs_nav_prefs_advanced.xhtml#fayt"/> </rdf:li>
         <rdf:li><rdf:Description ID="advanced_pref_cache" nc:name="Cache" nc:link="cs_nav_prefs_advanced.xhtml#cache"/> </rdf:li>
+        <rdf:li><rdf:Description ID="advanced_pref_offlineapps" nc:name="Offline Apps" nc:link="cs_nav_prefs_advanced.xhtml#offline_apps"/> </rdf:li>
         <rdf:li><rdf:Description ID="advanced_pref_proxies" nc:name="Proxies" nc:link="cs_nav_prefs_advanced.xhtml#proxies"/> </rdf:li>
         <rdf:li><rdf:Description ID="advanced_http_networking" nc:name="HTTP Networking" nc:link="cs_nav_prefs_advanced.xhtml#http_networking"/> </rdf:li>
         <rdf:li><rdf:Description ID="advanced_pref_installation" nc:name="Software Installation" nc:link="cs_nav_prefs_advanced.xhtml#software_installation"/> </rdf:li>
         <rdf:li><rdf:Description ID="advanced_pref_mouse_wheel" nc:name="Mouse Wheel" nc:link="cs_nav_prefs_advanced.xhtml#mouse_wheel"/> </rdf:li>
         <rdf:li><rdf:Description ID="advanced_pref_dom_inspector" nc:name="DOM Inspector" nc:link="cs_nav_prefs_advanced.xhtml#dom_inspector"/> </rdf:li>
       </rdf:Seq>
     </nc:subheadings>
   </rdf:Description>