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 123684 - Enhanced Help System
Summary: Enhanced Help System
Status: RESOLVED WONTFIX
Alias: None
Product: usersguide
Classification: Unclassified
Component: IDE (show other bugs)
Version: 6.x
Hardware: All All
: P1 blocker (vote)
Assignee: issues@usersguide
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-12-08 15:36 UTC by info2ram
Modified: 2010-02-24 00:01 UTC (History)
0 users

See Also:
Issue Type: ENHANCEMENT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description info2ram 2007-12-08 15:36:07 UTC
Today Netbean's Help System has the task-based demonstration. The task-based help is not fully reachable to end user 
(developer) to describe application/functionlity.  

Our idea enlightens the importance of using the application modules itself for Help system. In this way, its help menu 
is linked with the application modules for explaining the users about various functionalities by executing the actual 
code.

Almost all Help menus have the hierarchical architecture for help topics. Each topic explains the particular property 
of application. An individual help topic may be linked to more than one topics present in the hierarchy. Generally the 
help topics will be explained with text and in some cases after explaining, it may have links to open the particular 
application module about which the help is sought. In our ideas, the help menu demonstrates the help topics by 
executing the actual code of the module with some sample values as parameters. For this purpose the help menu uses two 
main parts,

* ‘Default Event Generator’, and 

* Help Assistant. 


Before help menu execution, the current environment of the application is saved to the disk/buffer. Since help menu 
uses the application for describing the features, this process may lead to the modification of the current 
environment. After the help demonstration is over, the information is retrieved from the disk/buffer to restore its 
original values. 

There are two cases that may occur based on current environment,

1.     The current environment value may be NULL. 

2.     The current environment value is NOT NULL, but it is NOT ENOUGH to explain the particular help topic.

3.     The current environment value is NOT NULL, also it is ENOUGH to explain the particular help topic.


If it is case 1 or case 2, the default environment value is taken as the current value.

If it is case 3, then the current environment value is used for explaining the topic. 


Example:
Consider a simple text editor, with the basic operations like ‘open file’, ‘save file’, ‘copy text’ and ‘paste text’. 
Here the current environment value is nothing but the text typed in the work area. If we want help about the ‘paste 
text’, then 

· If there is text (current environment) in the work area then the same text is used for help explanation.

· If the work area is empty, then a default text is taken for explaining the ‘paste text’.
Comment 1 Irina Filippova 2010-02-08 03:41:01 UTC
Assigning to the right component.
Comment 2 Irina Filippova 2010-02-17 11:50:11 UTC
Perhaps, too much efforts and an unclear value. The main purpose of javahelp is to help people get oriented in the ui, and it is not clear what demonstration will add to the text of the online help.
I vote for closing this RFE.

Other opinions are welcome.
Comment 3 Geertjan Wielenga 2010-02-18 02:37:44 UTC
Seems to be suggesting a context sensitive help system of some kind. We're trying to provide only UI-specific help in the help system, so I agree this could/should be closed.
Comment 4 Irina Filippova 2010-02-24 00:01:47 UTC
Closing this RFE as won't fix.