Skip to content
This repository has been archived by the owner on Mar 29, 2021. It is now read-only.
mjluser1 edited this page Jan 15, 2018 · 16 revisions

ABT Banner

Documentation

Installing or re-installing the plugin

Adding References

Removing References

Citing References

Citation Styles

Static Publication Lists

Miscellaneous

Keyboard Shortcuts

Feel free to request more!

PC/Linux Mac Action
ctrl + alt + r cmd + alt + r Open the Add References menu
ctrl + alt + p cmd + alt + p Pin/Unpin reference list
ctrl + z cmd + z Undo last change

Tips 'n Tricks

  • Double click on Cited Items or Uncited Items to fully expand that list while simultaneously collapsing the other.

Setting global citation style

After installing or re-installing, the default citation style needs to be changed to the desired style. The default is American Medical Association. It can be changed by typing in the name of the desired style and clicking on the Update button at the bottom right of the field. The field is a dropdown menu showing the styles starting with the letters typed into the field. For technical reasons, the field cannot recognize standard abbreviations for styles (e.g., APA for American Psychological Association). Thus start typing the full name and then select the desired version of the APA style from those shown on the dropdown menu.

Adding references automatically

  1. Click Add References to Reference List button [1b].
  2. Type a comma-separated list of one or more PMIDs or DOIs in the window that pops up [3].
  3. Click Add Reference [3c].

Adding references manually

  1. Click Add References to Reference List button [1b].
  2. Click Add Manually button [3a].
  3. Select your citation type from the dropdown list on the top [4a].
  4. Fill out the details for as many contributors as you are able to.
    • If another contributor is needed, click Add Another [4b], choose the contributor type [4c], and fill out his/her details. These contributors should be written in order.
    • If you need to remove a contributor, click the x button beside the contributor's name [4d].
  5. Fill out as much information about the reference as you can in the form below. Items highlighted in red are mandatory.
  6. When finished, click Add Reference.

Adding webpage references automatically using URL

Note: Some webpages actively prevent metadata scraping. These sites will not work (and you'll receive an error message letting you know). Additionally, sites behind a paywall will not work (e.g. www.wsj.com).

  1. Click Add References to Reference List button [1b].
  2. Click Add Manually button [3a].
  3. Enter the URL for the desired webpage in the Autocite input field and click Search or press Enter.
  4. The fields will then become populated with all the information the plugin was able to scrape from the web page (be sure to double-check this information for accuracy).
  5. When finished, click Add Reference.

Adding references using RIS file

Note: Currently, users are able to import entire reference lists using the widely available RIS format. This section assumes that you have already exported a .ris file from your reference manager, PubMed, or some other web service.

  1. Click the "hamburger menu" icon to open the secondary menu [1e].
  2. Click the Import references from RIS file button [2a].
  3. Click the Choose File button [5a] and select your .ris file.
  4. Click Import [5b] to import the references to your uncited list.

Removing one or more single references

Note: This action will delete references from your reference list, your bibliography, and all locations where it has been cited in the document. It will also adjust your inline citation numbers in your document automatically after the action has taken place.

  1. Click on one or more references in either the Cited Items or Uncited Items lists to select them. Selected items have a blue left border [6a,6b]
  2. Click Remove selected items from reference list to remove the selected references [1c].

Removing all references

Note: This is the single-most destructive action that you can perform. Be very cautious when doing this as it will delete all traces of references that you have added to your reference list, document, and bibliography.

  1. Click the "hamburger menu" button to expose the secondary menu [1e].
  2. Click the Delete all references button [2c].

Citing references at the same time the reference is added

  1. Be sure the carat is located at the postion that you want your citation added in the document.
  2. Follow the same instructions for adding references automatically or adding references manually.
  3. Just before clicking Add Reference in the final step, be sure that the Attach Inline checkbox [3d] is checked.

Citing references after the reference has been added

Note: References cited from the Uncited List will be brought into the cited list automatically as they are cited.

  1. Be sure the carat is located at the postion that you want your citation added in the document.
  2. Select all items that you'd like to cite at the current position (selected items have a blue left border [6a,6b]).
  3. Click Insert Selected References [1a].

Adding additional references to existing citation blocks

  1. Click the citation block to select it.
  2. Select all additional items that you'd like to add to the citation block in the reference list.
  3. Click Insert Selected References [1a].

Changing citation style

Permanently
  1. Navigate to the Academic Blogger's Toolkit options menu by clicking Settings -> Academic Blogger's Toolkit in the WordPress sidebar.
  2. Choose a citation style from the dropdown menu.
  3. Click Update.
For a single document

Note: Changing the citation style in the document will automatically adjust inline citations and the bibliography to match the newly chosen citation style.

  1. Click the "hamburger menu" button to expose the secondary menu [1e].
  2. Choose a citation style from the dropdown menu [2f].

Using a custom citation style

  1. Visit this link to create a fully custom citation style, or make tweaks to an existing style. Documentation for this service can be found here.
  2. After creating your citation style, select Style -> Save Style in the toolbar.

    Save CSL Style

  3. In the next window that pops up, select Save to Disk to save to your computer.

    CSL Save to Disk

  4. Navigate to the ABT options page and in the citation style panel, choose "Custom".
  5. Use the file upload input box to upload the .csl file that you just created.
  6. Click Update.

Inserting static publication lists

Note: Once a static publication list is inserted in the document, it will persist exactly the same state until manually deleted. See this issue comment for a more information on this.

  1. Be sure the carat is located in the position where you'd like the static publication list to be placed in your document.
  2. Click on one or more references in either the Cited Items or Uncited Items lists to select them. Selected items have a blue left border. [6a,6b]
  3. Click the "hamburger menu" button [1e] to open the menu.
  4. Click the "Insert Static Publication List" icon. [2d]

Adding references to existing static publication lists

  1. Click an existing publication list to select to.
  2. Select all additional references that you'd like to the selected publication list from the reference list.
  3. Click the "hamburger menu" button [1e] to open the menu.
  4. Click the "Insert Static Publication List" icon to insert the selected references into the selected static publication list. [2d]

Removing static publication lists

  1. Click the publication list that you'd like to remove with your mouse to select it.
  2. Press backspace or delete to remove it.

Pinning reference list

  1. Click the pin icon [1d] to toggle floating mode.

Note: During floating mode, the reference list will be resized dynamically to fit within the boundaries of your screen. This is by design. Without this, you would not be able to reach items below the lower margin of your screen.

Changing citation number or position

DO NOT DO THIS

The citation processor automatically sorts and inserts your citations based on how they are supposed to be sorted by your chosen citation style. In other words, each time that a citation is added to your document, EVERY citation within the document is checked and updated, where appropriate. If you attempt to move around citation numbers or alter the HTML generated by the processor in any way, the processor will fail.

If you find that the citation ordering is not the way that you like it, choose a different citation style.

Visual Aids

# Image
1.

Reference List Main Menu

2.

Secondary Menu

3.

Automatic Reference Insertion

4.

Manual Reference Window

5.

RIS Import Menu

6.

Cited and Uncited Lists