mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-23 18:28:51 +00:00
35cb550747
* DirectParsoidClient makes use of parsoid directly for performing transformations on both wikitext and/or HTML contents. * Also, it's used to fetch HTML from parsoid's parser cache. Before, this operation was done via RESTBase but now it's being fetched in core's parsoid parser cache. * This patch also enables VE clients to transform HTML to Wikitext when switching from HTML to source mode on. It makes use of the HtmlInputTransformHelper to perform this transformation. * Now, VE client can make use of core code for switching between HTML to source mode and back without RESTBase. Change-Id: I5c7cfcc4086d8da7905897194d8601aa07418b59 |
||
---|---|---|
.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