238221 - Land Firefox Help 1.1 onto the Firefox Trunk

Status: RESOLVED FIXED

(SeaMonkey :: Help Viewer, defect)

Description

[R.J. Keller]

This version contains a LOT of enhancements and bugs fixes over the previous
release. It also includes updated documentation that is up to date with this
version of Firefox.

See http://mozdev.org/bugs/show_bug.cgi?id=5983 for a list of major bug fixes in
this release.

Comment 1

[R.J. Keller]

Nominating for blocker status, because not only is there obsolete documentation
in the current Help Viewer, but bug 236690 still exists, which is a major issue
that causes the Help Viewer to have a 50/50 chance of loading help content.

Comment 2

[Jeff Walden [:Waldo]]

Attachment: Fire(bird|fox) Help 1.1 - untested

R.J. Keller is on vacation until April 1st, so I'm doing this patch instead of
him.

I don't have a working system for building on either Linux or Windows, and I
don't own a Mac, so this is unfortunately untested.  I spent enough time first
copying and then rewriting the build system to fit mozilla.org that I had to
manually check the mechanics of this thing for at least two hours, and as a
result I have every belief in the world that this patch will not break Help or
anything else.	The changes are numerous and momentous, however, so this
absolutely, absolutely requires a few builds for testing on various platforms.
As there's new functionality for both Windows and Mac, testing on all three
platforms is necessary.  Nilson, you can test on Linux with this patch and the
files I'll attach next to make sure everything's okay, right?  I don't know who
can test for Windows and Mac, tho.  Once it's tested it'll go for review.

A few files and one folder can be deled from the tree.	Here's the list:

browser/components/help/locale/en-US/firebird-glossary.rdf
browser/components/help/locale/en-US/glossary.xhtml
browser/components/help/locale/en-US/help-toc.rdf
browser/components/help/locale/en-US/help.dtd
browser/components/help/locale/en-US/help.properties
browser/components/help/locale/en-US/helpMenuOverlay.dtd
browser/components/help/locale/en-US/welcome.xhtml
browser/components/help/locale/en-US/images/opt_connection.png
browser/components/help/locale/en-US/images/opt_fontsandcolors.png
toolkit/components/help/locale/en-US/help	 (the folder and its files)

A few files/folders will need to be added, and some images need to be replaced.
 I'll attach them here (with instructions on their application) after I attach
this patch.

The bigger fixes:
-general documentation editing
-DL manager/Import documentation
-updated for cookies info, name change, menu information
-menu paths/items are all the same format
-"Preferences" are now properly called Options
-new Options screenshots (previously were from ~0.6)
-info on Help is now separate from the app-specific help files
-Mac skin
-alpha-transparent buttons

Comment 3

[Jeff Walden [:Waldo]]

The added/binary files/folders are too larege for Bugzilla, so here's a link:

http://firebirdhelp.mozdev.org/fbhelp-1.1-changes.zip

Inside the ZIP you'll find folders named like so:

to toolkit-components-help

Simply move the contents of each to the referred-to location (overwriting any
existing files) (in this case that's toolkit/components/help), and you should be
good to go.  If you try building with this, please comment on the results
(mentioning platform) so I know how well this patch works (and so that it can
get in the tree quickly).  I'll probably also post a message on the Mozillazine
forums so we can get tests done quickly.

Comment 4

[Jeff Walden [:Waldo]]

I've been told the earlier method of patching isn't particularly easy, so here's
an alternate ZIP file.  This one contains a mozilla folder with appropriate
subfolders to hold the entire content of (browser|toolkit)/components/help, so
simply copy the mozilla folder over that in your Mozilla tree and everything
should be okay.  There's also a simple shell script in the ZIP that can be run
from within mozilla/ to dele all the obsolete files.  Hope that helps...

http://firebirdhelp.mozdev.org/help.zip

Comment 5

[R.J. Keller]

Hi Jeff. Thanks for your work on this! I managed to get on a computer with 
internet access for 5 minutes ;). I should be able to test this patch on 
windows tomorrow or friday.

I'm going to try reinstalling my linux installation on friday also, so I should 
be able to help test there. stefan_h might be able to help on mac testing, but 
not sure.

Comment 6

[Nilson Cain]

I have been trying to test this patch, but my build system seems to be horribly
broken already.

I can download a new source tarball and try it,  but no promises.

Sorry :|

Comment 7

[R.J. Keller]

--> Jeff

Ben, can you review this?

Comment 8

[R.J. Keller]

Comment on attachment 144943 [details] [diff] [review]
Fire(bird|fox) Help  1.1 - untested

I'm cooking up a new patch with the added files in it. Once it finishes
compiling, I'm going to post it.

Comment 9

[Mike Connor [:mconnor]]

this isn't a blocker severity bug, the blocking0.9? flag is set.

unless of course something in this patch fixes something that's causing
topcrashers or killing the build...

Comment 10

[R.J. Keller]

> unless of course something in this patch fixes something that's causing
> topcrashers or killing the build...

sort of. This patch fixes a problem where help will only load half the time
(almost exactly :)). It is a major issue and definetely needs fixing for 0.9.

If you do not think that this is of blocker severity, then change it, but having
a major feature not function properly is of high severity IMO.


My patch may take longer because I forgot to do diff -N, so now I gotta do it
over again :).

Comment 11

[R.J. Keller]

Attachment: Patch

Includes new files and everything!

Comment 12

[Mike Connor [:mconnor]]

its major then, but it isn't blocker severity (blocker severity really means
"drop everything else until this is fixed, we can't keep working on the product
because of this")

severity != importance

Comment 13

[Asa Dotzler [:asa]]

Not going to block the 0.9 release but Ben says go ahead and check that patch in
and any similar patches. He's too busy to do reviews on this now and trusts you
(R.J.) to make it good :-)

Comment 14

[R.J. Keller]

Fix checked in (phew!).

I did an extensive amount of testing to make sure that this doesn't break the
build, but I'll be on IRC in case it does, so ping me if you see something
suspicious. I'm currently rebuilding from a fresh tree off of CVS to confirm
that this works without problems (the tinderboxes might beat me, though :)).