Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Mylyn/WikiText"

(New page: === Links === * {{bug|234210}}: [wikitext] Mylyn should support lightweight markup (eg: Textile) in its task editor * {{bug|233819}}: A Wiki Integrated Task Editor == Plan == Notes from...)
 
 
(23 intermediate revisions by 6 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
+
  
== Plan ==
+
* '''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
  
Notes from 2008-05-28 Meeting:
+
WikiText has parsers for MediaWiki, Textile, Markdown, CommonMark, AsciiDoc, Confluence, Creole, 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.
* 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
+
=== Downloads ===
** 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
+
Mylyn WikiText can be installed into Eclipse or used stand-alone.  WikiText can be installed in one of the following ways:
** createViewer()
+
 
** createEditor()
+
* Maven - see [https://github.com/greensopinion/wikitext-examples wikitext-examples] for examples
** createConfiguration()
+
* Eclipse p2 site: for using WikiText within Eclipse or an OSGi runtime
** getEditorContextId()
+
 
* Activate a new context when the New Comment viewer is active, can extend default task editor context
+
=== 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 [[Mylyn/FAQ#Where_can_I_find_out_more_about_WikiText.3F|WikiText FAQ]] for details.
 +
 
 +
==== WikiText Links ====
 +
 
 +
* [http://help.eclipse.org/mars/topic/org.eclipse.mylyn.wikitext.help.ui/help/Mylyn%20WikiText%20User%20Guide.html WikiText User Guide]
 +
* [http://help.eclipse.org/mars/topic/org.eclipse.mylyn.wikitext.help.ui/help/devguide/WikiText%20Developer%20Guide.html WikiText Developer Guide]
 +
* [[Mylyn/FAQ#WikiText|WikiText FAQ]]
 +
* [http://www.eclipse.org/mylyn/docs Mylyn Docs Homepage]
 +
 
 +
=== Feedback ===
 +
 
 +
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.
 +
 
 +
[[Category:Mylyn]]

Latest revision as of 09:04, 4 September 2023

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, Markdown, CommonMark, AsciiDoc, Confluence, Creole, 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.

Downloads

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

  • Maven - see wikitext-examples for examples
  • Eclipse p2 site: for using WikiText within Eclipse or an OSGi runtime

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.

WikiText Links

Feedback

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

Back to the top