420730 - update help for appearance / content pref panel

Status: RESOLVED FIXED

(SeaMonkey :: Help Documentation, defect)

Description

[Robert Kaiser]

I just added a new Appearance > Content pref panel in bug 411215, we should update help to include that.

Comment 1

[Robert Kaiser]

Attachment: add content, remove locales, adjust main appearance

This patch adds the help docs for the content panel, and also integrates the changes my soon-to-be-checked-in patch for the main appearance panel does, including the removal of the locales panel.

Comment 2

[jag (Peter Annema)]

Comment on attachment 308223 [details] [diff] [review]
add content, remove locales, adjust main appearance

>Index: mozilla/suite/locales/en-US/chrome/common

>+  <li><strong>User Interface Language</strong>: This setting allows you to
>+    change the language used in the user interface of &brandShortName;.
>+    Additional languages get available in the list when you install "language
>+    packs" from the &brandShortName; homepage.
>+    <strong>Note</strong>: You must restart &brandShortName; for a new language
>+    setting to take effect.
>+  </li>

|Additional languages are available from ...|

or

|Additional languages can be installed from ...|

Comment 3

[Robert Kaiser]

Comment on attachment 308223 [details] [diff] [review]
add content, remove locales, adjust main appearance

>Index: mozilla/suite/locales/en-US/chrome/common/help/cs_nav_prefs_appearance.xhtml
>===================================================================
>+      <li><strong>Aggressively look for Web Site Icons when the page does not
>+        define one <strong>: If the page itself does not define a Web Site

The second <strong> here should be a </strong>, sorry.
Everything works/looks fine in testing.

Comment 4

[jag (Peter Annema)]

Did you remove the space before it while you were at it?

Comment 5

[Stefan [:stefanh]]

+      <li><strong>Show Website Icons</strong>: Select this if you want see
+        site-specific icons, if available, in place of the bookmark icon
+        <img src="chrome://communicator/skin/bookmarks/bookmark-item.gif"
+        alt="Bookmark item icon"/>. Website icons are shown to the left of the
+        Location Bar and Browser tabs.</li>
+      <li><strong>Aggressively look for Web Site Icons when the page does not
+        define one <strong>: If the page itself does not define a Web Site

You mix "Website" and Web Site" here (and a few other places). The checkbox ui says "Web Site", but the text above the groupbox says "These settings influence how website and message content appears in SeaMonkey".

+        define one <strong>: If the page itself does not define a Web Site
+        Icon

No capitalizing, please.

Comment 6

[Stefan [:stefanh]]

Comment on attachment 308223 [details] [diff] [review]
add content, remove locales, adjust main appearance

I'll look at this when the main appearance patch has landed.

Comment 7

[Stefan [:stefanh]]

Comment on attachment 308223 [details] [diff] [review]
add content, remove locales, adjust main appearance

>Index: mozilla/suite/locales/en-US/chrome/common/help/cs_nav_prefs_appearance.xhtml
>===================================================================
>RCS file: /cvsroot/mozilla/suite/locales/en-US/chrome/common/help/cs_nav_prefs_appearance.xhtml,v
>retrieving revision 1.34
>diff -u -7 -p -r1.34 cs_nav_prefs_appearance.xhtml
>--- mozilla/suite/locales/en-US/chrome/common/help/cs_nav_prefs_appearance.xhtml	24 Oct 2007 20:02:14 -0000	1.34
>+++ mozilla/suite/locales/en-US/chrome/common/help/cs_nav_prefs_appearance.xhtml	8 Mar 2008 22:43:05 -0000
>@@ -45,17 +45,17 @@
>   <li>Double-click Appearance to expand the list, then click the name for the
>     preferences you want to view.</li>
> </ol>
> 
> <div class="contentsBox">In this section: 
>   <ul>
>     <li><a href="#appearance">Appearance</a></li>
>+    <li><a href="#content">Content</a></li>
>     <li><a href="#fonts">Fonts</a></li>
>     <li><a href="#colors">Colors</a></li>
>-    <li><a href="#locales">Languages</a></li>
>   </ul>
> </div>
> 
> <h2 id="appearance">Appearance Preferences - Appearance</h2>
> 
> <p>This section describes how to use the Appearance preferences panels. If
>   you&apos;re not already viewing one of these panels, follow these steps:</p>

1) Some where here it says:

"<p>The Appearance preferences panel allows you set components that you want to
  use when you start up &brandShortName;:</p>"

This is a little bit under-estimated, I think :-)

Please change it to:

"The Appearance preferences panel allows you to set &brandShortName; startup options and customizing the user interface."

>@@ -82,29 +82,74 @@
>         only.</li>
>     </ul>
>   </li>
>   <li><strong>Show Tooltips</strong>: Select this if you want to have 
>     <a href="glossary.xhtml#tooltip">tooltips</a> appear when the cursor
>     is placed over parts of the &brandShortName; user interface and some
>     websites.</li>
>-  <li><strong>Show Website Icons</strong>: Select this if you want see
>-    site-specific icons, if available, in place of the bookmark icon
>-    <img src="chrome://communicator/skin/bookmarks/bookmark-item.gif"
>-    alt="Bookmark item icon"/>. Website icons are shown to the left of the
>-    Location Bar and Browser tabs.</li>
>+  <li><strong>User Interface Language</strong>: This setting allows you to
>+    change the language used in the user interface of &brandShortName;.
>+    Additional languages get available in the list when you install "language
>+    packs" from the &brandShortName; homepage.

2) I think it's enough to mention where you can get more languages, jag's suggestion makes sense here.
So, use "Additional languages can be installed from the &brandShortName; home page." Note: "home page", not "homepage" ;-)

>+    <strong>Note</strong>: You must restart &brandShortName; for a new language
>+    setting to take effect.
>+  </li>
>+</ul>
>+
>+<p>[<a href="#appearance_preferences">Return to beginning of section</a>]</p>
>+
>+<h2 id="content">Appearance Preferences - Content</h2>
>+
>+<p>This section describes how to use the content appearance preferences

3) Just say "... to use the Content preferences..." (note the capital C in "Content")


>+  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 Appearance category, click Content. (If no
>+    subcategories are visible, double-click Appearance to expand the
>+    list.)</li>
>+</ol>
>+
>+<p>The content appearance preferences panel allows you to change settings that

4) Same here

>+  influence how website and message content appears in &brandShortName;.</p>
>+
>+<ul>
>+  <li>Web Site Icons:
>+    <ul>
>+      <li><strong>Show Website Icons</strong>: Select this if you want see

5) This should be "Show Web Site Icons" since that's what it says in the ui. Note that the ui have changed, we used to say "Website" before... I know about the mess (note that bug 90894 changed all our ui/help to "website") and bug 385452, but it would be nice if we used the same convention everywhere. Or, at least in the same pane. Looking at the description in the pane, it says "website" :-/

>+        site-specific icons, if available, in place of the bookmark icon
>+        <img src="chrome://communicator/skin/bookmarks/bookmark-item.gif"
>+        alt="Bookmark item icon"/>. Website icons are shown to the left of the

Here we use "Website"...

>+        Location Bar and Browser tabs.</li>
>+      <li><strong>Aggressively look for Web Site Icons when the page does not

6) Use "web site icons" (no capitals) here. Or "website icons"...

>+        define one <strong>: If the page itself does not define a Web Site
>+        Icon, turning on this setting makes &brandShortName; look for a

7) Same here (no capitals), also fix the </strong> and no space, ie; "one</strong>" as jag pointed out.

>+        &quot;favicon&quot; on the server and use that instead.</li>
>+    </ul>
>+  </li>
>   <li><strong>Use smooth scrolling</strong>: Select this to enable smooth
>     scrolling. Pressing the Page Down key when this is enabled
>     will&mdash;instead of an immediate jump&mdash;smoothly scroll the content
>     down to the next page.</li>
>   <li><strong>Resize large images to fit in the browser window</strong>: Select
>     this if you want &brandShortName; to automatically shrink large stand-alone
>     images so they will fit in the browser window. Clicking on the resized
>     image will make it appear at full size.</li>
>+  <li><strong>Zoom only text instead of full pages</strong>: Select this if you
>+    want &brandShortName; to only resize text of websites when using the

hmm, "websites" here...


r=me with comments 1-7 addressed. Can you also please file a follow-up on the "web site"/"website" issues? I don't have any specific preferences, and I know we're depending on toolkit strings that can't be changed now, but maybe we can fix it in the suite/ ui?

Comment 8

[Robert Kaiser]

(In reply to comment #7)
> Can you also please file a follow-up on the
> "web site"/"website" issues? I don't have any specific preferences, and I know
> we're depending on toolkit strings that can't be changed now, but maybe we can
> fix it in the suite/ ui?

Bug 423282 filed on that, I'll fix up the panel UI to be consistent with the help text in this regard in bug 420732, as I need to patch the panel's locale file there anyway.

Comment 9

[Robert Kaiser]

Patch checked in with comments addressed and actually putting a content entry into index1 instead of the locales one (OKed by stefanh via IRC).

Comment 10

[Lars P M]

This bug needs to be reopened, because similar changes also need to be done to http://mxr.mozilla.org/comm-central/source/suite/locales/en-US/chrome/common/help/nav_help.xhtml from line 1115 forward, possibly also affecting the TOC.

Comment 11

[Robert Kaiser]

(In reply to comment #10)
> This bug needs to be reopened, because similar changes also need to be done to
> http://mxr.mozilla.org/comm-central/source/suite/locales/en-US/chrome/common/help/nav_help.xhtml
> from line 1115 forward, possibly also affecting the TOC.

If so, please file a followup bug with the exact things that are missing or should be changed. There was an issue that was fixed here, if there's something else that still needs to be done another followup bug is the way to do it.

Comment 12

[Lars P M]

(In reply to comment #11)
> If so, please file a followup bug with the exact things that are missing or

Bug 459639