Book description
Effective, instantly available online help is a requirement for today's interactive applications. Until now, Java application developers have been forced to develop their own help system. That's no longer necessary. With the release of JavaHelp™, there is a complete and standard online help system for the Java™ platform. Creating Effective JavaHelp covers the main features and options of JavaHelp. It shows how to create a basic JavaHelp system, prepare help topics, and deploy the help system in an application. Written for all levels of Java developers and technical writers, the book takes a chapter-by-chapter approach to building concepts. It imparts a complete understanding of how to create usable JavaHelp systems and integrate them into Java applications and applets. Topics covered include:
Understanding JavaHelp
Creating your first HelpSet
Planning the JavaHelp project
Preparing Help topics
Creating HelpSet data and navigation files
Enhancing the HelpSet
Using the JavaHelp API for advanced presentation options
Deploying the help system to your users
Using third-party help-authoring tools
Publisher resources
Table of contents
-
Creating Effective JavaHelp
- Preface
-
1. Understanding JavaHelp
- What Is JavaHelp?
- Using JavaHelp for Online Documentation
- Understanding the Files in a HelpSet
- Following the JavaHelp Process
- Installing JavaHelp on Your Computer
- Seeing JavaHelp in Action
- Deciding How to Present a HelpSet
- Deciding How to Install a HelpSet
- Encapsulating HelpSet Files
- Finding More Information on JavaHelp
- 2. Creating Your First HelpSet
- 3. Planning the JavaHelp Project
- 4. Preparing Help Topics
- 5. Creating HelpSet Data and Navigation Files
- 6. Enhancing the HelpSet
- 7. Using the JavaHelp API for Advanced Presentation Options
- 8. Deploying the Help System to Your Users
- 9. Using Third-Party Help-Authoring Tools
- A. HelpSet Tags
- B. Lightweight Component Tags
-
C. The JavaHelp API
-
Classes in Package javax.help
- BadIDException
- CSH
- DefaultHelpBroker
- DefaultHelpModel
- FlatMap
- HelpBroker
- HelpModel
- HelpSet
- HelpSetException
- HelpUtilities
- IndexItem
- IndexView
- InvalidHelpSetContextException
- InvalidNavigatorViewException
- JHelp
- JHelpContentViewer
- JHelpIndexNavigator
- JHelpNavigator
- JHelpSearchNavigator
- JHelpTOCNavigator
- Map
- NavigatorView
- SearchHit
- SearchTOCItem
- SearchView
- TextHelpModel
- TOCItem
- TOCView
- TreeItem
- TreeItemFactory
- TryMap
- UnsupportedOperationException
- Classes in Package javax.help.event
-
Classes in Package javax.help
- D. TypeFacer.java Source Listing
- 10. Glossary
- Index
- Colophon
Product information
- Title: Creating Effective JavaHelp
- Author(s):
- Release date: June 2000
- Publisher(s): O'Reilly Media, Inc.
- ISBN: 9781565927193
You might also like
video
Clean Code
Expanded Edition (August 2018) Updated with Design Patterns episodes from the Clean Code series from Clean …
book
The Design of Web APIs
Drawing on author Arnaud Lauret's many years of API design experience, this book teaches you how …
book
Testing Microservices with Mountebank
Summary Testing Microservices with Mountebank is your guide to the ins and outs of testing microservices …
book
Microservices Patterns
Microservices Patterns teaches you how to develop and deploy production-quality microservices-based applications. This invaluable set of …