| Re: [ease-dev] Help Tutorials |
Hi Christian,I added the help hovers to modules, methods and fields. I had to add a dedicated marker to find start/end positions of the module section and method section. Just a tag called "<module>" and a tag called "<methods>". If you can customize the help builder according to this I can commit the stuff after doing minor modifications.<body><module><h1>Resources Module</h1>........................</module><methods><h2>Methods</h2>.........................</methods></body>Thank you.On Fri, May 22, 2015 at 11:42 PM, Vidura Mudalige <vbmudalige@xxxxxxxxx> wrote:Hi Christian,I had made a little mistake when generating help pages. I fixed the problem and also closed the link tag. Then I was able to parse those pages using XMLMemento. Now I can successfully display tooltips for modules.:) Current tooltip contains the module name and the paragraph about the module.(Now I am adding the table also) If the current page structure remain unchanged, I think it is unnecessary to add dedicated marker to find start/end positions of the relevant html code. I will let you know whether it is necessary after doing more testings.Thank you.On Fri, May 22, 2015 at 2:48 PM, <Christian.Pontesegger@xxxxxxxxxxxx> wrote:Hi Vidura,
ad 1) which ‚location‘ are you referring to? Did you follow the tutorial link? Which step is failing?
Ad 2) just checked. There is currently one XML error in the generated help pages. The ‘link’ tag in the header section is not closed. Do that manually until we fix the module doclet and you can parse those files using xmlmemento. No need for a third party library.
Ad 3) you are absolutely free to modify existing files. For minor changes I suggest to leave the header as-is. If you modify major parts of a source file you could add yourself to the list of contributors in the header if you like. In case you create new files (which you will have to do throughout this summer) please copy a disclaimer and excahnage date and name accordingly.
Best regards
CHristian
From: ease-dev-bounces@xxxxxxxxxxx [mailto:ease-dev-bounces@xxxxxxxxxxx] On Behalf Of Vidura Mudalige
Sent: Friday, May 22, 2015 10:53 AM
To: ease developer discussions
Subject: 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.
_______________________________________________
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 MudaligeUndergraduateComputer Science & EngineeringUniversity of Moratuwa.--Vidura MudaligeUndergraduateComputer Science & EngineeringUniversity of Moratuwa.