Hi,
Tycho is typically Manifest-first: all the information which already exists in the Manifest is (automatically) translated to Maven at build time. So I suppose that’s something Tycho should do, if it doesn’t already.
Eclipse relies only on the Manifest at development time and runtime, so the information needs to be there.
In the specific case of bundle-description, I’m not sure it is displayed anywhere (I found the feature description but didn’t see anything related to plug-in
information in Eclipse. I may have missed it)
Camille
De : mdt-papyrus.dev-bounces@xxxxxxxxxxx [mailto:mdt-papyrus.dev-bounces@xxxxxxxxxxx]
De la part de Christian W. Damus
Envoyé : mercredi 14 janvier 2015 14:50
À : Papyrus Project list
Objet : Re: [mdt-papyrus.dev] Rip Pdoc
Hi,
It sounds like there is value in having the plug-in’s description in both the POM and the bundle manifest. The latter supports translation into multiple languages for users to read in their language of choice. Presumably the POM would
not need translation because we would only publish the maven site in one language (where would it be published, and why?).
But, I assume that we don’t want to maintain this information in duplicate, so could we implement something in the maven site generation that grabs the default translation of the description from the bundle manifest (plugin.properties)?
Perhaps Tycho already provides a solution?
I will still make the migration to get rid of pdoc as described in the bug.
But we will discuss this specific point in the next task “Generate site documentation with maven”.
May I have additional elements?
Why not use the description element
in the pom.xml?
“A detailed description of the project, used by Maven whenever it needs to describe
the project, such as on the web site. While this element can be specified as CDATA to enable the use of HTML tags within the description, it is discouraged to allow plain text representation. If you need to modify the index page of the generated web site,
you are able to specify your own instead of adjusting this text.
So we can generate better automatically site descriptor? And not duplicate basic documentation location.
I think we have to keep documentation as closed as possible to the artifact/plugin element and not to duplicate it across several place.
I could investigate more time on how to use the maven template project (mainly src/site with the site descriptor and the xdoc) ?
The key idea will be how to generate the actual site directly in the eclipse media wiki.
I will try to do it for the emfgen plugin (still in my branch, I will cherry peak it in the week).
Now I feel silly for having diligently added pdoc files to all of the new plug-ins I have contributed in Luna and Mars releases … ;-)
There is currently a sub project called “pdoc” in Papyrus.
It was intended to add some description for each plugins but was never widely used (less than 30 plugins).
The plugins are still in developer directory and are not deployed, a newcomer
won’t understand what these files are for.
I believe that we should use the Bundle-Description properties and add other information in the pom.xml.
(I already talked about that with most of the team)
So here are the next steps (for mars):
o The
description in pdoc will be moved to MANIFEST.MF\Bundle-Description
- Add
a text in the wiki to explain all of that.
If anyone is against it, “speak now or forever hold your peace” J
_______________________________________________
mdt-papyrus.dev mailing list
mdt-papyrus.dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/mdt-papyrus.dev
|
