257507 - Small glitches in various inline help files

Status: VERIFIED FIXED

(Documentation Graveyard :: Help Viewer, defect)

Description

[Giacomo Magnini]

User-Agent:       Mozilla/5.0 (Windows; U; Windows NT 5.0; it-IT; rv:1.8a3) Gecko/20040829
Build Identifier: Mozilla/5.0 (Windows; U; Windows NT 5.0; it-IT; rv:1.8a3) Gecko/20040829

I've found a few small glitches in the Suite help files. I'll list them here,
and will provide a patch (separate for evry single one or complete), if none of
them is being addressed in some other bug. Here we go:
customize_help.xhtml, 358-359: the <span class="mac"> is different from anywhere
else
help_help.xhtml, 77: help_print.png should be help_print.gif
nav_help.xhtml, 1357: "Choose a between to have..." should be "Choose between
having..."
composer_help.xhtml, 2383: Different copyright years from the rest of the docs
cs_nav_prefs_appearance.xhtml, 260: Different copyright years from the rest of
the docs

Reproducible: Always
Steps to Reproduce:

Comment 1

[Giacomo Magnini]

--> me
Adding knowledgeable person! :)

Comment 2

[Stefan [:stefanh]]

(In reply to comment #0)

> composer_help.xhtml, 2383: Different copyright years from the rest of the docs
That will be fixed by the patch in bug 210335. Actually, for the moment the
composer_help file lacks changes made after rev 1.14...

Comment 3

[Giacomo Magnini]

Attachment: Fix a few small things

Fix for customize_help, help_help and nav_help files. The last two issues are
being addressed in bug 210335 and bug 198006.

Comment 4

[Giacomo Magnini]

Attachment: Updated patch

Updated patch as requested by Stefan by email. Added the copyright fix for
cs_nav_prefs_appearance.xhtml.

Comment 5

[[e-mail]]

Fix checked in.

Comment 6

[Gérard Talbot]

I wish this bug could remain opened since there are many glitches and links not
responding in help files. E.g.:
Go to Help/Help Contents/Contents tab/Customizing Mozilla/Navigator Settings: 
in the right pane, it is written 
"In this section:
Appearance Settings
Navigator Settings
Advanced Settings"
but when you click the Navigator Settings link, there is no response. There are
many occurences like that.

Comment 7

[Giacomo Magnini]

If you can report here all the glitches you find, I'll be glad to reopen it and
provide a fix (if you can't do that yourself). I hope Neil will agree about that.
The problem you are getting is a missing 'x' in the filename in
cs_nav_prefs_appearance.xhtml, line 31.

Comment 8

[Gérard Talbot]

Here are 6 of them for starters:

Clicking in the left pane:
Creating Web Pages/Adding Images to Your Web Page
the right pane content is not loaded

Clicking in the left pane:
Customizing Mozilla/Changing Fonts, Colors, and Themes
the right pane content is not loaded

Clicking in the left pane:
Customizing Mozilla/Changing Fonts, Colors, and Themes
the right pane content is not loaded

Bring the content Customizing Mozilla/Navigator Settings in the right pane:
Clicking in the RIGHT pane:
Navigator Settings
does not load/bring the referenced content.

Bring the content Customizing Mozilla/Bookmarks in the right pane:
then clicking in the RIGHT pane:
Exporting or Importing a Bookmark List
does not load/bring the referenced content.

Clicking in the left pane:
Using Privacy Features/Using the Cookie Manager/Cookie Manager Settings/Cookie Sites
does not load anything in the right pane.

There ought to be a better way, a reliable, efficient way to verify internal
links between these content panes so that one can get a summary report of all
internal link malfunctions, broken links which would need to be corrected, adjusted.

Comment 9

[Gérard Talbot]

Browsing the Web/Navigating Web Pages in the right pane has no anchor attached
to it (it seems so: I can't see the source code). Therefore, at least 10 links
fail to bring up this precise location in the right pane.

8 of them are "[Return to beginning of section]" intra-right pane links.
1 is the right-pane "In this section: * Navigating Web Pages" link
1 is the left-pane Browsing the Web/Navigating Web Pages

Comment 10

[Gérard Talbot]

4 additional ones:

Bring the content Browsing the Web/Copying, Saving, and Printing Pages in the
right pane:
Clicking in the RIGHT pane:
Saving All or Part of a Page
does not load/bring the referenced content.

Clicking in the left pane:
Browsing the Web/Improving Speed and Efficiency/Using a Mouse Wheel
does not load anything in the right pane.

Clicking "[Return to beginning of section]" in the right-pane at the end of the
section 
Browsing the Web/Proxies/Setting Proxy Values
does not bring you back to the Proxies section. But we can deduce that the
anchor must exist.

Clicking in the left pane:
Using Mail/Using Address Books/Searching Address Books
does not load anything in the right pane.

enough for today.

Using Mozilla 1.8a3 build 2004090507 here.

Comment 11

[Giacomo Magnini]

(In reply to comment #8)
> Clicking in the left pane:
> Creating Web Pages/Adding Images to Your Web Page
> the right pane content is not loaded

help-toc.rdf, fixed here.

> Clicking in the left pane:
> Customizing Mozilla/Changing Fonts, Colors, and Themes
> the right pane content is not loaded

help-toc.rdf, fixed here.

> Clicking in the left pane:
> Customizing Mozilla/Changing Fonts, Colors, and Themes
> the right pane content is not loaded

duplicate! :)

> Bring the content Customizing Mozilla/Navigator Settings in the right pane:
> Clicking in the RIGHT pane:
> Navigator Settings
> does not load/bring the referenced content.

cs_nav_prefs_appearance.xhtml, fixed here.

> Bring the content Customizing Mozilla/Bookmarks in the right pane:
> then clicking in the RIGHT pane:
> Exporting or Importing a Bookmark List
> does not load/bring the referenced content.

nav_help.xhtml, fixed here.

> Clicking in the left pane:
> Using Privacy Features/Using the Cookie Manager/Cookie Manager Settings/Cookie
Sites
> does not load anything in the right pane.

help-toc.rdf, fixed here.

> There ought to be a better way, a reliable, efficient way to verify internal
> links between these content panes so that one can get a summary report of all
> internal link malfunctions, broken links which would need to be corrected,
adjusted.

Someone was checking all of the links and anchors, but I don't know the outcome.

(In reply to comment #9)
> Browsing the Web/Navigating Web Pages in the right pane has no anchor attached
> to it (it seems so: I can't see the source code). Therefore, at least 10 links
> fail to bring up this precise location in the right pane.

This is a problem with the helper app: navigating the help files in a true
navigator window doesn't show this problem (which is very true in the help
window, but the links are correct, AFAICT).

(In reply to comment #10)
> Bring the content Browsing the Web/Copying, Saving, and Printing Pages in the
> right pane:
> Clicking in the RIGHT pane:
> Saving All or Part of a Page
> does not load/bring the referenced content.

nav_help.xhtml, fixed here.

> Clicking in the left pane:
> Browsing the Web/Improving Speed and Efficiency/Using a Mouse Wheel
> does not load anything in the right pane.

help-toc.rdf, fixed here.

> Clicking "[Return to beginning of section]" in the right-pane at the end of the
> section 
> Browsing the Web/Proxies/Setting Proxy Values
> does not bring you back to the Proxies section. But we can deduce that the
> anchor must exist.

nav_help.xhtml, fixed here.

> Clicking in the left pane:
> Using Mail/Using Address Books/Searching Address Books
> does not load anything in the right pane.

help-toc.rdf, fixed here.

> Using Mozilla 1.8a3 build 2004090507 here.

Same here, good for comparision... ;)
Reopening, patch coming soon...

Comment 12

[Giacomo Magnini]

(In reply to comment #11)
> > Clicking in the left pane:
> > Using Privacy Features/Using the Cookie Manager/Cookie Manager Settings/Cookie
> Sites
> > does not load anything in the right pane.
> 
> help-toc.rdf, fixed here.

Ooops, the error is actually in using_priv_help.xhtml

> This is a problem with the helper app: navigating the help files in a true
> navigator window doesn't show this problem (which is very true in the help
> window, but the links are correct, AFAICT).

I'm correcting myself: an anchor was missing. Fixed here.

> Bring the content Customizing Mozilla/Bookmarks in the right pane:
> then clicking in the RIGHT pane:
> Exporting or Importing a Bookmark List
> does not load/bring the referenced content.

customize_help-xhtml, fixed here.

Comment 13

[Giacomo Magnini]

Attachment: Variuos fixes, as reported

Hopefully corrected all of the reported problems... Neil, if you check this in,
please leave the bug open for further fixes.

Comment 14

[Gérard Talbot]

> Neil, if you check this in,
> please leave the bug open for further fixes.

Thanks! This is best because I'm sure there are (many?) more; I deliberately did
not report a few I found. For instance, checking all "[Return to beginning of
section]" and links leading to glossary tab: there will be a few for sure broken
links or missing anchors.

Comment 15

[Giacomo Magnini]

Please add them here when you find them. I'll do my best to fix all of them, as
soon as I can. Will also fix in a later patch the last different copyright line
in composer_help.xhtml, so every file will be up to date.

Comment 16

[Gérard Talbot]

Clicking in the left pane:
Privacy on the Internet/How Can I Make Sure Unauthorized People Don't Use
Information About Me?
does not load anything in the right pane.

Clicking "[Return to beginning of section]" in the right-pane at the end of the
section
Privacy on the Internet/How Can I Make Sure Unauthorized People Don't Use
Information About Me?
does not bring you back to the Privacy on the Internet section. But we can
deduce that the anchor must exist.

Clicking in the left pane:
Browsing the Web/Using Languages and International Content/Selecting Character
Encodings and Fonts
does not load anything in the right pane.

Clicking in the left pane:
Browsing the Web/Copying, Saving, and Printing Pages/Copying Part of a Page
does not load anything in the right pane.

Minor bug
Bring the content "Using the Help Window" in the right pane:
In the right pane of that page, only 3 clickable items/links will be listed
while the left pane will indicate 4 items.
The "Using Help Buttons" item in the list of links is missing in the right pane.

Minor bug
Bring the content Mozilla Keyboard Shortcuts/Mail & Newsgroups Shortcuts in the
right pane:
Clicking in the RIGHT pane:
General Mail & Newsgroups Shortcuts
does not scroll to the referenced content.

Clicking in the left pane:
Creating Web Pages/Formatting Your Web Pages/Formatting Paragraphs, Headings,
and Lists
does not load anything in the right pane.

Minor bug
Clicking in the left pane:
Creating Web Pages/Formatting Your Web Pages/Checking the HTML
Left pane says: Checking the HTML; right pane says: Validating the HTML
I think the left pane should say Validating the HTML so that expressions, terms
and vocabulary are consistent, constant everywhere.

Clicking in the left pane:
Creating Web Pages/Adding Tables to Your Web Page/Adding and Deleting Rows,
Columns, and Cells/Changing the Default Table Editing Behavior
does not load anything in the right pane.

The interpretation of what [Return to beginning of section] is supposed to bring
up (in terms of intra-navigation) is wrong everywhere in the whole "Using
Certificates" topic. The helpfile itself refers to topic, subtopic and (content)
section. When clicking on a [Return to beginning of section] link, the user
would normally expect and should be brought to the closest gray-background block
of content which starts with "In this section:". Let me give you an example of
what is wrong:
In the left pane:
Using Certificates/Controlling Validation/
Now, you should have "Controlling Validation" content in the right pane which
has that subsection content. Click
in the right pane the link "Configuring OCSP".
Now, as you've reached the "Configuring OSCP" content in the right pane, click
"[Return to beginning of section]" which should bring you back to where you were
just before: you should get back to the "Controlling Validation" section where
"Configuring OSCP" appears in the menu.
The bug is that you are brought back to "Using Certificates" section, not the
"Controlling Validation".

If you agree with my understanding, then every link occurences of "[Return to
beginning of section]" happening in Using Certificates would need to be updated,
corrected.
Other topic sections I checked did not function like this "Using Certificates" one.

I'm pretty sure there could still be a few other intra-navigation glitches to
fix  but now it becomes harder, longer to spot them with all those I found being
checked in and incorporated into a build: I have to compare with a long list of
those I found. Can we submit the patch with those corrections? Then I'll make a
final check of the helpfile again. I hope you understand what I mean.

Mozilla 1.8a4 build 2004090707 here.

Comment 17

[Giacomo Magnini]

Attachment: Revised patch, hopefully all-inclusive

Ok, I think I've got fixed all of the reported problems. Apart from typos, I've
changed help_help.xhtml (to conform to help-toc.rdf headings) and
using_certs_help.xhtml (added a bunch of "Return to beginning of section",
where they were obviously missing).
I won't make any other patch before this gets checked in or refused, in order
to be aligned the the next set of changes (if and when they are needed).
Neil, would you please take a look? TIA, Giacomo.

Comment 18

[[e-mail]]

Comment on attachment 158407 [details] [diff] [review]
Revised patch, hopefully all-inclusive

Exclude the composer_help changes which were covered by stefan's patch.

Comment 19

[Giacomo Magnini]

Great job, Neil! Thanks!
drunclear: I'm ready for the next roundup... Just wait one or two days and grab
another nightly before starting your hunt. I'll do the same, so we start on a
common base.

Comment 20

[Gérard Talbot]

I loaded build 2004091105 and noticed that almost all corrections (except 1)
were done.

Still to do:
------------

Clicking "[Return to beginning of section]" in the right-pane at the end of the
section
Privacy on the Internet/How Can I Make Sure Unauthorized People Don't Use
Information About Me?
does not bring you back to the "Privacy on the Internet" section.

Load
Using Certificates/Certificate Settings/Certificate Information and Decisions
in both panes.
Now, the left pane will have "Encryption Key Copy" as an item (end leave) but in
the gray block section, "Encryption Key Copy" link is missing. Correction to do:
Add it as a link in the gray block section.

Comment 21

[Giacomo Magnini]

(In reply to comment #20)
> Clicking "[Return to beginning of section]" in the right-pane at the end of the
> section
> Privacy on the Internet/How Can I Make Sure Unauthorized People Don't Use
> Information About Me?
> does not bring you back to the "Privacy on the Internet" section.

This seems correct, since that section is actually in a different document, and
the "Return.." goes back to the top of this new document.

> Load
> Using Certificates/Certificate Settings/Certificate Information and Decisions
> in both panes.
> Now, the left pane will have "Encryption Key Copy" as an item (end leave) but in
> the gray block section, "Encryption Key Copy" link is missing. Correction to do:
> Add it as a link in the gray block section.

Fixed here. Will wait for more glitches before providing another patch (so Neil
won't kill me! :) ).

Comment 22

[Gérard Talbot]

Clicking in the left pane:
Browsing the Web/Searching the Web/Using Find-as-you-type
The font-size of the header "Using Find-as-you-type" should be as big/tall as
other items (end leaves) of the section.

Bring the content of the right pane to
Browsing the Web/Searching the Web/
Now, in the gray block section, "Using Find-as-you-type" link is missing.

In the left pane:
Using Mail/Getting Started with Mail
the item "Changing the Settings for an Account" is missing

In the left pane:
Using Mail/Reading Messages/
the item should read "Choosing How You View the Mail Window";
"Choosing How You" is missing.

3 links "[Return to beginning of section]" in the right pane in the
Using Mail/Getting Started with Mozilla Mail & Newsgroups
should bring the user back to "Getting Started with Mozilla Mail & Newsgroups"
section and not to "Using Mail" top section.
E.g.: when clicking on "[Return to beginning of section]" link at the end of
Using the Mail Account Setup Wizard, the user should be brought back to "Getting
Started with Mozilla Mail & Newsgroups" section

Minor bug:
In the left pane:
Using Mail/Using Address Books/
the item "Editing a Mailing List" is mispositioned. It should be before
Searching Address Books.

In the left pane:
Using Mail/Using Address Books/
the item "Importing Address Books" is missing.

The link "[Return to beginning of section]" in the right pane at the end of the
content
Using Mail/Using Address Books/Creating a New Address Book Card
should bring the user back to the section "Using Address Books" and not to the
topmost section

In the left pane:
Clicking Using Mail/Organizing Your Messages/Marking or Flagging Messages
does not load the content in the right pane.

In the left pane:
Using Mail/Controlling Junk Mail
the items "Junk Mail Controls Options" and "Junk Mail Controls and Filters"
are missing

In the right pane:
Using Mail/Working Offline
the link in the gray block section says:
"Downloading Selected or Flagged Messages for Offline User"
it should be "Use", not "User"

In the left pane:
Using Mail/Mail & Newsgroups Account Settings/
the "Return Receipts" section should be a distinct item, not an element of the
section "Offline & Disk Space"

Comment 23

[Gérard Talbot]

> This seems correct, since that section is actually in a different document, and
the "Return.." goes back to the top of this new document.

Well, be careful because so far, every link "Return back to section" will bring
the user to the closest gray-background section within the content tree. In
comment #16, I said: The helpfile itself refers to topic, subtopic and (content)
section. When clicking on a [Return to beginning of section] link, the user
would normally expect and should be brought to the closest gray-background block
of content which starts with "In this section:".

Comment 24

[jon rekai]

Bug 258264 has a patch for these two, however, this (bug) sounds like what
Neil's comment 2 there may referring to.  If fixes for the below aren't yet in
the tree of the appropriate individual, it's attachment 158586 [details] [diff] [review].

(In reply to comment #22)
> In the left pane:
> Clicking Using Mail/Organizing Your Messages/Marking or Flagging Messages
> does not load the content in the right pane.
> 
> In the left pane:
> Using Mail/Controlling Junk Mail
> the items "Junk Mail Controls Options" and "Junk Mail Controls and Filters"
> are missing

Comment 25

[Giacomo Magnini]

(In reply to comment #22)
> Clicking in the left pane:
> Browsing the Web/Searching the Web/Using Find-as-you-type
> The font-size of the header "Using Find-as-you-type" should be as big/tall as
> other items (end leaves) of the section.
> 
> Bring the content of the right pane to
> Browsing the Web/Searching the Web/
> Now, in the gray block section, "Using Find-as-you-type" link is missing.

I've fixed everything except for the above, since I'm not sure how to handle it. 
The problem is that f-a-y-t was added at a later date and since it is a very
useful addition, it was added to the toc even if it doesn't have a real
subsection for it in the mail_help.xhtml. Now, the question is: should we tweak
heavily the mail_help.xhtml file or should we just remove the entry from the toc
file? The former will take some time (as I've never done such a big change), the
latter is a quick fix, but we lose a direct reference to such a feature.
Suggestions? Neil?

I've taken onboard jon rekai's patch (don't know if it's right to do so, or if I
should wait for the checkin of his patch before submitting mine).

Comment 26

[[e-mail]]

*** Bug 258264 has been marked as a duplicate of this bug. ***

Comment 27

[Giacomo Magnini]

Attachment: More fixes...

Third round of fixes. I have added a few fixes other than the ones reported:
mainly removed some useless <p><br /></p> and added a few correct (at least I
think) "Return to the beginning of section".
Daniel: I've got what you was referring to, and fixed it.

Comment 28

[Giacomo Magnini]

Comment on attachment 158614 [details] [diff] [review]
More fixes...

Here we go. Added a new subsection to nav_help.xhtml (not mail_help, as I
wrongly wrote before) for f-a-y-t. Please Neil, remember to credit jon rekai
if/when you check this in! Thx.

Comment 29

[Tsahi Asher]

i've summarized about two dozens of what i consider to be errors in mail_help,
in bug 258257.

Comment 30

[Giacomo Magnini]

(In reply to comment #29)
> i've summarized about two dozens of what i consider to be errors in mail_help,
> in bug 258257.

Some of them have been fixed/are being fixed. Will get to the rest of the list
as soon as the new patch is in. I will try to rewrite some things you spotted,
but I don't think to be the right person to do that: maybe Stefan?

Comment 31

[Giacomo Magnini]

Comment on attachment 158614 [details] [diff] [review]
More fixes...

Small typo in patch: Find as you type <h2> has a closing </h3>!!!!

Comment 32

[Gérard Talbot]

In the left pane:
Mozilla Keyboard Shortcuts/Navigator Shortcuts
and here it should be listed
# Bookmarks Shortcuts
# Page Navigation Shortcuts
# Page Viewing Shortcuts

Right now, in Mozilla 1.8a4 build 2004092306, the 
# Page Navigation Shortcuts
item is missing.

Comment 33

[Giacomo Magnini]

Attachment: Fix for the reported missing entry

Here is the fix for the last problem reported.
Hopefully Neil can check all the patches in as soon as the tree reopens.

Comment 34

[[e-mail]]

Comment on attachment 159950 [details] [diff] [review]
Fix for the reported missing entry

Depends on whether the tree opens before the 8th when I get back from holiday
;-)

Comment 35

[Giacomo Magnini]

Please Neil, check & review also the previous patch (attachment 158614 [details] [diff] [review]), and add
the fix in comment 31!!! :)

Comment 36

[Ian Neal]

Checking in More fixes... patch:
Checking in en-US/cert_dialog_help.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/cert_dialog_help.xhtml,v
 <--  cert_dialog_help.xhtml
new revision: 1.7; previous revision: 1.6
done
Checking in en-US/help-toc.rdf;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/help-toc.rdf,v  <-- 
help-toc.rdf
new revision: 1.63; previous revision: 1.62
done
Checking in en-US/mail_help.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/mail_help.xhtml,v  <-- 
mail_help.xhtml
new revision: 1.43; previous revision: 1.42
done
Checking in en-US/nav_help.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/nav_help.xhtml,v  <-- 
nav_help.xhtml
new revision: 1.38; previous revision: 1.37
done
Checking in en-US/privacy_help.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/privacy_help.xhtml,v 
<--  privacy_help.xhtml
new revision: 1.36; previous revision: 1.35
done

Comment 37

[Ian Neal]

Checking in Fix for the reported missing entry
Checking in help-toc.rdf;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/help-toc.rdf,v  <-- 
help-toc.rdf
new revision: 1.64; previous revision: 1.63
done

If you need these patches in 1.8a4, please set the flag to request approval.

Comment 38

[Stefan [:stefanh]]

Giacomo, If you feel that everything is fixed - just resolve as Fixed ;)

Comment 39

[Ian Neal]

Sorry I got confused, 1.8a4 has been cut not branched, so do what Stefan says.

Comment 40

[Giacomo Magnini]

I'm going to resolve this bug as fixed, since it's really getting overloaded
with text and patches (my fault). If there are more errors, bug me and I will
open a new cumulative bug to track them down.
Now, if you guys have some little time to review and checkin bug 258257, I would
be grateful... :)
Stefan patches for platform hiding will indeed apply with just one already
reported rejection.
Thank you all for reporting, reviewing and checking in.

Comment 41

[Giacomo Magnini]

More work to come in bug 262080. Please add new reports there.

Comment 42

[Stefan [:stefanh]]

v