mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-23 10:19:35 +00:00
3901a8a4f1
Introduced in FlaggedRevs with Idbdab9a7396 (6bfd276e64), and I've migrated consumers away from the singleton in I192b962147 (5ee96e5ca7) and I04fdbd497b8 (bbdfc4c024). The one thing that remains global by default is the context, but VE already avoids that with setContext, and (correctly) restores this afterward since the FlaggablePageView object is re-used by title. That's exactly as terrible as it sounds, but at least it's a bit more visible after my refactor. Bug: T314008 Change-Id: I0008818ec821c35c570d9db9c82f737783e6729b |
||
---|---|---|
.jsduck | ||
.phan | ||
.vscode | ||
bin | ||
build | ||
i18n | ||
images | ||
includes | ||
lib | ||
maintenance | ||
modules | ||
screenshots | ||
tests | ||
.eslintignore | ||
.eslintrc.json | ||
.gitignore | ||
.gitmodules | ||
.gitreview | ||
.mailmap | ||
.phpcs.xml | ||
.stylelintrc.json | ||
AUTHORS.txt | ||
composer.json | ||
CONTRIBUTING.md | ||
extension.json | ||
Gruntfile.js | ||
jsduck.json | ||
LICENSE.txt | ||
package-lock.json | ||
package.json | ||
Rakefile | ||
README.md | ||
VisualEditor.i18n.alias.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.
Terminology
- Apex: See https://www.mediawiki.org/wiki/Skin:Apex
- CE: ContentEditable
- DM: Data model
- Invocation: Here the act of calling a template from a page, visible as e.g.
{{reflist}}
in the wikitext. - MW: MediaWiki
- Page: See https://www.mediawiki.org/wiki/OOUI/Layouts/Booklets_and_Pages
- Parameter: A template parameter. Can be known (i.e. documented via TemplateData) or unknown.
- Part: A template-level entity in a transclusion, i.e. either a template, template placeholder, or wikitext snippet.
- SA: Standalone
- Template: See https://www.mediawiki.org/wiki/Help:Templates
- Transclusion: A sequence of one or more template invocations, possibly mixed with raw wikitext snippets.
- UI: User interface
- VE: VisualEditor
- WT: Wikitext