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:RE: Web application help From:"Richard Smith" <Richard -dot- Smith -at- windriver -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 9 Jan 2001 15:29:08 -0800
Megan asks:
<Am I describing a ready-made tool or is hand-coding HTML in vi my best
(read - "easiest") bet? My requirements:
1. End help product is platform independent (Win32, Linux, etc.)
2. End help product is browser compatible (IE, Netscape)
3. Development tool is platform independent
4. Development tool is open source>
#4 is gonna limit you pretty much. Just about every dev tool people on this
list talk about is not open source.
Hi Megan,
Javascript works well for a secondary window popup type help topics. It is
also easy to script the help popup to close when the page that calls it is
unloaded. It is dev platform independent and relatively browser independent.
Oh, wait... you said vi, so if you still use lynx ;-)
you're outa luck.
But seriously, you mention two possibilities. A popup or a designated part
of the page (via tables or frames, i'd assume). Either path will have
certain browser issues unless you use very plain (old school) HTML. But
don't kill yourself trying to include everybody. Use whatever research your
app developers have to guide you. Will the app make use of scripts? If so,
then you can too. Does the app use a frameset? If so, you can too. Your
audience is their audience. Don't hold yourself to a more stringent criteria
than the app developers do.
So the real question is... vi or emacs.
btw, is vi platform independent?
Have fun,
Richard Smith
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Sponsored by DigiPub Solutions Corp, producers of PDF 2001
Conference East, June 4-5, Baltimore/Washington D.C. area. http://www.pdfconference.com or toll-free 877/278-2131.
---
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.