OReilly - Creating Effective JavaHelp.pdf

(1033 KB) Pobierz
Brought to you by ownSky!
Creating Effective JavaHelp
By
Kevin Lewis
Publisher : O'Reilly
Pub Date : June 2000
ISBN : 1-56592-719-2
Table of
Contents
Pages : 184
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.
Table of Content
Table of Content
......................................................................................................ii
Preface......................................................................................................................v
Audience...............................................................................................................v
About This Book
..................................................................................................v
Assumptions This Book Makes........................................................................vi
Conventions Used in This Book.......................................................................vi
Comments and Questions
...............................................................................vii
Acknowledgments
.............................................................................................vii
Chapter 1. Understanding JavaHelp
....................................................................1
1.1 What Is JavaHelp?
.......................................................................................1
1.2 Using JavaHelp for Online Documentation
..............................................3
1.3 Understanding the Files in a HelpSet........................................................4
1.4 Following the JavaHelp Process................................................................5
1.5 Installing JavaHelp on Your Computer
.....................................................6
1.6 Seeing JavaHelp in Action
..........................................................................6
1.7 Deciding How to Present a HelpSet
........................................................11
1.8 Deciding How to Install a HelpSet
...........................................................12
1.9 Encapsulating HelpSet Files.....................................................................13
1.10 Finding More Information on JavaHelp.................................................13
Chapter 2. Creating Your First HelpSet.............................................................14
2.1 Creating the HelpSet's Directory Structure
............................................14
2.2 Creating HelpSet Data and Navigation Files
.........................................16
2.3 Creating Help Topic Files
..........................................................................19
2.4 Checking Your Work
..................................................................................21
2.5 Testing the Finished HelpSet
...................................................................21
Chapter 3. Planning the JavaHelp Project
........................................................22
3.1 General Planning Tasks
............................................................................22
3.2 Planning Tasks Specific to JavaHelp
......................................................29
Chapter 4. Preparing Help Topics
......................................................................33
4.1 Planning Your Help Topics
.......................................................................33
4.2 Creating Help Topics and Applying Appropriate HTML Tags
.............35
4.3 Writing Effective and Meaningful Help Topics
.......................................38
4.4 Using Preexisting HTML Topic Files
.......................................................41
Chapter 5. Creating HelpSet Data and Navigation Files
................................42
5.1 Understanding XML
...................................................................................42
5.2 Creating the HelpSet File
..........................................................................43
5.3 Assigning Map IDs to Help Topics...........................................................45
5.4 Specifying the Navigation Components..................................................47
Chapter 6. Enhancing the HelpSet.....................................................................56
6.1 Creating Pop-up and Secondary Windows
............................................56
6.2 Customizing the Navigation Facility.........................................................61
6.3 Merging HelpSets
.......................................................................................68
Chapter 7. Using the JavaHelp API for Advanced Presentation Options
....73
7.1 The TypeFacer Application
.......................................................................73
7.2 Invoking Help with a Button, Menu Item, or Key
...................................76
7.3 Using Screen-Level Context-Sensitive Help
..........................................78
ii
7.4 Using Field-Level Context-Sensitive Help
..............................................81
7.5 Embedding Help into the Application
......................................................83
Chapter 8. Deploying the Help System to Your Users
....................................88
8.1 Encapsulating the HelpSet........................................................................88
8.2 Delivering All the Required Files
..............................................................89
8.3 Ensuring Basic Java Support
...................................................................90
Chapter 9. Using Third-Party Help-Authoring Tools
........................................91
9.1 How JavaHelp Relates to Third-Party Tools
..........................................91
9.2 How Third-Party Tools Work.....................................................................91
Appendix A. HelpSet Tags...................................................................................96
A.1 Map File
.......................................................................................................96
A.2 TOC File
......................................................................................................96
A.3 Index File
.....................................................................................................97
A.4 HelpSet File.................................................................................................97
Appendix B. Lightweight Component Tags.....................................................100
B.1 Pop-up and Secondary Windows
..........................................................100
Appendix C. The JavaHelp API
........................................................................104
C.1 Classes in Package javax.help
..............................................................104
C.2 Classes in Package javax.help.event
...................................................119
Appendix D. TypeFacer.java Source Listing...................................................121
Glossary................................................................................................................128
Colophon
..............................................................................................................131
iii
Copyright © 2000 O'Reilly & Associates, Inc. All rights reserved.
Printed in the United States of America.
Published by O'Reilly & Associates, Inc., 101 Morris Street, Sebastopol, CA 95472.
Nutshell Handbook, the Nutshell Handbook logo, and the O'Reilly logo are registered trademarks,
and The Java™ Series is a trademark of O'Reilly & Associates, Inc. The association of the image
of a flashlight with the topic of JavaHelp™ is a trademark of O'Reilly & Associates, Inc. Java™
and all Java-based trademarks and logos are trademarks or registered trademarks of Sun
Microsystems, Inc., in the United States and other countries. O'Reilly & Associates, Inc. is
independent of Sun Microsystems.
Many of the designations used by manufacturers and sellers to distinguish their products are
claimed as trademarks. Where those designations appear in this book, and O'Reilly & Associates,
Inc. was aware of a trademark claim, the designations have been printed in caps or initial caps.
While every precaution has been taken in the preparation of this book, the publisher assumes no
responsibility for errors or omissions, or for damages resulting from the use of the information
contained herein.
While every precaution has been taken in the preparation of this book, the publisher assumes no
responsibility for errors or omissions, or for damages resulting from the use of the information
contained herein.
4

Plik z chomika:

Inne pliki z tego folderu:

Inne foldery tego chomika:

Zgłoś jeśli naruszono regulamin