Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Pubmed Plugin

The Pubmed Plugin is for Grav CMS. It uses the National Center for Biotechnology Information's E-utils API to access pubmed information about publications. This is accomplished by passing UIDs via a special shortcode.

For a demo, visit my blog.

Installation

Installing the Pubmed plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.

GPM Installation (Preferred)

The simplest way to install this plugin is via the Grav Package Manager (GPM) through your system's terminal (also called the command line). From the root of your Grav install type:

bin/gpm install pubmed

This will install the Pubmed plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/pubmed.

Manual Installation

To install this plugin, just download the zip version of this repository and unzip it under /your/site/grav/user/plugins. Then, rename the folder to pubmed. You can find these files either on GitHub or via GetGrav.org.

You should now have all the plugin files under

/your/site/grav/user/plugins/pubmed

NOTE: This plugin is a modular component for Grav which requires Grav; the Error, Problems, and Shortcode Core plugins; and a theme to be installed in order to operate.

Usage

This plugin extends the Shortcode Core interface. It accepts two parameters:

  • type, which must be one of the following:
    • short
    • long
    • summary
  • ids, which must be a list of UIDs separated by commas (no spaces!)

The following are valid shortcodes:

  • [pubmed type=short ids=11111]
  • [pubmed type=long ids=11111,22222]
  • [pubmed type=summary ids=11111,22222,33333]

The expanded shortcode is cached. The UID string and results are also cached so that if you have multiple pages citing the same UID string, only one external API call will be made.

You can customize the exact contents of the short and long citation as described in the Configuration section. The summary report is a raw dump of the returned JSON data from the E-utils service.

If an error occurs, the short or long output will be replaced by a message stating there was a problem fetching that UID.

Each citation is enclosed in a named <div></div> for easy styling. See the Customization section.

Configuration

To change the configuration, copy pubmed.yaml from the plugins/pubmed folder into your config/plugins folder. That way, if the plugin gets updated, your custom configuration is not lost.

The default configuration is as follows:

enabled: true

# Formats are a string that only contain 
#   - valid field names enclosed in square brackets
#   - HTML is permitted, so insert <br> for line breaks
#   - other literals (printed as is)
#
# Valid field names are as follows (case sensitive!)
#   - uid
#   - title
#   - authors_long
#   - authors_short
#   - journal
#   - volume
#   - pages
#   - date
#
# Raw fields are fields not embedded into <span></span> tags.
# They are suitable to build links, for instance.

formats:
  short: "[authors_short] [journal] [volume] [pages] [date]"
  long: "<a href='https://www.ncbi.nlm.nih.gov/pubmed/[uid raw]'>[title]</a><br>[authors_long] [journal] [volume] [pages] [date]"
  author_sep: ", "  # string that is inserted between list of authors when using [authors_long]
  • enabled tells Grav to run the plugin. If you set this to false, the plugin will be fully disabled and the shortcodes will print as is.

  • formats gives you flexibility over how the short and long versions are formatted. The embedded instructions are hopefully self-explanatory.

Customization

Each citation is enclosed in a named <div></div>. Each element of the citation also has a class assigned to it for easy styling. Copy the pubmed.css file from the plugins/pubmed/assets folder and add it to your theme's assets folder. Edit as you see fit.