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 222709 - Help button not working
Summary: Help button not working
Status: REOPENED
Alias: None
Product: usersguide
Classification: Unclassified
Component: Form (show other bugs)
Version: 7.3
Hardware: PC Linux
: P4 normal (vote)
Assignee: AlyonaStashkova
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-11-25 13:40 UTC by mstarnacki
Modified: 2012-12-12 02:45 UTC (History)
1 user (show)

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments
Pdf defect report file (201.87 KB, application/octetstream)
2012-11-25 13:40 UTC, mstarnacki
Details

Note You need to log in before you can comment on or make changes to this bug.
Description mstarnacki 2012-11-25 13:40:40 UTC
Created attachment 128355 [details]
Pdf defect report file

Attached file contains my report after 1/4 of GuiBuilder test review.
Comment 1 Tomas Pavek 2012-11-27 14:55:55 UTC
These are missing help topics.

1) The create Master/Detail form wizard has two pages with help IDs assigned for long time, but still with no help written:
org.netbeans.modules.form.j2ee.wizard.MasterPanel
org.netbeans.modules.form.j2ee.wizard.DetailPanel

2) I think we don't need the specific help for the second and third steps of the Connection Wizard. I've changed them to use the same help ID as the first step.
Comment 2 Kenneth Ganfield 2012-11-27 16:05:11 UTC
The help topic exists for the New Master /Detail Form.

j2ee/platform/docs/enterprise/csh/NewMasterFormWizard_MasterTable.html

The topic is located in the java ee clustor, so if the tested version of the IDE was the Java SE version the topic would not be there.

Alyona, can you move the topic and entry in the map file from the current location to probably the java/helpset module.
Comment 3 Quality Engineering 2012-11-28 02:35:48 UTC
Integrated into 'main-golden', will be available in build *201211280002* on http://bits.netbeans.org/dev/nightly/ (upload may still be in progress)
Changeset: http://hg.netbeans.org/main-golden/rev/bf1b25fbcfe2
User: Tomas Pavek <tpavek@netbeans.org>
Log: #222709: setting same help for all steps of the connection wizard
Comment 4 AlyonaStashkova 2012-11-28 09:41:07 UTC
a New Master/Detail Form Wizard topic is added to java.helpset  https://hg.netbeans.org/main/rev/655a4bd1afb6
Comment 5 AlyonaStashkova 2012-11-28 11:36:30 UTC
Had a discussion with Ken who clarified the following:

1. The master detail wizard specific help topics (j2ee/platform/docs/enterprise/csh/NewMasterFormWizard_MasterTable.html and j2ee/platform/docs/enterprise/csh/NewMasterFormWizard_DetailOptions.html) need to go to java.helpset and it would be better to have different help ids (shorter and more descriptive) for them.
Tomas, can you, please, create them?

2. The existing connection wizard specific help topic (nbdocs:/org/netbeans/modules/java/helpset/docs/gui/csh/gui_connection_wizard.html) is insufficient and needs to be expanded and a separate topic to describe the parameters panel needs to be created.
Tomas, can you, please, bring back the 2 help ids: gui.connecting.target and gui.connecting.source ?
Comment 6 AlyonaStashkova 2012-11-28 12:06:09 UTC
New Master/Detail Form specific help topics are moved to java.helpset
https://hg.netbeans.org/main/rev/436b07727552
New Master/Detail Form specific help topics are deleted from j2ee.platform
https://hg.netbeans.org/main/rev/064c3e6c6df4
links in the moved topics are updated
https://hg.netbeans.org/main/rev/aa17208d70e5
Comment 7 Tomas Pavek 2012-11-28 13:26:43 UTC
> Had a discussion with Ken who clarified the following:
> 
> 1. The master detail wizard specific help topics
> (j2ee/platform/docs/enterprise/csh/NewMasterFormWizard_MasterTable.html and
> j2ee/platform/docs/enterprise/csh/NewMasterFormWizard_DetailOptions.html) need
> to go to java.helpset and it would be better to have different help ids
> (shorter and more descriptive) for them.
> Tomas, can you, please, create them?

I can change them...

> 
> 2. The existing connection wizard specific help topic
> (nbdocs:/org/netbeans/modules/java/helpset/docs/gui/csh/gui_connection_wizard.html)
> is insufficient and needs to be expanded and a separate topic to describe the
> parameters panel needs to be created.
> Tomas, can you, please, bring back the 2 help ids: gui.connecting.target and
> gui.connecting.source ?

Are you sure? The gui_connection_wizard.html is insufficient, but it links to gui/gui_events_setting.html which describes the connection wizard quite well. Maybe just make this one the context topic?

BTW I think bug 222833 is more important, i.e. it would deserve the new help topic more than the connection wizard... Thanks.
Comment 8 AlyonaStashkova 2012-11-28 13:57:35 UTC
(In reply to comment #7)
> > Had a discussion with Ken who clarified the following:
> > 
> > 1. The master detail wizard specific help topics
> > (j2ee/platform/docs/enterprise/csh/NewMasterFormWizard_MasterTable.html and
> > j2ee/platform/docs/enterprise/csh/NewMasterFormWizard_DetailOptions.html) need
> > to go to java.helpset and it would be better to have different help ids
> > (shorter and more descriptive) for them.
> > Tomas, can you, please, create them?
> 
> I can change them...

Thank you!

> 
> > 
> > 2. The existing connection wizard specific help topic
> > (nbdocs:/org/netbeans/modules/java/helpset/docs/gui/csh/gui_connection_wizard.html)
> > is insufficient and needs to be expanded and a separate topic to describe the
> > parameters panel needs to be created.
> > Tomas, can you, please, bring back the 2 help ids: gui.connecting.target and
> > gui.connecting.source ?
> 
> Are you sure? The gui_connection_wizard.html is insufficient, but it links to
> gui/gui_events_setting.html which describes the connection wizard quite well.
> Maybe just make this one the context topic?

Well, Ken thinks each panel requires a separate csh topic and gui/gui_events_setting.html needs to be edited.

Meanwhile, found help ids reserved for this purpose in javadev-map.jhm:

mapID target="org.netbeans.modules.form.ConnectionWizard1" url="pending.html" 
mapID target="org.netbeans.modules.form.ConnectionWizard2" url="pending.html" mapID target="org.netbeans.modules.form.ConnectionWizard3" url="pending.html" 

Are they still valid?

> 
> BTW I think bug 222833 is more important, i.e. it would deserve the new help
> topic more than the connection wizard... Thanks.

Going to work on this new topic too.
Comment 9 Kenneth Ganfield 2012-11-28 14:00:40 UTC
(In reply to comment #7)

> > 2. The existing connection wizard specific help topic
> > (nbdocs:/org/netbeans/modules/java/helpset/docs/gui/csh/gui_connection_wizard.html)
> > is insufficient and needs to be expanded and a separate topic to describe the
> > parameters panel needs to be created.
> > Tomas, can you, please, bring back the 2 help ids: gui.connecting.target and
> > gui.connecting.source ?
> 
> Are you sure? The gui_connection_wizard.html is insufficient, but it links to
> gui/gui_events_setting.html which describes the connection wizard quite well.
> Maybe just make this one the context topic?
> 

Both the existing and the new CSH topics would link to the events_setting topic which provides STEPS on how to use the wizard. For this wizard each of the panels should have topics which describe the properties that can be set in that specific panel because they are not exactly self-evident. The properties that are currently in the events_settings topic should be moved to the CSH topic.

JDev makes a greater distinction between TOC topics (ie how to, steps) and CSH topics (ie, you can set the following properties) than NetBeans. Basically, a help id in a dialog or wizard should not link to a TOC topic, only CSH topics. This is because of the way they organize their help and going forward we will need to follow this system in NetBeans.
Comment 10 Quality Engineering 2012-11-30 02:47:15 UTC
Integrated into 'main-golden', will be available in build *201211300001* on http://bits.netbeans.org/dev/nightly/ (upload may still be in progress)
Changeset: http://hg.netbeans.org/main-golden/rev/655a4bd1afb6
User: AlyonaStashkova@netbeans.org
Log: #222709 csh topic for the New Master/Detail wizard and its help id added
Comment 11 Quality Engineering 2012-12-02 03:06:33 UTC
Integrated into 'main-golden', will be available in build *201212020001* on http://bits.netbeans.org/dev/nightly/ (upload may still be in progress)
Changeset: http://hg.netbeans.org/main-golden/rev/436b07727552
User: AlyonaStashkova@netbeans.org
Log: #222709 two csh topics for the new master/detail form wizard added
Comment 12 Tomas Pavek 2012-12-03 14:10:21 UTC
I've returned back help IDs for the second and third step of the connection wizard. They are now "gui.connecting.target" and "gui.connecting.param". So these now need new CSH topic.
Also updated the IDs for the master/detail wizard as was requested.
http://hg.netbeans.org/jet-main/rev/73f9de1b03f3
Comment 13 Quality Engineering 2012-12-04 03:16:33 UTC
Integrated into 'main-golden', will be available in build *201212040001* on http://bits.netbeans.org/dev/nightly/ (upload may still be in progress)
Changeset: http://hg.netbeans.org/main-golden/rev/73f9de1b03f3
User: Tomas Pavek <tpavek@netbeans.org>
Log: #222709: returned specific help IDs for connection wizard, simplified IDs for master detail form wizard
Comment 14 AlyonaStashkova 2012-12-10 12:50:11 UTC
(In reply to comment #12)
> I've returned back help IDs for the second and third step of the connection
> wizard. They are now "gui.connecting.target" and "gui.connecting.param". So
> these now need new CSH topic.
> Also updated the IDs for the master/detail wizard as was requested.
> http://hg.netbeans.org/jet-main/rev/73f9de1b03f3

Thank you!

New csh topics and their ids are now in hg:
https://hg.netbeans.org/main/rev/3384081a7518
Comment 15 Quality Engineering 2012-12-12 02:45:21 UTC
Integrated into 'main-golden', will be available in build *201212120001* on http://bits.netbeans.org/dev/nightly/ (upload may still be in progress)
Changeset: http://hg.netbeans.org/main-golden/rev/3384081a7518
User: AlyonaStashkova@netbeans.org
Log: #222709 adding new csh topics and their help ids for gui builder connection wizard