Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [mylyn-docs-dev] Markup bridge from Wikitext to EMF: should we pull this up ?

Just created the bugzilla https://bugs.eclipse.org/bugs/show_bug.cgi?id=411880

Le 27/06/2013 19:09, David Green a écrit :
Alex,

On Thu, Jun 27, 2013 at 9:02 AM, Alex Lagarde <alex.lagarde@xxxxxxx> wrote:
Le 27/06/2013 17:48, David Green a écrit :
Alex,

By pulling the plug-in into Mylyn Docs do you mean into Mylyn WikiText or something else?
I meant the Mylyn Docs repository https://github.com/eclipse/mylyn.docs , so yep the WikiText project :)

Sounds good 

We would welcome any contributions that make it easier to augment the Mylyn WikiText generation capabilities.  Providing a way to generate EMF models and an easy way to use those with generators sounds great.  

With a contribution of this size introducing new technologies such as EMF, we'll have to consider things like general applicability, user features versus extensibility and API, documentation, testing and maintenance.
Yes of course, from now on the documentation is inexistant (but it would not take too much time to write, it should just contains a few usage examples).
We have some tests ran with the mylyn Intent build, but of course code coverage should be increased https://hudson.eclipse.org/hudson/job/mylyn-docs-intent-0.7-nightly/549/testReport/org.eclipse.mylyn.wikitext.textile.model.tests.unit.parsing/

In regards to API & maintenance, I wrote this bridge during my internship, although it works I would like to refactor it a bit.

That sounds good but we also need to think about how this would work long-term.  For example, who will fix bugs?  If changes/enhancements are made to the DocumentBuilder or other parts of Mylyn WikiText, how would that affect this component?
 

Notice that the plugin is not that big:
- markup bridge:  5 000 lines of code including more that 1500 lines of EMF-generated code http://nemo.sonarsource.org/drilldown/measures/397381?metric=ncloc&rids%5B%5D=397383).
- markup.gen (HTML & PDF generators): 1 500 lines of code including around 600 lines of EMF-generated code http://nemo.sonarsource.org/drilldown/measures/397381?metric=ncloc&rids%5B%5D=397384


~6500 lines of code is approximately 1/2 the size of wikitext.core, wikitext.ui and wikitext.textile.core combined, so a fairly large contribution.
 
And yes as the bridge introduces new dependencies, it would be better to embed it inside a new & separated feature in Wikitext.

Makes sense.
 


 I'd love to see a more concrete description and proposal so that we can explore further.

Ok do you want me to file a bugzilla? I don't want to "force" this integration, the fact that it is in Mylyn Intent code suits me well, I just thought that it could interest other people.

Yes, filing a bug/enhancement for this is the right way to go.  It'll be a good spot to focus interest, define the nature of the contribution and see if there's community support for it.

I look forward to seeing this evolve!

Alex
 

Best regards,
Alex


David

On Thu, Jun 27, 2013 at 8:28 AM, Alex Lagarde <alex.lagarde@xxxxxxx> wrote:
Hi guys,

for Mylyn Intent we had to develop a bridge allowing to represent Wikitext-parsable content as EMF models (more details here http://t.co/pCAi3aGYVO).

This is a work in progress, an it has not been heavily used so it probably still  contains bugs, but I think it would make cense to pull this plugin (and maybe markup.gen, which contains HTML & LaTeX generators based on these EMF models) in mylyn.docs.

Then we could work together on the Metamodel and on the parser so that it can fulfil all the community needs (e.g. https://bugs.eclipse.org/bugs/show_bug.cgi?id=409694#c5).

The main benefit that I see is that we could easilly write generators allowing to go from Wikitext to any langage. For instance I love the LaTeX rendering, but always have a hard time writing LaTeX documents. If I could write my doc in textile and get a nice LaTeX-based PDF export I'll be glad :)

Best regards,
Alex


_______________________________________________
mylyn-docs-dev mailing list
mylyn-docs-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/mylyn-docs-dev



--
David Green
VP of Architecture, Tasktop
Committer, Eclipse Mylyn



_______________________________________________
mylyn-docs-dev mailing list
mylyn-docs-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/mylyn-docs-dev


_______________________________________________
mylyn-docs-dev mailing list
mylyn-docs-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/mylyn-docs-dev




--
David Green
VP of Architecture, Tasktop
Committer, Eclipse Mylyn
+1-778-588-6896 ext. 115



_______________________________________________
mylyn-docs-dev mailing list
mylyn-docs-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/mylyn-docs-dev


Back to the top