Project Plan For Intent, version 0.8

Introduction

Mylyn Intent is an open source documentation environment, that allows you to keep your doc synchronized with any development artifact (Source code, Models, Dependencies...) while being customizable for your development processes (domain specific constraints, syntax or tools...).

Release Deliverables

  • Mylyn Intent : Intent generic components and authoring environment (editor, compiler, synchronizer...). Notice that it can be used in RCP mode as it is independant from core.resources
  • Mylyn Intent - Workspace support: Required to make Intent work on an Eclipse workspace (specific views, project wizards...)
  • Mylyn Intent - CDO support: Required to make Intent work on a CDO repository (specific views, project wizards...)
  • Mylyn Intent Connector: Java: allows to directly drop java files/classes/methods inside an Intent doc an synchronize them
  • Doc generators For Wikitext : A set of generators for Wikitext documents (Latex, html...)
  • Doc generators For Intent document : A set of generators allowing to export an Intent Project to several formats (HTML Bootstrap...)

Table of Contents

Release Milestones

Mylyn Intent 0.8 is part of the Mylyn Docs 1.8, which is part of the Mylyn 3.9 release. Please refer to the Mylyn plan for release milestones.
0.8 RC12013-05-22
Mylyn Intent 0.8 - Release candidate (API and Feature Complete)
0.8 RC12013-05-29
Mylyn Intent 0.8 - Release candidate
0.8 RC12013-06-05
Mylyn Intent 0.8 - Release candidate (API Freeze)
0.8 RC12013-06-12
Mylyn Intent 0.8 - Release candidate (Final Build)
0.8 RC12013-06-26
Mylyn Intent 0.8 - Major release

Table of Contents

Target Environments

Mylyn Docs follows the target environment guidelines of the Mylyn project.

Internationalization

Mylyn Docs follows the internationalization guidelines of the Mylyn project.

Table of Contents

Compatibility with Previous Releases

As Intent is still in incubation, there are some API changes since the 0.7 release to handle new features

Table of Contents

Themes and Priorities

The main priority for Intent 0.8 is to provide the miminal set of features allowing to document java code, and provide a good end-user experience (completion, syntax highliting, real-time preview, exports...).

Stability and performances

Although Intent 0.8 will not be perfect in regards to those concerns, we have improved stability and performances.

Improve end-user experience

Improve the end-user experience by: Integration with EMFCompare 2 to improve sync. issues display (https://bugs.eclipse.org/bugs/show_bug.cgi?id=395458) Minor UI features (link with editor mechanism, improved preference page, better syntax highliting and completion...) Provide an 'Intent preview' view allowing to get real-time HTML boostrap preview of the currently opened Intent doc part

Java bridge for Intent

We have provided a new feature allowing to directly drop java files/classes/methods inside an Intent section. You can then use ctrl+click to open a java editor on those elements, get sync. issues in real-time. Each reference is displayed using an Image showing the element and its javadoc (customizable).

Table of Contents