Jump to: navigation, search

Difference between revisions of "Mylyn/Incubator/WikiText/ReleaseReview"

m (Preview)
m (Editor Context Menu)
Line 64: Line 64:
 
* editor uses context menu for setting markup language to a non-default value
 
* editor uses context menu for setting markup language to a non-default value
 
** setting is persisted
 
** setting is persisted
 +
 +
=== Cheat Sheet ===
 +
 +
[[image:Cheat-sheet.png]]
 +
 +
* pressing 'F1' in the editor causes the cheat-sheet pop-up to be displayed
 +
* pressing the question mark help icon at the bottom of the pop-up causes WikiText help to be displayed
  
 
== Workspace Preferences ==
 
== Workspace Preferences ==

Revision as of 01:29, 30 December 2008

DRAFT

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

Editor-showing-highlighting-fonts-contentassist-markers.png

  • fonts show how markup will render
  • content assist
  • markers for warnings and errors

Editor Outline

Editor-outline.png

  • editor has outline view that shows headings
  • outline selection follows caret position in the editor
  • outline is always expanded

Content Assist

Editor-contentassist2.png

  • editor content-assist suggestions are adjusted depending on cursor position

Editor Preview

Editor-preview.png

  • editor has tabs at the bottom
  • the Preview tab shows a rendered version of the markup using the browser

Editor And Markers

Editor-markers2.png

  • editor uses markers
  • markers of course are visible in navigator views, in the editor and in the problems view

Editor Context Menu

Editor-markuplanguage.png

  • editor uses context menu for setting markup language to a non-default value
    • setting is persisted

Cheat Sheet

Cheat-sheet.png

  • pressing 'F1' in the editor causes the cheat-sheet pop-up to be displayed
  • pressing the question mark help icon at the bottom of the pop-up causes WikiText help to be displayed

Workspace Preferences

Editor-preferences-context-help.png

  • workspace preferences are available for setting fonts/styles in the editor
  • shown with context-help visible

Workspace

WikiText Files

Wikitext-files.png

  • have the content-type 'wikitext'
  • have an icon

Context Menus

Wikitext-file-context-menu.png

  • available for converting wikitext files to HTML, DocBook, Eclipse Help
  • on wikitext files only

Project Settings

Project-settings.png

  • for enabling wikitext validation

Task Editor Extension

WikiText provides a task editor extension for each markup language

Repository Settings

Tee-settings.png

  • each option in the the 'editor' section is contributed by WikiText

Task Editor

Tee-editor.png

  • the task editor behaves much the same as the wikitext editor with the extension enabled

Preview

Tee-editor-preview.png

  • editor preview is rendered by a StyledText

Architecture

todo