Re: web apps - how to embed help ?

Subject: Re: web apps - how to embed help ?
From: Craig Haiss <craighaiss -at- yahoo -dot- com>
To: monique -dot- semp -at- earthlink -dot- net, techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 2 Sep 2010 08:53:20 -0700 (PDT)

Hi, Monique. You could try using the HTML-based outputs from Flare or RoboHelp. Both have APIs that programmers can use to link help into the GUI.

You could also just use straight HTML topics, and the programmers can manually build calls to show the right topic. You'll just have to provide some sort of map file that tells the programmer which help topic should show up for each interface object. The JavaScript OnMouseOver event can be used to display topics when you hover over an interface element.

However, the first option (Flare or RoboHelp) is probably the easiest, since help topics in these tools are available to guide you and the programmers through the process of linking your help to the interface.

Good luck!

-Craig Haiss

--- On Wed, 9/1/10, Monique Semp <monique -dot- semp -at- earthlink -dot- net> wrote:

> From: Monique Semp <monique -dot- semp -at- earthlink -dot- net>
> Subject: web apps - how to embed help ?
> To: "techwr-l" <techwr-l -at- lists -dot- techwr-l -dot- com>
> Date: Wednesday, September 1, 2010, 7:36 PM
> So, what technologies or tools are
> out there?  My client is finally ditching the old
> Word-to-PDF that was hyperlinked from the Web app, and wants
> context-sensitive help; yay!  They want to investigate
> the possibilities.  Other divisions in their company
> use Confluence; they've played around with TiddlyWiki, which
> you can apparently link from any given app page to a given
> wiki page.  But what other options are there?
> But I was thinking that there must be some tool that
> provides those helpful popups when you hover over a question
> mark; and I'm sure there are plenty of other things.
> Looking forward to ideas,
> -Monique


Gain access to everything you need to create and publish information
through multiple channels. Your choice of authoring (and import)
formats with virtually any output. Try Doc-To-Help free for 30-days.

LavaCon 2010 in San Diego Sept 29 - Oct 2 is now open for registration.
Use referral code TECHWR-L for $50 off conference tuition!
See program at:

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Please move off-topic discussions to the Chat list, at:

web apps - how to embed help ?: From: Monique Semp

Previous by Author: RE: Two Professional Questions
Next by Author: RE: What sort of experience would be better?
Previous by Thread: web apps - how to embed help ?
Next by Thread: Use of screenshots in procedures?

What this post helpful? Share it with friends and colleagues:

Sponsored Ads