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.
RE: Query on WebWorks Publisher Professional 2003 for Framemaker
Subject:RE: Query on WebWorks Publisher Professional 2003 for Framemaker From:"technicoid" <technicoid -at- cableone -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 2 Jul 2004 08:25:55 -0600
David D. suggested:
>This is easily done by embedding a <filename> marker in each heading that
is to break to a
>topic and assign the hardcode filename to the topic. For example, if the
heading text is
> "Using the Main Window" and you want the filename to be
"Using_the_Main_Window.htm," go to
>the FrameMaker source file, click your cursor in the heading text
>anywhere, create a new marker there called "Filename" and assign the
filename in the dialog
> as "Using_the_Main_Window.htm." Then rebuild the help. You will find that
custom filename
>assigned to the file instead of the autogenerated one.
>The advice is the same -- just use a map id number instead of the htm
filename.
This method is useful as a workaround for the limitations of VB .NET, which
doesn't use the standard HTML Help API to call help topics. However, it
won't work for WinHelp, which RTF based and compiled into a binary.
I recommend two things. First, check out the WebWorks Publisher user list on
Yahoo groups. It's an excellent resource for technical questons on WWP.
Second, read the WWP online documentation on creating context-sensitive
help. It suggests a number of methods for handling topic mapping.
My recommendation is that you get a header file from your developers with
all of the help resource strings. It will have the following for each
dialog/button/control for which help is enabled:
A directive - #define
A contant - an alphanumeric string often prefaced by IDH_. You can
also use hyphens and underscores. It's also called a topic ID, but only by
help developers.
A value - the decimal or hexidecimal value assigned to the constant. It's
also called a context ID.
Together, it looks like this:
#define IDH_MY_DIALOG_BOX 12200
You'll have a list of these in the text (header) file that your developer
gives you. The file usually has the extension .h but sometimes .hh or
something else. If your developer doesn't have a separate file for help
mappings, you can create your own in Notepad. You can map multiple values to
a single constant, but each context ID can be used only once.
In Frame, you want to create a custom marker called TopicAlias. Insert this
marker in the heading for each topic, and insert the topic ID (the constant)
as the value of the TopicAlias marker. For example, if you have a topic
"Saving Files" you would use the constant for the related dialog box, such
as IDH_FILE_SAVE.
In WWP, the Frame TopicAlias marker will be mapped to the WWP TopicAlias
marker. You want to then open the template.hpj file for your WWP project in
Notepad. Find the section called [MAP]. You'll see something like this:
#include "$PROJECTNAME;.h"
Replace the name in quotes with the name of your header file, like this:
#include "mymappings.h"
In WWP, make sure all topics are mapped to NewTopicMain or to another
appropriate NewTopic style. You don't need to set any of these headings to
split. (If this were an HTML Help project, you'd want to split the files on
headings.)
Once you've made the changes above, regenerate your project. You can use the
WinHelp API from the Microsoft Help Workshop to test the mappings.
ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl
COMPONENTONE DOC-TO-HELP 7 PROFESSIONAL: From a single set of Word documents, create online Help and printed documentation. New version offers yearly subscription service, Natural Search, Modular TOC Utility, Image Map Editor, Theme Designer, Context String Editor, plus more. http://www.componentone.com/doctohelp .
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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.