Help:VisualEditor/VE as the main editor

From MediaWiki.org
Jump to: navigation, search

Other languages:
English • ‎日本語
VisualEditor-logo.svg


Here is a quick-start guide so that you can learn how to support your community while VisualEditor becomes available by default to editors at your wiki.

  1. The first step is involving your whole community to let them know VisualEditor is now available for editors at your wiki and to get further help with the following tasks.
    • Note Note: You can start a conversation at your Village Pump in your language and then link to this page, or you can set up a sitenotice, or a watchlist notice for logged-in contributors.
    • Note Note: Make sure that local documentation, especially pages read by new editors such as tutorials for newcomers, editing guides etc., mentions VisualEditor and its documentation. You may want to provide a dedicated space (a sandbox in the main or in the User: namespace) where even logged-out editors can try VE. Here is an example of how this was done on the English Wikipedia (note the ?veaction=edit string at the end of the URL).
  2. There is key documentation to translate, mainly the User guide and the interface itself.
  3. Help:TemplateData contains information about how to add TemplateData information to common templates on your wiki. This is important because if templates do not include this data, they will be difficult to use inside VisualEditor.
    • Tip: There is now an editing tool that allows you to add TemplateData in a simpler way.
    • Start with templates that are often used in articles, such as citation and reference templates, as well as infoboxes. The MostTranscludedPages special page on your wiki might help you find out which are the most important templates you need to work on. The ones which are heavily used in the article namespace have the priority.
    • Tip: Check how other wikis did this. For example, here is the TemplateData for the {{Cite web}} template at the English Wikipedia. If you recently imported {{Cite web}} from that wiki and didn't customize it further, then copying and pasting their TemplateData will probably work for you.
  4. Check bugs on the local feedback page, if your wiki has one, to see if they are already known to developers.
  5. Patrollers might want to keep an eye on the log of edits made with VisualEditor for a few weeks. You can reach it from this link (you'll need to change language code and sister project name in the browser's address bar after you click on it!).
    • Tip: Experienced users may make more mistakes than expected, as they need some time to adapt to the new environment.
  6. Add special characters which are relevant to your language to the set of characters displayed inside the related tool.
  7. Set up a customized Cite menu with the most used Cite templates at your wiki.
  8. Keep yourself and your community up-to-date on VisualEditor news.


Please let the VisualEditor team know if you have further questions. Click here to go to the main VisualEditor page.