TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Online Help in Windows From:Glen Accardo <glen -at- SOFTINT -dot- COM> Date:Tue, 31 May 1994 15:35:29 CDT
> 1. Do any of you use any color other than the green that is generated
> by HC31 for your jump/popup links?
I changed the settings in my WIN.INI file to use different colors. I can't
really see the green on a white background. You could also manually change
the colors, but that tends to be more of a pain than it's worth -- just because
you don't like the colors doesn't mean you can make the rest of the world
happy. You may consider documenting the following items (in your paper docs),
or including a program called JMPCOL (I'll get the exact reference if anyone
JumpColor=255 0 0
PopupColor=255 0 0
MacroColor=255 0 0
; All of the above are red.
IFJumpColor=0 255 0
IFPopupColor0 255 0
; both of those are blue.
> 2. Do any of you use any other graphic annotation other than a single
> underline for jump links or a dashed underline for popups?
Nope. Most of the programs I've seen which use other indicators get somewhat
annoying. HyperWriter has little triangles before and after every jump, and
seeing all those triangles is a blechy.
> 3. Usually, how many topic levels do you create below the initial
> contents topic? (I think that three to four should be the limit)
Let the topic define the limit. Hypertext should live without meaningless
> 4. When using keywords, I believe that, for a multiple word entry, the
> following format should be used: "topic, deleting". This preserves the index
Good idea. The entries are in alphabetic order so the above is a nice
mechanism. You may want to double post everything; that is, have two entries
for the above: "topic, deleting" and "deleting a topic."
glen accardo glen -at- softint -dot- com
Software Interfaces, Inc. (713) 492-0707
Houston, TX 77084