mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-27 15:50:29 +00:00
b518e55ef9
This is not great, but it's a start (and unblocks other pull-throughs). New changes: c401efc98 build: Replace jsduck with jsdoc for documentation 16ba162a0 JSDoc: @mixins -> @mixes 9e0a1f53b JSDoc: Fix complex return types 449b6cc0f Prefer arrow function callbacks 1539af2c8 Remove 'this' bindings in arrow functions b760f3b14 Use arrow functions in OO.ui.Process steps 57c24109e Use arrow functions in jQuery callbacks 9622ccef9 Convert some remaining functions callbacks to arrow functions f6c885021 Remove useless local variable 1cd800020 Clear branch node cache when rebuilding tree Bug: T250843 Bug: T363329 Change-Id: I0f4878ca84b95e3f388b358b943f105637e455f9 |
||
---|---|---|
.phan | ||
bin | ||
build | ||
editcheck | ||
i18n | ||
images | ||
includes | ||
lib | ||
modules | ||
screenshots | ||
tests | ||
.eslintignore | ||
.eslintrc.json | ||
.gitignore | ||
.gitmodules | ||
.gitreview | ||
.jsdoc.json | ||
.mailmap | ||
.phpcs.xml | ||
.stylelintrc.json | ||
AUTHORS.txt | ||
composer.json | ||
CONTRIBUTING.md | ||
extension.json | ||
Gruntfile.js | ||
LICENSE.txt | ||
package-lock.json | ||
package.json | ||
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