VisualEditor/API

From MediaWiki.org
Jump to: navigation, search
shortcut: VE/API

Discussion about already or not-yet presented requirements and/or feature requests should take place on the talk page.

While collecting and interpreting requirements and feature requests from the Wikimedia Foundation staff and developer community some of these requirements were understood to be either mutually exclusive or out of scope of the resources dedicated to this project or the scale of the system. For this reason, this specification is the result of negotiation between multiple parties.


Use cases[edit | edit source]

Adding support for a new kinds of content or annotations

Involves providing model and view classes, converter rules and possibly tools and inspectors for working with the content.

Getting information about and making changes to the surface.

Involves interacting with a surface fragment, which provides a wrapper around a surface, it's document and the current selection. Supported actions include getting information about the current selection, applying annotations to selected content, and modifying the structure of the document.

Interfaces[edit | edit source]