Giter Club home page Giter Club logo

academic-bloggers-toolkit's Introduction

Coverage Status Build Status WordPress Dependencies Changelog

Academic Blogger's Toolkit

An open source WordPress plugin providing an all-in-one solution for effective academic blogging.

Contents

Manifesto

To my knowledge, there is not one citation plugin that exists for WordPress that does its job the way it should. Every other citation plugin uses WordPress shortcodes to render citations. Is that a bad thing. Yes. Here's why:

Once you commit to using a plugin that uses shortcodes to render content, you're stuck with it for the life of your website. If you uninstall that plugin, all posts which rely on the shortcodes from that plugin break. Additionally, if the person who wrote the plugin decides he/she no longer wants to support it and the shortcode API changes, all of your posts will break. This is unacceptable for academic writing.

This plugin generates plain, beautiful HTML and renders it at the time of insertion. There are zero shortcodes. There is zero chance of your posts breaking.

Need to write one long blog post with lots of references? Download this plugin, write the post, and then delete the plugin if you don't need it any longer. Freedom.

Features

  • Insert formatted references on the fly using digital identifiers (PMID or DOI).
  • Manually insert formatted references from over 15 types of references.
  • Import a full bibliography from your favorite reference manager using an exported .ris file.
  • Automatically format references for every citation style on planet earth (over 1300).
  • Fully interactive reference list which lives beside the post editor.
  • Search PubMed from the post editor and insert references instantly.
  • Inline citations display full formatted references on the frontend when hovered with the mouse (or when tapped on mobile). No more scrolling down and losing your focus!

Translations

Click Here to Translate this Plugin

Translations for this plugin can be completed and submitted here. After submission of a translation, I'll try to update the plugin with your translations within 7 days.

Contributing

If you'd like to contribute to this project, please read the contributor guide.

Usage

Adding References

Removing References

Citing References

Citation Styles

Miscellaneous

Keyboard Shortcuts

(feel free to request more)

PC/Linux Mac Action
ctrl-alt-r cmd-alt-r Open the Add References menu

Tips 'n Tricks

  • Double click the heading to either Cited Items or Uncited Items to fully expand that list and simultaneously collapse the other.

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 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].

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 [2e].

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. Upload the file to your WordPress site using the WordPress Media Manager and copy the direct URL to the file.

    Upload Custom CSL

  5. Paste the URL in the field shown below.

    Paste Custom CSL URL

    Note: Selecting the radio button labelled Use custom citation style by default is completely optional. If checked, then the style will automatically be used as default for new posts. If not, you will still be able to choose the style from the reference list.

  6. Click Update.

    Note: The URL will be verified by the plugin and converted from a URL to a path automatically. In other words, if you notice that the URL changes after clicking the Update button, that means everything worked!

  7. The custom style will now be accessible from the reference list.

    Custom Style Reference List

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

academic-bloggers-toolkit's People

Contributors

dsifford avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.