Help:VisualEditor: Difference between revisions

Content deleted Content added
NM Demo (talk | contribs)
→‎Saving changes: minor copyedits - press Esc.
Kylemm (talk | contribs)
Changed link from Mac(disambiguation) to Mac(computer)
 
(31 intermediate revisions by 12 users not shown)
Line 1:
{{Short description|Help for Wikimedia editing software development project}}
{{WP:VisualEditor/tabs}}{{pb}}
<noinclude>{{pp-semi-indef}}</noinclude>{{VisualEditor navbox}}
 
{{shortcut|WP:VE/UG}}
<div style="display:table;margin:auto; padding: 2em; background: #EBF4FA; box-shadow: 7px 7px 5px #CCC; border-radius: 15px; ">
Line 9:
'''[[Wikipedia:VisualEditor|VisualEditor]]''' gives you the ability to edit without needing to learn simple wikitext markup, as is required by the default [[WP:WIKITEXT|wikitext]] editor (also known as [[WP:Source Editor|Source Editor]]). Unlike that editing tool, VisualEditor displays the text being edited [[rich-text editor|almost as if it were already published]]. This guide gives illustrated, step-by-step instructions on the editor's features.
 
Be aware that VisualEditor is still in [[Software_release_life_cycle#Beta|development]] and thus has [[Wikipedia:VisualEditor#Limitations|known limitations]] and bugs, and this guide may occasionally lag behind the release of new updates. For larger pages, VisualEditor can be slower than using wikitext with Source Editor and is not available for discussion pages. While VisualEditor remains in development, you should [[#Saving changes|review your changes]] to ensure that the edits are those you intended.
 
We welcome your problem sightings, comments and suggestions on the [[Wikipediamw: VisualEditor/Feedback|MediaWiki Feedback page]]. ''(Please note: In late 2017 all '''Save changes''' and '''Save page''' buttons were renamed '''Publish changes''' or '''Publish page'''. Every edit – even to drafts – is now saved in this way, and this should not be confused with [[Wikipedia:Moving a page|putting drafts into the main part of Wikipedia]]. That is a separate process.)''
 
__TOC__
Line 30:
==First step: enabling VE==
[[File:Enabling Visual Editor.png|right|frameless|Enabling the visual editor in your preferences]]
If you are registered on Wikipedia, you can opt to make VisualEditor available for editing, by changing [[Special:Preferences#mw-prefsection-editing| your preferences]]. You'll need a VisualEditor-supported browser; most are. In your preferences you need to go to the "Editing" tab and in the "Editor" section find the "Editing mode". Here you can choose to have both the visual and the source editor displayed or only the one you prefer.
 
If you are not registered, you can still use VisualEditor by adding <code>?veaction=edit</code> 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 ==
Line 54:
 
<div class="overflowbugx" style="overflow:auto; width: 100%;">
[[File:VisualEditor toolbar-en.png|frameless|center|1200pxupright=5.5|alt=Screenshot of the VisualEditor toolbar]]</div>
 
{| cellpadding="20"
Line 67:
| colspan=2 | <hr />
|-
| [[File:VisualEditor Toolbar Headings-en.png|frameless|border|300pxupright=0.7|center]]
| '''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 "{{int:visualeditor-formatdropdown-format-mw-heading2}}", and subsections are "{{int:visualeditor-formatdropdown-format-heading2mw-heading3}}", "{{int:visualeditor-formatdropdown-format-heading3mw-heading4}}", and so on. The normal format for text is "{{int:visualeditor-formatdropdown-format-paragraph}}".
|-
| colspan=2 | <hr />
|-
| [[File:VisualEditor Toolbar Formatting-en.png|frameless|border|300pxupright=1.4|center]]
|
'''Formatting:''' Clicking the "<u>'''''A'''''</u>" opens a menu.
Line 89:
| colspan=2 | <hr />
|-
| [[File:VisualEditor - Toolbar - Linking.png|frameless|border|300pxupright=1.4|center]]
| '''Linking tool:''' The chain icon is the [[#Editing links|linking tool]]. Clicking on it (usually after selecting some text) opens the [[#Editing links|link dialog]].
|-
| colspan=2 | <hr />
|-
| [[File:VisualEditor -citoid Cite Pulldownbutton.png|frameless|border|150pxupright=0.7|center]]
| '''{{int:Cite-ve-toolbar-group-label}} menubutton:''' The "{{int:Cite-ve-toolbar-group-label}}" menubutton is used to add inline citations (also called "footnotes" or "references"). AllThe projectsAutomatic havetab accessservice to "{{int:Cite-ve-dialogbutton-reference-tooltip}}" reference formatting and the abilitytries to "{{int:Cite-ve-dialog-reference-useexisting-tool}}"fill citations,out usingcitation thistemplates menuautomatically. ThisTemplates menucan also givesbe youmanual quickadded accessfrom tothe localManual citationtab. templates, if these are enabled on your wiki.
 
(Instructions for addingconfiguring the local citation templates toin the {{int:Cite-ve-toolbar-group-label}}Manual menu at a specific wikitab are available at [[MW:VisualEditor/Citation tool|VisualEditor/Citation tool]].) Instructions for configuring the citation templates used by Automatic tab are available at [[mw:Citoid/Enabling_Citoid_on_your_wiki|Citoid/Enabling Citoid on your wiki.]]
|-
| colspan=2 | <hr />
|-
| [[File:VisualEditor citoidToolbar CiteLists buttonand indentation-en.png|frameless|border|150pxupright=1.4|center]]
| '''{{int:Cite-ve-toolbar-group-label}} button:''' If the citoid service is enabled on your wiki, then you will see a "{{int:Cite-ve-toolbar-group-label}}" button instead of a {{int:Cite-ve-toolbar-group-label}} menu.
 
The citoid service tries to fill out citation templates automatically.
|-
| colspan=2 | <hr />
|-
| [[{{#ifexist: Media:VisualEditor Toolbar Lists and indentation-{{CONTENTLANGUAGE}}.png|File:VisualEditor Toolbar Lists and indentation-{{CONTENTLANGUAGE}}.png|File:VisualEditor Toolbar Lists and indentation-en.png}}|frameless|border|300px|center]]
| '''Lists and indentation:''' The first two items allow you to format text as either a "{{int:visualeditor-listbutton-bullet-tooltip}}" or a "{{int:visualeditor-listbutton-number-tooltip}}". The last two items allow you to decrease or increase the indentation level of list items.
|-
| colspan=2 | <hr />
|- id="insert"
|-
| [[File:VisualEditor Insert Menu-en.png|frameless|border|250pxupright=1.1|center]]
| '''{{int:visualeditor-toolbar-insert}}:''' The "{{int:visualeditor-toolbar-insert}}" menu may be different on some projects. Below is a list of '''all''' options that may appear.
* The "{{int:visualeditor-dialogbutton-media-tooltip}}" icon (a picture of mountains) opens the [[#Editing images and other media files|media dialog]].
Line 123 ⟶ 116:
* The "{{int:wikihiero-visualeditor-mwhieroinspector-title}}" icon (an [[:w:ankh|ankh]] symbol – ☥) allows you to enter the hieroglyphics inserter. <!-- (<s>See below.</s> Not mentioned again.) -->
* The "{{int:cite-ve-dialogbutton-referenceslist-tooltip}}" icon (three books) opens a dialog in which you can specify where references will be displayed to the reader. Usually this only needs to be done once on every page.
Note: To '''remove''' any inserted image or template, simply select the item and press 'Delete' on your keyboard. To remove a Table, select the item and click the red 'delete' button that appears on screen.
|-
| colspan=2 | <hr />
Line 129 ⟶ 123:
|}
<div class="overflowbugx" style="overflow:auto; ">
[[File:VisualEditor Toolbar SpecialCharacters-en.png|frameless|border|1100pxupright=5.0|center]]</div>
{| cellpadding="20"
|-
Line 135 ⟶ 129:
| colspan=2 | <hr />
|-
| [[File:VisualEditor More Settings-en.png|frameless|400pxupright=1.8|border|center]]
| The '''Switch editor''' button (slanted pencil icon) is to the left of the '''Publish changes''' button. It lets you switch from VisualEditor to the classic 'Source Editor' and vice versa without losing the work you've done.
 
 
 
The '''{{int:visualeditor-pagemenu-tooltip}}''' menu (hamburger icon) is further 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 [[#Editing categories|add, edit, or delete categories]]; and to see, using the "{{int:visualeditor-annotationbutton-language-tooltip}}" item, the list of articles on the same subject that are in other languages. It also includes a Find/Replace tool.
The '''{{int:visualeditor-pagemenu-tooltip}}''' menu (hamburger icon) is further 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 [[#Editing categories|add, edit, or delete categories]]; and to see, using the "{{int:visualeditor-annotationbutton-language-tooltip}}" item, the list of articles on the same subject that are in other languages. It also includes a Find/Replace tool that supports plain text searches as well as [[regular expression]] searches with capture groups that can be recalled using backreferences such as $1, $2, etc.
|}
 
Line 164 ⟶ 159:
|-
| [[File:VisualEditor - Toolbar - Linking.png|frameless|border|300px|center]]
| Links can be added through the "{{int:visualeditor-annotationbutton-link-tooltip}}" icon (links in a chain) in the toolbar, or by using the shortcut {{key press|Ctrl|K}} on PC (or {{Key press|Command|K}} on a [[Mac (computer)|Mac]]).
 
If you select (highlight) text and then press the "{{int:visualeditor-annotationbutton-link-tooltip}}" 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 withinanywhere thatwithin wordit.
|-
| colspan=2 | <hr />
Line 184 ⟶ 179:
|-
| [[File:VisualEditor-link tool-external link.png|frameless|border|400px|center]]
| To link to a web page on another website, the process is similar: Choose the "{{int:visualeditor-linkinspector-button-link-external}}" tab, and enter a URL in the box.
|-
| colspan=2 | <hr />
|-
| [[File:VisualEditor link tool simple link.png|frameless|border|400px|center]]
| External links without labels look like this: [http://example.com]. You can add these by placing your cursor awayto fromthe anyright wordof (e.g.,the aftertext ato space)which the link is related. Open the link tool by clicking on the button or pressing the shortcut keys. Type the URL in the box, and click the "{{int:visualeditor-dialog-action-done}}" button to insert the link.
|-
| colspan=2 | <hr />
Line 201 ⟶ 196:
== Editing references ==
<div style="margin:auto; padding: 2em; background: #EBF4FA; box-shadow: 7px 7px 5px #CCC; border-radius: 15px; ">
<big>This section is '''out of date'''. A more current user manual can be found [[mw:Help:VisualEditor/User guideUser_guide#Editing_references|on mediawiki.org]]</big> </div>
<br/>
 
Line 221 ⟶ 216:
Many wikis use templates to format references automatically. If a template is used in your reference, then all the text in the template will be highlighted when you click on the reference information.
 
<!--T:56-->
If a template was used and you've clicked on information in that template, then the {{int:visualeditor-dialogbutton-template-tooltip}} icon (puzzle piece) will appear. Click on that to edit the content of the template, in the template mini-editor dialog.
|-
Line 228 ⟶ 222:
| [[File:VisualEditor - Editing References - Cite Web.png|frameless|border|center|300px]]
| If, instead of the "{{int:cite-ve-dialogbutton-reference-title}}" icon (bookmark), what appears when you click on a reference is an icon for a standard template for citations, clicking on that icon will take you directly to the template mini-editor dialog.
|-
| colspan="2" | <hr />
|-
|If you open a reference and it only contains a link, you may see any option to "Convert" the reference. This will attempt to use the Automatic feature to replace the simple reference with a fully formatted reference.
|[[File:Visual editor citoid convert button.png|thumb|300x300px]]
|-
| colspan=2 | <hr />
Line 234 ⟶ 233:
| Inside the template mini-editor, you can add or remove types of information or change current content. Only fields (template parameters) that are used (have content) should be shown, initially. To add fields, click on "{{int:visualeditor-dialog-transclusion-add-param}}", which is at the very bottom of the mini-editor.
|-
| colspan="2" | <hr />
|-
| [[File:VisualEditor - Apply changes.png|frameless|border|center|150px]]
Line 242 ⟶ 241:
|-
| colspan=2 |
 
 
=== Re-using an existing reference ===
Line 247:
| colspan=2 | <hr />
|-
| [[File:VisualEditor Cite menu re-use tab.png|frameless|border|200px|center|500px]]
| If the page already contains a citation that applies to the text you want to source, then you can choose to re-use the existing citation.
 
To re-use an existing reference, place your cursor in the body of the text where you want to add a new reference (number) for that citation. ThenClick on the "{{int:citoid-citoidtool-title}}" button, and then click on the "{{int:citoid-citoiddialog-mode-reuse}}" itemtab from the "{{int:citoid-citoidtoolcitoiddialog-title}}" menudialog.
 
You can also just copy-and-paste the reference number.
 
In the "{{int:citoid-citoiddialog-mode-reuse}}" dialog, look at the list for the reference you want to reuse, and select it. If there are many references, you can use the search box (labeled "{{int:cite-ve-reference-input-placeholder}}") to list only those references that include certain text.
|-
| colspan=2 | <hr />
|-
| colspan=2 |
| [[File:VisualEditor - Editing references 18.png|frameless|border|500px|center]]
|}
| In the dialog, look at the list for the reference you want to reuse, and select it. If there are many references, you can use the search box (labeled "{{int:cite-ve-reference-input-placeholder}}") to list only those references that include certain text.
 
=== Adding a new reference ===
{| cellpadding="15"
|-
| colspan=2 |
|-
| colspan=2 | <hr />
|-
| [[File:VisualEditor_Citoid_Inspector-en.png|frameless|border|500px|center]]
| To add a citation using the "{{int:citoid-citoidtool-title}}" button, place your cursor where you want to add it in the text. Then on the "{{int:citoid-citoiddialog-title}}" dialog, select the appropriate tab.
|-
| colspan="2" |<hr />
|-
| colspan=2 |
 
==== AddingUsing a new referenceAutomatic tab====
|-
| colspan=2 |The '''[[:mw:Citoid|Citoid service]]''' takes a [[:en:URL|URL]] , [[:en:Digital object identifier|DOI]] , ISBNs, PMIDs, QID, and full text search, and returns a pre-filled, pre-formatted bibliographic citation. After creating it, you will be able to change or add information to the citation, in the same way that you edit any other pre-existing citation in VisualEditor. Later, editors will be able to improve precision and reduce the need for manual corrections by contributing to the Citoid service's definitions for each website.
|-
| [[File:Citoid in VisualEditor Screen Shot 2015-04-02.png|frameless|border|430px|center]]
| With [[:mw:Citoid|Citoid]] in VisualEditor, you click the 'book with bookmark' icon (next to the 'Links' icon) in the main toolbar, paste in the URL or DOI of a reliable source, and click 'Lookup'.
|-
|-
| colspan=2 | <hr />
|-
| [[File:Citoid results in VisualEditor referencesScreen Shot more2015-04-02.png|frameless|border|200px430px|center]]
| Citoid looks up the source and returns available citation details as result. Click the green "Insert" button to accept its results and add them to the article.
| To add a citation using the "{{int:citoid-citoidtool-title}}" menu, place your cursor where you want to add it in the text. Then on the "{{int:citoid-citoidtool-title}}" menu, select the appropriate item.
 
After inserting the citation, you can change it. Select the reference, and click the "Edit" button in the context menu to make changes.
|-
|
===== Using standard cite templates =====
|
|-
| colspan=2 | <hr />
|-
| [[File:Manual_tab_only_-_visual_editor_-_citations.png|frameless|border|500px|center]]
| The Manual tab offers quick access to the most-used citation templates. Extra citation templates can be added by following the directions at [[MW:VisualEditor/Citation tool|VisualEditor/Citation tool]].
 
|-
|-
| colspan=2 | <hr />
|-
| [[File:VisualEditor - Editing references - Cite book required fields.png|frameless|border|430px|center]]
| Clicking on a template icon such as "Cite book" will take you into the template mini-editor for that template. Important information fields may be marked with an asterisk. While the most common fields will be shown, not all of them are required.
|-
| colspan=2 | <hr />
|-
| [[File:VisualEditor - Editing references - Add parameter.png|frameless|border|230px|center]]
| To add additional parameters, scroll down in the template mini-editor and click on the "{{int:visualeditor-dialog-transclusion-add-param}}" option.
 
Click on "{{int:visualeditor-dialog-action-insert}}" when you're done.
|-
|-
| colspan=2 |
Line 309 ⟶ 353:
| colspan=2 |
 
==== Using standard cite templates ====
|-
| colspan=2 | <hr />
|-
| [[File:VisualEditor - Editing References - Cite Pulldown.png|frameless|border|150px|center]]
| Your local wiki may have added extra citation templates to this menu. This offers quick access to the most-used citation templates. (Instructions for adding extra citation templates to your local wiki are available at [[MW:VisualEditor/Citation tool|VisualEditor/Citation tool]].)
 
|-
|-
| colspan=2 | <hr />
|-
| [[File:VisualEditor - Editing references - Cite book required fields.png|frameless|border|430px|center]]
| Clicking on a template icon such as "Cite book" will take you into the template mini-editor for that template. Important information fields may be marked with an asterisk. While the most common fields will be shown, not all of them are required.
|-
| colspan=2 | <hr />
|-
| [[File:VisualEditor - Editing references - Add parameter.png|frameless|border|230px|center]]
| To add additional parameters, scroll down in the template mini-editor and click on the "{{int:visualeditor-dialog-transclusion-add-param}}" option.
 
Click on "{{int:visualeditor-dialog-action-insert}}" when you're done.
|-
|-
| colspan=2 |
 
==== Using Citoid ====
|-
| colspan=2 |The '''[[:mw:Citoid|Citoid service]]''' takes a [[:en:URL|URL]] or [[:en:Digital object identifier|DOI]] for a reliable source, and returns a pre-filled, pre-formatted bibliographic citation. After creating it, you will be able to change or add information to the citation, in the same way that you edit any other pre-existing citation in VisualEditor. Support for ISBNs, PMIDs, and other identifiers is planned. Later, editors will be able to improve precision and reduce the need for manual corrections by contributing to the Citoid service's definitions for each website.
|-
| [[File:Citoid in VisualEditor Screen Shot 2015-04-02.png|frameless|border|430px|center]]
| With [[:mw:Citoid|Citoid]] in VisualEditor, you click the 'book with bookmark' icon (next to the 'Links' icon) in the main toolbar, paste in the URL or DOI of a reliable source, and click 'Lookup'.
|-
|-
| colspan=2 | <hr />
|-
| [[File:Citoid results in VisualEditor Screen Shot 2015-04-02.png|frameless|border|430px|center]]
| Citoid looks up the source and returns available citation details as result. Click the green "Insert" button to accept its results and add them to the article.
 
After inserting the citation, you can change it. Select the reference, and click the "Edit" button in the context menu to make changes.
|}
 
Line 469 ⟶ 475:
| colspan=2 | <hr />
|-
|If a template has been updated to contain [[VisualEditor/Portal/Wikipedia:TemplateData#What_is_TemplateData.3FWhat is template data?|TemplateData]] information, then the dialog will show a list of all available individual (named) parameters. in the left sidebar
|[[File:VisualEditor template with TemplateData.png|frameless|border|center|400px]]
|-
| colspan=2 | <hr />
|-
| For an existing template, you can edit the parameters shown in the dialog, and you can add and remove parameters byfrom clickingthe main "{{int:visualeditor-dialog-transclusion- by checking and unchecking its checkbox in the sidebar. To add-param}}" an undocumented parameter, press Ctrl+⇧ Shift+D on your keyboard. The input field will appear at the very bottom of the dialog.
| [[File:VisualEditor - Template editing 3.png|frameless|border|center|500px]]
|-
Line 492 ⟶ 498:
|-
| 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|frameless|border|center|150px]]
|-
| colspan=2 | <hr />
Line 536 ⟶ 542:
|-
| [[File:VisualEditor lists 4 indentation menu.png|frameless|border|center|400px]]
| 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)
|-
| colspan=2 | <hr />
Line 550 ⟶ 556:
 
== Editing tables ==
{{Main|Help:Table#Tables and the visual editor (VE)}}
 
{| cellpadding="15"
Line 593 ⟶ 600:
| colspan=2 | <hr />
|-
|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.
|[[File:VisualEditor tables split cells.png|frameless|border|center|200px]]
|}