User:Jeropbrenda/Sandbox/CitationWithCitoid

From MediaWiki.org
Jump to navigation Jump to search

Overview[edit]

This page is a guide to adding footnotes (also called "citations", "inline citations" or "references") when the citoid service has been configured for your wiki.

Citoid is a service that automatically creates a citation template given a URL, DOI, ISBN, PMID, PMCID or QID. It has a companion extension, Citoid, which makes use of VisualEditor's citation tool to provide the citoid service to VisualEditor.

The toolbar[edit]

The VisualEditor toolbar appears at the top of the screen when you begin editing. It includes the icons that will be needed in order to add citations to the page.

VisualEditor toolbar-en.png

Prerequisites[edit]

VisualEditor's citation tool should be enabled in your wiki. If the citation tool is enabled, a "Cite" dropdown menu will be available in the toolbar. Instructions on how to enable the citation tool are available at VisualEditor/Citation tool

Citoid should be configured in your wiki. If configured, a "⧼citoid-citefromidtool-title⧽" button will be available in your toolbar. If both the citation tool and the citoid service are enabled, the "Cite" dropdown menu will be replaced by the "⧼citoid-citefromidtool-title⧽" button. Instructions on how to configure citoid are available at Citoid/Enabling Citoid on your wiki

Add a new reference[edit]

Click on the "⧼citoid-citefromidtool-title⧽" button in the toolbar. This will open a dialog box with three tabs: Automatic, Manual, and Re-use.

Automatic[edit]


In the automatic field you can enter a variety of input and a citation template will be automatically generated. You can input a URL (website address), a unique identifier like an ISBN for books, DOI (Digital Object Identifier), PubMed ID, PMCID (including the PMC prefix), or QID (from Wikidata). You can also enter a plain text fully formatted citation or title of the work.

You should be as specific as possible, as the citoid service returns only the first result from both WorldCat (which mostly contains books) and Crossref (which mostly contains academic papers), in a random order.

VisualEditor Citoid Inspector-en.png

Manual[edit]

There are two ways to add footnotes from the Manual tab: using a standard citation template, or using the basic form.

Using standard cite templates[edit]


Your local wiki may have added extra citation templates to this menu. This offers quick access to the most frequently used citation templates. (Instructions for adding extra citation templates to your local wiki are available at VisualEditor/Citation tool.)
Manual tab citation.png

Clicking on a template item such as "VisualEditor icon ref-cite-book.svg Book" will take you into the template mini-editor for that citation template. Required information fields will be marked with an asterisk.
VisualEditor - Editing references - Cite book required fields.png

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

Click on "Insert" when you're done.

Using the "Basic" citation[edit]


Clicking on "Basic" will open the basic Reference editor, where you can type your citation, including formatting. You can also use the Basic form to insert a citation template that is not in the list of frequently used citation templates (see next).

You can make the reference belong to a given group, although normally this is left blank. (This option is used to display different groups of references separately with the "References list" tool.)

VisualEditor - Editing references 20.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 Template Insert Menu-en.png

Then, look for the template you want to use, add it and edit it as you would any other template.
VisualEditor - Editing references 9.png

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

Edit an existing reference[edit]

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.

Note Note: It is not possible to select and edit a footnote by clicking on it in the References list. Clicking on the References list will highlight the whole list and open the References list editor.

VisualEditor - Editing references 1.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 6.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 - Cite Web.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 - Editing references 5.png

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

Re-use an existing reference[edit]

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 "⧼citoid-citefromidtool-title⧽" button in the toolbar, and click on the "Re-use" tab from the dialog box.

VisualEditor Citoid Re-use.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.
VisualEditor - Editing references 18.png

Position the list of references[edit]

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 Insert Menu-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".

VisualEditor references list-en.png

Add a citation outside of a footnote[edit]

You can add citation templates directly into the article, without putting them in footnotes (this can be helpful if you want to create, say, a "Further Reading" list). The citoid service will not automatically fill in these citation templates.
Further reading.png

Place your cursor where you want the citation template to appear (if you are creating a "Further Reading" list, this may be after a bullet point), then from the "Insert" menu, click on the "Template" icon (a puzzle piece).
VisualEditor Template Insert Menu-en.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.

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 (if you are creating a "Further Reading" list, you will have to repeat the steps above at every bullet point of the list).

Cite book Screenshot.png

See also[edit]