This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 60998 - Help buttons
Summary: Help buttons
Status: VERIFIED FIXED
Alias: None
Product: apisupport
Classification: Unclassified
Component: Project (show other bugs)
Version: 5.x
Hardware: All All
: P3 blocker (vote)
Assignee: Martin Krauskopf
URL:
Keywords: UI
: 63483 (view as bug list)
Depends on:
Blocks:
 
Reported: 2005-07-14 18:32 UTC by Geertjan Wielenga
Modified: 2005-11-25 13:29 UTC (History)
2 users (show)

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments
help ids (1.00 KB, text/plain)
2005-07-21 16:10 UTC, Martin Krauskopf
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Geertjan Wielenga 2005-07-14 18:32:21 UTC
Help buttons needed on the following ui:
-- Each wizard panel (module wizard and module suite wizard)
-- Each properties panel (Sources, Display, Libraries, Versioning, Compiling,
packaging, and Documenting -- but NOT on the Build panel)
-- NetBeans Platform Manager
Comment 1 Martin Krauskopf 2005-07-21 12:24:32 UTC
Fixed. I suppose that somebody (probably you Geertjan) write a documentation
itself. Please look for "API Support" in
javahelp/org/netbeans/modules/usersguide/Map.jhm and adjust as you need.

apisupport/project
Checking in ui/customizer/CustomizerLibraries.java; 1.24 --> 1.25
Checking in ui/customizer/CustomizerProviderImpl.java; 1.31 --> 1.32
Checking in ui/customizer/SuiteCustomizer.java; 1.2 --> 1.3
Checking in ui/platform/NbPlatformCustomizer.java; 1.6 --> 1.7
Checking in ui/platform/PlatformChooserWizardPanel.java; 1.1 --> 1.2
Checking in ui/platform/PlatformInfoWizardPanel.java; 1.1 --> 1.2
Checking in ui/wizard/BasicConfWizardPanel.java; 1.6 --> 1.7
Checking in ui/wizard/BasicInfoWizardPanel.java; 1.9 --> 1.10
usersguide:
Checking in javahelp/org/netbeans/modules/usersguide/Map.jhm; 1.344 -> 1.345
Comment 2 Martin Krauskopf 2005-07-21 15:20:57 UTC
I've got a feedback from Patrick:

==
Any reason you made these changes  in usersguide?

IMO, there  should be a separate help set for API Support help. There might be
distributions of NB that don't have the API support, so it's best not to have
this help in usersguide, which would appear in all IDE distros.
==

I will have to investigate how to create own help set.
Comment 3 Geertjan Wielenga 2005-07-21 16:03:26 UTC
Already there:

apisupport\javahelp\org\netbeans\modules\apisupport\help

This is where the help should go, I think. And yes, I will write it. All I need
to know is what the help IDs are.
Comment 4 Martin Krauskopf 2005-07-21 16:09:31 UTC
Aha. I'm begging to undestand :) So you are probably looking for.... attachment
to prevents formating.
Comment 5 Martin Krauskopf 2005-07-21 16:10:14 UTC
Created attachment 23215 [details]
help ids
Comment 6 Martin Krauskopf 2005-07-21 16:12:45 UTC
Of course, I meant "beginning" :)
Also this means that this issue is actually fixed.
Comment 7 Jesse Glick 2005-07-21 17:06:14 UTC
Do NOT use apisupport/javahelp. That is documentation for the old, mostly
obsolete module. Create and use apisupport/project/javahelp for all new docs
pertaining to the NBM project type.
Comment 8 Geertjan Wielenga 2005-07-21 17:08:50 UTC
I don't know how to set that up; I suspect that normally a developer sets it up
for docs people (I don't want to mess up some code level stuff). So, could you
set this up Jesse?
Comment 9 Jesse Glick 2005-07-21 17:14:46 UTC
Martin should set up the javahelp area (or Martin reassign to me if you don't
know how and want help). In either case, M please revert the changes to
apisupport/help.
Comment 10 Martin Krauskopf 2005-07-21 17:20:34 UTC
I can try it (steal from another module). It was commited by Geertjan (to
apisupport/help), but I could revert if he is not working on it already. Nice
mess :)
Comment 11 Geertjan Wielenga 2005-07-21 17:22:34 UTC
Sure, you can revert it. Thanks!
Comment 12 Jesse Glick 2005-07-21 17:51:02 UTC
If you haven't worked with JavaHelp before, read

1. The help guide, in the NB API documentation.

2. The harness README for what the relevant properties and file locations and
targets are. It should be pretty simple though; basically just make
javahelp/org/netbeans/modules/apisupport/project/docs/ and put the help set there.

Which reminds me to add a JavaHelp wizard to phase IV. :-)
Comment 13 Geertjan Wielenga 2005-07-21 17:52:50 UTC
That would be brilliant. If all those fiddly files were to be created for you by
a wizard... awesome.
Comment 14 Geertjan Wielenga 2005-07-22 16:46:52 UTC
Actually, since I just wrote the tutorial for creating java help the other day
(http://platform.netbeans.org/tutorials) it's a bit odd that I'm claiming that I
don't know how to do it and asking others to set it up for me. :-) :-)
Comment 15 Martin Krauskopf 2005-07-22 16:54:18 UTC
It would be very nice if you contribute it to the apisupport. You actually have
relatively long time for it until the feature freeze. So feel free to reasign
this issue to yourself, thanks ;)
Comment 16 Geertjan Wielenga 2005-07-22 16:57:17 UTC
Reassigned to myself.
Comment 17 Geertjan Wielenga 2005-07-28 11:24:01 UTC
1. When you first open the Project Properties dialog box, no help button is
displayed. Only after selecting a node, does the help button appear.
2. The Help button for the Build node should be greyed-out (see other project
types for the same implementation).
Comment 18 Martin Krauskopf 2005-08-29 23:34:01 UTC
The rest is P3.
Comment 19 Martin Krauskopf 2005-08-31 21:25:23 UTC
Let's this time try "passing helpCtx ID to constructor of the base class" way.
Started...
Comment 20 Martin Krauskopf 2005-08-31 21:44:26 UTC
Fixed.

Checking in ui/customizer/BasicCustomizer.java; 1.1 --> 1.2
Checking in ui/customizer/CustomizerCompiling.java; 1.4 --> 1.5
Checking in ui/customizer/CustomizerDisplay.java; 1.21 --> 1.22
Checking in ui/customizer/CustomizerDocumenting.java; 1.5 --> 1.6
Checking in ui/customizer/CustomizerLibraries.java; 1.28 --> 1.29
Checking in ui/customizer/CustomizerPackaging.java; 1.7 --> 1.8
Checking in ui/customizer/CustomizerSources.java; 1.11 --> 1.12
Checking in ui/customizer/CustomizerVersioning.java; 1.24 --> 1.25
Checking in ui/customizer/NbPropertyPanel.java; 1.9 --> 1.10
Checking in ui/customizer/SuiteCustomizerBasicBranding.java; 1.7 --> 1.8
Checking in ui/customizer/SuiteCustomizerLibraries.java; 1.9 --> 1.10
Checking in ui/customizer/SuiteCustomizerModuleList.java; 1.5 --> 1.6
Checking in ui/customizer/SuiteCustomizerSources.java; 1.2 --> 1.3
Checking in ui/customizer/SuiteCustomizerSplashBranding.java; 1.4 --> 1.5
Comment 21 Martin Krauskopf 2005-09-01 09:09:24 UTC
*** Issue 63483 has been marked as a duplicate of this issue. ***
Comment 22 pzajac 2005-11-25 13:29:43 UTC
verified