Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [ease-dev] Help Tutorials
Hi Christian,

I generated the help pages using "javadoc.exe". But the generated help pages are completely different from the default help pages that come with the EASE installation.(The latest EASE version doesn't include any module help pages at all) Then I imported the deployed o.e.e.m.platform plugin and copied the help pages in to the exact location in source bundle. After that I was able to load the relevant help pages when hover on the modules. The main problems now I am facing are these,

1. When I generate the help pages using "javadoc.exe" I can select any location I want. What would be the correct location? I cannot decide the correct location since the new EASE version does not include any help pages.

2. The help pages does not support for  XMLMemento. On the other hand converting the help pages in to xml files is somewhat costly task. Therefore I think we should use some third party library to parse.

3. In order to display the tooltips in modules explorer I have to modify "ModulesDecoratedLabelProvider.java" class. You hold the copyright for that file. Will my changes make some licence problems? 

Thank you.

On Mon, May 18, 2015 at 12:08 AM, Christian Pontesegger <christian.pontesegger@xxxxxx> wrote:
Hi Vidura,

glad you are already working on some topics!

Regarding displaying help:
To display help in general on a debug run add follwing plugin to your run configuration:
  • org.eclipse.help.ui
  • org.eclipse.help.webapp
  • org.eclipse.equinox.http.jetty
  • org.eclipse.ui.browser

Remember: just to the run configuration. No need to add any kind of dependencies to a plugin. Do not add any dependency to org.eclipse.ease.modules.* to any of the core packages. This would result in a cyclic build dependency. We don't need it anyway.

To see online help working for a module you either need to consume these modules from our download site (as part of your target platform) or build the help manually. For the latter, see http://codeandme.blogspot.co.at/2014/10/writing-modules-for-ease.html for details.
Reason is that we dynamically generate help during our automated build, so help pages are not available in the source bundles you download from git.

2) I checked an jsoup is part of eclipse orbit, so we are allowed to use it. Yet if it is not really needed I would like to avoid to add this as a new dependency. Eventually XMLMemento might be sufficient to parse for the relevant help section. If the created pages are not conform to XML, let me know and I will have a look. I guess we also need to modify the generated help pages a bit. You will need a dedicated marker to find start/end positions of the relevant html code. Please come up with an example how to modify the help pages accordingly and I will customize our help builder.

best regards
Christian



_______________________________________________
ease-dev mailing list
ease-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/ease-dev



--
Vidura Mudalige
Undergraduate
Computer Science & Engineering
University of Moratuwa.

Back to the top