Kevin Lewis - Creating Effective Java Help.pdf - ►Java - Kapy97

Creating Effective JavaHelp

•

By Kevin Lewis

Publisher : O'Reilly

Pub Date : June 2000

ISBN

: 1-56592-719-2

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.

IT-SC book

Life is Beautiful.

Creating Effective JavaHelp

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.

IT-SC book

Creating Effective JavaHelp

Preface ........................................................................................................................... 5

Audience .................................................................................................................... 5

About This Book ....................................................................................................... 5

Assumptions This Book Makes .............................................................................. 6

Conventions Used in This Book ............................................................................. 6

Comments and Questions ...................................................................................... 7

Acknowledgments .................................................................................................... 7

Chapter 1. Understanding JavaHelp ......................................................................... 9

1.1 What Is JavaHelp? ............................................................................................ 9

1.2 Using JavaHelp for Online Documentation ................................................. 10

1.3 Understanding the Files in a HelpSet ........................................................... 12

1.4 Following the JavaHelp Process ................................................................... 13

1.5 Installing JavaHelp on Your Computer ........................................................ 13

What About JavaHelp 1.0? ....................................................................................... 14

1.6 Seeing JavaHelp in Action ............................................................................. 14

1.7 Deciding How to Present a HelpSet ............................................................. 19

1.8 Deciding How to Install a HelpSet ................................................................ 20

1.9 Encapsulating HelpSet Files .......................................................................... 21

1.10 Finding More Information on JavaHelp ...................................................... 22

Chapter 2. Creating Your First HelpSet .................................................................. 23

2.1 Creating the HelpSet's Directory Structure ................................................. 23

2.2 Creating HelpSet Data and Navigation Files .............................................. 25

2.3 Creating Help Topic Files ............................................................................... 29

2.4 Checking Your Work ....................................................................................... 31

2.5 Testing the Finished HelpSet ........................................................................ 31

Chapter 3. Planning the JavaHelp Project ............................................................. 32

3.1 General Planning Tasks ................................................................................. 32

3.2 Planning Tasks Specific to JavaHelp ........................................................... 39

Chapter 4. Preparing Help Topics ........................................................................... 43

4.1 Planning Your Help Topics ............................................................................ 43

4.2 Creating Help Topics and Applying Appropriate HTML Tags .................. 45

4.3 Writing Effective and Meaningful Help Topics ............................................ 48

4.4 Using Preexisting HTML Topic Files ............................................................ 52

Chapter 5. Creating HelpSet Data and Navigation Files ..................................... 53

5.1 Understanding XML ........................................................................................ 53

5.2 Creating the HelpSet File ............................................................................... 54

5.3 Assigning Map IDs to Help Topics ................................................................ 57

5.4 Specifying the Navigation Components ....................................................... 59

Chapter 6. Enhancing the HelpSet .......................................................................... 69

6.1 Creating Pop-up and Secondary Windows ................................................. 69

6.2 Customizing the Navigation Facility .............................................................. 75

6.3 Merging HelpSets ............................................................................................ 84

Chapter 7. Using the JavaHelp API for Advanced Presentation Options ......... 89

7.1 The TypeFacer Application ............................................................................ 89

IT-SC book

Kevin Lewis - Creating Effective Java Help.pdf

Plik z chomika:

Inne pliki z tego folderu:

Inne foldery tego chomika: