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.
Are you documenting a web or desktop application? I'll assume web. You
do not need Topic Aliases if you already have a standard for creating
Filename markers. Besides, later versions of WW allow you to use
Filename and Topic markers interchangeably. The following uses the
method already suggested in your style guide...
Since WW allows style-based page breaks, note all heading levels in
Frame that you want to mark new topics in your help system. Create and
apply Filename markers that specify the name you want to give each
separate html file that WW will create based on style.
WW allows you to link to topics using various methods. Your WW
documentation provides more info on this subject. However, your
developers can make direct function calls to html topic files. This is
simpler for them to implement and you wouldn't have to be concerned
about GUI filename changes. For your own records, however, manually
maintain a mapping of GUI-to-topic links.
A context sensitive call from a help link on the web GUI typically looks
something like this:
<a href="javascript:document.open('http://www.myco.com/helpdirectory/
default.htm?single=false&href=Accessing_XYZ_Widget_from_the_ABC_Pane.htm
l')">Help</a>
This calls the frameset file for your help system (default.htm), tells
the it to show the TOC panel (single=false) and identifies the html
topic that services the context
(href=Accessing_XYZ_Widget_from_the_ABC_Pane.html).
WW's built-in script is even intelligent enough to handle direct calls
to
www.myco.com/helpdirectory/Accessing_XYZ_Widget_from_the_ABC_Pane.html,
which opens the topic without the TOC panel.
Anyway, don't panic. The process is relatively pain free for web apps
with no crazy topic id or .h file requirements.
HTH,
Lisa H.
GTA, ON
-----Original Message-----
From: Julia Cemer
Hello everyone.
I'm having a bit of a struggle figuring out how to create context
sensitive help for our software.
Bit of background:
I've been here about 2 years. Before me there was another writer there
was a writer in a remote office. The remote writer developed all the
styles, templates, style guides etc. I am not allowed to change them.
That writer is long gone and I came in just to pick up where he'd left
off.
Now they want me to make sure for the next release of the product I have
created the help to be context sensitive. My developers claim that they
never did anything with a context sensitive help system, even when the
other writer was here. And I have no idea where to start. This is what
I've got to go on from the style guide:
Context-sensitive Help
The WebWorks template used by the Documentation Team is automatically
enabled to hand context-sensitive requests. To enable
context-sensitivity for a help system, you must assign a FileName marker
to each heading within your FrameMaker files. These filename markers
automatically assign the name of the heading to the name of the
corresponding Web page generated by WebWorks.
Filename markers are applied using the same method as other FrameMaker
markers. Each filename marker should have the same name as its
corresponding heading, with spaces between each word replaced with
underscores.
I know without taking a look at my WW templates you may not be able to
give me much advice, but if you have anything to get me started, I would
really appreciate it. I know how to tag the headings, but I don't know
what to tell the developers to do after that... Any suggestions??
I'm sorry if this doesn't make much sense. I honestly don't even know
how to ask for what I need.
Thanks in advance.
Julia
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
******* Confidentiality Notice *******
ESI Canada -- Optimizing the value of drug and dental benefits
This email, its electronic document attachments, and the contents of its website linkages may contain confidential health information. This information is intended solely for use by the individual or entity to whom it is addressed. If you have received this information in error, please notify the sender immediately and arrange for the prompt destruction of the material and any accompanying attachments.
******* Avis de confidentialite *******
ESI Canada -- Optimiser la valeur des regimes d'assurance medicaments et dentaires
Ce courriel ainsi que tout document y etant joint de meme que le contenu des liens vers des sites Web peuvent reunir des renseignements confidentiels sur la sante. Cette information s'adresse uniquement a l'usager ou a l'organisation auxquels elle est destinee. Si vous avez recu ce message par erreur, veuillez en aviser l'expediteur immediatement et proceder a la suppression du document et des fichiers joints sans tarder.
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l
