How to generate Eclipse Help from RoboHelp

Thursday, December 10 2009 @ 1:52 PM, By Siddharth Sodhani

What is Eclipse Help?

Eclipse platform has an in-built documentation which can be accessed from Help -> Help Contents. This documentation contains a list of “Help Systems” or “Books” for several plug-ins installed on the machine. Each help system contains a bunch of HTML files with an XML based table of contents (TOC) referring those files and plugin.xml file (file required by Eclipse to display the help).

Eclipse1.png

A sample help system:

Eclipse2.png

How would RoboHelp make your work easier?

RoboHelp provides a simple way to publish Eclipse Help. It would create all the necessary files required to generate the Help System. Here is how you should proceed for creating Eclipse Help from RoboHelp 8:-
1. Go to Tools->Options: Check flag “Convert RoboHelp edited topics to HTML”

EclipseHelp3.png

2. Generate WebHelp SSL

3. If you have Eclipse already installed, create a folder say “MyHelpPlugin” under plugins folder of Eclipse (its under Eclipse installed folder) else create a new folder to dump output into it.

4. Open Scripts Explorer pod, View->Pods->Script Explorer

5. Run the Script “EclipseHelp.jsx”

6. Select the generated webhelp SSL folder i.e. under !SSL!

7. Click Ok

8. In Select Eclipse Plugin directory, select the folder created in Step 3.

Caution: Contents of the folder would be deleted, so double-check the folder selected.

9. Click Ok

10. In “Describe plugin.xml file” dialog, specify the name of Help and provider name

11. Click Ok

12. View help in Eclipse by Help -> Help Contents

And you should be able to view your Help as a Book in Eclipse..!!!

You can also download updated script file from here.

To update, perform the following steps:
1. Open Scripts Explorer pod, View->Pods->Script Explorer.
2. Right-click on “EclipseHelp.jsx”.
3. Click on “properties”
4. Click on “Open Folder”
5. Save the download script file to this location.

Drop a comment for any suggestion and how do you want this feature to work natively in RoboHelp 9.

Thanks
Siddharth Sodhani
RH Engineering TEAM

COMMENTS

  • By Marco Holzhäuser - 11:12 AM on September 3, 2010  

    Hello Siddharth,

    thank you for your instruction. I did the steps like you mentioned above. I created a new folder in the plugin folder but unfortunately I can´t see my own help project in the eclipse help.

    Do I have to do some other settings within Eclipse? Or do I have to create the folder in another directory?

    Thank you very much for your efforts.

    Best regards

    Marco Holzhäuser

  • By Miriam Magid - 3:03 PM on January 25, 2011  

    The link to the updated script does not work. I have been using the script for a long time, and all of a sudden I am getting an error message stating I have an invalid token.

    Any ideas?

  • By Twilight - 1:23 PM on June 8, 2011  

    really thank you very much :)
    I love this blog :)

  • By susan - 8:49 AM on September 14, 2011  

    thanks for the instructions very informative

  • By http://www.moviereleaseguide.com/sky-high-2005-07-24 - 5:07 PM on October 2, 2011  

    I can see that you are putting a lots of efforts into your blog. Keep posting the good work. Some really helpful information in there. Bookmarked. Nice to see your site. Thanks!

  • By Grant Hogarth - 4:49 PM on October 18, 2011  

    Question: Can RH Master Pages be applied to Eclipse Help in RH 9? I’ve added one to the project, but it doesn’t seem to be getting picked up.

  • By Sharma_2003 - 9:15 AM on April 3, 2012  

    Good one… I tried this… Thanks for sharing

  • By Arianna Christian - 12:26 PM on September 28, 2012  

    thanks for explain with diagrams..!!!

  • Categories

  • Archives

  • Authors

  • Useful Links

  • Recent Comments

    • Joel: Thanks for fixing the links guys!
    • Maxwell Hoffmann: Ted, one aspect of the blog that may have escaped your notice; you can launch the HTML5 version in...
    • Maxwell Hoffmann: Joel, per comments made above, I discovered that the original URLs were incorrect with pointers to...
    • Maxwell Hoffmann: Paul, as I indicated in the comments below, the original blog had links that pointed to a...
    • Maxwell Hoffmann: I apologize to all concerned regarding my suggestion to “clear the cache” … it...