mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-25 06:46:26 +00:00
96677fb74a
References to JS objects for VE elements can determined by referencing the VE and OOUI API documentation[1][2] and interrogating the objects in a browser console. Errors should be closer to what developers understand but testers should pair with developers to better understand how to define new page elements and where to go for documentation/help. The VE entrypoint for the singleton reference is `ve.init.target` (if there's only one instance of VE target; there may be multiple in some cases like Flow). [1] https://doc.wikimedia.org/VisualEditor/master/ [2] https://doc.wikimedia.org/oojs-ui/master/js/ Change-Id: I1f642807cdd3059d8e7e885a8b239ac01b9b3024 |
||
---|---|---|
.jsduck | ||
bin | ||
build | ||
lib | ||
modules | ||
.csslintrc | ||
.gitignore | ||
.gitmodules | ||
.gitreview | ||
.jscsrc | ||
.jshintignore | ||
.jshintrc | ||
.mailmap | ||
.rubocop.yml | ||
.rubocop_todo.yml | ||
ApiVisualEditor.php | ||
ApiVisualEditorEdit.php | ||
AUTHORS.txt | ||
autodisablePref.php | ||
betafeatures-icon-VisualEditor-ltr.svg | ||
betafeatures-icon-VisualEditor-rtl.svg | ||
composer.json | ||
CONTRIBUTING.md | ||
extension.json | ||
Gemfile | ||
Gemfile.lock | ||
Gruntfile.js | ||
jsduck.json | ||
LICENSE.txt | ||
package.json | ||
phpcs.xml | ||
Rakefile | ||
README.md | ||
VisualEditor.hooks.php | ||
VisualEditor.php | ||
VisualEditorDataModule.php | ||
VisualEditorDesktopArticleTargetInitModule.php |
VisualEditor
VisualEditor provides a visual editor for wiki pages. It is written in JavaScript and runs in a web browser.
It uses the Parsoid parser to convert wikitext documents to annotated HTML which the VisualEditor is able to load, modify and emit back to Parsoid at which point it is converted back into wikitext.
For more information about these projects, check out the VisualEditor and Parsoid pages on mediawiki.
Developing and installing
For information on installing VisualEditor on a local wiki, please see https://www.mediawiki.org/wiki/Extension:VisualEditor
For information about running tests and contributing code to VisualEditor, see CONTRIBUTING.md. Patch submissions are reviewed and managed with Gerrit. There is also API documentation available for the VisualEditor.