Help Buttons in New and Existing Ruby windows and dialog boxes.

[Chris Kutler]

Hello,

Do we have any new Ruby/Rails windows or dialog boxes with Help buttons
that need help text? If so, I need the ids for the online help.

Is there a way to get a list of the existing Ruby/Rails windows & dialog
boxes that have help buttons along with their ids? I already found one
with a help button that is not wired up (that is, there is no help for
that id), and I need to make sure we have help for every button (or the
buttons get removed).

Also, what is my deadline for negotiating ids and addition/removal of
buttons?

Thanks,

Chris



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@...
For additional commands, e-mail: dev-help@...

[Martin Krauskopf]

Chris Kutler wrote:
 >   Hello,
 >
 >   Do we have any new Ruby/Rails windows or dialog boxes with Help
 >   buttons that need help text? If so, I need the ids for the online
 >   help.
 >
 >   Is there a way to get a list of the existing Ruby/Rails windows &
 >   dialog boxes that have help buttons along with their ids? I already
 >   found one with a help button that is not wired up (that is, there is
 >   no help for that id), and I need to make sure we have help for every
 >   button (or the buttons get removed).

I'm not sure how this works. When I worked on APISupport, docs always
filed a bug that a Help ID is missing there, the other one is wrong, the
two are the same, etc. I'm not sure whether docs teams have some trick
to find help buttons. I suppose they just know where the they are. I can
cooperate on some Wiki which would list such places.

This might also helps:

http://bits.netbeans.org/dev/javadoc/org-netbeans-modules-javahelp/org/netbeans/api/javahelp/doc-files/api.html

   ".......If you are having trouble figuring out why you are not seeing
   the help you expect, try running the IDE with the command-line option
   -J-Dorg.netbeans.modules.javahelp=0 and look in your system/ide.log
   file for details. -J-Dorg.openide.util.HelpCtx=0 may also be used to
   get further information on association between help IDs and GUI
   components, and so on............"

I can give you list of classes which contains refer to HelpCtx classes
which usually means there is Help button around. Usually clear from
class name:

ruby.platform/src/org/netbeans/modules/ruby/platform/RubyPlatformCustomizer.java
ruby.platform/src/org/netbeans/modules/ruby/platform/RubyPlatformAction.java
ruby.platform/src/org/netbeans/modules/ruby/platform/gems/GemRunner.java
ruby.platform/src/org/netbeans/modules/ruby/platform/gems/GemPanel.java
ruby.platform/src/org/netbeans/modules/ruby/platform/gems/GemAction.java
ruby.platform/src/org/netbeans/api/ruby/platform/RubyPlatform.java
ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/plugins/PluginAction.java
ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/plugins/PluginPanel.java
ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/plugins/PluginManager.java
ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/RailsProjectOption.java
ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/MigrateAction.java
ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/ui/wizards/DatabaseConfigPanel.java
ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/ui/wizards/PanelConfigureProject.java
ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/ui/wizards/RailsInstallationPanel.java
ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/ui/RailsLogicalViewProvider.java
ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/ui/customizer/CustomizerRun.java
ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/GenerateAction.java
ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/server/nodes/StopAction.java
ruby.samples.depot/src/org/netbeans/modules/ruby/samples/depot/DepotWizardPanel.java
ruby.refactoring/src/org/netbeans/modules/refactoring/ruby/ui/WhereUsedQueryUI.java
ruby.refactoring/src/org/netbeans/modules/refactoring/ruby/ui/RenameRefactoringUI.java
ruby.project/src/org/netbeans/modules/ruby/rubyproject/templates/RubyTargetChooserPanel.java
ruby.project/src/org/netbeans/modules/ruby/rubyproject/ui/RubyLogicalViewProvider.java
ruby.project/src/org/netbeans/modules/ruby/rubyproject/ui/wizards/PanelConfigureProject.java
ruby.project/src/org/netbeans/modules/ruby/rubyproject/ui/wizards/PanelSourceFolders.java
ruby.project/src/org/netbeans/modules/ruby/rubyproject/ui/customizer/CustomizerRun.java
ruby.project/src/org/netbeans/modules/ruby/rubyproject/ui/customizer/CustomizerSources.java
ruby.project/src/org/netbeans/modules/ruby/rubyproject/rake/RakeRunnerAction.java
ruby.project/src/org/netbeans/modules/ruby/rubyproject/RubyOptionsAdvancedPanel.java
ruby/src/org/netbeans/modules/ruby/RubyOptionsPanelController.java
ruby/src/org/netbeans/modules/ruby/options/FmtOptions.java
ruby/src/org/netbeans/modules/ruby/options/FormatingOptionsPanelController.java
ruby.javaint/src/org/netbeans/modules/ruby/javaint/CustomizerProviderImpl.java
ruby.javaint/src/org/netbeans/modules/ruby/javaint/CustomizerLibraries.java
ruby.testrunner/src/org/netbeans/modules/ruby/testrunner/ui/ResultWindow.java
ruby.rhtml/src/org/netbeans/modules/ruby/rhtml/editor/RhtmlKit.java

 >   Also, what is my deadline for negotiating ids and addition/removal
 >   of buttons?

Until feature freeze? But likely also after it, since when there is
missing Help button on the place where it supposed to be, it's a bug,
not RFE.

        m.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@...
For additional commands, e-mail: dev-help@...

[Chris Kutler]

Thanks Martin, this is helpful information.

Martin Krauskopf wrote:

> Chris Kutler wrote:
> >   Hello,
> >
> >   Do we have any new Ruby/Rails windows or dialog boxes with Help
> >   buttons that need help text? If so, I need the ids for the online
> >   help.
> >
> >   Is there a way to get a list of the existing Ruby/Rails windows &
> >   dialog boxes that have help buttons along with their ids? I already
> >   found one with a help button that is not wired up (that is, there is
> >   no help for that id), and I need to make sure we have help for every
> >   button (or the buttons get removed).
>
> I'm not sure how this works. When I worked on APISupport, docs always
> filed a bug that a Help ID is missing there, the other one is wrong, the
> two are the same, etc. I'm not sure whether docs teams have some trick
> to find help buttons. I suppose they just know where the they are. I can
> cooperate on some Wiki which would list such places.
>
> This might also helps:
>
> http://bits.netbeans.org/dev/javadoc/org-netbeans-modules-javahelp/org/netbeans/api/javahelp/doc-files/api.html 
>
>
>   ".......If you are having trouble figuring out why you are not seeing
>   the help you expect, try running the IDE with the command-line option
>   -J-Dorg.netbeans.modules.javahelp=0 and look in your system/ide.log
>   file for details. -J-Dorg.openide.util.HelpCtx=0 may also be used to
>   get further information on association between help IDs and GUI
>   components, and so on............"
>
> I can give you list of classes which contains refer to HelpCtx classes
> which usually means there is Help button around. Usually clear from
> class name:
>
> ruby.platform/src/org/netbeans/modules/ruby/platform/RubyPlatformCustomizer.java
>
> ruby.platform/src/org/netbeans/modules/ruby/platform/RubyPlatformAction.java
>
> ruby.platform/src/org/netbeans/modules/ruby/platform/gems/GemRunner.java
> ruby.platform/src/org/netbeans/modules/ruby/platform/gems/GemPanel.java
> ruby.platform/src/org/netbeans/modules/ruby/platform/gems/GemAction.java
> ruby.platform/src/org/netbeans/api/ruby/platform/RubyPlatform.java
> ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/plugins/PluginAction.java
>
> ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/plugins/PluginPanel.java
>
> ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/plugins/PluginManager.java
>
> ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/RailsProjectOption.java
>
> ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/MigrateAction.java
>
> ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/ui/wizards/DatabaseConfigPanel.java
>
> ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/ui/wizards/PanelConfigureProject.java
>
> ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/ui/wizards/RailsInstallationPanel.java
>
> ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/ui/RailsLogicalViewProvider.java
>
> ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/ui/customizer/CustomizerRun.java
>
> ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/GenerateAction.java
>
> ruby.railsprojects/src/org/netbeans/modules/ruby/railsprojects/server/nodes/StopAction.java
>
> ruby.samples.depot/src/org/netbeans/modules/ruby/samples/depot/DepotWizardPanel.java
>
> ruby.refactoring/src/org/netbeans/modules/refactoring/ruby/ui/WhereUsedQueryUI.java
>
> ruby.refactoring/src/org/netbeans/modules/refactoring/ruby/ui/RenameRefactoringUI.java
>
> ruby.project/src/org/netbeans/modules/ruby/rubyproject/templates/RubyTargetChooserPanel.java
>
> ruby.project/src/org/netbeans/modules/ruby/rubyproject/ui/RubyLogicalViewProvider.java
>
> ruby.project/src/org/netbeans/modules/ruby/rubyproject/ui/wizards/PanelConfigureProject.java
>
> ruby.project/src/org/netbeans/modules/ruby/rubyproject/ui/wizards/PanelSourceFolders.java
>
> ruby.project/src/org/netbeans/modules/ruby/rubyproject/ui/customizer/CustomizerRun.java
>
> ruby.project/src/org/netbeans/modules/ruby/rubyproject/ui/customizer/CustomizerSources.java
>
> ruby.project/src/org/netbeans/modules/ruby/rubyproject/rake/RakeRunnerAction.java
>
> ruby.project/src/org/netbeans/modules/ruby/rubyproject/RubyOptionsAdvancedPanel.java
>
> ruby/src/org/netbeans/modules/ruby/RubyOptionsPanelController.java
> ruby/src/org/netbeans/modules/ruby/options/FmtOptions.java
> ruby/src/org/netbeans/modules/ruby/options/FormatingOptionsPanelController.java
>
> ruby.javaint/src/org/netbeans/modules/ruby/javaint/CustomizerProviderImpl.java
>
> ruby.javaint/src/org/netbeans/modules/ruby/javaint/CustomizerLibraries.java
>
> ruby.testrunner/src/org/netbeans/modules/ruby/testrunner/ui/ResultWindow.java
>
> ruby.rhtml/src/org/netbeans/modules/ruby/rhtml/editor/RhtmlKit.java
>
> >   Also, what is my deadline for negotiating ids and addition/removal
> >   of buttons?
>
> Until feature freeze? But likely also after it, since when there is
> missing Help button on the place where it supposed to be, it's a bug,
> not RFE.
>
>     m.
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@...
> For additional commands, e-mail: dev-help@...
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@...
For additional commands, e-mail: dev-help@...