Eclipse Community Forums: Eclipse Platform

Home » Eclipse Projects » Eclipse Platform » Export help contents

Fri, 29 February 2008 10:30

Eclipse User

Hello guys

I have written lots of documentation for some Eclipse plugins. Now some of
my "managers" want to read this documentation (offline because they have
no Eclipse and do not want to install it only because of the doc).

Is there any way to export the documentation for a certain topic and its
subtopics as one or many html web page where the links that are used are
resolved so that easy navigation between several web pages is possible.

I know that I can print a topic (recursively) but here the links inside
the html files are always pointing to the webserver. The only links
working are the ones defined through the toc files.

Thanks in advance for any hint

Greetings Marko T.

Re: Export help contents [message #325894 is a reply to message #325880]

Sat, 01 March 2008 12:20

Eclipse User

Originally posted by: nospam_kowalskilee.gmail.com

Hello Marko,

Note: I'm adding eclipse.platform.ua newsgroup also to this thread, as
that newsgroup is focused on UA items (help system/cheat sheets/forms/etc).

What do you mean by "(recursively)" in printing a topic?

AFAIK, there's no "export" action in the help system to export or
otherwise generate an offline readable module.

I can see a potential work around for your situation:
I'm looking at Eclipse 3.4 M5, and if you select a topic, you can use
the Print icon that's above the table of contents to generate a single
HTML page that contains that topic and its subtopics. It's *not* the
Print icon that's above the topic itself (on the right hand side)--it's
a Print icon with a little black down arrow that's in the left hand
frame above the full table-of-contents tree.

When you press the black down arrow of that Print button, select "Print
selected topic and all subtopics" choice. This will build a single HTML
page that contains all of those topics and sends that page to your
system browser.

Once that page appears in your system browser, then I expect you can use
your browser's menu File->Save Web Page option and save it as an
offline file that you can send to your managers.

Would you give that a try and let us know what you think?

Sincerely,
Lee Anne
http://www.linkedin.com/in/leeannekowalski

Marko T. wrote:
> Hello guys
>
> I have written lots of documentation for some Eclipse plugins. Now some
> of my "managers" want to read this documentation (offline because they
> have no Eclipse and do not want to install it only because of the doc).
>
> Is there any way to export the documentation for a certain topic and its
> subtopics as one or many html web page where the links that are used are
> resolved so that easy navigation between several web pages is possible.
>
> I know that I can print a topic (recursively) but here the links inside
> the html files are always pointing to the webserver. The only links
> working are the ones defined through the toc files.
>
> Thanks in advance for any hint
>
> Greetings Marko T.
>

Re: Export help contents [message #325949 is a reply to message #325894]

Mon, 03 March 2008 20:05

Eclipse User

I take it that you are using the print topics and all subtopics feature.
Making the links relative where possible would seem to be a useful
enhancement (although this would only work for links which stayed within
the area being printed). Can you open a bug against this? If it is easy
to do I may be able to get it into 3.4.

Previous Topic:	Massive OutOfMemory Errors with 3.3.1
Next Topic:	Feture Details Table

Goto Forum:

-=] Back to Top [=-

Current Time: Sat May 10 23:17:48 EDT 2025

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter