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:Question about Window-Level Help From:"Miller, Lisa" <Lisa -dot- Miller -at- Anheuser-Busch -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 2 Mar 2001 15:01:34 -0600
TECHWR-Ls
I'm creating window-level help using RoboHelp HTML 2000. I am unable to explain
to my developer the purpose of the Topic ID. From the RoboHelp help, "HTML Help
translator looks up map number in the Map file and outputs matching Topic ID.
HTML Help Translator looks up Topic ID in Alias List and outputs the matching
Topic File Name. HTML Help displays help topic." What I can't explain (because
I don't know this), is whether or not the Topic ID must match the name
development uses to identify the window. According to the help only the Map#
must be the same, but I don't know why RoboHelp help says to "Talk to your
developer if you are unsure of what to enter in [the Topic Id] field." I am
assuming this is because the the Topic ID is how the developer identifes the
window instead of by the name displayed to the user (which is more than likely
the Help Topic name I will use) and that having the Topic Id match the window
name facilitates communication between development and help development.
If I don't need the Topic ID from development, I will not pursue this issue
further and use my own naming convention. However, if it is necessary, I will
need to explain to development how the Topic ID is used and why I need it from
him. It would also be helpful to know from which field in the window definition
this name comes. Development is coding in Visual Basic.
Lisa A. Miller
Technical Writer
Anheuser-Busch, Inc.
Packaging Team - Corporate Engineering mailto:lisa -dot- miller -at- anheuser-busch -dot- com
(314) 865-8904
"Beer is proof that God loves us and wants us to be happy."
-- Benjamin Franklin
IPCC 01, the IEEE International Professional Communication Conference,
October 24-27, 2001 at historic La Fonda in Santa Fe, New Mexico, USA.
CALL FOR PAPERS OPEN UNTIL MARCH 15. http://ieeepcs.org/2001/
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
