RDF-ification of the help system

VERIFIED FIXED in mozilla0.9.9

Status

VERIFIED FIXED
17 years ago
5 years ago

People

(Reporter: oeschger, Assigned: oeschger)

Tracking

Trunk
mozilla0.9.9
x86
Windows 2000
Dependency tree / graph

Firefox Tracking Flags

(Not tracked)

Details

(Whiteboard: [adt3], URL)

Attachments

(8 attachments, 3 obsolete attachments)

339.38 KB, patch
hewitt
: review+
hewitt
: superreview+
Details | Diff | Splinter Review
11.68 KB, patch
Details | Diff | Splinter Review
27.97 KB, patch
Details | Diff | Splinter Review
2.00 KB, patch
Details | Diff | Splinter Review
2.32 KB, patch
Details | Diff | Splinter Review
13.10 KB, patch
Details | Diff | Splinter Review
17.30 KB, patch
Details | Diff | Splinter Review
17.26 KB, patch
oeschger
: review+
hewitt
: superreview+
Details | Diff | Splinter Review
(Assignee)

Description

17 years ago
Help system should be more dynamic than it is now, and determine which content
to load based on what components are available. RDF-ification in patch to be
posted here shortly also provides a client-side search capability, some
sidebar-like panels on the left, and better use of templates there as well.

See spec at URL above for more info.
(Assignee)

Updated

17 years ago
Blocks: 67376

Comment 1

17 years ago
Setting nsbeta1+, 0.9.9 milestone. 
Keywords: nsbeta1+
Target Milestone: --- → mozilla0.9.9
(Assignee)

Comment 2

17 years ago
Created attachment 68454 [details] [diff] [review]
update for help system: rdfification

Updated patch from 67376: this one has been cleaned up, includes the fix for
the retired outlinerbody stuff (so now it works), includes some cleaning out of
the old, no-longer-used help files, has an updated toc and index.

Comment 3

17 years ago
Comment on attachment 68454 [details] [diff] [review]
update for help system: rdfification

r=hewitt
sr=waterson (from earlier)
Attachment #68454 - Flags: superreview+
Attachment #68454 - Flags: review+
(Assignee)

Comment 4

17 years ago
Created attachment 68471 [details] [diff] [review]
update to UI to get context sensitive help

We also have to change references to help.js to contextHelp.js in the UI where
openHelp() is being called. This patch is an update for all the places in
security that need the update. Working on the dozen or so others.

Updated

17 years ago
Attachment #68471 - Flags: review+
(Assignee)

Comment 5

17 years ago
Created attachment 68474 [details] [diff] [review]
same thing for the editor dialogs that get context-sensitive help

This patch updates all references to help.js in the editor dialogs.
(Assignee)

Comment 6

17 years ago
Created attachment 68477 [details] [diff] [review]
the real editor dialog update

actually, scratch that. This one is the real one. The syntax for opening help
has changed too: the function does not need to include the url anymore.
Attachment #68474 - Attachment is obsolete: true
(Assignee)

Comment 7

17 years ago
Created attachment 68480 [details] [diff] [review]
re-update in security: syntax change for openHelp

sigh...another update. This includes the help.js->contextHelp.js updates I made
in security but also has the update for the syntax of openHelp, which now
*doesn't* want to old url to the help window, chrome://help/content/help.xul,
but *does* want the key by itself of a full url like this:
chrome://help/locale/mozillahelp.rdf?key, where mozillahelp.rdf is the rdf file
at the top of the help system that spells out what content is available.
Attachment #68471 - Attachment is obsolete: true
(Assignee)

Comment 8

17 years ago
Created attachment 68498 [details] [diff] [review]
yet another patch (YAP)

update to preferences dialog: hooks context sensitive help back up post help
check-in
(Assignee)

Comment 9

17 years ago
Created attachment 68500 [details] [diff] [review]
updating the AccountManager dialog for cs help

I think this is the last one we need: the AccountManger dialog also needs to be
updated to ask for help in the right way (i.e., without the
chrome://help/content/help.xul) and from the right file (contextHelp.js).
(Assignee)

Comment 10

17 years ago
Jag - Can I have your practiced eye on these updates to spots in the UI where
help is being asked for with context? I had to update the file that gets
included (contextHelp.js) and the syntax of openHelp(). 
Status: NEW → ASSIGNED

Comment 11

17 years ago
Hey, Ian. Can you remove the 'xmlns:html' from the window element in 
'help.xul'. One, it's not needed, and two, the namespace 'REC-html40' is 
long obsolete.
(Assignee)

Comment 12

17 years ago
Roger, John. I'll pull it out next time I go in with an update. Thanks.
(Assignee)

Comment 13

17 years ago
Created attachment 69402 [details] [diff] [review]
update to context-sensitive help: openHelp() takes a topic param or nothing; setHelpFileURI is used to specify other help content sets.
(Assignee)

Updated

17 years ago
Depends on: 124902
(Assignee)

Comment 14

17 years ago
Created attachment 74096 [details] [diff] [review]
big patch that includes all the changes we need in the help viewer

This patch fixes the following bugs in one big schmear:

128098
128360
129061
92412
107188
130346
(Assignee)

Comment 15

17 years ago
adding dependencies for a group of open bugs that need review
(Assignee)

Comment 16

17 years ago
adding the anchor bug as a dependency. Navigation in the help viewer is pretty
well broken without link->anchors working.

Depends on: 130447
(Assignee)

Comment 17

17 years ago
Created attachment 75002 [details] [diff] [review]
some refinements to sooperpatch

the displayIndex() function uses jan varga's iteration instead of my own clumsy
go-to-a-big-number version, and the isMatch() function for checking RE's has
been cleaned up (but not actually changed).
Attachment #74096 - Attachment is obsolete: true
(Assignee)

Comment 18

17 years ago
adding the panel-sorting bug as a dependency. Patch in that bug adjusts the
attributes on the outliner for different panels.
Depends on: 131204

Comment 19

17 years ago
Looks good. Glad to see the search database. I was getting annoyed at the 
incoherent results that the current find returns.  What's the bug to expand the 
contents of the search database?

+  // search additional search datasources	
+  if (searchDatasources != "rdf:null") {
+  		if (!searchDS)
+			searchDS = loadCompositeDS(searchDatasources);
+	  doFindOnDatasource(resultsDS, searchDS, RDF_ROOT, 0);
+  }

Remove the tabs there.

+  //outliner = document.getElementById("help-index-outliner");
+  //sourceDS = outliner.database;
+  //if (!sourceDS) // If the index has never been displayed this will be null 
(sigh!).
+  //  sourceDS = loadCompositeDS(outliner.datasources);
+  //doFindOnDatasource(resultsDS, sourceDS, RDF_ROOT, 0);

Why is this commented out? Do you intend to uncomment it later?

-    if (!RE[i].test(text))
+    if (!RE[i].test(text))  

Unnecessary change.

What is the purpose of displayIndex? The comment doesn't really tell me. Is it 
supposed to close all the open toplevel help topics when you go to the index, 
or something?  If so, why?  Why only those and not open children?  And

+      var rowCount = oview.rowCount;
+      oview.toggleOpenState(i);
+      i = i + oview.rowCount - rowCount;

Isn't that last statement equivalent to i = i?

<button id="findButton" label="&gobtn.label;" oncommand="doFind()" flex="0"/>

This should have default="true" specified.


(Assignee)

Comment 20

17 years ago
Created attachment 75628 [details] [diff] [review]
new sooperpatch based on blake's feedback

removed tabs, redid index-opening function (and added explanation in comments),
added sorting of search results (and unsorting of glossary results) from patch
in 131204, which you were asking about, added default=true to find button,
removed commented-out index-searching code.
(Assignee)

Comment 21

17 years ago
Blake
Thanks for looking at this! Here is a new version of the patch that includes the
sorting stuff from 131204 and the fixes you describe.

Comment 22

17 years ago
Comment on attachment 75628 [details] [diff] [review]
new sooperpatch based on blake's feedback

sr=hewitt, contingent on fixing these nits:

Don't hard-code keyCode values like 13, use the constants in KeyEvent.DOM_VK_*,
see nsIDOMKeyEvent.idl

If you're incrementing a variable and don't need to store the previous value,
use ++i instead of i++
Attachment #75628 - Flags: superreview+
(Assignee)

Comment 23

17 years ago
Thanks Joe! I will put the changes you mention in. Now, Blake, if you can
r=blake it, I'll get all this stuff in in time for the help system usability
test that is scheduled for Thursday morning.

(Assignee)

Comment 24

17 years ago
Comment on attachment 75628 [details] [diff] [review]
new sooperpatch based on blake's feedback

author=pwilson, r=oeschger. There! Hewitt's suggested fixes are in. Has review.
Most of the search functionality is Peter's anyway, and he and I have been over
this code a dozen times.
Attachment #75628 - Flags: review+

Updated

17 years ago
Whiteboard: [adt3]
(Assignee)

Comment 25

17 years ago
Help system rdf-ified. Marking FIXED.
Status: ASSIGNED → RESOLVED
Last Resolved: 17 years ago
Resolution: --- → FIXED

Comment 26

17 years ago
Indeed it is, marking verified as of win xp build 2002041206
Status: RESOLVED → VERIFIED
Product: Browser → Seamonkey
You need to log in before you can comment on or make changes to this bug.