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: Context sensitivity and help produced from XML
Subject:Re: Context sensitivity and help produced from XML From:Sean Wheller <seanwhe -at- yahoo -dot- com> To:Faith Weber - ESC <faithw -at- esystem -dot- com> Date:Fri, 16 Jan 2004 23:27:51 -0800 (PST)
--- Faith Weber - ESC <faithw -at- esystem -dot- com> wrote:
> -Are any of you using XML to produce HTML-based help
> for a Web-based application?
I use it for output to the following formats: PS, RTF,
PDF, HTML, HTML based help (CHM), JavaHelp, MANPAGES.
Try to see XML as just a neutral storage format on
which you can run XSL stylesheets to produce the above
mentioned formats.
>
> -Is the end product of HTML-based help produced via
> XML still essentially a set of HTM files (plus
> framesets and navigation), or is it a set of XML
> files?
If you use an XSL for HTML it will give you HTM pages.
If you use an XSL for HTML-based help it will give you
a CHM. Note that CHM is just another HTML application.
The HTM pages are just compiled into a file format
that can be read by the Windows Help Engine of today.
>
> -Was context sensitivity in place before you moved
to
> XML? If so, were there
> any issues with the transition on the development
> side, such as having to
> recode context sensitive links?
Yes, but did not make any difference. It is good
practice to use a map file. Help Topic Numbers are
listed in the file and the application just calls the
Help Engine + Help Document + Topic Number. You can go
two ways:
1. Change the topic numbers in the program.
2. Change the topic numbers in the help.