Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 348298

Summary: [api] provide a way to construct richtext task descriptions
Product: z_Archived Reporter: Benjamin Muskalla <b.muskalla>
Component: MylynAssignee: Project Inbox <mylyn-triaged>
Status: CLOSED MOVED QA Contact:
Severity: enhancement    
Priority: P3 CC: greensopinion
Version: unspecified   
Target Milestone: ---   
Hardware: PC   
OS: Linux   
Whiteboard:
Bug Depends on: 357294    
Bug Blocks:    
Attachments:
Description Flags
mylyn/context/zip none

Description Benjamin Muskalla CLA 2011-06-04 07:22:07 EDT 
We should investigate if it's possible to provide a rich text description for a task based on a build in case the task connector supports the notation of a rich description.

Eg create a new task from a failed build
* connector supports richtext/wikitext: provide build description as html/wikitext
* connector supports plain text: do the same as now

From a quick look, this means we would need to extend the TaskMapper and TaskMapping by a new flavor of description (eg. richDescription) and let the taskmapper decide (depending on the attribute type) which description to use (and fallback).
Comment 1 Steffen Pingel CLA 2011-06-09 10:58:09 EDT 
That's an interesting suggestion. I would think that we would need a sort of dom to describe a rich text document that is then converted to the repository (markup) specific representation. David, does WikiText already have an API to facilitate that type of conversion?
Comment 2 David Green CLA 2011-06-14 14:39:19 EDT 
(In reply to comment #1)
> ...David, does WikiText already have an API to facilitate that type of conversion?

WikiText is specifically designed to do conversion: when parsing wiki markup it sends events to a @DocumentBuilder@.  All that is needed to convert to something else is a concrete DocumentBuilder that can emit the desired output (we currently have these for HTML, DocBook, DITA, XSL-FOP).   What is the desired output format?
Comment 3 Steffen Pingel CLA 2011-06-16 06:24:02 EDT 
That looks promising. The desired output format would be anything supported by task repositories such as wiki markup, html or plain text.
Comment 4 David Green CLA 2011-06-16 19:49:16 EDT 
(In reply to comment #3)
> That looks promising. The desired output format would be anything supported by
> task repositories such as wiki markup, html or plain text.

Once a specific output format is selected, all that is needed is the appropriate DocumentBuilder that can emit that output.  Also needed is something to drive the DocumentBuilder interface (for example, we have a wiki markup parser for Textile, MediaWiki, Confluence, TracWiki and TWiki).  Presumably anything could drive the interface (such as an HTML parser) enabling conversion from one format to another.
Comment 5 David Green CLA 2011-11-17 00:40:31 EST 
The required API is now there for both Textile (used at Eclipse.org, and default for Bugzilla repositories) and Confluence (JIRA), developed on bug 357294.  See @org.eclipse.mylyn.wikitext.core.parser.markup.MarkupLanguage.createDocumentBuilder(Writer)@.  For repositories that use HTML or XHTML content, there is @HtmlDocumentBuilder@.
Comment 6 David Green CLA 2011-11-17 00:41:37 EST 
Created attachment 207124 [details]
mylyn/context/zip
Comment 7 Eclipse Webmaster CLA 2022-11-15 11:45:08 EST 
Mylyn has been restructured, and our issue tracking has moved to GitHub [1].

We are closing ~14K Bugzilla issues to give the new team a fresh start. If you feel that this issue is still relevant, please create a new one on GitHub.

[1] https://github.com/orgs/eclipse-mylyn