Project Plan For WTP Source Editing, version Helios

Introduction

The Source Editing project is a sub-project in the Eclipse WTP top level Project. Its main goal is to provide source editing support for typical "web" languages and the mixing of them, with a focus on making the editors extensible and easily reusable. This document describes the features and the API set in the Source Editing subproject for the WTP 3.2 release.

Release Deliverables

  • Source code for deliverables tagged in CVS as version tagged "R3_2_0", viewable in the WebTools_Project CVS repository .

Table of Contents

Release Milestones

Source Editing adheres to the overall WTP Milestones .

Table of Contents

Target Environments

WTP will support the platforms certified by the Eclipse Platform project for their 3.6 release. For a list of platforms supported in WTP 3.2, see Eclipse Target Operating Environments .

Internationalization

Internationalization and Localization will be supported.

Table of Contents

Compatibility with Previous Releases

Table of Contents

Themes and Priorities

Themes and their priorities communicate the main objectives of the project and their importance. These will be prioritized based on the community feedback. New themes could be synthesized from the requirements submitted by the community.

The sections to follow defines the plan items in the Source Editing project. The plan items are grouped under the respective themes where applicable. Each plan item corresponds to a new feature, API or some apsects of the project that needs to be improved. A plan item has an entry in the Eclipse Bugzilla system that has a detailed description of the plan item. Not all plan items represent the same amount of work; some may be quite large, others, quite small. Although some plan items are for work that is more pressing than others, the plan items appear in no particular order. See the corresponding bugzilla items for up-to-date status information on ongoing work and planned delivery milestones.

Ease of Use

Features provided by WTP should be simple to use for users with widely-varying backgrounds and skill sets.

  • WTP User Interface should be consistent and should follow the Eclipse User Experience Guidelines. Experienced Eclipse users should find few, if any, unpleasant surprises or omissions in the UI.
  • Usability and Accessibility reviews should be done for the most common task flows. Cheat Sheets should be provided to assist users in performing tasks.
  • WTP should provide enhanced user documentation, tutorials, white papers, demonstrations.

Ease of Use plan items are designated with "EaseOfUse" in the Status Whiteboard and the "plan" keyword.

  • Committed
    • [UI] XML editor's design page should use table columns for a more native feel [271844] (target milestone: 3.2 M4)
    • Register jsp to web.xml is not user friendly [242240] (target milestone: 3.2 M6)
  • Proposed
    • No items.
  • Deferred
    • [Graphical Editor, Properties] Provide better support for editing complex types with simple content [251555] (target milestone: Future)

Scaling Up

Source Editing must be able to deal with development and deployment on an increasingly larger and more complex scale. WTP should spend focused effort on performance testing and improvement when dealing with extremely large projects and workspaces, particularly where extensibility is offered.

Scaling Up plan items are designated with the "plan" and "performance" keywords together.

  • Committed
    • Code folding inefficient and broken [281380] (target milestone: 3.2 M2)
    • Content model validation utility fails to handle large size documents [294896] (target milestone: 3.2 M4)
  • Proposed
    • No items.
  • Deferred
    • No items.

Design for Extensibility

The 'P' in WTP stands for Platform, meaning Source Editing can be used by adopters to extend its functionality. This theme is about continuing to ensure the success of its adopters by promoting new API's and Extension points. These should be backed with robust Junit tests and good documentation.

Design for Extensibility plan items are designated with the "plan" and "api" keywords together.

  • Committed
    • Taglib index unit tests are unstable [213754] (target milestone: 3.2)
    • [editor] Offer extension for "Toggle Comment" command [246636] (target milestone: 3.2)
    • Javadoc incorrectly states that TaglibIndexListeners are non-API [279998] (target milestone: 3.2 M1)
    • [editor] Add Extension point for Content Assist [259721] (target milestone: 3.2 M3)
    • [api] Non-validation annotations for the StructuredTextEditor [247221] (target milestone: 3.2 M4)
    • [Extensibility] Provide extensibility in the refactoring context menu [253264] (target milestone: 3.2 M6)
  • Proposed
    • No items.
  • Deferred
    • [Extensibility] Provide an extension point for alternate graphical views [252048] (target milestone: Future)
    • SSE SourceParser Interfaces should be made API and documented [270708] (target milestone: Future)

Quality

Source Editing is one of the most heavily used projects within WTP and carries a correspondingly weighty bug report list because of it. Items under this theme are meant to address the backlog of bug reports not concerning performance and is not to include enhancements. It is expected that these require a significant enough amount of time to merit inclusion within the plan. Items under this theme are only to be chosen by Committers.

Quality plan items are designated with the "plan" keyword and "qplan" within the status whiteboard.

  • Committed
    • [editor] toggle comment always uses <!-- --> [86520] (target milestone: 3.2)
    • [validation] JSP parser : <%= true // comment %> is validated as a correct expression [238385] (target milestone: 3.2)
    • [validation] Form and form fields cannot be resolved [240134] (target milestone: 3.2)
    • [content assist] Duplicate page directive imports added by content assist [237775] (target milestone: 3.2 M3)
  • Proposed
    • No items.
  • Deferred
    • No items.

Everything

Following are plan items including those not yet categorized into a theme.
  • Committed
    • [editor] toggle comment always uses <!-- --> [86520] (target milestone: 3.2)
    • Taglib index unit tests are unstable [213754] (target milestone: 3.2)
    • Formatting of HTML loses indentation [122051] (target milestone: 3.2)
    • [validation] JSP parser : <%= true // comment %> is validated as a correct expression [238385] (target milestone: 3.2)
    • [validation] Form and form fields cannot be resolved [240134] (target milestone: 3.2)
    • [editor] Offer extension for "Toggle Comment" command [246636] (target milestone: 3.2)
    • Need Content Assistance for XSLT 2.0 [287500] (target milestone: 3.2)
    • Javadoc incorrectly states that TaglibIndexListeners are non-API [279998] (target milestone: 3.2 M1)
    • Code folding inefficient and broken [281380] (target milestone: 3.2 M2)
    • [content assist] Duplicate page directive imports added by content assist [237775] (target milestone: 3.2 M3)
    • [editor] Add Extension point for Content Assist [259721] (target milestone: 3.2 M3)
    • [xpath2] Make sure PsychoPath XPath 2.0 processor passes W3C Test Suite [262765] (target milestone: 3.2 M4)
    • [api] Non-validation annotations for the StructuredTextEditor [247221] (target milestone: 3.2 M4)
    • [UI] XML editor's design page should use table columns for a more native feel [271844] (target milestone: 3.2 M4)
    • Content model validation utility fails to handle large size documents [294896] (target milestone: 3.2 M4)
    • Include Java EE 6 XML Schema files [262038] (target milestone: 3.2 M5)
    • [XSD Editor] Screen reader cannot read schema objects when selected by keyboard [271496] (target milestone: 3.2 M5)
    • [xpath] Need to enhance the XPath View to support XPath 2.0 [297975] (target milestone: 3.2 M5)
    • [Extensibility] Provide extensibility in the refactoring context menu [253264] (target milestone: 3.2 M6)
    • Register jsp to web.xml is not user friendly [242240] (target milestone: 3.2 M6)
    • Migrate XSL Syntax Highlighting to Semantic Highlighting [256339] (target milestone: 3.2 M6)
    • [Editor] Dialogs missing keyboard mnemonics [271504] (target milestone: 3.2 M6)
    • [patch] [XML Catalog] Add full XML Catalog UI support in Preferences [273402] (target milestone: 3.2 M6)
    • [explorer] WebContent folder has JavaScript decorator [274550] (target milestone: 3.2 M6)
  • Proposed
    • No items.
  • Deferred
    • React to content type changes in EMF and XSD [226967] (target milestone: Future)
    • [Graphical Editor, Properties] Provide better support for editing complex types with simple content [251555] (target milestone: Future)
    • SSE Undo stack different from standard operation history [191754] (target milestone: Future)
    • [Extensibility] Provide an extension point for alternate graphical views [252048] (target milestone: Future)
    • [Search] Provide reusable XSD component selection dialogs [256465] (target milestone: Future)
    • SSE SourceParser Interfaces should be made API and documented [270708] (target milestone: Future)

Table of Contents

Appendix References

  • The general WTP plan can be found here .

Table of Contents