77629 - Update of Mozilla Help

Status: VERIFIED DUPLICATE of bug 46917

(Documentation Graveyard :: Help Viewer, defect)

Description

[Rohinton Kazak]

From Bugzilla Helper:
User-Agent: Mozilla/5.0 (Windows; U; WinNT4.0; en-US; rv:0.8.1+) Gecko/20010425
BuildID:    2001042504

Not sure but I thnk that there is a missing element from the
table of contents - If I follow the flow - I have attached an
image of the possible problem.

Reproducible: Always
Steps to Reproduce:
1. Startup Mozilla help
2. Expand the table of contents.
3. Follow in main window...

Actual Results:  Missing the Searching the Web entry in the TOC

Expected Results:  Entry in TOC for Searching the WEB.

Attached image.

Comment 1

[Rohinton Kazak]

I am haviing trouble uploading the image file, I have
reduced it's size as muchas possible, I will get to it
tomorrow.

I have found some more missing TOC enteries:
"Reading Messages" after "Using Instant Messenger with Netscape Mail"
"Formatting Your Web Page" after "Saving and Browsing Your New Page"
"
Selecting "Customizing Netscape 6", gives "My Sidebar" in the main
window, also should this not be Mozilla? ( IMHO references to Netscape6 
should be removed, converted to Mozilla )

There are others, some sort of review is required, there aslo seems to
be content enteries which are out of step with the TOC, eg "Changing Fonts,
Colors, and Themes" appear after "Customizing Netscape 6" but in the
main window appears after "Opening, Closing, and Resizing My Sidebar"

"Using the Buddy List" in main window after "Specifying Connection Settings"
is missing from the TOC.

"Using Security and Privacy Features" is missing.
"SSL Page Info" missing.

The Index is missing too. :-)

Comment 2

[Brian 'netdragon' Bober]

Steve, do you think we should change this bug to something like, "Content 
errors fix, and updating of Mozilla help system necessary"? Gerv, I have added 
you to CC, I hope you don't mind.

Chuck R. has fixed up a lot of the help files. How do you think he should 
attach them to the bug? I think the best thing would be for him to zip up the 
files he changed with the proper directory layout. 

Chuck R., I am not exactly sure of where these help files you have made are to 
be located - "menuedit.html", "menufile.html", and "index.html". The help files 
are located in the chrome in "chrome/locale/en-US/help". The chrome contains 
the UI for Mozilla and is written in XML, Javascript, and HTML. First unpack 
all the jar files in your bin/chrome/ dir using winzip or any other jar 
unpacking software, then edit "installed-chrome.txt". For example, the first 
line:
content,install,url,jar:resource:/chrome/comm.jar!/content/necko/
should be changed to:
content,install,url:resource:/chrome/comm/content/necko/

I am not sure if there should be a comma between url, and resource, so try that 
if the previous doesn't work.


Then you should be ready to go. You can edit the html files in the 
chrome/locale/en-us/help, and add new ones, etc. I believe the table of 
contents is contained within "help-toc.rdf" and the index is 
within "index.html".

If you have any questions, please email me.

Comment 3

[Brian 'netdragon' Bober]

Or you can put the questions here. After we have all the help files looked at, 
and they seem good, they will need to be added to the source tree.

Comment 4

[Brian 'netdragon' Bober]

Also, the html in the help system should follow the w3c standard.

Chuck R.: Thanks for helping on the Mozilla project. Remember to disable XUL 
cache in the preferences when working with the chrome.

Comment 5

[Brian 'netdragon' Bober]

Sorry for multiple postings but I keep thinking of something else.

Remember to validate your html: "http://validator.w3.org/"

Comment 6

[rudman]

Brian, you're right, the summary needs to be updated. 

Rohinton, several of the items you mention should indeed be removed, like all 
refs to Netscape and to Instant Messenger.

The update of the ToC and the update of the content could be seen as separate 
activities (and under other circumstances would be), but in this case, since the 
content update has to precede the ToC fixes, both things can be lumped in this 
bug. The real bug seems to be, Clean Up the Mozilla Help. In which case, this 
bug is a dupe of http://bugzilla.mozilla.org/show_bug.cgi?id=46917.

*** This bug has been marked as a duplicate of 46917 ***

Comment 7

[Chuck R.]

I think it might be helpful if I wrote a program to track all the index entries 
for the help files, and generate the index file. Anyone object? This would 
probably be in Access. 

Comment 8

[Gervase Markham [:gerv]]

> I think it might be helpful if I wrote a program to track all the index 
> entries for the help files, and generate the index file. Anyone object? This 
> would probably be in Access. 

I'd object if you did it in Access, because then very few other people would be 
able to run it if necessary :-) This seems like an ideal opportunity to learn 
Perl to me... 

Gerv

Comment 9

[Brian 'netdragon' Bober]

Agreed. Perl should be fine. http://www.activeperl.com/. Chuck, you should talk 
in the other bug now, also. The problem with access is its windows/mac-
specific. If you talk to someone in #mozwebtools on IRC, they should be able to 
help you throw something together. ;-)

Comment 10

[Ian Oeschger (gone)]

Attachment: script for generating an index page

Comment 11

[Ian Oeschger (gone)]

Chuck
I just attached the script I am using on the NS side to generate an index. It's
sort of lame, but it grabs the specially-formatted index anchors (e.g., <A
NAME="SomeTextIDX"></A> and formats them in a page.

Feel free to adapt it, throw it away, or whatever. If you do use it, you will
have to change some of the stuff like where the script chdir's to.

Way to go on the documentation updates, too.

By the way, is this bug really dupe'd and dead? Should this conversation be
going on over in 46917 instead?

Comment 12

[Brant Gurganus]

duplicate notation missing

Comment 13

[Brant Gurganus]

duping against 46917

*** This bug has been marked as a duplicate of 46917 ***

Comment 14

[Brant Gurganus]

v