Creating a Java Help System Presented By Kevin

Creating a Java. Help System Presented By: Kevin Lewis www. kevinlewis. com Start © 2000 Kevin Lewis All rights reserved.

Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts q What is Java. Help? § What you need q Demo q Components of a Java. Help system § § q Java. Help system enhancements § § © 2000 Kevin Lewis All rights reserved. How they work together Directory and file organization XML and Java. Help Topic, data, and navigation files Secondary windows Pop-up windows Custom lightweight components Merging Help. Sets

Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts q Presenting a Java. Help system § Standalone § Context-sensitive § Embedded q Help-authoring tools § Robo. HELP q Closing thoughts § Future of Java. Help § Survey information § More information q Questions & answers © 2000 Kevin Lewis All rights reserved.

What is Java. Help? Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q Online help system written in Java § Platform independent § Best for Java-based interfaces q Topic files based on HTML q Data and navigation files based on XML q Installation options § § Local application Network application Java applet Java product suite

What You Need Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q Java. Help download § http: //www. java. sun. com/products/javahelp q Java runtime environment (JRE) q JDK 1. 1 or, preferably, Java SDK 1. 2 or higher q Version 1. 1 with JDK 1. 1 requires Swing 1. 1 or higher q Optional help-authoring tool q Java developer

Demo Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. System uses standard tripane window

Demo Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. Toolbar

Demo Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. Navigation pane

Demo Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts Content pane: uses standard HTML © 2000 Kevin Lewis All rights reserved.

Demo Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. ‘File’ menu offers standard ‘Open’ (for opening other Help. Sets) and ‘Exit’ menu items

Demo Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. ‘Options’ menu offers option for changing the font in the navigation pane

Demo Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. • Standard previous and next buttons function like in a Web browser—not in a predefined order • Print buttons for setting up your printer and printing the current topic

Demo Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. Tabs for switching between TOC, index, and word-search index

Demo Contents What is Java. Help? Demo Components of a Java. Help System Enhancements • Standard TOC with expandable and collapsible categories Presenting a Java. Help System • Categories and/or topics can link to topics Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. • Synchronized

Demo Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. • Standard index with primary and secondary index terms • Find feature for user to type word to search for in index

Demo Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts • Word-search index for user to search contents of all help topics for word or phrase • Search results are listed by topic title in order of likely match • Circle shows how close the match is • Number indicates how many times the search term is found in that topic • System displays #1 topic and highlights the search term © 2000 Kevin Lewis All rights reserved.

Demo Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. Show and hide buttons for showing and hiding the navigation pane

Demo Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts Invoke secondary and pop-up windows using links in text, buttons, or images © 2000 Kevin Lewis All rights reserved.

Components of a Java. Help System Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q Topic files (HTML) q Data files § Help. Set file (XML) § Map file (XML) q Navigation files § TOC (XML) § Index (XML) § Word search index q Help. Set Viewer

How the Components Work Together Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved.

Directory and File Organization Contents What is Java. Help? Demo Components of a Java. Help System Type. Facer. Help. Set. hs Map. jhm Java. Help System Enhancements TOC. xml Presenting a Java. Help System Index. xml Help-Authoring Tools Closing Thoughts Java. Help. Search Images Topics Field. Level. Help © 2000 Kevin Lewis All rights reserved. Standard directory and file structure for a Java. Help system

Directory and File Organization Contents What is Java. Help? Demo Components of a Java. Help System Type. Facer. Help. Set. hs Map. jhm Java. Help System Enhancements TOC. xml Presenting a Java. Help System Index. xml Help-Authoring Tools Closing Thoughts Java. Help. Search Images Topics Field. Level. Help © 2000 Kevin Lewis All rights reserved. Help. Set data and navigation files at top level of project folder

Directory and File Organization Contents What is Java. Help? Demo Components of a Java. Help System Type. Facer. Help. Set. hs Map. jhm Java. Help System Enhancements TOC. xml Presenting a Java. Help System Index. xml Help-Authoring Tools Closing Thoughts Java. Help. Search Images Topics Field. Level. Help © 2000 Kevin Lewis All rights reserved. Directory that you create when generating the word-search index

Directory and File Organization Contents What is Java. Help? Demo Components of a Java. Help System Type. Facer. Help. Set. hs Map. jhm Java. Help System Enhancements TOC. xml Presenting a Java. Help System Index. xml Help-Authoring Tools Closing Thoughts Java. Help. Search Images Topics Field. Level. Help © 2000 Kevin Lewis All rights reserved. Contains image files for images used in topic files as well as navigation system

Directory and File Organization Contents What is Java. Help? Demo Components of a Java. Help System Type. Facer. Help. Set. hs Map. jhm Java. Help System Enhancements TOC. xml Presenting a Java. Help System Index. xml Help-Authoring Tools Closing Thoughts Java. Help. Search Images Topics Field. Level. Help © 2000 Kevin Lewis All rights reserved. Contains HTML topic files and other subdirectories— subdirectory structure is easy to manage if you copy the structure of your TOC

Directory and File Organization Contents What is Java. Help? Demo Components of a Java. Help System Type. Facer. Help. Set. hs Map. jhm Java. Help System Enhancements TOC. xml Presenting a Java. Help System Index. xml Help-Authoring Tools Closing Thoughts Java. Help. Search Images Topics Field. Level. Help © 2000 Kevin Lewis All rights reserved. Contains HTML files for field-level help topics

Topic Files Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q HTML-based q Use hyperlinks and other standard HTML components q Employ lightweight components § Standard Java. Help components § “Home-grown” components q See Java. Help documentation for limitations

XML and Java. Help Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q Java. Help files are XML-based § § Help. Set Map TOC Index q Help. Set Viewer uses DTDs for each Java. Help file

Help. Set File Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts q q XML-based “Master control” file in system System reads this file first Help. Set data elements § Title of help system § Location of map file § Default help topic on startup q Navigation elements § § © 2000 Kevin Lewis All rights reserved. Internal information Tool tip labels Name and location of navigation files Delete or rearrange order for the same appearance in the viewer’s navigation pane

Help. Set File Contents Java. Help System Enhancements <? xml version='1. 0' encoding='ISO-8859 -1' ? > <!DOCTYPE helpset PUBLIC "-//Sun Microsystems Inc. //DTD Java. Help. Set Version 1. 0//EN" "http: //java. sun. com/products/javahelp/helpset_1_0. dtd"> Presenting a Java. Help System <helpset version="1. 0"> What is Java. Help? Demo Components of a Java. Help System Help-Authoring Tools Closing Thoughts … Help. Set Data Elements … Navigation Elements </helpset> Uses the <helpset> tag to nest all of the information © 2000 Kevin Lewis All rights reserved.

Help. Set File Contents Help. Set Data Elements What is Java. Help? Demo <title>Typeface Tester Online Help</title> Components of a Java. Help System Enhancements Specifies the title of the help system Presenting a Java. Help System Help-Authoring Tools Closing Thoughts <maps> <mapref location="Map. jhm"/> <home. ID>overview</home. ID> </maps> © 2000 Kevin Lewis All rights reserved.

Help. Set File Contents Help. Set Data Elements What is Java. Help? Demo <title>Typeface Tester Online Help</title> Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts <maps> Location and name of map file and the map ID of the default help topic <mapref location="Map. jhm"/> <home. ID>overview</home. ID> </maps> © 2000 Kevin Lewis All rights reserved.

Help. Set File Contents Navigation Elements What is Java. Help? <view> Demo <label>Type. Facer TOC</label> Components of a Java. Help System Text for the tool tip Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts <name>TOC</name> <type>javax. help. TOCView</type> <data>TOC. xml</data> </view> © 2000 Kevin Lewis All rights reserved.

Help. Set File Contents Navigation Elements What is Java. Help? <view> Demo <label>Type. Facer TOC</label> Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts <name>TOC</name> <type>javax. help. TOCView</type> <data>TOC. xml</data> </view> © 2000 Kevin Lewis All rights reserved. Internal information

Help. Set File Contents Navigation Elements What is Java. Help? <view> Demo <label>Type. Facer TOC</label> Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts <name>TOC</name> <type>javax. help. TOCView</type> <data>TOC. xml</data> </view> © 2000 Kevin Lewis All rights reserved. Location and name of file containing navigation data

Map File Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q XML-based q Assigns URLs to map IDs (shorter “nicknames”) q Map topic files and image files used in navigation controls or lightweight components q Use IDs instead of full URL § Help. Set and navigation files § Topic files for secondary windows

Map File Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools <? xml version='1. 0' encoding='ISO-8859 -1' ? > <!DOCTYPE map PUBLIC "-//Sun Microsystems Inc. //DTD Java. Help Map Version 1. 0//EN" "http: //java. sun. com/products/javahelp/map_1_0. dtd"> <map version="1. 0"> … Map IDs with corresponding URLs Closing Thoughts </map> Uses the <map> tag to nest all of the information © 2000 Kevin Lewis All rights reserved.

Map File Contents <!-- Image Files --> What is Java. Help? Demo <map. ID target="toplevelfolder“ url="images/toplevel. gif" /> Components of a Java. Help System Enhancements I use optional comments to identify different sections in the map file Presenting a Java. Help System Help-Authoring Tools Closing Thoughts <!-- Topics --> <map. ID target="overview" url="topics/overview. htm" /> <map. ID target="colors" url="topics/colors_view. htm" /> © 2000 Kevin Lewis All rights reserved.

Map File Contents <!-- Image Files --> What is Java. Help? Demo <map. ID target="toplevelfolder“ url="images/toplevel. gif" /> Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts <!-- Topics --> <map. ID target="overview" url="topics/overview. htm" /> <map. ID target="colors" url="topics/colors_view. htm" /> Map ID © 2000 Kevin Lewis All rights reserved. Corresponding URL

TOC Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q TOC file in Help. Set § XML-based § Uses map IDs to map top level, category, and topic titles to topic files § TOC file dictates structure of TOC in help system § Nest items to create top level, category, and topic levels q TOC component in help system § Traditional online help TOC § Uses default top level, category, and topic icons or custom icons for each § Synchronized

TOC Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System <? xml version='1. 0' encoding='ISO-8859 -1' ? > <!DOCTYPE toc PUBLIC "-//Sun Microsystems Inc. //DTD Java. Help TOC Version 1. 0//EN" "http: //java. sun. com/products/javahelp/toc_1_0. dtd"> <toc version="1. 0"> Help-Authoring Tools Closing Thoughts … TOC structure for top level, categories, and topics </toc> Uses the <toc> tag to nest all of the information © 2000 Kevin Lewis All rights reserved.

TOC Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts <tocitem image="toplevelfolder" text="Typeface Tester Online Help"> <tocitem image="topic" target="overview" text="Overview"/> target="typefaces" text="Typeface View"/> target="colors" text="Color View"/> target="online_help" text="Online Help"/> <tocitem image="category" text="How to"> <tocitem <tocitem image="topic" image="topic" target="switch_views" text="Switch Views"/> target="enter_text" text="Enter Text"/> target="clear_text" text="Clear Text"/> target="change_fonts" text="Change Fonts"/> target="text_styles" text="Apply Text Styles"/> target="apply_colors" text="Apply Colors"/> </tocitem> © 2000 Kevin Lewis All rights reserved. Notice the nests and the hierarchy for top level, category, and topics

TOC Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. The TOC file yields this TOC in the help system

TOC Contents What is Java. Help? <tocitem image="toplevelfolder" text="Typeface Tester Online Help"> Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. First item in the nest creates the top level

TOC Contents What is Java. Help? <tocitem image="toplevelfolder" text="Typeface Tester Online Help"> Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. Map ID of the image to display with the corresponding line in the TOC

TOC Contents What is Java. Help? <tocitem image="toplevelfolder" text="Typeface Tester Online Help"> Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. The top level text to display on the corresponding line in the TOC

TOC Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. <tocitem image="topic" target="overview" text="Overview"/> target="typefaces" text="Typeface View"/> target="colors" text="Color View"/> target="online_help" text="Online Help"/> Series of TOC items yields those lines in the TOC

TOC Contents What is Java. Help? Demo <tocitem image="topic" target="overview" text="Overview"/> target="typefaces" text="Typeface View"/> target="colors" text="Color View"/> target="online_help" text="Online Help"/> Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. Map ID for the topic icon —if you don’t specify an image, Java. Help uses its own default

TOC Contents What is Java. Help? Demo <tocitem image="topic" target="overview" text="Overview"/> target="typefaces" text="Typeface View"/> target="colors" text="Color View"/> target="online_help" text="Online Help"/> Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts The topic title to display on the corresponding line in the TOC © 2000 Kevin Lewis All rights reserved.

TOC Contents What is Java. Help? Demo <tocitem image="topic" target="overview" text="Overview"/> target="typefaces" text="Typeface View"/> target="colors" text="Color View"/> target="online_help" text="Online Help"/> Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. The map ID of the topic file to display when the user selects that topic

TOC <tocitem image="category" text="How to"> Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. <tocitem <tocitem image="topic" image="topic" target="switch_views" text="Switch Views"/> target="enter_text" text="Enter Text"/> target="clear_text" text="Clear Text"/> target="change_fonts" text="Change Fonts"/> target="text_styles" text="Apply Text Styles"/> target="apply_colors" text="Apply Colors"/> </tocitem> Notice that the nest creates a category with topics

TOC <tocitem image="category" text="How to"> Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. <tocitem <tocitem image="topic" image="topic" target="switch_views" text="Switch Views"/> target="enter_text" text="Enter Text"/> target="clear_text" text="Clear Text"/> target="change_fonts" text="Change Fonts"/> target="text_styles" text="Apply Text Styles"/> target="apply_colors" text="Apply Colors"/> </tocitem> Map ID for the category icon —if you don’t specify an image, Java. Help uses its own default

Index Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts q Index file in Help. Set § XML-based § Uses map IDs to map index terms to topic files § Index file dictates structure of index in help system § Must manually alphabetize index terms § Nest items to create primary and secondary index terms § Must manually produced “see” or “see also” terms q Index component in help system § Traditional online help index § Feature to type keyword to search the index © 2000 Kevin Lewis All rights reserved.

Index Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System <? xml version='1. 0' encoding='ISO-8859 -1' ? > <!DOCTYPE index PUBLIC "-//Sun Microsystems Inc. //DTD Java. Help Index Version 1. 0//EN" "http: //java. sun. com/products/javahelp/index_1_0. dtd"> <index version="1. 0"> Help-Authoring Tools Closing Thoughts … Index structure for index terms </index> Uses the <index> tag to nest all of the information © 2000 Kevin Lewis All rights reserved.

Index Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts <indexitem target="overview" text="overview"/> <indexitem target="switch_views" text="switching views"/> <indexitem text="text"> <indexitem <indexitem target="text_styles" text="bolding"/> target="clear_text" text="clearing"/> target="apply_colors" text="colors, applying"/> target="enter_text" text="entering"/> target="change_fonts" text="fonts, changing"/> target="text_styles" text="italicizing"/> </indexitem> <indexitem target="typefaces" text="Typeface View"/> Notice the nest to specify primary and secondary index terms © 2000 Kevin Lewis All rights reserved.

Index Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. Partial index from the index file

Index Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. <indexitem target="switch_views" text="switching views"/> <indexitem text="text"> <indexitem target="text_styles" text="bolding"/> <indexitem target="clear_text" text="clearing"/> <indexitem target="apply_colors" text="colors, applying"/> <indexitem target="enter_text" text="entering"/> <indexitem target="change_fonts" text="fonts, changing"/> <indexitem target="text_styles" text="italicizing"/> </indexitem> The index term to display on the corresponding line in the index

Index Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. <indexitem target="switch_views" text="switching views"/> <indexitem text="text"> <indexitem target="text_styles" text="bolding"/> <indexitem target="clear_text" text="clearing"/> <indexitem target="apply_colors" text="colors, applying"/> <indexitem target="enter_text" text="entering"/> <indexitem target="change_fonts" text="fonts, changing"/> <indexitem target="text_styles" text="italicizing"/> </indexitem> The map ID of the topic file to display when the user selects that index item

Index Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. <indexitem target="switch_views" text="switching views"/> <indexitem text="text"> <indexitem target="text_styles" text="bolding"/> <indexitem target="clear_text" text="clearing"/> <indexitem target="apply_colors" text="colors, applying"/> <indexitem target="enter_text" text="entering"/> <indexitem target="change_fonts" text="fonts, changing"/> <indexitem target="text_styles" text="italicizing"/> </indexitem> Notice that the nest creates primary and secondary index terms

Word Search Index Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q Word-search index files § Create with the jhindexer command that accompanies Java. Help § Results in a set of files within one ‘Java. Help. Search’ directory, which you include with your delivered files § Uses stopwords to eliminate common words such as “a” or “the” q Word-search index component in help system § User enters a “natural language query”—similar to conducting a search through a Web site’s search engine § Help system searches database in the ‘Java. Help. Search’ folder

Word Search Index Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts 1. To build word-search index, start with all help topics under one master ‘Topics’ directory in your master project file § One reason to follow my recommendations for directory and file structure 2. At a command prompt, make the project directory (the one immediately above the ‘Topics’ directory) the active directory 3. Run the jhindexer command against the ‘Topics’ directory § C: jh 1. 1javahelpbinjhindexer Topics (Windows) § /jh 1. 1/javahelp/bin/jhindexer Topics (Unix) 4. Run the help system and try it out © 2000 Kevin Lewis All rights reserved.

Java. Help System Enhancements Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q q Secondary windows Pop-up windows Other lightweight components Merging Help. Sets

Secondary and Pop-Up Windows Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q Use lightweight components q Implemented in the topic file as an object q Invoked with buttons, images, or text

Secondary and Pop-Up Windows Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q Both programmed the same but function differently § A pop-up always appears adjacent to the link that invokes it, but you can specify where a secondary window appears § Users can’t adjust or move a pop-up, but they can minimize, maximize, resize, and move a secondary window § A pop-up does not have a title bar—it just contains text, but a secondary window has a title bar § A pop-up closes automatically when the user clicks another area in the viewer, but the user must manually close a secondary window

Secondary and Pop-Up Windows Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools <object CLASSID="java: com. sun. java. help. impl. JHSecondary. Viewer"> <param name="id" value="pop. jhtoc"> <param name="viewer. Activator" value="javax. help. Link. Button"> <param name="viewer. Style" value="javax. help. Popup"> <param name="viewer. Size" value="325, 150"> <param name="text" value="Java. Help Note"> <param name="text. Color" value="red"> <param name="text. Font. Size" value="medium"> <param name="text. Font. Weight" value="plain"> </object> Closing Thoughts The code, embedded in the topic’s HTML file, produces a button that invokes a popup window © 2000 Kevin Lewis All rights reserved.

Secondary and Pop-Up Windows Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. <object CLASSID="java: com. sun. java. help. impl. JHSecondary. Viewer"> <param name="id" value="pop. jhtoc"> The ‘CLASSID’ is the same <param name="viewer. Activator" value="javax. help. Link. Button"> for both secondary and <param name="viewer. Style" value="javax. help. Popup"> popup windows <param name="viewer. Size" value="325, 150"> <param name="text" value="Java. Help Note"> <param name="text. Color" value="red"> <param name="text. Font. Size" value="medium"> <param name="text. Font. Weight" value="plain"> </object>

Secondary and Pop-Up Windows Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools <object CLASSID="java: com. sun. java. help. impl. JHSecondary. Viewer"> <param name="id" value=" pop. jhtoc"> <param name="viewer. Activator" value="javax. help. Link. Button"> The ‘id’ parameter specifies the map <param name="viewer. Style" value="javax. help. Popup"> ID for value="325, 150"> the topic file containing the <param name="viewer. Size" text to display in the window <param name="text" value="Java. Help Note"> <param name="text. Color" value="red"> <param name="text. Font. Size" value="medium"> <param name="text. Font. Weight" value="plain"> </object> Closing Thoughts The text in this popup window comes from the file assigned to the map ID ‘pop. jhtoc’ © 2000 Kevin Lewis All rights reserved.

Secondary and Pop-Up Windows Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools <object CLASSID="java: com. sun. java. help. impl. JHSecondary. Viewer"> <param name="id" value="pop. jhtoc"> <param name="viewer. Activator" value="javax. help. Link Button"> <param name="viewer. Style" value="javax. help. Popup"> The ‘viewer. Activator’ parameter specifies <param name="viewer. Size" value="325, 150"> which mechanism. Note"> is used to invoke the <param name="text" value="Java. Help window: text, image, or button <param name="text. Color" value="red"> <param name="text. Font. Size" value="medium"> <param name="text. Font. Weight" value="plain"> </object> Closing Thoughts The system uses a button to invoke the popup window © 2000 Kevin Lewis All rights reserved.

Secondary and Pop-Up Windows Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools <object CLASSID="java: com. sun. java. help. impl. JHSecondary. Viewer"> <param name="id" value="pop. jhtoc"> <param name="viewer. Activator" value="javax. help. Link. Button"> <param name="viewer. Style" value="javax. help. Popup"> <param name="viewer. Size" value="325, 150"> The ‘viewer. Style’ parameter <param name="text" value="Java. Help Note"> specifies whether to open a popup <param name="text. Color" value="red"> windowvalue="medium"> or a secondary window <param name="text. Font. Size" <param name="text. Font. Weight" value="plain"> </object> Closing Thoughts The window invoked is a popup window © 2000 Kevin Lewis All rights reserved.

Secondary and Pop-Up Windows Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools <object CLASSID="java: com. sun. java. help. impl. JHSecondary. Viewer"> <param name="id" value="pop. jhtoc"> <param name="viewer. Activator" value="javax. help. Link. Button"> <param name="viewer. Style" value="javax. help. Popup"> <param name="viewer. Size" value=" 325, 150"> <param name="text" value="Java. Help Note"> The ‘viewer. Size’ <param name="text. Color" value="red">parameter specifies the size of the window in pixels <param name="text. Font. Size" value="medium"> <param name="text. Font. Weight" value="plain"> </object> Closing Thoughts The popup window is 325 pixels wide and 150 pixels tall © 2000 Kevin Lewis All rights reserved.

Secondary and Pop-Up Windows Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts <object CLASSID="java: com. sun. java. help. impl. JHSecondary. Viewer"> <param name="id" value="pop. jhtoc"> <param name="viewer. Activator" value="javax. help. Link. Button"> <param name="viewer. Style" value="javax. help. Popup"> <param name="viewer. Size" value="325, 150"> <param name="text" value=" Java. Help Note"> <param name="text. Color" value=" red"> <param name="text. Font. Size" value=" medium"> <param name="text. Font. Weight" value=" plain"> </object> The ‘text’ parameters specify the text to display on a button, the text color, font size, and font weight The text in this button says ‘Java. Help Note’, is red, is of medium size, and has a plain weight (as opposed to bold) © 2000 Kevin Lewis All rights reserved.

Custom Lightweight Components Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q Multimedia q Related topics q Whatever you create

Merging Help. Sets Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q Two ways to merge Help. Sets § Dynamically, through programming using the Java. Help API § Statically, through the Help. Set file q Static merging uses the <subhelpset> tag to specify a secondary Help. Set to merge with the master Help. Set q Can use an optional “dataless” Help. Set q TOCs, indexes, and word-search indexes merge in same components

Merging Help. Sets Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. <subhelpset location=“. . /Other. Project/Help. Set. hs” /> <subhelpset location=“. . /Third. Project/Help. Set. hs” /> In the master Help. Set file, specify the relative URL(s) to the secondary Help. Set file(s)

Presenting a Java. Help System Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q Application without help q Standalone help q Context-sensitive help § Screen-level § Field-level q Embedded help

Application Without Help Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. F 1 does not activate help system

Application Without Help Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. No ‘Help’ menu

Application Without Help Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts No ‘Help' button © 2000 Kevin Lewis All rights reserved.

Standalone Help System Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts F 1, ‘Contents’ menu item, and ‘Help’ button all launch same standalone help system © 2000 Kevin Lewis All rights reserved.

Context-Sensitive Help: Screen-Level Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. ‘Contents’ menu item launches default standalone help system

Context-Sensitive Help: Screen-Level Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts F 1, ‘For This Screen’ menu item, and ‘Help’ button launches CSH for current screen © 2000 Kevin Lewis All rights reserved.

Context-Sensitive Help: Field-Level Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts First click field-level help button and then a control—system displays help for that control © 2000 Kevin Lewis All rights reserved.

Embedded Help Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. Good practice to provide mechanism for hiding embedded help

Help-Authoring Tools Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q Major vendors provide Java. Help support § § e. Help Robo. HELP Fore. Front Fore. HTML Wex. Tech Doc-to-Help Visit Sun’s Java. Help Web page for complete list - http: //java. sun. com/products/javahelp/industry. html q Make process easier and faster q Less room for error q Best if you have strong knowledge of both the HAT and Java. Help so that you can better customize your Java. Help system q Should still understand Java. Help without HAT in case you must troubleshoot problems

Robo. HELP Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q Robo. HELP HTML provides single source for developing Web-based systems: § § Sun Microsystems Java. Help Oracle Help for Java Microsoft HTML Help e. Help Web. Help q Get more product information at e. Help’s Web site § http: //www. ehelp. com

Robo. HELP Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. When creating new projects, Robo. HELP provides a wizard to specify information you would otherwise manually enter in Help. Set data files

Robo. HELP Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. A common interface enables the user to work on both data files and topic files without switching to different screens

Robo. HELP Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. Robo. HELP has a related topics feature that embeds its own lightweight component into the help topic to implement a related topics control

Robo. HELP Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. Robo. HELP has an auto-generate TOC feature, but it typically requires modification to get what you want

Robo. HELP Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. Robo. HELP’s Smart Index Wizard automatically creates indexes (including the primary and secondary index terms) and is good in a pinch, but it requires a lot of modification to create a solid index

Robo. HELP Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. Generating a the final help system is easy, and you can select different types of help platforms (such as HTML Help or Web Help)—this illustration shows that I chose a Java. Help system

Robo. HELP Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. One of my favorite features during the Java. Help system generation is a pop-up box that reminds the user of Java. Help’s limitations

Robo. HELP Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. Robo. HELP handles displaying the help system so that you don’t have to manually run the Help. Set Viewer

Robo. HELP Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. Robo. HELP’s finished system would require a bit of modification to match the system I created manually—but it certainly makes the development process much less painful and offers a few great enhancements

Future of Java. Help Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts q Version 1. 1. 1 is the latest q Future versions unknown q Viewer module (JEditor. Pane) is being improved q Java SDK 1. 4 will contain important performance improvements § More efficient memory usage § Added HTML 4 tags § Bug fixes q Serious investigation about adding an XML editor kit q Need (or no need) for Java. Help? © 2000 Kevin Lewis All rights reserved.

Closing Thoughts Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q Win. Writers survey § Java. Help authors’ experience levels - 1% could write a book on it 5% used it frequently in several projects 17% experimented or used it a bit 31% read or heard about it 45% had no experience § Help authors’ views on Java. Help’s importance - 4% found it invaluable, a core component 6% found it very important to their projects 9% found it useful, but could get along without it 11% used it very little in their projects 69% had no need for it

More Information Contents What is Java. Help? Demo Components of a Java. Help System Enhancements Presenting a Java. Help System Help-Authoring Tools Closing Thoughts © 2000 Kevin Lewis All rights reserved. q Java. Help Web site § http: //java. sun. com/products/javahelp/ q Java. Help list archives § http: //archives. java. sun. com/archives/javahelpinterest. html q “Creating Effective Java. Help” § http: //www. oreilly. com/catalog/creatingjavahelp/ q These slides maintained on the Web § http: //www. kevinlewis. com