273619 - Inconsistency Between Contents Headings and Text Headings

Status: RESOLVED FIXED

(SeaMonkey :: Help Documentation, defect)

Description

[David E. Ross]

User-Agent:       Mozilla/5.0 (Windows; U; Win98; en-US; rv:1.7.3) Gecko/20040910
Build Identifier: Mozilla/5.0 (Windows; U; Win98; en-US; rv:1.7.3) Gecko/20040910

Under "Using Privacy Features", a number of headings in the Contents do not
match the headings in the Help text.  This can be very confusing, especially to
a novice user.  

In some cases, the Contents headings are better; in other cases, the text
headings are better.  Please make the two groups of headings the same.  

Reproducible: Always
Steps to Reproduce:




This might be a problem elsewhere in the Help information.  However, it is very
noticeable in the "Using Privacy Features" section.  I limited this bug to that
section to avoid creating an open-ended bug.  

While I indicate a severity of Trivial, this is one of those user issues that
should be addressed if Mozilla products are indeed going to capture increased
market shares.  Thus, care should be taken to maintain and increase consistency
between Contents and text whenever any section of Help information is modified.

Comment 1

[Stefan [:stefanh]]

I can imagine that the original author made the headings in the Contents frame
shorter by purpose. But it's true that it's not very consistent. And this
inconsistency is not very consistent either since some headings are really long
in the Contents frame...

Comment 2

[Giacomo Magnini]

Attachment: WIP patch, open for comments/suggestions.

What the patch does:
 - fix some of the more visible inconsistencies in help-toc.rdf
 - reorganize a bit the Master Passwords help (passwords_help.xhtml), but still not perfectly.
I'll be glad to hear some comments on this before going forward...

Comment 3

[Giacomo Magnini]

I'll use this bug to fix also the Master Passwords pref panel: the title says Master Passwords (plural) but in reality we have only *one* Master Password!

Comment 4

[Giacomo Magnini]

Attachment: Updated patch

Revised patch, which fixes also a logical inconsistency in the pref panels. Fixes also a wrong link in help-toc.rdf (the one to master pass timeout).

Comment 5

[Stefan [:stefanh]]

--> Giacomo

Comment 6

[Ian Neal]

Comment on attachment 217270 [details] [diff] [review]
Updated patch

>Index: extensions/help/resources/locale/en-US/passwords_help.xhtml
>===================================================================
>@@ -94,18 +95,18 @@
> <p>Using encryption versus obscuring for stored sensitive data is a tradeoff
>   between improved security and convenience:</p>
> 
> <ul>
>   <li>If you use encryption, you will need to enter a master password
>     periodically, which can be inconvenient. (For information about controlling
>     how often it is requested, see the discussion of the Master Password
>     timeout at
>-    <a href="#master_passwords">Privacy &amp;
>-    Security Preferences - Master Passwords</a>.)</li>
>+    <a href="#master_password">Privacy &amp;
>+    Security Preferences - Master Password</a>.)</li>
Can you not move "Security Preferences -" to the line above?

>@@ -177,118 +178,86 @@
>   <li><strong>Remove All:</strong> Click this button to remove all the entries
>     listed in the tab you are viewing.</li>
> </ul>
> 
> <p>For more information about the Password Manager, see <a href=
>   "using_priv_help.xhtml#using_the_password_manager">Using the Password
>   Manager</a>.</p>
> 
>-<h2 id="master_passwords">Privacy &amp;
>-  Security Preferences - Master Passwords</h2>
>+<h2 id="master_password">Privacy &amp;
>+  Security Preferences - Master Password</h2>
Can you not move "Security Preferences -" to the line above?

.
.
.
> <p>The master password for the browser&apos;s built-in Software Security Device
>   also protects stored sensitive information such as email passwords, website
>   passwords, and other data stored by the Password Manager and Form
>   Manager.</p>
> 
>+<p>Each security device (being it software or hardware) has its separate Master
>+  Password.</p>
>+
Use "be" instead of "being" here or alternatively "whether it is software or hardware". Perhaps use commas instead of brackets too.

Comment 7

[Giacomo Magnini]

Actually fixed elsewhere: just needs a correction to a link in help-index1.rdf, line 1507:
-         nc:link="passwords_help.xhtml#master_passwords"/>
+         nc:link="passwords_help.xhtml#master_password_timeout"/>
Obviously needs fixing both in extensions/ and in suite/.
Any volunteer?

Comment 8

[Giacomo Magnini]

Attachment: simple link fix in index1.rdf (both SM and suiterunner)

Comment 9

[Giacomo Magnini]

Attachment: Real fix, SM only (since suiterunner has no help-toc.rdf file)

Comment 10

[Ian Neal]

Comment on attachment 241838 [details] [diff] [review]
Real fix, SM only (since suiterunner has no help-toc.rdf file)

You will need to patch suite-toc.rdf instead but r=me for this change to that.

Comment 11

[Giacomo Magnini]

Attachment: Unified patch, fixing both issues. (Checked into trunk & 1.8.1 branch)

Comment 12

[Giacomo Magnini]

Please check this in, both trunk and branch!

Comment 13

[Stefan [:stefanh]]

Comment on attachment 242193 [details] [diff] [review]
Unified patch, fixing both issues. (Checked into trunk & 1.8.1 branch)

(In reply to comment #12)
> Please check this in, both trunk and branch!
>

We need approval :-)

Comment 14

[Robert Kaiser]

Comment on attachment 242193 [details] [diff] [review]
Unified patch, fixing both issues. (Checked into trunk & 1.8.1 branch)

a=me for 1.1b

Comment 15

[Ian Neal]

Comment on attachment 242193 [details] [diff] [review]
Unified patch, fixing both issues. (Checked into trunk & 1.8.1 branch)

Checking in (trunk)
help-index1.rdf;
new revision: 1.54; previous revision: 1.53
suite-toc.rdf;
new revision: 1.90; previous revision: 1.89
done
Checking in (1.8.1 branch)
help-index1.rdf;
new revision: 1.44.8.8; previous revision: 1.44.8.7
help-toc.rdf;
new revision: 1.78.4.10; previous revision: 1.78.4.9
done