Synopses & Reviews
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
Aimed at all levels of Java developers and technical writers, Lewis' book takes a chapter-by-chapter approach to building concepts and gives lessons on how to create usable Java Help systems and integrate them into Java applications and applets.
JavaHelp is an online help system developed in the Java programming language. "Creating Effective JavaHelp covers the main features and options of JavaHelp and 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, to impart a complete understanding of how to create usable JavaHelp systems and integrate them into Java applications and applets.
About the Author
Kevin Lewis holds a master's degree in technical and professional writing from Northeastern University in Boston. He has worked extensively with many online help systems and was one of the first help authors to work with JavaHelp. He offers training services in several online help technologies. Kevin has published articles on message-box design and on version-control systems for technical documents.
Table of Contents
Preface; Audience; About This Book; Assumptions This Book Makes; Conventions Used in This Book; Comments and Questions; Acknowledgments; Chapter 1: Understanding JavaHelp; 1.1 What Is JavaHelp?; 1.2 Using JavaHelp for Online Documentation; 1.3 Understanding the Files in a HelpSet; 1.4 Following the JavaHelp Process; 1.5 Installing JavaHelp on Your Computer; 1.6 Seeing JavaHelp in Action; 1.7 Deciding How to Present a HelpSet; 1.8 Deciding How to Install a HelpSet; 1.9 Encapsulating HelpSet Files; 1.10 Finding More Information on JavaHelp; Chapter 2: Creating Your First HelpSet; 2.1 Creating the HelpSet's Directory Structure; 2.2 Creating HelpSet Data and Navigation Files; 2.3 Creating Help Topic Files; 2.4 Checking Your Work; 2.5 Testing the Finished HelpSet; Chapter 3: Planning the JavaHelp Project; 3.1 General Planning Tasks; 3.2 Planning Tasks Specific to JavaHelp; Chapter 4: Preparing Help Topics; 4.1 Planning Your Help Topics; 4.2 Creating Help Topics and Applying Appropriate HTML Tags; 4.3 Writing Effective and Meaningful Help Topics; 4.4 Using Preexisting HTML Topic Files; Chapter 5: Creating HelpSet Data and Navigation Files; 5.1 Understanding XML; 5.2 Creating the HelpSet File; 5.3 Assigning Map IDs to Help Topics; 5.4 Specifying the Navigation Components; Chapter 6: Enhancing the HelpSet; 6.1 Creating Pop-up and Secondary Windows; 6.2 Customizing the Navigation Facility; 6.3 Merging HelpSets; Chapter 7: Using the JavaHelp API for Advanced Presentation Options; 7.1 The TypeFacer Application; 7.2 Invoking Help with a Button, Menu Item, or Key; 7.3 Using Screen-Level Context-Sensitive Help; 7.4 Using Field-Level Context-Sensitive Help; 7.5 Embedding Help into the Application; Chapter 8: Deploying the Help System to Your Users; 8.1 Encapsulating the HelpSet; 8.2 Delivering All the Required Files; 8.3 Ensuring Basic Java Support; Chapter 9: Using Third-Party Help-Authoring Tools; 9.1 How JavaHelp Relates to Third-Party Tools; 9.2 How Third-Party Tools Work; HelpSet Tags; Map File; TOC File; Index File; HelpSet File; Lightweight Component Tags; Pop-up and Secondary Windows; The JavaHelp API; Classes in Package javax.help; Classes in Package javax.help.event; TypeFacer.java Source Listing; Chapter 10: Glossary; Colophon;