Difference between revisions of "Mylyn/WikiText"

From Eclipsepedia

Jump to: navigation, search
(Documentation)
 
(15 intermediate revisions by 4 users not shown)
Line 1: Line 1:
=== Links ===
+
== Mylyn WikiText ==
  
* {{bug|234210}}: [wikitext] Mylyn should support lightweight markup (eg: Textile) in its task editor
+
Mylyn WikiText provides an extensible framework and tools for parsing, editing and presenting [http://en.wikipedia.org/wiki/Lightweight_markup_language lightweight markup], including:
* {{bug|233819}}: A Wiki Integrated Task Editor
+
  
== WikiText Project Charter ==
+
* '''Editor for wiki files''' using a source editor paradigm with preview
 +
* '''Mylyn task editor integration''' making the task editor markup-aware for displaying and editing markup
 +
* '''Ant Tasks''' for converting markup to other formats
 +
* '''API''' a framework and API for handling lightweight markup
  
Lightweight markup languages (such as Textile), hereafter referred to as LWM, are commonly used in issue tracking systemsInformation displayed by Mylyn
+
WikiText has parsers for MediaWiki, Textile, Confluence, TracWiki and TWiki markup, and can be extended to support other languages.  WikiText provides [http://ant.apache.org Ant] tasks for converting lightweight markup to HTML, Eclipse Help, [http://www.docbook.org DocBook], [http://dita.xml.org DITA] and [http://en.wikipedia.org/wiki/XSL_Formatting_Objects XSL-FO]WikiText also provides an editor for editing such markup within Eclipse, and integrates with the Mylyn task editor causing it to be markup-aware.  WikiText provides API for integrating wiki markup capabilities into Eclipse, RCP, stand-alone and server-side applications.
is commonly authored in such formats and is displayed to the user as raw markup.
+
  
The WikiText project will provide components for use in dislpaying and authoring LWM.  With these components, the user will have access to a LWM-aware authoring environment and will be presented with formatted content wherever LWM is authored or displayed.
+
=== Downloads ===
  
=== Requirements ===
+
Mylyn WikiText can be installed into Eclipse or used stand-alone.  WikiText can be installed in one of the following ways:
  
The following are requirements that pertain to the WikiText project:
+
* Using an Eclipse update site: for using WikiText within Eclipse
 +
* As a stand-alone download: for using WikiText as a set of Ant tasks or for integrating WikiText within your stand-alone or server-side application
  
# The project shall provide a common framework for implementing parsers of LWM
+
Stable releases are made available as well as weekly builds that include the latest features and bug fixes.
## The project shall provide a single reference implementation of such a parser, implementing the Textile markup language
+
## Other markup language parsers may be provided by the project, focusing on markup languages supported by repositories for which there is a Mylyn connector (eg: TracWiki, Confluence markup and MediaWiki)
+
## The project shall provide a means of extending the framework to support other markup languages, using standard Eclipse facilities such as extension points such that the framework may be extended outside of the project.
+
## Where feasible the LWM parser framework and LWM parser implementations provided by the framework shall be usable outside of an Eclipse environment (stand-alone) without reference to Eclipse or OSGI APIs. The intention is to foster maximum community adoption of the parser components of the project in order to maximize community contributions back to the project in improving LWM parser components.
+
### The project shall provide Ant tasks for converting files containing LWM to HTML, to Eclipse Help format, and where feasible to DocBook
+
# The project shall provide a means of displaying LWM content as it is intended to be viewed in its formatted form in an SWT UI
+
## A 'lite' version of a viewer will be provided that makes a best attempt at displaying markup without use of a Browser component
+
## The project shall also facilitate use of a Browser to display content
+
# The project shall provide an editor that is markup-aware, capable of authoring markup for any LWM supported by a parser component
+
# The project shall provide a set of patches to the Mylyn project which may be adopted by Mylyn in order to use components of WikiText in the Mylyn UI
+
## The patches shall not reference APIs of the WikiText project, rather the reverse is true; the WikiText project may reference APIs of Mylyn
+
  
==== Non-Requirements ====
+
See [http://www.eclipse.org/mylyn/downloads Mylyn Downloads] for the package that best suits your needs.
  
The following are non-requirements of the WikiText project, and as such the listed feature are explicitly identified as objectives or features that are out of scope of the project.
+
=== Documentation ===
  
# a WYSIWYG markup editor
+
Mylyn WikiText has a user guide and a developer guide.  These documents are periodically published online, though the most up-to-date versions are provided when WikiText is installed.  Other articles, documents and guides are available; see the [http://wiki.eclipse.org/Mylyn/FAQ#Where_can_I_find_out_more_about_WikiText.3F WikiText FAQ] for details.
# integration with wiki APIs for retrieving, submitting, managing or editing wiki content
+
# LWM parser implementations for arbitrary specific markup languages (only those listed above need be implemented by the project)
+
  
=== Direction ===
+
==== WikiText Links ====
  
The project shall consist initially of a contribution from the open-source [https://textile-j.dev.java.net/ Textile-J] project, which satisfies many of the project objectives and requirements.
+
* [http://help.eclipse.org/juno/topic/org.eclipse.mylyn.wikitext.help.ui/help/Mylyn%20WikiText%20User%20Guide.html WikiText User Guide]
 +
* [http://help.eclipse.org/juno/topic/org.eclipse.mylyn.wikitext.help.ui/help/devguide/WikiText%20Developer%20Guide.html WikiText Developer Guide]
 +
* [http://wiki.eclipse.org/Mylyn/FAQ#WikiText WikiText FAQ]
 +
* [http://www.eclipse.org/mylyn/downloads Downloads]
 +
* [http://www.eclipse.org/mylyn/docs Mylyn Docs Homepage]
  
=== Stakeholders ===
+
=== Feedback ===
  
* Mylyn and Mylyn committers
+
We're interested in any feedback that you might have.  For patches, enhancement requests, bugs: [https://bugs.eclipse.org/bugs post an issue] under Tools/Mylyn/WikiText.
* Tasktop
+
* Mylyn users and contributors
+
* David Green and Textile-J
+
* Jingwen 'Owen' Ou
+
 
+
==== Mentors and Committers ====
+
 
+
this project is sponsored and mentored by the following Mylyn committers:
+
 
+
* Steffen Pingal
+
* Mik Kersten
+
 
+
== Plan ==
+
 
+
Notes from 2008-05-28 Meeting:
+
* Extension point to override default viewer and editor: needs to declare what editor it's using, need to declare language being used
+
* If multiple viewer extensions present, our editor creates tabs
+
** for example, if a viewer and editor are available, the edit area creates an 'Edit' tab and a 'Preview' tab for editable areas
+
* E.g.: ITaskEditorExtension
+
** createViewer()
+
** createEditor()
+
** createConfiguration()
+
** getEditorContextId()
+
* Activate a new context when the New Comment viewer is active, can extend default task editor context
+

Latest revision as of 16:46, 7 February 2013

Contents

[edit] Mylyn WikiText

Mylyn WikiText provides an extensible framework and tools for parsing, editing and presenting lightweight markup, including:

  • Editor for wiki files using a source editor paradigm with preview
  • Mylyn task editor integration making the task editor markup-aware for displaying and editing markup
  • Ant Tasks for converting markup to other formats
  • API a framework and API for handling lightweight markup

WikiText has parsers for MediaWiki, Textile, Confluence, TracWiki and TWiki markup, and can be extended to support other languages. WikiText provides Ant tasks for converting lightweight markup to HTML, Eclipse Help, DocBook, DITA and XSL-FO. WikiText also provides an editor for editing such markup within Eclipse, and integrates with the Mylyn task editor causing it to be markup-aware. WikiText provides API for integrating wiki markup capabilities into Eclipse, RCP, stand-alone and server-side applications.

[edit] Downloads

Mylyn WikiText can be installed into Eclipse or used stand-alone. WikiText can be installed in one of the following ways:

  • Using an Eclipse update site: for using WikiText within Eclipse
  • As a stand-alone download: for using WikiText as a set of Ant tasks or for integrating WikiText within your stand-alone or server-side application

Stable releases are made available as well as weekly builds that include the latest features and bug fixes.

See Mylyn Downloads for the package that best suits your needs.

[edit] Documentation

Mylyn WikiText has a user guide and a developer guide. These documents are periodically published online, though the most up-to-date versions are provided when WikiText is installed. Other articles, documents and guides are available; see the WikiText FAQ for details.

[edit] WikiText Links

[edit] Feedback

We're interested in any feedback that you might have. For patches, enhancement requests, bugs: post an issue under Tools/Mylyn/WikiText.