Eclipse Community Forums: Eclipse Platform

Help

Home

Home » Eclipse Projects » Eclipse Platform » All new to me

Show: Today's Messages :: Show Polls :: Message Navigator

All new to me [message #260809]

Mon, 12 July 2004 16:59

Eclipse User

Originally posted by: bthoenen.avaki.com

Soon I'll start writing online help for an Eclipse plug-in that my company
is developing. Having no experience with Eclipse (and little with online
help), I've looked for articles on this topic -- found one that looks very
helpful (Help Part 1: Contributing a little help), but it's for 2.0. Has
the process changed significantly for 3.0?

Some other questions:

The "Help - Part 1" article explains how to set up online help using the
toc extension point. Is this the same kind of help I see referred to
elsewhere as "standalone help"? I assume standalone help is the
alternative to context-sensitive help...?

Are there any special requirements for the HTML files in which the doc
lives? Do they have to be set up as HTML help, or can I convert a chapter
to vanilla HTML and expect it to work?

We write in FrameMaker and will probably use a 3rd-party tool like
WebWorks Publisher Pro or Mif2go to produce HTML for our Eclipse plug-in
doc. I'd be very interested to hear from anyone else using Frame to write
Eclipse docs.

cheers,

Beth Thoenen
Avaki Corp.

Report message to a moderator

Re: All new to me [message #261073 is a reply to message #260809]

Tue, 13 July 2004 11:02

James Willans

Messages: 303
Registered: July 2009

Senior Member

Beth,

I don't think help has changed much since 2.x and 3.0. Having read the
document you mention, I would be inclined to have a look at how the help
documents are implemented for the Eclipse Java IDE. The HTML files are
just regular HTML files.

James

Beth Thoenen wrote:

> Soon I'll start writing online help for an Eclipse plug-in that my company
> is developing. Having no experience with Eclipse (and little with online
> help), I've looked for articles on this topic -- found one that looks very
> helpful (Help Part 1: Contributing a little help), but it's for 2.0. Has
> the process changed significantly for 3.0?

> Some other questions:

> The "Help - Part 1" article explains how to set up online help using the
> toc extension point. Is this the same kind of help I see referred to
> elsewhere as "standalone help"? I assume standalone help is the
> alternative to context-sensitive help...?

> Are there any special requirements for the HTML files in which the doc
> lives? Do they have to be set up as HTML help, or can I convert a chapter
> to vanilla HTML and expect it to work?

> We write in FrameMaker and will probably use a 3rd-party tool like
> WebWorks Publisher Pro or Mif2go to produce HTML for our Eclipse plug-in
> doc. I'd be very interested to hear from anyone else using Frame to write
> Eclipse docs.

> cheers,

> Beth Thoenen
> Avaki Corp.

Report message to a moderator

Previous Topic:	Help needed getting started with a new application
Next Topic:	Deprecated element flags

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

]

Current Time: Sat Nov 09 03:39:33 GMT 2024

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter