Help:VisualEditor/User guide/Citations-Full

From MediaWiki.org
Jump to: navigation, search
Translate this page; This page contains changes which are not marked for translation.

Other languages:
български • ‎Cymraeg • ‎English • ‎日本語 • ‎português do Brasil • ‎سنڌي
PD Note: When you edit this page, you agree to release your contribution under the CC0. See Public Domain Help Pages for more info.
PD
Warning Warning: Translation admins: Please do not mark this page for translation while it's still a draft. The content is being re-written and simplified before being marked for translation, and marking it for translation (including adding translation tags to sentences that still need to be re-written) before that's done increases the work of volunteer writers and translators. Thank you!

The toolbar[edit]

Screenshot of the VisualEditor toolbar
The VisualEditor toolbar appears at the top of the screen when you begin editing. It includes some familiar icons:
VisualEditor citoid Cite button.png
Cite menu: The "Cite" menu or button 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 here. This menu also gives you quick access to local citation templates and the citoid automatic reference filling service, if these are enabled on your wiki.

(Instructions for adding local citation templates to the Cite menu at a specific wiki are available at VisualEditor/Citation tool. Instructions for enabling the citoid service are at Citoid/Enabling Citoid on your wiki.)

VisualEditor Insert Menu-en.png
Insert: The "Insert" menu may be different on some projects. Two options are useful for citations:
  • The "Template" icon (a puzzle piece) allows you to insert and edit templates.
  • The "References list" 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.

Editing an existing reference[edit]


VisualEditor - Editing references 1.png
To edit an existing reference, click on it where it appears in the text (usually as a bracketed number). You will see either a "Basic" icon (bookmark) or an icon (and name) for the template that was used to create this reference. Clicking on this icon will open a dialog where you can edit the reference.

VisualEditor - Editing references 6.png
If what appears is the "Basic" icon, clicking on it opens the Reference dialog, where you can edit the reference's contents.

Many wikis use templates to format references. 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.

If a template was used and you've clicked on information in that template, then the Template icon (puzzle piece) will appear. Click on that icon to edit the content of the template in the template mini-editor dialog.


VisualEditor - Editing References - Cite Web.png
If, instead of the "Basic" icon (bookmark), what appears when you click on a reference is an icon for a standard template for citations, then clicking on that icon will take you directly to the template mini-editor dialog.

VisualEditor - Editing references 5.png
Inside the template mini-editor, you can add or remove types of information or change current content. Only fields (template parameters) that have content are supposed to be shown initially. To add fields, click on "Add more information" at the bottom of the mini-editor.

VisualEditor Apply Changes-en.png
Click on "Apply changes" when you're done.

Re-using an existing reference[edit]

VisualEditor Citoid Re-use.png
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. Then click on the "Re-use" item from the "Cite" menu.


VisualEditor - Editing references 18.png
In the Reference 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 "Search within current citations") to list only those references that include certain text.

Adding a new reference[edit]

Clicking on the Cite menu opens a dialog box with three tabs: Automatic, Manual, and Re-use

Automatic[edit]

VisualEditor Citoid Inspector-en.png

Manual[edit]

VisualEditor Citoid Manual.png

There are two types of footnotes that can be added from the Manual tab - using a standard template, or using the basic template.

Using standard cite templates[edit]

VisualEditor - Editing References - Cite Pulldown.png
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 VisualEditor/Citation tool.)

VisualEditor - Editing references - Cite book required fields.png
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.

VisualEditor - Editing references - Add parameter.png
To add more parameters, scroll down in the template mini-editor and click on the "Add more information" option.

Click on "Insert" when you're done.

Using the "Basic" citation[edit]


VisualEditor - Editing references 20.png
Shown here is what you will see if you select the "Basic" 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.)


VisualEditor Template Insert Menu-en.png
In the Reference dialog, if you want to include a template in your new reference, click the Template icon (puzzle piece) in the "Insert" toolbar menu within the Reference editor.

VisualEditor - Editing references 9.png
Then, look for the template you want to use, add it and edit it as you would any other template. (See the Editing templates section, below, if you need more information about templates.)

After you're done editing your new template, click on "Apply changes" to return to the Reference editor, and "Apply changes" again to return to the page you're editing.


VisualEditor References List Insert Menu-en.png
If there isn't already a list of references on the page (for example, if you're adding the first reference for the page), you need to specify where the list of references, and their text, will be displayed to the reader.

Place the cursor where you want to display the references list (usually at the bottom of the page), open the "Insert" menu and click the "References list" icon (three books).


VisualEditor references list-en.png
If you are using several groups of references, which is relatively rare, you can specify the group in this dialog. Only the references that belong to that group will be displayed here.

The final step in the References list dialog is to click "Insert".

Manually editing a template-built footnote[edit]

ConvertManualCiteToBasicCite 001.png
Sometimes you want a footnote to contain more than a citation template. You can make changes to such a footnote using the "Basic form" footnote editor.

ConvertManualCiteToBasicCite 002.png
Click once on the footnote that you want to edit, to select it. Don't click on the "Edit" button in the pop-up dialog, because that will take you to the simplified template editor. Instead, click on the "Cite" button in the main toolbar.

ConvertManualCiteToBasicCite 003.png
The "Cite" button will take you to the citation dialog. Choose the "Manual" tab, and then click on "Basic form".

ConvertManualCiteToBasicCite 004.png
Clicking "Basic form" will take you to a free-form text editor for the footnote. The existing information in the footnote, a citation template, will be shown. You can place your cursor before or after the citation template to type additional text or to insert pictures, templates, mathematical formulae, or more next to the citation template.

You can also do a several things with the existing citation template. You could delete that template, and then replace it with other content. (This is convenient if you are replacing a named footnote and want all instances on the page to be replaced by your new content.) You could copy the template so that it could be pasted somewhere else (as a citation, not a footnote). Or you could double-click the citation template to open the template editor.


ConvertManualCiteToBasicCite 005.png
To add a new template, click the "Insert" menu and then choose "Template". The process is then the same as adding a template to the main page.

ConvertManualCiteToBasicCite 008.png
When you have finished filling in all of the relevant fields for the template, click "Insert". The template you just added will appear where your cursor was originally placed.

When you have finished inserting text, templates, and other content, click on "Apply changes" to go back to the main editing window.


Image Text

Adding a citation outside of a footnote[edit]

How to create a ==Further reading== list using Insert > Template > Cite book (etc.)

VisualEditor Template Insert Menu-en.png
You can add citation templates directly into the article, without putting them in footnotes. From the Insert menu, click on the "Template" icon (a puzzle piece)

VisualEditor - Editing references 9.png
Then, type the name (or part of the name) of the citation template you want to use, select it, click on "Add template", and edit it as you would any other template. (See the Editing templates section in the user guide if you need more information about templates.)

After you're done editing the template, click on "Insert" to return to the Reference editor, and "Insert" again to return to the page you're editing.


Image Text

Image Text