253104 - [TRACKER] Firefox Help Documentation changes before the 1.0 release

Status: RESOLVED FIXED

(Firefox Graveyard :: Help Documentation, defect, P3)

Description

[R.J. Keller]

This is a tracker bug for inaccuracies and typos found in the Help documentation
that need to be repaired even though the Help freeze has occured.

Comment 1

[Steffen Wilberg]

I just checked in a couple of minor updates. There's no bug for them, so please
have a look at this:
http://bonsai.mozilla.org/cvsquery.cgi?treeid=default&branch=&date=explicit&mindate=07%2F27%2F2004+02%3A05&maxdate=07%2F27%2F2004+03%3A24

Comment 2

[Mark Tyndall]

The following is based on this cmd pulling the same files you're meaning:
cvs checkout -r AVIARY_1_0_20040515_BRANCH mozilla/components/help/locale

These are all minor points - I didn't think a separate bug was necessary.

Nits:

customization.xhtml
 line 175: "extensions" should be extension

glossary.xhtml
 "email" not "e-mail" in Internet (line 200) and Master Password (line 236)
  (cf "e-mail" in plug-in (line 281)

menu_reference.xhtml
 line 81: missing full-stop

using_firebird.xhtml
 line 77: <p> element begins with an extra unneeded ">"
 lines 277 + 306: reference to "hard drive", not "hard disk"

welcome.xhtml
 lines 87-88: "Firebird" (not -fox) and "Mozilla" - replace with
  &brandShortName; / &vendorShortName;?

Semantics:

firefox_welcome.xhtml
 too many unneeded ' valign="top"' strings in the table
 several headings should be in <th>s, not <td>s?
  (NB - if you change the above, need to add a
    (.noTableBorder) th { text-align: left; }
  rule into the css (.noTableBorder to limit application))
prefs.xhtml
 lines 104-110: inconsistent <p>s and <br/>s

Suggestion:

menu_reference.xhtml
 could <h4> do to be indented, if you're going to use <h2-4> as menu levels?

Comment 3

[R.J. Keller]

(In reply to comment #2)
> The following is based on this cmd pulling the same files you're meaning:
> cvs checkout -r AVIARY_1_0_20040515_BRANCH mozilla/components/help/locale
> 
> These are all minor points - I didn't think a separate bug was necessary.
> 
> Nits:
> 
> customization.xhtml
>  line 175: "extensions" should be extension

done

> 
> glossary.xhtml
>  "email" not "e-mail" in Internet (line 200) and Master Password (line 236)
>   (cf "e-mail" in plug-in (line 281)

No, it should be e-mail ->
http://www.mozilla.org/projects/help-viewer/documentation_language-style.php#terms

> 
> menu_reference.xhtml
>  line 81: missing full-stop

what do you mean by this?

> 
> using_firebird.xhtml
>  line 77: <p> element begins with an extra unneeded ">"

fixed

>  lines 277 + 306: reference to "hard drive", not "hard disk"

I personally would prefer "hard drive" over "hard disk".

> 
> welcome.xhtml
>  lines 87-88: "Firebird" (not -fox) and "Mozilla" - replace with
>   &brandShortName; / &vendorShortName;?

fixed

> 
> Semantics:
> 
> firefox_welcome.xhtml
>  too many unneeded ' valign="top"' strings in the table
>  several headings should be in <th>s, not <td>s?
>   (NB - if you change the above, need to add a
>     (.noTableBorder) th { text-align: left; }
>   rule into the css (.noTableBorder to limit application))

I'll do this one later :).

> prefs.xhtml
>  lines 104-110: inconsistent <p>s and <br/>s

That is done for a reason.

> 
> Suggestion:
> 
> menu_reference.xhtml
>  could <h4> do to be indented, if you're going to use <h2-4> as menu levels?

No, I don't feel that it's necessary, but I understand where you think that. The
paragraph indentation makes the menu reference headings look thrown off. I might
remove that indentation from the CSS.

Comment 4

[R.J. Keller]

steffen: Firefox 1.0 PR is the localization freeze, so this bug couldn't
possibly block 1.0.

Comment 5

[Mark Tyndall]

(In reply to comment #3)
> (In reply to comment #2)
[...]
> > glossary.xhtml
> >  "email" not "e-mail" in Internet (line 200) and Master Password (line 236)
> >   (cf "e-mail" in plug-in (line 281)
> 
> No, it should be e-mail ->

Sorry, that's what I meant - line 200 & 236 have instances of "email", not "e-mail".

> > menu_reference.xhtml
> >  line 81: missing full-stop
> 
> what do you mean by this?

That line is missing a full-stop, compared to all the other lines.
Or is it a UK/US thing?  full-stop == period == "."

> >  lines 277 + 306: reference to "hard drive", not "hard disk"
> 
> I personally would prefer "hard drive" over "hard disk".

hard disk is more used throughout the Help, AFAICT. I don't mind, as long as
it's consistent.

Comment 6

[R.J. Keller]

(In reply to comment #5)
> hard disk is more used throughout the Help, AFAICT. I don't mind, as long as
> it's consistent.

Most users I've met know what a Hard Drive is, but not what a Hard Disk is. I'd
rather use that definition since it's more commonly used (at least in the
end-user world). If you see Hard Disk, then it needs to be changed.

Comment 7

[Ben Goodger (use ben at mozilla dot org for email)]

Assigning a priority for neatness. 

Comment 8

[chris hofmann]

need to wrap up these changes in the next few days or risk missing 1.0
localization freeze and final release.  I'm going to -minus this bug and plus
any in the dependence list that seem critical at this point.

Comment 9

[HAL]

In the cookie section under "Setting Up Cookie-Rules" at "ask me every time" i
miss the note that "Allow sites to set cookies" MUST be activated. Because it's
possible to select "ask me every time" without activating "Allow sites to set
cookies" it will be a problem for beginners and not only.

Comment 10

[Steffen Wilberg]

I've removed the unused file
mozilla/browser/components/help/locale/en-US/firebird-glossary.rdf from both
branch and trunk. r=rlk via IRC.

However, we have two more unused files:
mozilla/browser/components/help/locale/en-US/glossary.xhtml
mozilla/browser/components/help/locale/en-US/help-toc.rdf
They were copied to mozilla/toolkit/components/help/helpOnHelp/locale/en-US/.
Can I remove these as well?

Comment 11

[R.J. Keller]

(In reply to comment #10)
> I've removed the unused file
> mozilla/browser/components/help/locale/en-US/firebird-glossary.rdf from both
> branch and trunk. r=rlk via IRC.
> 
> However, we have two more unused files:
> mozilla/browser/components/help/locale/en-US/glossary.xhtml
> mozilla/browser/components/help/locale/en-US/help-toc.rdf
> They were copied to mozilla/toolkit/components/help/helpOnHelp/locale/en-US/.
> Can I remove these as well?

yup, burn 'em. r=[e-mail] on removal of those files.

Comment 12

[Steffen Wilberg]

burned branch and trunk.

Comment 13

[R.J. Keller]

Moving to new Firefox Help owner.

Comment 14

[Steffen Wilberg]

I just landed a patch to change Help image paths to 1.0 and change some
resolutions, see bug 248264 comment 38.

Comment 15

[Jeff Walden (gone starting June 8)]

As an FYI, Help in 1.0mac might have a fix or two (mostly for shortcuts that
might be incorrect and for some menus like Window that don't exist elsewhere),
but it'll be nowhere near the number of changes we've now.

Now, finally, Help for 1.0 is done.