Help:VisualEditor/User guide

This is a user guide for the VisualEditor. See also the FAQ.

How do I get started?


Once you begin editing through VisualEditor, you will encounter the VisualEditor toolbar, which appears above the screen.

The toolbar includes some familiar icons--undo and redo are first represented. They are followed by a pulldown menu that allows you to change the header level of text.

The "B" turns highlighted text bold, while the "I" will italicize it. The chain is the linking tool (See How do I edit links). The clear formatting tool will remove whatever formatting is currently applied to highlighted text. The "media" icon (which looks like a small picture) opens the media subpage (See How do I edit images and other media files?). The "transclusion" icon is useful for working with templates (see How do I work with templates?. The next two icons will allow you to make numbered or bulleted lists, respectively, while the following two will allow you to increase or decrease the indentation level of content.

To the right side of the toolbar is currently displayed the version, followed by the Page settings link (with its corresponding "cog" icon) which currently allows you to add categories (see How do I edit categories?) and language links. Finally, you have the option to "cancel" or "save" your changes.

Pressing "save" pulls up a small box into which you can enter a brief summary of your actions, mark your edit as minor, choose to watch the page (by default; click on the box to change), review your changes to be sure they work as intended and save your change. It also includes information on license.

How do I edit links?
Links can be added through the "link" button (looks like a couple of links in a chain) at the top of the page, or by using the shortcut Ctrl. If you do not first highlight a word, pressing the "link" button will insert a link where your cursor is on the page at the time you enter the link. If you have first selected a word (or multiple words), your selection will become the display text for the link.

When you press "link" or use the shortcut, you will bring up a small window that includes a box into which you may type the link (internal or external). The VisualEditor will try to assist with internal links by looking for likely matches as you begin to type. Once you have entered or selected the link, you can press return, click outside of the box, or press the close key (<). Your link will appear on the VisualEditor page, but it will not be saved until you press "save page".

To remove or changing an existing link, click in the link's display text or select it, then press the "link" button, keyboard shortcut, or clicking on the link button in the annotation menu that comes up to bring up the link tool. The link target will display, and you have the option to change the link to something else, or remove it by pressing the 'remove' icon in the top-right corner of the tool. In either case, you may close the window and save your edits as above.

How do I edit templates?
(pending)

How do I add or remove existing templates?
Once you enter the VisualEditor, pressing the "transclusion" icon in the toolbar above the editing window (this looks like a puzzle piece) will bring up a subscreen to assist in working with templates. Pressing "new template" gives you the option to add a template. Once you begin typing a template name in the box, it will search for matching text strings from which you can select.

When you are finished adding a template, press "apply changes" to leave the menu and return to the VisualEditor editing screen. At that time, you can either continue editing with the VisualEditor or press "save page" to complete your addition. Please note that if you do not press "save page", your addition will not be saved.

(more information pending)

How do I edit images and other media files?
(pending)

How do I edit categories?
Categories can be edited through the "Page settings" menu in the VisualEditor toolbar. The "Page settings" menu will give you a pop-up window in which to modify, remove or add categories.

Each category already in use on a page will be listed with a pull-down menu. Pulling down the menu for an individual category allows you to remove it (by pressing the trash can icon) or changing its display by entering a name in the box labeled "Sort this page as".

You may add new categories in the box labeled "Add a category." As you enter the category name, it will search for matching categories which you can – if appropriate – select.

When you are finished adding, editing or removing categories, press "apply changes" to leave the menu and return to the VisualEditor editing screen. At that time, you can either continue editing with the VisualEditor or press "save page" to complete your change to the category. Please note that if you do not press "save page", your changes will not be saved.

How do I edit references?
(pending)

What about editing LaTeX for mathematical formulas, image files, and other special items?
Some, like images and categories, will be supported directly in VisualEditor. There are plans to support mathematical formulas as well. For more exotic features, it will still be possible to edit the source wikitext directly.

What keyboard shortcuts are supported?
See VisualEditor/Features/Keyboard shortcuts. Many of the shortcuts commonly in use (Ctrl for bold, for instance) will still function.

Will the VisualEditor make automatic fixes to pages?
In general, VisualEditor should never make changes to formatting on lines that are not being directly edited.