| From a writer - how to build help [message #28783] |
Wed, 23 February 2005 18:29  |
Eclipse User |
|
|
|
Originally posted by: voconnor.xaware.com
This is a question from a technical writer, not a developer. If someone
can help me determine how writers should build help files to integrate
with eclipse products, I would appreciate it.
FYI, I've the article "Help -- Part 1, Contributing a little help" in hand.
I've an existing help system built as JavaHelp (which uses simple HTML
files and some control files, as you probably know), so how difficult will
it be to convert this existing help system? My development staff is
migrating to the eclipse platform.
Thank you in advance for your kind help,
Virginia
|
|
|
| Re: From a writer - how to build help [message #28787 is a reply to message #28783] |
Wed, 23 February 2005 22:50  |
| Eclipse User |
|
|
|
Originally posted by: Chris_Laffra.ca.ibm.com
An experience report will be given at EclipseCON:
http://www.eclipsecon.org/event.php?id=152
Believe it or not, we actually used the Eclipse Help system to write The
"Official Eclipse 3.0 FAQs" as a plugin. Managing the html files and the
toc.xml is a pain. We wrote a tool to manage that process. It may be of
value to you.
Check out http://eclipsefaq.org and read the preface of the book.
The tool we wrote for editing the toc.xml, TocViewer, can be found at
http://www.eclipsefaq.org/chris/faq/samples.html.
With the tocviewer, it is a snap to convert your help system.
--
Chris Laffra, http://eclipsefaq.org
"Virginia" <voconnor@xaware.com> wrote in message
news:cvj3l6$c1g$1@www.eclipse.org...
> This is a question from a technical writer, not a developer. If someone
> can help me determine how writers should build help files to integrate
> with eclipse products, I would appreciate it.
>
> FYI, I've the article "Help -- Part 1, Contributing a little help" in
hand.
>
> I've an existing help system built as JavaHelp (which uses simple HTML
> files and some control files, as you probably know), so how difficult will
> it be to convert this existing help system? My development staff is
> migrating to the eclipse platform.
>
> Thank you in advance for your kind help,
>
> Virginia
>
|
|
|
Powered by
FUDForum. Page generated in 0.08660 seconds
Home