VisualEditor

From University Innovation Fellows
Jump to navigation Jump to search
Line 247: Line 247:
 
*You can resize an existing image by clicking on it, then moving the resize icon (the two-headed arrow on one or both bottom corners).
 
*You can resize an existing image by clicking on it, then moving the resize icon (the two-headed arrow on one or both bottom corners).
 
*You can also drag and drop an image to a place higher or lower on the page.
 
*You can also drag and drop an image to a place higher or lower on the page.
|}
 
 
== Editing templates ==
 
 
=== Starting ===
 
{| cellpadding="15"
 
|-
 
| To add a new template to a page, place your cursor where you want the template to be inserted, and click on the "{{int:visualeditor-dialogbutton-template-tooltip}}" icon (a puzzle piece) in the "{{int:visualeditor-toolbar-insert}}" menu.
 
| [[File:VisualEditor Template Insert Menu-en.png|thumb|border|300px|center]]
 
|-
 
| colspan=2 | <hr />
 
|-
 
| Start typing the name of the template you want to insert. When you see it on the list, click on its name. Then click "{{int:visualeditor-dialog-transclusion-add-template}}".
 
| [[File:VisualEditor - Template editing 4.png|thumb|border|500px|center]]
 
|-
 
| colspan=2 | <hr />
 
|-
 
| You can also edit a template that is already on the page. When you click on the template to select it, it turns blue, and a box appears with an "{{int:visualeditor-dialogbutton-template-tooltip}}" icon (a puzzle piece). Then click on the "{{int:vector-view-edit}}" link.
 
| [[File:VisualEditor - Template editing 1.png|thumb|border|300px|center]]
 
|-
 
| colspan=2 | <hr />
 
|-
 
|Some templates are not visible to someone reading a page. In VisualEditor, such hidden templates are shown as puzzle icons, such as [[Template:Anchor|Anchor]].
 
|[[File:VisualEditor template not visible.png|thumb|border|center|70px]]
 
|-
 
| colspan=2 | <hr />
 
|-
 
|When you select the icon, the context menu is displayed, and you can edit the template.
 
|[[File:VisualEditor template not visible context menu.png|thumb|border|center|300px]]
 
|-
 
| colspan=2 | <hr />
 
|-
 
| colspan=2 |
 
=== Template parameters ===
 
|-
 
|When you add a new template or open an existing one, VisualEditor opens the "{{int:visualeditor-dialog-transclusion-title}}" dialog. What you see depends upon whether there is TemplateData for that template.
 
|
 
|-
 
| colspan=2 | <hr />
 
|-
 
| The template shown here has no TemplateData set up for it. The dialog shows a link to documentation for the template. You can read the documentation to figure out if the template has any parameters (fields), and what goes in each field. Use numbers as the name for each nameless parameter. The first un-named parameter is named <code>1</code>, the second is named <code>2</code>, and so forth.
 
|[[File:VisualEditor template with no TemplateData.png|thumb|border|center|400px]]
 
|-
 
| colspan=2 | <hr />
 
|-
 
|If a template has been updated to contain [[VisualEditor/Portal/TemplateData#What_is_TemplateData.3F|TemplateData]] information, then the dialog will show a list of individual (named) parameters.
 
|[[File:VisualEditor template with TemplateData.png|thumb|border|center|400px]]
 
|-
 
| colspan=2 | <hr />
 
|-
 
| For an existing template, you can edit the parameters shown in the dialog, and you can add parameters by clicking "{{int:visualeditor-dialog-transclusion-add-param}}", at the very bottom of the dialog.
 
| [[File:VisualEditor - Template editing 3.png|thumb|border|center|500px]]
 
|-
 
| colspan=2 | <hr />
 
|-
 
| When a template embeds other templates, these sub-templates will appear inside the parameters that display them. They can be edited or removed inside the parameter field.
 
 
New sub-templates are added by following the steps for adding a parameter. You may need to check the template documentation to make sure that the sub-template is supported. Nested templates can currently be edited as wikitext only, without the facility offered by VisualEditor (see [[phab:T52182]]).
 
| [[File:VisualEditor - Template editing 5.png|thumb|border|center|500px]]
 
|-
 
| colspan=2 | <hr />
 
|-
 
|-
 
| colspan=2 |
 
 
=== Finishing ===
 
|-
 
| When you have finished editing a template, click "{{int:visualeditor-dialog-action-apply}}" to close the dialog and return to editing the main page.
 
| [[File:VisualEditor Apply Changes-en.png|thumb|border|center|150px]]
 
|-
 
| colspan=2 | <hr />
 
|-
 
| colspan=2 |
 
=== Substituting templates ===
 
|-
 
| When a template must be [[:w:en:Help:Substitution|substituted]], type <code><nowiki>subst:</nowiki></code> (colon included) before the template's name.
 
 
Autocompletion doesn't work with <code><nowiki>subst:</nowiki></code>. If you want to use autocompletion, first find the template you are looking for, and then add <code><nowiki>subst:</nowiki></code> in front of the template name.
 
 
Then, click the green "{{int:visualeditor-dialog-transclusion-add-template}}" button.
 
 
Add any parameters as usual and click "{{int:visualeditor-dialog-action-insert}}".
 
| [[File:VisualEditor - Template editing 7.png|thumb|border|center|400px]]
 
|-
 
| colspan=2 | <hr />
 
|-
 
| You will see the template expand on the page after you click "{{int:visualeditor-dialog-action-apply}}".
 
| [[File:VisualEditor - Template editing 8.png|thumb|border|center|400px]]
 
 
|}
 
|}
  

Revision as of 18:56, 12 June 2020

Availability

VisualEditor is available on the following types of pages (namespaces):

  • PLACEHOLDER

First step: enabling VE

If you are registered on Wikipedia, you can opt to make VisualEditor available for editing, by changing your preferences. You'll need a VisualEditor-supported browser; most are. More information can be found here.

If you are not registered, you can still use VisualEditor by adding ?veaction=edit to the end of a Wikipedia page URL. (Registered editors who have not enabled VisualEditor in their preferences - that is, the box for "Temporarily disable the visual editor while it is in beta" option is checked - can do the same.)

Opening VisualEditor

VisualEditor edit tab-en.png
  • To edit a page using VisualEditor, click on the "Edit" tab at the top of the page.
  • It can take a few seconds for the page to open for editing, and longer if the page is very long.
  • Clicking on the "Edit source" tab will open the classic wikitext source editor.

VisualEditor - Section edit links-en.png
  • You can also open VisualEditor by clicking on the "edit" link on each section. Protected pages do not have this link.

Getting started: the VisualEditor toolbar

Screenshot of the VisualEditor toolbar
The VisualEditor toolbar appears at the top of the screen when you begin editing. It includes the following icons:

VisualEditor - Toolbar - Undo-redo.png
Undo and Redo the changes you have made.

VisualEditor Toolbar Headings-en.png
Headings pull-down menu: allows you to change how the paragraph is formatted.
  • To change the style of a paragraph, put your cursor in the paragraph and select an item in this menu (you don't have to highlight any text).
  • Section titles are formatted "Heading", and subsections are "Heading 2", "Heading 3", and so on.
  • The normal format for text is "Paragraph".

VisualEditor Toolbar Formatting-en.png

Formatting: Clicking the "A" opens a menu.

  • The "Bold" item (B) bolds the selected text.
  • The "Italic" item (I) italicizes the selected text.
  • The "Superscript" item (x2) causes the selected text to appear smaller than surrounding text and to be slightly higher than the surrounding text.
  • The "Subscript" item (x2) causes the selected text to appear smaller than surrounding text and slightly lower than the surrounding text.
  • The "Strikethrough" item (S) adds a solid bar through the selected text.
  • The "Computer code" item (a set of curly brackets: {}) changes the font of the selected text to a monospaced font, which sets it apart from surrounding (proportionally spaced) text.
  • The "Underline" item (U) adds a solid line beneath the selected text.
  • The "Language" item (Aあ) allows you to label the language (for example, Japanese) and direction (for example, right-to-left) of the selected text.
  • The final item (VisualEditor MediaWiki theme clear icon bitmap.png), called "Remove", removes all character formatting from the selected text, including links.

If you have not selected any text, then when you click the "A" to open the menu, and then select an item, that formatting will apply to the text that you start typing, from wherever your cursor is located.


VisualEditor - Toolbar - Linking.png
Linking tool: The chain icon is the linking tool. Clicking on it (usually after selecting some text) opens the link dialog.

VisualEditor - Cite Pulldown.png
Cite menu: The "Cite" menu is used to add inline citations (also called "footnotes" or "references"). All projects have access to "Basic" reference formatting and the ability to "Re-use" citations, using this menu. This menu also gives you quick access to local citation templates, if these are enabled on your wiki.

VisualEditor citoid Cite button.png
Cite button: If the citoid service is enabled on your wiki, then you will see a "Cite" button instead of a Cite menu.

The citoid service tries to fill out citation templates automatically.


VisualEditor Toolbar Lists and indentation-en.png
Lists and indentation: The first two items allow you to format text as either a "Bullet list" or a "Numbered list". The last two items allow you to decrease or increase the indentation level of list items.

VisualEditor Insert Menu-en.png
Insert: The "Insert" menu may be different on some projects. Below is a list of all options that may appear.
  • The "Media" icon (a picture of mountains) opens the media dialog.
  • The "Template" icon (a puzzle piece) allows you to edit templates.
  • The "Comment" item (a speech balloon with a "!") allows you to insert comments that are not visible to readers; these comments can be seen only when in edit mode and are then indicated by an exclamation mark icon.
  • The table item allows you to insert a table.
  • The "⧼visualeditor-mwgalleryinspector-title⧽" icon (a set of photos) allows you to insert a gallery to the page.
  • The "⧼math-visualeditor-mwmathinspector-title⧽" icon (Σ) opens the formula inserter dialog.
  • The "⧼wikihiero-visualeditor-mwhieroinspector-title⧽" icon (an ankh symbol - ☥) allows you to enter the hieroglyphics inserter. (See below. Not mentioned again.)
  • The "⧼visualeditor-dialogbutton-referenceslist-tooltip⧽" icon (three books) opens a dialog in which you can specify where will references be displayed to the reader. Usually this only needs to be done once on every page.

Special character insertion: The "Special character" (Ω) icon on the "Insert" menu, when clicked, displays a dialog showing many special characters. By clicking on a specific character, you place it into the text. These special characters include some standard symbols, accents, and mathematical symbols.
VisualEditor Toolbar SpecialCharacters-en.png

VisualEditor More Settings-en.png
The Page options menu is to the left of the Publish changes button. On this menu there are options to adjust page settings, such as whether the page is a redirect, or how it is indexed; to add, edit, or delete categories. You can also switch (one-way only) from VisualEditor to the classic wikitext source editor without losing the editing work you've done.

Saving changes

VisualEditor toolbar actions-en.png
  • When you're done editing, click the blue Publish changes button in the toolbar.
  • If you have not made any changes, the button will be disabled (grayed out). To cancel all your editing changes, just close your browser window.

VisualEditor save dialog-en.png
  • Pressing the blue "Publish changes" button opens a dialog. You can then enter a brief summary of your actions, mark your edit as minor, and add the page to your Watchlist.
  • You can also review your changes using the "Review your changes" button to be sure they will work as intended before saving your changes.
  • The "Resume editing" button returns you to the page you were editing. You can save and publish all of your changes later.

Editing links

VisualEditor - Toolbar - Linking.png
Links can be added through the "Link" icon (links in a chain) in the toolbar. If you select (highlight) text and then press the "Link" button, that text will be used in creating the link. For a link that involves just one word, you can either select that word or just put the cursor within that word.

VisualEditor-link tool-search results.png
When you use either the button or the shortcut, a dialog will open in which you may type the link. VisualEditor will try to help with internal links by looking for likely matches.

VisualEditor link tool 2015.png
Once you have entered or selected the link, you complete the linking process by pressing the "Done" button. Your link will immediately appear on the VisualEditor page but, as with other changes to the page, it will not be saved until you 'Publish' the entire page.

VisualEditor-link tool-external link.png
To link to a web page on another website, the process is the similar: Choose the "External link" tab, and enter a URL in the box.

VisualEditor link tool simple link.png
External links without labels look like this: [1]. You can add these by placing your cursor away from any word (e.g., after a space). Open the link tool by clicking on the button or pressing the shortcut keys. Type the URL in the box, and click the "Done" button to insert the link.

VisualEditor-context menu-link tool.png
To change or remove an existing link, click within the text for that link, then press the "Link" icon that appears near it. The dialog will appear, for editing. In the link editing dialog, you can then change where the link goes. You can also remove the link altogether by pressing the "Remove" button in the lower left corner of the dialog.

Editing references

Adding a new reference


VisualEditor references more.png
To add a citation using the "Cite" menu, place your cursor where you want to add it in the text. Then select the appropriate citation type in the menu.

Using the "Basic" citation


VisualEditor - Editing references 20.png
Shown here is what you will see if you select the basic references item. In the Reference editor, you can add your citation, including formatting.
You can make the reference belong to a given group, although normally this is left blank. (This option is used to display groups of references with the "References list" tool.)

Editing images and other media files

VisualEditor Media Insert Menu-en.png
  • To add a new image (or another type of media file) to the page, click the "Media" icon (a picture of mountains) in the "Insert" menu.
  • The image will be added wherever your cursor is.

VisualEditor - Media editing 2.png
  • Clicking the "Media" icon opens a dialog that automatically searches Wikimedia Commons and your local wiki for media files related to the title of the page you're editing.
  • You can change the search by changing the text in the dialog's search box.
  • To choose a file, click on its thumbnail image.
  • This places the image onto the page you are editing.

VisualEditor - Media editing 6.png
  • After the image you selected is inserted into the page, another dialog will open.
  • This dialog allows you to add and edit the caption of the image. The caption can contain formatting and links.


VisualEditor - Media editing 8.png
You can also set various parameters for the image in the "Advanced settings" window. These include the alignment, the type, and size of the image.

VisualEditor Apply Changes-en.png
When you're done, click "Apply changes" to close the dialog and return to editing the page.

VisualEditor - Media editing 3.png
  • For an existing image, you can add or edit a caption or other settings by clicking on the image, then clicking on the "Media" icon that appears below the picture.
  • You can resize an existing image by clicking on it, then moving the resize icon (the two-headed arrow on one or both bottom corners).
  • You can also drag and drop an image to a place higher or lower on the page.

Editing lists

VisualEditor Toolbar Lists and indentation-en.png
You can use VisualEditor to create lists, or to change the format of an existing list. There are two types of lists: unordered (bullet) and ordered (numbered).

To start a new list, just click on one of the two menu items shown here. Or, if you already have typed the list (on separate lines), select (highlight) the list you have typed, then click on one of the menu items.


VisualEditor lists 1 unordered bullet.png
VisualEditor lists 2 ordered numbered.png
Shown here are examples of the two types of lists: unordered (bullet) and ordered (numbered).

VisualEditor lists 3 select to indent.png
If you want to change the indentation level of part of an existing list, select the part of the list that you want to change.

VisualEditor lists 4 indentation menu.png
Then use the menu, or press the Tab key. (The Tab key increases indentation; use the shift key plus the Tab key to decrease indentation)

VisualEditor lists after indenting.png
Here is the result of increased indentation.

VisualEditor lists mixed.png
You can even mix ordered (numbered) and unordered (bullet) lists, if the list items have different indentations.

Editing tables

VisualEditor insert table.png
You can use VisualEditor to insert and change tables.

You can even import a table by dragging a comma-separated value (.csv) file from your computer into the main editing window.


toolbar>Insert</>" menu, VisualEditor inserts as a default a blank four-by-four table.

Now the "Table" menu is available. From that menu, you can add a caption to the top of the table.

VisualEditor empty table.png

To select a cell, click it once.
VisualEditor tables select one cell.png

To edit the contents of the cell (for example, to add content or to correct a spelling error), double click in the cell. Or you can select the cell and then press Return.

To end your editing of a cell, just click elsewhere.

VisualEditor tables type inside a cell.png
|-

VisualEditor table editing add and remove columns.png
You can add or delete a column or a row.

You can merge cells: Select them, then from the Table menu, click on "Merge cells".
VisualEditor tables merge cells.png

If you merge cells, only the text in one cell is kept; any text in the other cells is deleted when you merge the cells. If you decide that you wanted some or all of the text that was deleted, use the Undo button, move or copy the text you want, then merge the cells again.
VisualEditor tables post-merge cell.png

You can also split cells that were previously merged. All the content that was in the merged cell will remain in the first cell when you do the split. You can then cut and paste text to other cells, if you want.
VisualEditor tables split cells.png

Editing categories

VisualEditor category item-en.png
To edit categories, on the "Page options" menu, click the "Categories" item. If the tool is not visible, first search for three horizontal lines. That's where it is.

VisualEditor category editing-en.png
Clicking on "Categories" opens a dialog that lists existing categories and allows you to add new ones, and to delete existing categories.

You also have the option of setting or changing the general (default) sorting key, which determines where the page appears when listed with other pages in the same category.

For example, the default sorting key for the article "George Washington" is "Washington, George". In the category "Presidents of the United States", the article is listed under the letter "W", not the letter "G".


VisualEditor - Category editing 3.png
To add a category for a page, type the name of the category into the field "Add a category". As you type, VisualEditor will search for possible matching, existing categories. You can either select an existing category, or you can add a category that doesn't yet have its own category page. (Until that category page is created, your new category will show as a red link after you publish all your editing changes.)

VisualEditor - Category editing 2.png
To remove an existing category, click on it and click on the "Remove" icon (trash can) in the dialog that opens.

Clicking on a category also allows you to specify a sorting key for that specific category. Such a sorting key overrides the default sorting key.


VisualEditor Apply Changes-en.png
Click "Apply changes" when you're done editing categories to return to the page editor.

Editing page settings

VisualEditor page settings item-en.png
To edit a page's settings, click to open the "Page options" menu, in the toolbar, and select the "Page settings" button.

VisualEditor Page Settings-en.png
The "Page settings" button opens a dialog that shows several options.

VisualEditor Page Settings Redirects-en.png
You can make a page a redirect to another page by checking the "Redirect this page to" checkbox, and then typing the name of the page to which you want to send the reader who tries to go to the page that you're editing.

At the bottom is the option to prevent page renames from updating this redirect. This is very rarely used.


VisualEditor Page Settings TOC-en.png
You can change whether the page shows a Table of Contents by selecting one of these three buttons. The default option is "If needed", which shows a Table of Contents if there are three or more headings.

VisualEditor Page Settings Edit Links-en.png
You can make a page not show edit links next to each section header by checking this checkbox.

VisualEditor Apply Changes-en.png
Click "Apply changes" when you're done editing the Page options to return to the page editor.

Editing mathematical formulae

To add a new mathematical formula to the page, place your cursor where you want it to be inserted, and click on the "⧼math-visualeditor-mwmathinspector-title⧽" icon ("Σ") in the "Insert" menu on the toolbar.
VisualEditor Formula Insert Menu-en.png

A window will open in which you can type the formula, using LaTeX syntax. VisualEditor will update the formula as you type it, so you can see how it will look as you make changes. Once you are happy with the formula, click the "Done" button.
VisualEditor formula-en.png

To edit an existing mathematical formula on the page, click on it and then click on the "Σ" icon that appears. This will open up the formula window, where you make changes.
VisualEditor - editing existing mathematical formula.png

Mathematical formulae can be placed inline or centered as a block.
VisualEditor mathematic formula inline.png

Editing poems and other special items

Some items, such as association lists, poems, and musical scores, are not yet fully supported by VisualEditor.
VisualEditor editing poem 1.png

In most cases, the existing items can be edited, but new ones cannot be inserted in VisualEditor.
VisualEditor editing poem 2.png

You cannot add an automatic datestamp to a page in VisualEditor.

Until they are fully supported, you can copy an existing one from another page, or edit the source wikitext directly.

Moving pages

Moving a page with VisualEditor is functionally the same as moving it with the source editor; see Help:How to move a page for an introduction to moving pages, or Wikipedia:Moving a page for more detailed instructions.

Keyboard shortcuts

Many editors are used to entering wikitext directly, especially bold, italics and wikilinks. Keyboard shortcuts allow to quickly insert similar formatting without having to use toolbar items. Here are the common general shortcuts in VisualEditor:

PC shortcut Action Mac shortcut

Template:Key press Bold Template:Key press

Template:Key press Italics Template:Key press

Template:Key press Insert link Template:Key press

Template:Key press Cut Template:Key press

Template:Key press Copy Template:Key press

Template:Key press Paste Template:Key press

Template:Key press Undo Template:Key press