Difference between revisions of "Mylyn/SOC/A Wiki Integrated Task Editor"

From Eclipsepedia

< Mylyn‎ | SOC
Jump to: navigation, search
(Abstract)
(Hackers)
 
(47 intermediate revisions by one user not shown)
Line 1: Line 1:
 
== Hackers ==
 
== Hackers ==
Student: [http://www.cs.ubc.ca/~jingweno/ Jingwen Ou]
+
Student: [http://owenou.com/ Jingwen Ou]
  
 
Mentor(s): Steffen Pingel
 
Mentor(s): Steffen Pingel
  
 
== Abstract ==
 
== Abstract ==
This project is part of [http://code.google.com/soc/2008/ Google Summer of Code 2008]. It is formally renamed as '''WikiText'''.
+
[http://wiki.eclipse.org/Mylyn/Incubator/WikiText WikiText] is a new component of Mylyn, supporting [http://en.wikipedia.org/wiki/Lightweight_markup_language lightweight markup language] for its task editor. The goal is to provide Mylyn’s task editor with rich text viewing and editing of markup dialects such as Textile and MediaWiki. Detailed proposal is available [http://www.cs.ubc.ca/~jingweno/soc/SoC2008.pdf here].  
  
The goal is to extend Mylyn’s task editor to provide generic wiki integration, supporting offline rich text editing with syntax highlight, auto-complete, structure outline and rich text preview. The basic mechanism is a source code parser that renders wiki syntax into HTML. Inputted with wiki code and an URL of the wiki system, the parser elegantly translates them into HTML before they are posted to the issue tracking systems. When displayed, any internal links of the bug reports will be directed to correspondent wiki systems.
+
This project is part of [http://code.google.com/soc/2008/eclipse/appinfo.html?csaid=CE8223F432E4EBF4 Google Summer of Code 2008].
 
+
Detailed proposal is available here: [http://www.cs.ubc.ca/~jingweno/soc/SoC2008.pdf http://www.cs.ubc.ca/~jingweno/soc/SoC2008.pdf].
+
  
 
== Timeline ==
 
== Timeline ==
Here is a complete list of the milestones and release dates. Considering the status of Mylyn's ongoing refactoring, the date is subject to change.
+
Here is a complete list of the milestones and release dates.
  
A bug that summarizes all the tasks: {{bug|233819}}.
+
{{bug|233819}} is the root bug for this project. The following is a list of selected bugs. A complete list is available [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&classification=Tools&product=Mylyn&long_desc_type=allwordssubstr&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=&emailassigned_to1=1&emailreporter1=1&emailcc1=1&emaillongdesc1=1&emailtype1=substring&email1=jingweno%40cs.ubc.ca&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&field0-0-0=noop&type0-0-0=noop&value0-0-0= here].
  
{| class="wikitable" style="text-align:center"
+
<table border="0" cellspacing="3" cellpadding="2">
|- style="background:#efefef;"
+
<tr align="center" bgcolor="#595791">
! Milestone !! Deadline !! Planned items !! Related bugs
+
<td><font color="#FFFFFF"><b>Milestone</b></font></td>
|- style="background:lightgrey;"
+
<td><font color="#FFFFFF"><b>Date</b></font></td>
! M1
+
<td><font color="#FFFFFF"><b>Planned items</b></font></td>
| June 8
+
<td><font color="#FFFFFF"><b>Related bugs</b></font></td>
| Textile-J integration
+
</tr>
| {{bug|234210}}
+
<tr align="center" bgcolor="#faf7fb">
|- style="background:lightgrey;"
+
<td>M1</td>
! M2
+
<td>June 8, 2008</td>
| June 29
+
<td>Textile-J integration</td>
| rich text integration  
+
<td>{{bug|234210}}</td>
| {{bug|235222}}, {{bug|237131}}. {{bug|237504}}, {{bug|203670}}, {{bug|194269}}
+
</tr>
|- style="background:lightgrey;"
+
<tr align="center" bgcolor="#e0d0e6">
! M3
+
<td>M2</td>
| July 13
+
<td>June 29, 2008</td>
| drop & drag of the source element to the task editor  
+
<td>rich text integration</td>
| {{bug|237831}}, {{bug|237974}}
+
<td>{{bug|235222}}, {{bug|237131}}. {{bug|237504}}, {{bug|203670}}, {{bug|194269}},
|- style="background:lightgrey;"
+
{{bug|236962}}, {{bug|241167}}, {{bug|213131}}, {{bug|219939}}, {{bug|236962}}</td>
! M4
+
</tr>
| July 27
+
<tr align="center" bgcolor="#faf7fb">
| configuration setting of the rich text editor  
+
<td>M3</td>
| {{bug|237500}}, {{bug|237678}}, {{bug|235439}}
+
<td>July 13, 2008</td>
|- style="background:lightgrey;"
+
<td>drop &amp; drag of the source element to the task editor</td>
! M5
+
<td>{{bug|237831}}, {{bug|237974}}, {{bug|239087}}</td>
| August 4
+
</tr>
| structure outline, code format & spell checking  
+
<tr align="center" bgcolor="#e0d0e6">
| this item may be canceled
+
<td>M4</td>
|- style="background:lightgrey;"
+
<td>July 27, 2008</td>
! RC1
+
<td>configuration setting of the rich text editor</td>
| August 10
+
<td>{{bug|237500}}, {{bug|237678}}, {{bug|235439}}</td>
| critical bugs, performance improvement  
+
</tr>
| {{bug|238038}}, {{bug|116487}}
+
<tr align="center" bgcolor="#faf7fb">
|- style="background:lightgrey;"
+
<td>M5</td>
! RC2
+
<td>August 18, 2008</td>
| August 15
+
<td>structure outline, code format &amp; spell checking</td>
| documentation
+
<td>{{bug|242977}}</td>
|
+
</tr>
|- style="background:lightgrey;"
+
<tr align="center" bgcolor="#e0d0e6">
! Pencils down
+
<td>RC1</td>
| August 18
+
<td>Auguest 10, 2008</td>
| final evaluations
+
<td>related bugs, performance improvement</td>
|
+
<td>{{bug|238038}}, {{bug|116487}}, {{bug|203670}}, {{bug|239087}}, {{bug|237831}},
|}
+
{{bug|134165}}</td>
 +
</tr>
 +
<tr align="center" bgcolor="#faf7fb">
 +
<td>RC2</td>
 +
<td>August 15, 2008</td>
 +
<td>documentation</td>
 +
<td>http://wiki.eclipse.org/Mylyn/SOC/A_Wiki_Integrated_Task_Editor</td>
 +
</tr>
 +
<tr align="center" bgcolor="#e0d0e6">
 +
<td>Pencils down</td>
 +
<td>August 18, 2008</td>
 +
<td>final evaluations</td>
 +
<td>&nbsp;</td>
 +
</tr>
 +
</table>
  
 
== Getting the source ==
 
== Getting the source ==
  
Here is the [http://wiki.eclipse.org/Image:WikiText.psf team project set] to get all the source code. All new features would be available in Mylyn 3.1. Stay tuned...
+
Please refer to [http://wiki.eclipse.org/index.php/Mylyn/Contributor_Reference#Checkout this page] to get all the source code. New features will be shipped with [http://wiki.eclipse.org/Mylyn/Plan/3.1 Mylyn 3.1] in December, 2008. Stay tuned...
  
 
== WikiText "Trailers" ==
 
== WikiText "Trailers" ==
All available features will be listed here.
 
  
{| style="width:75%;
+
<table cellpadding="10" cellspacing="0">
|- valign="top"
+
<tr>
| '''Screen shot of Mylyn's Bugzilla task editor with wiki styles'''
+
<td align="left" valign="top" width="20%" bgcolor="#E0D0E6">
|| Developers can organize their comments and bug descriptions in a wiki way. WYSIWYG is not a dream anymore in Mylyn's task editor.
+
<p align="right"><b>Rich Text Editing</b></p>
 +
</td>
 +
<td valign="top" width="80%">
 +
<p align="left">New comments can now be typed in a WYSIWYG way. The formatting
 +
will appear as typing goes and be rendered with a stylesheet.</p>
 +
<p>[[Image:Wikitext_rich_text_editing.PNG]]</p><br>
 +
<hr> <br>
 +
<p align="left">Users don’t have to remember any syntax with the help of content assist.</p>
 +
<p>[[Image:Wikitext_content_assist.PNG]]</p>
 +
</td>
 +
</tr>
 +
 
 +
        <tr>
 +
<td colspan="2"><hr></td>
 +
</tr>
 +
 
 +
<tr>
 +
<td align="left" valign="top" width="20%" bgcolor="#E0D0E6">
 +
<p align="right"><b>Rich Text Viewing</b></p>
 +
</td>
 +
<td valign="top" width="80%">
 +
<p align="left">New comments can be previewed before posting.</p>
 +
<p>[[Image:Wikitext_rich_text_viewing.PNG]] </p><br><hr> <br><p>Comments are
 +
viewed in rich text formatting. </p><p>[[Image:Wikitext_rich_text_viewing2.PNG]]</p>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2"><hr></td>
 +
</tr>
 +
 
 +
<tr>
 +
<td align="left" valign="top" width="20%" bgcolor="#E0D0E6">
 +
<p align="right"><b>Dialects Switching</b></p>
 +
</td>
 +
<td valign="top" width="80%">
 +
<p align="left">Use your favorite dialects in current repository.</p>
 +
<p>[[Image:Wikitext_selecting_markup.PNG]]</p>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2"><hr></td>
 +
</tr>
 +
 
 +
<tr>
 +
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
 +
<p align="right"><b>Maximization of New Comment Textarea</b></p>
 +
</td>
 +
<td valign="top" width="70%">
 +
<p align="left">Press to maximize the text area.</p>
 +
<p>[[Image:Wikitext_maximise_editor.PNG]]</p>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2"><hr></td>
 +
</tr>
 +
 
 +
<tr>
 +
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
 +
<p align="right"><b>Support of Drop &amp; Drag (Beta)</b></p>
 +
</td>
 +
<td valign="top" width="70%">
 +
<p align="left">Drop any source elements to the task editor instead of typing
 +
their long names.</p>
 +
<p>[[Image:Wikitext_drop_and_drag1.PNG]]</p> <p>[[Image:Wikitext_drop_and_drag2.PNG]]</p>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2"><hr></td>
 +
</tr>
 +
<tr>
 +
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
 +
<p align="right"><b>Dynamic Comment Groupings (Beta)</b></p>
 +
</td>
 +
<td valign="top" width="70%">
 +
<p align="left">Group all the comments after your last comment in the &quot;Current&quot;
 +
section and always expand the section for you.</p>
 +
<p>[[Image:Wikitext_grouping_comments.PNG]]</p>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2"><hr></td>
 +
</tr>
  
[[Image:WikiText_preview.PNG]]
+
<tr>
 +
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
 +
<p align="right"><b>Task Editor Find (Beta)</b></p>
 +
</td>
 +
<td valign="top" width="70%">
 +
<p align="left">Find &amp; highlight the keywords instead of looking for information
 +
by eyes.</p>
 +
<p>[[Image:Wikitext_find.PNG]]</p>
 +
</td>
 +
</tr>
 +
</table>
  
|}
+
== Related Links ==
 +
* http://tasktop.com/blog/?p=37
 +
* http://greensopinion.blogspot.com/2008/08/textile-j-is-moving-to-mylyn-wikitext.html
 +
* http://www.osbr.ca/ojs/index.php/osbr/article/view/800/771 (this project is named as one of the success stories in the Google Summer of Code program)

Latest revision as of 20:45, 7 April 2011

Contents

[edit] Hackers

Student: Jingwen Ou

Mentor(s): Steffen Pingel

[edit] Abstract

WikiText is a new component of Mylyn, supporting lightweight markup language for its task editor. The goal is to provide Mylyn’s task editor with rich text viewing and editing of markup dialects such as Textile and MediaWiki. Detailed proposal is available here.

This project is part of Google Summer of Code 2008.

[edit] Timeline

Here is a complete list of the milestones and release dates.

bug 233819 is the root bug for this project. The following is a list of selected bugs. A complete list is available here.

Milestone Date Planned items Related bugs
M1 June 8, 2008 Textile-J integration bug 234210
M2 June 29, 2008 rich text integration bug 235222, bug 237131. bug 237504, bug 203670, bug 194269, bug 236962, bug 241167, bug 213131, bug 219939, bug 236962
M3 July 13, 2008 drop & drag of the source element to the task editor bug 237831, bug 237974, bug 239087
M4 July 27, 2008 configuration setting of the rich text editor bug 237500, bug 237678, bug 235439
M5 August 18, 2008 structure outline, code format & spell checking bug 242977
RC1 Auguest 10, 2008 related bugs, performance improvement bug 238038, bug 116487, bug 203670, bug 239087, bug 237831, bug 134165
RC2 August 15, 2008 documentation http://wiki.eclipse.org/Mylyn/SOC/A_Wiki_Integrated_Task_Editor
Pencils down August 18, 2008 final evaluations  

[edit] Getting the source

Please refer to this page to get all the source code. New features will be shipped with Mylyn 3.1 in December, 2008. Stay tuned...

[edit] WikiText "Trailers"

Rich Text Editing

New comments can now be typed in a WYSIWYG way. The formatting will appear as typing goes and be rendered with a stylesheet.

Wikitext rich text editing.PNG




Users don’t have to remember any syntax with the help of content assist.

Wikitext content assist.PNG


Rich Text Viewing

New comments can be previewed before posting.

Wikitext rich text viewing.PNG




Comments are viewed in rich text formatting.

Wikitext rich text viewing2.PNG


Dialects Switching

Use your favorite dialects in current repository.

Wikitext selecting markup.PNG


Maximization of New Comment Textarea

Press to maximize the text area.

Wikitext maximise editor.PNG


Support of Drop & Drag (Beta)

Drop any source elements to the task editor instead of typing their long names.

Wikitext drop and drag1.PNG

Wikitext drop and drag2.PNG


Dynamic Comment Groupings (Beta)

Group all the comments after your last comment in the "Current" section and always expand the section for you.

Wikitext grouping comments.PNG


Task Editor Find (Beta)

Find & highlight the keywords instead of looking for information by eyes.

Wikitext find.PNG

[edit] Related Links