Re: [mylyn-dev] Mylyn Intent initial contribution : emf bridge for wikit

[alagarde <alex.lagarde@xxxxxxx>]

Hi David,
thanks for your reply.

ok for the plugins naming, we'll prefix our plugin with org.eclipse.mylyn.docs.intent.

But my question was concerning the emf bridge we wrote  for wikitext.

As explained in my previous message, this bridge :
- allows to represent any wikitext document as a model
- provides a set of Acceleo generators for creating HTML 5, Latex, PDF documents from this model

do you want this bridge to be a part of wikitext  :
- org.eclipse.mylyn.docs.wikitext.model.core
- org.eclipse.mylyn.docs.wikitext.model.gen
- org.eclipse.mylyn.docs.wikitext.model.test

or as part of intent :
- org.eclipse.mylyn.docs.intent.markup.model.core
- org.eclipse.mylyn.docs.intent.markup.model.gen
- org.eclipse.mylyn.docs.intent.markup.model.test

The plugin org.eclipse.mylyn.docs.intent.model.core already exists in Intent, and is used to describe the meta-model of an intent document.

I think it makes sense to go through an incubation phase, as several improvments, API changes and additional features are planned for the next months.

Alex

Le 16/02/2011 19:56, David Green a écrit :

Alex,

Great to hear that the Intent proposal is moving along.  The project looks great so far. I've CC'd the mylyn-dev mailing list in my response since this relates to the top-level Mylyn project.

The focus of the Intent proposal is clearly documentation - so it makes sense to me to have this in the Mylyn docs project.   As such, the initial contribution would likely go in the existing Mylyn docs Git repository.  Steffen you may have some input on this: willt the Intent project will have to go through an incubation phase?  

As for plug-in bundle naming, I'd like to see a prefix more like this: org.eclipse.mylyn.docs.intent.*   Usually we like to see a core/ui split as well, so you might see the following bundles:

org.eclipse.mylyn.docs.intent.model.core

org.eclipse.mylyn.docs.intent.model.ui

org.eclipse.mylyn.docs.intent.gen.core

org.eclipse.mylyn.docs.intent.gen.ui

What do you think?

David

On Wed, Feb 16, 2011 at 6:38 AM, alagarde <alex.lagarde@xxxxxxx> wrote:

Hello David,

first of all let me introduce myself : I'm Alex Lagarde, lead committer of the new Intent project (in proposal phase, see http://eclipse.org/proposals/mylyn.docs.intent/).

In a nutshell, Intent's purpose is to allow developers to easily write a documentation up-to-date with any development artifact (models, code, environment…). We hope to reconcile developers with doc, as we are convinced that it is an essential part of ALM. Meant to be released under Mylyn/docs, we have planned to integrate Intent with Mylyn (referencing Tasks inside doc, integrating Intent's documents inside a mylyn task...).

Intent's syntax mixes a wiki syntax (used to explain design choices in natural language) with a formal syntax dedicated to the definition of model fragments. We use the wikitext parser to implement this wiki syntax. In that context, we have created two plugins :

- org.eclipse.mylyn.wikitext.model : a plugin that uses the signals sent by the wikitext parser to build a model, instance of a generic "Markup" metamodel, that represents any document written using a Markup language. Any document that can be parsed with wikitext can be represented as an instance of the Markup metamodel. You can see this plugin as an emf bridge for wikitext.

- org.eclipse.mylyn.wikitext.model.gen : a plugin that contains a library of generators, taking a Markup model and generating HTML 5 documents, Latex documents, PDF documents... Those generators have been implemented using Acceleo (http://wiki.eclipse.org/Acceleo).

Notice that wikitext.model does not require wikitext.model.gen to work.

Initial contribution of Intent is approaching, and I contact you to determine the proper location for these 2 plugins :
- if you think they are interesting for wikitext, we will be glad to releases them as such. In that case, we would like to have at least one committer on these 2 plugins ;
- otherwise, they will be released in Intent (org.eclipse.mylyn.intent.markup.model and org.eclipse.mylyn.intent.markup.model.gen). Of course we will be able to move them later.

If you have any question about Intent, do not hesitate to contact me or check the wiki (http://wiki.eclipse.org/Intent).

Thanks,
Alex (http://twitter.com/#!/alex_lagarde, http://twitter.com/#!/Intent_project)

--

David Green

VP of Engineering, Tasktop

Committer, Eclipse Mylyn

http://tasktop.com 

+1-778-588-6896 ext. 115