Bug 410832 - Mylyn Preference Page & Help should be pulled up to Mylyn commons
Summary: Mylyn Preference Page & Help should be pulled up to Mylyn commons
Status: ASSIGNED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Mylyn (show other bugs)
Version: 3.9   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: Alex Lagarde CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2013-06-14 11:57 EDT by Alex Lagarde CLA
Modified: 2014-02-05 14:23 EST (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Alex Lagarde CLA 2013-06-14 11:57:31 EDT
Hi everyone,

as the Intent project is under the Mylyn Docs component, I defined the Intent User Guide and Preference Page under the Mylyn categories.

However, these information are defined "too low" in the plugin hierarchy according to me: although Intent has no code dependency toward Mylyn Tasks, I have to import:
- the org.eclipse.mylyn.task.ui plugin (that declares the 'org.eclipse.mylyn.preferencePages.Mylyn' Mylyn Preference Page)
- the org.eclipse.mylyn.help.ui plugin (that declares the org.eclipse.mylyn.help.ui/primary-toc.xml#additions entry in the Eclipse help).

This may seem to be a detail, but this introduces a dependency from Intent to those 2 plugins, and I have to use the "org.eclipse.mylyn.ide_feature.feature.group" feature to build Intent, although 80% of Intent should not depend and eclipse.ide or core.resource.

Could it be possible to pull up the Mylyn Preference Category & the default Mylyn help in some mylyn.commons plugins without too much dependency?

Please let me know if I'm not making cense or if you have a good reason to do so.

Best regard,
Alex
Comment 1 Tomasz Zarna CLA 2013-06-17 08:31:11 EDT
Sounds reasonable to me, guys?
Comment 2 Steffen Pingel CLA 2013-06-17 10:35:13 EDT
The preference node used to be called 'Tasks' but we now seem to have settled on Mylyn. It makes sense to me to pull it up but we would probably need to introduce a new feature for others to consume it.
Comment 3 Alex Lagarde CLA 2013-06-17 10:41:10 EDT
Yep a new feature providing both the Preference Page category & the general help topic would be great !

Thanks a lot for your fast answer,
Alex
Comment 4 Sam Davis CLA 2013-06-19 16:35:15 EDT
Makes sense to me. Alex, are you interested in submitting a review with the proposed change?
Comment 5 Alex Lagarde CLA 2013-06-20 04:10:48 EDT
Of course, but I fear I don't know Mylyn good practices and sub-projects enough to make a good contribution without help :)

But if we decide together:
- if we should have only one plugin holding both Preference Page & doc entries or 2 (one for each) - basically this plugin would have the fewest dependencies possible so that contributing plugins do not have to rely on some mylyn UI plugin
- the name & location in git repository of this (these) plugin(s)

then I should be able to do it :)
In regards to builds, I'm only experienced with tycho, hope this is what you are using.

Thanks again,
Alex
Comment 6 Sam Davis CLA 2013-07-17 17:53:43 EDT
Let's consider this for 3.10.
Comment 7 Sam Davis CLA 2013-08-26 12:27:51 EDT
I'm afraid we probably won't be able to spend any time on this in the 3.10 release cycle since it will be a significant restructuring.

I think what we want here is:

* an o.e.m.commons.preferences plugin declaring the preference page
* an o.e.m.commons.help.ui plugin declaring the help
* an o.e.m.commons.integrations feature including both of the above plugins

Steffen, does that make sense to you?
Comment 8 Alex Lagarde CLA 2013-08-27 03:26:20 EDT
Hi Sam,

yes this is exactly what I had in mind.
Comment 9 Alex Lagarde CLA 2013-10-01 03:14:25 EDT
Hi everyone, 

any news on this subject ?

Best regards,
Alex
Comment 10 Sam Davis CLA 2013-10-03 20:45:44 EDT
This won't make it for 3.10 but we'll consider it for 3.11. It would be great if you took a look at how the existing projects are structured and submitted a review.
Comment 11 Alex Lagarde CLA 2013-10-04 03:15:00 EDT
Sure! Right now I'm in eclipse-con rush on Intent, but just after the conference I should have time to submit a review.
Comment 12 Sam Davis CLA 2013-10-04 11:34:56 EDT
That's great to hear!
Comment 13 Alex Lagarde CLA 2013-11-08 12:06:41 EST
Hey guys!

Just to let you know I'll start working on this next week, seems not too long.

Is the following still OK (quoting Sam previous message)?
* an o.e.m.commons.preferences plugin declaring the preference page
* an o.e.m.commons.help plugin declaring the help
* an o.e.m.commons.integrations feature including both of the above plugins

Best regards, 
Alex
Comment 14 Steffen Pingel CLA 2013-11-08 12:58:26 EST
(In reply to comment #13)

> Is the following still OK (quoting Sam previous message)?
> * an o.e.m.commons.preferences plugin declaring the preference page
> * an o.e.m.commons.help plugin declaring the help
> * an o.e.m.commons.integrations feature including both of the above plugins

Since that would be a separate component I would suggest to use a separate namespace as we have done for other components, i.e.:

* o.e.m.commons.preferences.ui plugin declaring the preference page
* o.e.m.commons.preferences.help plugin declaring the help
* o.e.m.commons.preferenes-feature  (feature ID being o.e.m.commons.preferenes) feature including both of the above plugins
Comment 15 Sam Davis CLA 2013-11-08 17:10:09 EST
Maybe I misunderstood, but I thought the help plugin would be to declare the top level help entry and neither it nor the feature were related to preferences.
Comment 16 Steffen Pingel CLA 2013-11-08 17:28:36 EST
(In reply to comment #15)
> Maybe I misunderstood, but I thought the help plugin would be to declare the top
> level help entry and neither it nor the feature were related to preferences.

Right. Then the component should be IDE?

•  o.e.m.commons.ide.ui plugin declaring the preference page
•  o.e.m.commons.ide-feature

Any reason we need a separate bundle for help and preference page?
Comment 17 Sam Davis CLA 2013-11-08 19:01:28 EST
No, I guess not. o.e.m.commons.ide.ui could have the preference page and the help.
Comment 18 Sam Davis CLA 2014-01-24 18:13:16 EST
Hi Alex, are you still planning to work on this? We're planning to do the RC build on Feb. 18.
Comment 19 Sam Davis CLA 2014-02-05 14:23:04 EST
I'm moving this to the backlog as it's getting late in the release cycle. We can still consider pulling it back on.