Wikipedia:RefToolbar/2.0

This screencast walks through how to use the various features of RefTools.

RefToolbar 2.0 is the current version of RefToolbar, which adds citing capability to the enhanced editing toolbar (the MediaWiki extension WikiEditor). It may appear two different ways depending on a user's preferences. See the troubleshooting section below for details.

Reftoolbar 2.0 consists of a series of JavaScript scripts that use the jQuery and jQuery UI JavaScript libraries. It also makes use of the JSON standard.

RefToolbar 2.0 is now turned on by default for all users on English Wikipedia. You don't have to do anything to install it.

To disable the refTools script from loading, add the following line to your skin JS page:

On the left side of the Cite panel is a dropdown list of all available templates. Clicking one will open a dialog box with the fields for that template. Buttons on the bottom of the dialog are used to insert the ref into the article, preview the ref, reset the form, and close the dialog without changing the article. Clicking Nuvola apps date.svg will insert the current date into the adjacent text box. Clicking System-search.svg will attempt to autofill citation details given an ID entered in the adjacent text box. An ISBN, DOI, or PMID can be used for autofilling.

Clicking the "Named refs" button will open a dialog listing all of the named references in the article. Choosing one will show the wikitext of the reference with an option to preview how the reference looks after parsing. Clicking the "Insert" button will insert the named reference (<ref name=Foo />) into the last cursor position in the article.

To use error checking, click the Error check symbol, then select the error checks to run. A panel listing any errors found will be inserted underneath the edit area. Additional error checks can be added, see below for details.

Unlike the old version of the script, this version is highly customizable sitewide and on a per-user basis.

Note that while the script is designed to be easily configurable, the configuration options do need to be valid JavaScript code - brackets and parentheses must be matched and strings must be wrapped in quotation marks with quotation marks in the string escaped as necessary.

Configuration is done using a global CiteTB object. Configuration options are stored in CiteTB.Options and CiteTB.UserOptions

No customization is required, the script will use the sitewide defaults "out of the box". All user configuration options override the sitewide options.

Changing the date format used for automatically added dates (such as accessdate) is done using a simple string replacement system. "Special" words will be replaced with their corresponding date, all other characters will be left as-is.

Other options may be available on request. Currently only one format will be used. If there is demand for it, the automatic date system may be extended to allow multiple options in a dropdown selection box. The date is always in UTC.

The fields that have an automatic date option are stored in the "autodate fields" option.

To set whether the dialogs should be modal, use the "modal" option. If set to true, opening one of the dialogs will block access to the rest of the edit page until the dialog is closed.

The script can be set to automatically provide a parsed preview when previewing a citation template through the "autoparse" option. Its not recommended to set this to true as a global setting as it may slow the script down for people with slow connections.

The month names used for automatic date insertion are also customizable, for translation to other languages, or to use abbreviations.

Citation templates can be added using an object syntax. To add a new template, simply create a new citeTemplate object. Each template has 4 required parameters.

For sitewide settings, templates should be included in the RefToolbarConfig page. Users can also add their own templates with this system by adding them to their user script page. If the script is installed on the user script page (as opposed to using a gadget), the templates must be below where the script is imported.

Each field is described as an object in a list, using JavaScript Object Notation. The basic options are:

The object system allows other options for additional features, which are described below.

For fields such as authors and editors where it is frequently necessary to specify more than one, automatic-incrementing fields can be used. For each field, an "increment_group" option is set. This allows fields such as last/first to be incremented together, as long as they're in the same group. One field in each group should also have an "increment_button" option set - this field will have a button (Nuvola action edit add.svg) next to them to increment them. The name of the field should contain "<N>", which will be replaced with the incrementing numbers when the template is generated. For the label on the dialog, the "<N>" will be removed. For example, to create separate last/first, but a single editor field, the following would be specified:

For authors, auto-incrementing fields can also be used with the autofilling options, see the section below for details.

For multiple authors, the autofill system accepts several possible options. In order that the script checks for:

If using the lastN / firstN or authorN option, coauthors must also be set, otherwise some authors may be omitted if there are more authors than fields specified. For the automatic-incrementing options to work properly, they should be set up as auto-incrementing fields.

There are also several options for dates and the behavior of the script will depend on how complete a date is returned by the database. Not all DOI/PMIDs will return a full date. For DOI/PMID

For DOI/PMID, date is required, month and year are optional. For ISBN, only year is used.

Error checking functions can be added in a way similar to citation templates. The citeErrorCheck object requires one parameter, an object. This object should contain certain the information as described below. Currently all attributes are required. In the future, optional attributes may be added to support other features.

There are currently 3 types of error checks. The differences between them are described below:

The function given is passed each ref individually, it should return a single error object or not return.
The function is passed the entire list of references, it should return an array of error objects.
The function is passed the wikitext of the article, it should return an array of error objects.

An error object is a JavaScript object that should contain 2 attributes. The 'msg' attribute should be an error message describing the problem and the 'err' attribute should be a portion of the wikitext showing the error, such as the content of the reference with the problem.

Some example code for a simple function that checks whether each reference uses a template could be:

"Does not use a <a href='http://en.wikipedia.org/wiki/Wikipedia:Citation_templates'>citation template</a>"

The refToolbar comes in three versions, depending on the settings at Preferences → Editing → Editor:

This script is designed to be easily portable to other wikis that use a similar (template-based) reference system.

You should not need to copy the main script itself. You can, but it means that you will have to check for changes and manually update to receive bug fixes and new features. You do need to copy the following files to your wiki (this requires sysop access on the wiki the script is being ported to). Then you can customize the options, templates, error functions, and translate the messages as necessary.

Note: If you translate the "field" names in the "MediaWiki:RefToolbarConfig.js" page, you also need to change the corresponding message keys at "MediaWiki:RefToolbarMessages-<language code>.js", to avoid "null" descriptions in the popups.

Note that the script has not yet been tested using RTL (right to left) languages.

Ensure that the Gadgets extension has been installed in the LocalSettings.php file. Then follow these steps to install RefToolbar as a gadget:

To enable this tool for everyone, follow the same steps as above but add the "default" option to the gadget's definition:

This section covers information relevant to developers that might not be covered above.

Descriptions of the citeTemplate and citeErrorCheck objects are described in detail in above sections.

Reference objects are created for each reference currently on the page, and whenever a reference is added by the script. Reference objects have several attributes:

The script uses the jQuery library, which is well documented at . It also uses some modules from WikiEditor extension, which is documented at mw:Extension:WikiEditor/Toolbar customization.