Systems for providing extensible help
View Patent ↗Extensible online help systems and methods are described. There can be at least two parts to the extensible help facility, such as may include a help system and a help display. A help system can be integrated with runtime extensibility mechanisms to process documentation content upon import of an extension. A help display can support help display operations, such as providing search capabilities and a table of contents. This description is not intended to be a complete description of, or limit the scope of, the invention. Other features, aspects, and objects of the invention can be obtained from a review of the specification, the figures, and the claims.
1. A system, executed by a processor, for extending online help for an integrated development environment, comprising:
a help system configured to merge documentation content of an integrated development environment extension with current documentation content of the integrated development environment upon import of the integrated development environment extension into the integrated development environment, wherein the help system includes context-sensitive help topics; and
a help display, wherein search capabilities and table of contents are automatically updated to reflect the documentation content after the integrated development environment extension is imported, wherein the help display is configured to display the documentation content in a web browser;
wherein the documentation content for the integrated development environment extension is integrated with the help system during the import of the integrated development environment extension,
wherein when a control is installed, documentation for the control is integrated with the help system during the installation of the control into the integrated development environment,
wherein the integrated development environment issues a context ID to the help display when a context-sensitive help gesture is performed, wherein the context ID comprises a uniform resource name that is a fully qualified Java class name for control classes, and
wherein the help system is integrated with an extension installation mechanism of the integrated development environment.
2. The system of claim 1 wherein help display is externally controllable.
3. The system of claim 1 wherein the context-sensitive help topics are organized by a context ID.
4. The system of claim 3 wherein the context ID is a fully qualified name from a non-Java resource.
5. The system of claim 1 , wherein the documentation content is in HTML or XML format.
6. The system of claim 1 , wherein the documentation content supports delivery of help for a particular component in a JAR file.
7. The system of claim 1 , wherein integrated development environment widgets, controls, and control properties are associated with documentation topics that are automatically displayed in the help system when requested by a user performing a context-sensitive help gesture.
8. The system of claim 1 , wherein each control class, method, callback, field, and property has a unique context ID.
9. A method for extending online help for an integrated development environment, comprising:
importing an integrated development environment extension into the integrated development environment;
merging documentation content of the integrated development environment extension with current documentation content of the integrated development environment upon import of the integrated development extension, wherein the documentation content includes context-sensitive help topics with respect to the integrated development environment extension; and
displaying operations for a help system, wherein search capabilities and table of contents are automatically updated to reflect the documentation content after the integrated development environment extension is imported, wherein a help display is configured to display the documentation content in a web browser;
wherein the documentation content for the integrated development environment extension is integrated with the help system during the import of the integrated development environment extension into the integrated development environment,
wherein when a control is installed, documentation for the control is integrated with the help system during the installation of the control into the integrated development environment,
wherein the integrated development environment issues a context ID to the help display when a context-sensitive help gesture is performed wherein the context ID comprises a uniform resource name that is a fully qualified Java class name for control classes, and
wherein the help system is integrated with an extension installation mechanism of the integrated development environment.
10. The method of claim 9 , wherein the help display is externally controllable.
11. The method of claim 9 , wherein the context-sensitive help topics are organized by a context ID.
12. The method of claim 11 , wherein the context ID is a fully qualified name from a non-Java resource.
13. The method of claim 9 , wherein the documentation content is in HTML or XML format.
14. The method of claim 9 , wherein the documentation content supports delivery of help for a particular component in a JAR file.
15. The method of claim 9 , wherein integrated development environment widgets, controls, and control properties are associated with documentation topics that are automatically displayed in the help system when requested by a user performing a context-sensitive help gesture.
16. The method of claim 9 , wherein each control class, method, callback, field, and property has a unique context ID.