Help:VisualEditor/User guide/Citation templates
| File:PD-icon.svg | Note: When you edit this page, you agree to release your contribution under the CC0. See Public Domain Help Pages for more info. | File:PD-icon.svg |
This page is a guide to adding footnotes (also called "citations", "inline citations" or "references") when local citation templates have been configured for your wiki, but the citoid service has not been set up for your wiki.
The toolbar
| The VisualEditor toolbar appears at the top of the screen when you begin editing. | |
| Cite button: The "Cite" button is used to add footnotes. All projects have access to "Basic" reference formatting and the ability to "Re-use" citations from here. This dialog also gives you quick access to local citation templates.
(Instructions for adding more local citation templates to the Cite menu at your wiki are available at VisualEditor/Citation tool.) | |
Insert: The "Insert" menu may be different on some projects. Two options are useful for citations:
| |
Editing an existing footnote
| To edit an existing footnote, click on it where it appears in the text (usually as a bracketed number). You will then see either a "Basic" icon (bookmark) or, an another icon with the name of the template that was used to create this footnote. Clicking on the "Edit" button will open a dialog where you can edit the footnote. | |
| If you are editing a "Basic" footnote, clicking on "Edit" will open the Reference dialog, where you can edit the text which is in the footnote. Editing this text is similar to editing in the main window - you can format text, add a link, or use special characters.
Unless you are sure you know what you are doing, do not use the Cite or Insert menus within the Reference dialog. | |
| If, instead of the "Basic" icon (bookmark), what appears when you click on a footnote is an icon for a standard template for citations, then clicking on "Edit" will take you directly to the template mini-editor dialog. | |
| In the template mini-editor, fields (template parameters) that already have content will be shown initially. While some recommended parameters will also be shown, not all of them are required. You can remove them from the main dialog by unchecking the checkbox in the sidebar. If a parameter’s checkbox is greyed out and not clickable, that field is required and can't be removed.
To add an entirely new field, use the shortcut Ctrl+⇧ Shift+D and then click on "Add undocumented parameter" at the bottom of the mini-editor. | |
| Click on "Apply changes" when you're done. | |
Re-using an existing footnote
| Ideally, every sentence or paragraph in an article should be supported by a citation, in a footnote. If you have some text that needs a citation (source) to support it, and the page already has a footnote that applies to (supports) that text, then you can re-use the existing citation, because one footnote can support multiple, different sentences or paragraphs.
To re-use an existing reference, place your cursor in the body of the text where you want to add a footnote. Then from the "Cite" dialog, click on the "Re-use" tab. Then 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 find only those references that include certain text. | |
Adding a new footnote
Using a standard citation template for a new footnote
| The "Cite" button is used to add a new footnote. First, place your cursor where you want to add a footnote, in the text. Then, click on the "⧼citoid-citoiddialog-mode-manual⧽" tab. Then select a standard citation type in the dialog. If the citation type you want is not on the menu, select the "Basic" item. (Instructions for adding more citation templates to this menu, on your local wiki, are available at VisualEditor/Citation tool.) | |
| Clicking on a standard cite template icon such as "Book" will take you into the template mini-editor for that template. While the most common fields (template parameters) will be shown, not all of them are required. Important fields may be marked with an asterisk and a grey checkbox in the left sidebar. Optional fields (blue checkbox) can be added and removed from the template by checking and unchecking them in the sidebar.
To add an entirely new field, use the shortcut Ctrl+⇧ Shift+D and then click on "Add undocumented parameter" at the bottom of the mini editor. Click on "Insert" when you're done. | |
Using the Basic citation for a new footnote
| You can also choose the "Basic" item from the "Cite" menu.
The "Basic" item is used for two purposes. You can create a footnote that doesn't use any citation template. Or you can create a footnote using a citation template that is not on the "Cite" menu. | |
| Shown here is an example of selecting the "Basic" item, and then, in the Reference editor, adding text, including formatting, but not using a citation template.
You can make the new footnote belong to a group other than general references, although this is normally not done. (If you do have two or more groups of footnotes, the "References list" tool must specify the group of footnotes to be displayed). | |
| In the Reference dialog, you can get to a citation template that is not (yet) on the "Cite" menu. From the "Insert" toolbar menu, click on the Template icon (puzzle piece). | |
| 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, below, 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. | |
Adding a citation outside of a footnote
How to create a ==Further reading== list using Insert > Template > Cite book (etc.)
| You can add citation templates directly into the article, without putting them in footnotes or by using Basic references editor. From the Insert menu, click on the "Template" icon (a puzzle piece) | |
| 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. | |
