Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Mylyn/Incubator/WikiText/ReleaseReview"
m (→Architecture) |
m (→Tests) |
||
Line 136: | Line 136: | ||
WikiText uses JUnit tests to verify correctness. Currently the test suite consists of aproximately 430 JUnits. All of these are passing. | WikiText uses JUnit tests to verify correctness. Currently the test suite consists of aproximately 430 JUnits. All of these are passing. | ||
− | Code coverage of core framework classes is excellent. Every markup language notation has at least one JUnit test. Recent changes to the build structure and IP rules have caused code coverage measurements to be ceased, however coverage reports would look something like this: [https://textile-j.dev.java.net/builds/net.java.textilej/2.2.864/coverage/frame-summary.html Textile-J Coverage Report] | + | Code coverage of core framework classes is excellent. Every markup language notation has at least one JUnit test. |
+ | |||
+ | UI tests are lacking. | ||
+ | |||
+ | Recent changes to the build structure and IP rules have caused code coverage measurements to be ceased, however coverage reports would look something like this: [https://textile-j.dev.java.net/builds/net.java.textilej/2.2.864/coverage/frame-summary.html Textile-J Coverage Report] | ||
== Dependencies == | == Dependencies == |
Revision as of 01:51, 30 December 2008
DRAFT
Contents
Release Review
A release review must occur for Mylyn/Incubator/WikiText to come out of incubation. This page provides materials for discussion related to the release review.
User Interface
This section is provided as the basis for discussion around the User Interface of Mylyn/Incubator/WikiText. The UI portion of the release review is tracked with bug 257593.
UI Summary
WikiText provides the following UI components:
- Eclipse preferences page
- Context menu contributions
- File editor with outline
- TaskEditorExtension implementation
WikiText Editor
The WikiText editor is enabled for all files whose content type extends wikitext.
Editor Overview
- fonts show how markup will render
- content assist
- markers for warnings and errors
Editor Outline
- editor has outline view that shows headings
- outline selection follows caret position in the editor
- outline is always expanded
Content Assist
- editor content-assist suggestions are adjusted depending on cursor position
Editor Preview
- editor has tabs at the bottom
- the Preview tab shows a rendered version of the markup using the browser
Editor And Markers
- editor uses markers
- markers of course are visible in navigator views, in the editor and in the problems view
Editor Context Menu
- editor uses context menu for setting markup language to a non-default value
- setting is persisted
Cheat Sheet
- pressing 'F1' in the editor causes the cheat-sheet pop-up to be displayed
- cheat-sheet is specific to the markup language setting of the editor
- pressing the question mark help icon at the bottom of the pop-up causes WikiText help to be displayed
Workspace Preferences
- workspace preferences are available for setting fonts/styles in the editor
- shown with context-help visible
Workspace
WikiText Files
- have the content-type 'wikitext'
- have an icon
Context Menus
- available for converting wikitext files to HTML, DocBook, Eclipse Help
- on wikitext files only
Project Settings
- for enabling wikitext validation
Task Editor Extension
WikiText provides a task editor extension for each markup language
Repository Settings
- each option in the the 'editor' section is contributed by WikiText
Task Editor
- the task editor behaves much the same as the wikitext editor with the extension enabled
Preview
- editor preview is rendered by a StyledText
Architecture
API
Parser
Tests
WikiText uses JUnit tests to verify correctness. Currently the test suite consists of aproximately 430 JUnits. All of these are passing.
Code coverage of core framework classes is excellent. Every markup language notation has at least one JUnit test.
UI tests are lacking.
Recent changes to the build structure and IP rules have caused code coverage measurements to be ceased, however coverage reports would look something like this: Textile-J Coverage Report
Dependencies
Core
- note that many of the WikiText classes are usable without runtime or ant
- the ant plug-in is a build-time dependency only and is optional