Jump to table of contents

About Plugins

Introduction #

The plugin inventory brings together links to existing plugin documentation for OJS/OMP/OPS. This list is not exhaustive and will continue to be updated as more plugin guides become available. All plugins on this list should be compatible with OJS/OMP/OPS 3.2+. For compatibility details, see the live plugin gallery list on GitHub, a list of compatible plugins for possible installation with version listing.

The OJS/OMP/OPS built-in Plugin Gallery provides access to externally-created plugins that may not be included in your OJS/OMP/OPS installation, but are available for download and activation. Only an Administrator can install a new plugin. For a full list of plugins included in the Plugin Gallery consult the live plugin gallery list on GitHub.

Sometimes new plugins or plugins that are developed by users or contributors outside of PKP will not appear in the Plugin Gallery and you need to install them separately. For more details on how to do that consult the External Plugins section of the Learning OJS guide.

Find a plugin compatible with your software version #

The best way to identify and install a plugin compatible with your version of OJS/OMP/OPS is from within the platform’s Plugin Gallery. The Plugin Gallery will only show plugins compatible with your version and will refresh automatically to reflect the plugins added to the live plugin gallery list on GitHub.

Another useful tool for checking plugin version compatibility at a glance is the PKP Plugin Compatibility utility.

For external plugins that do not appear in the live plugin gallery list, consult the plugin developer’s GitHub page to determine compatibility. These plugins will need to be installed manually.

IMPORTANT: Installing a plugin that is not compatible with your OJS/OMP/OPS version can seriously impact software functionality. Installing the compatible version from the Plugin Gallery is the best way to prevent technical issues.

Contribute a plugin #

If you have developed a plugin, contributing it to the Plugin Gallery is the best way to make it automatically available for OJS/OMP/OPS users to install. See instructions on how to do this in the Plugin Gallery readme page.

If your plugin is not available for the Plugin Gallery but you would like to have it included in the inventory below, edit this page on GitHub or send this information via Documentation Feedback. Make sure the plugin is compatible with OJS/OMP/OPS 3.2+. Plugins not in the Gallery will be marked as “unvetted” on the list.

Inventory #

Acron #

Attempts to reduce the dependance of the application on periodic scheduling tools such as ‘cron.’ Once enabled, this plugin should result in the processing of log files (along with other scheduled tasks, such as review and subscription reminders).

AddThis #

Provides the addThis social media sharing on the articles abstract/landing page.

Allowed Uploads #

Enables journals to choose the filetypes that are allowed when submitting a manuscript.

Announcement Feed #

Produces RSS/Atom web syndication feeds for journal announcements.

Ark #

Enables the assignation and management of ARK ID to issue, article and galley.

Articles Report #

Generates a CSV spreadsheet containing a list of articles (published and unpublished), including the submission ID, title, abstract, author information, current status, and more.

Akismet #

Verifies new user registrations via the Akismet anti-spam service. A subscription to Akismet is required for this plugin.

Author Requirements #

Allows certain author fields (e.g., email) to be made optional. This is useful in cases where required information does not exist for authors.

Authors History #

Generates an additional tab within the manuscripts Publication tab and lists additional submissions in the system from each contributor.

Backup #

Allows site administrators to generate and download a full backup of the various components of their OJS 3.x/OMP/OPS installation.

Bepress Import (unvetted) #

Facilitates the import from Bepress Digital Commons journals to OJS 3.1.1 or newer.

Better Password #

Provides additional password restriction options when users are selecting their own password.

Bibi Epub Viewer #

Embeds EPUb files on the article galley view for OJS and OMP using Bibi Epub Reader.

Bootstrap3 Theme #

Applies a starter Bootstrap 3 theme. Knowledge of HTML, CSS and JavaScript will be needed for this theme as it is designed to be a base and not a final product.

Browse By Section #

Allows visitors to browse published articles by section in a journals sidebar or footer (depending on the theme).

Citation Style Language #

Allow readers to get a published article’s citation in one of several formats supported by the Citation Style Language.

Clam Antivirus Plugin for OJS #

Scans submission files using Clam Antivirus, blocking files with a known virus signature.

Classic Theme #

An official theme for OJS 3 that applies that plays on colour and font contrasts based on literary classicism.

COinS #

Embeds OpenURL COinS in OJS articles permitting tools like Zotero to grab citations.

Content Analysis #

Checks the content of the submitted document for certain submission information and metadata for OPS

Control Public Files #

Allows journal and press managers to limit who can upload public files and what kind of files they can upload. Provides settings to restrict who can upload, what kind of files they can upload, and how large their directory of files can grow.

Custom Header Plugin #

Permits the addition of custom headers to the website, including custom JavaScript.

Custom Locale #

Allows customization of message keys (field names, labels, links, etc.) in locale files via the GUI. The default locales are replaced but not overwritten and can easily be restored.

Datacite export for OJS #

Export or register issue, article, galley and supplementary file metadata in DataCite format.

Datacite export for OMP #

Registers DOIs for monographs and chapters for DOI provider Datacite.

DC Metadata Format #

Structures metadata in a way that is consistent with the Dublin Core format.

Default Theme #

The default theme for OJS and OMP applies a simple, straightforward design. As of OJS/OMP/OPS 3.3, the Default Theme has been externally audited for accessibility and adheres to best practices like colour contrast, keyboard navigation, and form/link focus.

Developed By Block #

Adds a link to Open Journal Systems in the sidebar.

Disqus #

Integrates with Disqus and allows users to add comments to the abstract pages.

DOAJ Export Plugin #

Allows journals to manually or automatically deliver articles to the Directory of Open Access Journals (DOAJ) with a DOAJ API Key. Requires a journal to be DOAJ member - see DOAJ application guide for application instructions.

DOI #

Enables the assignment of the Digital Object Identifiers to issues, articles and galleys in OJS. Can work in pair with Crossref, Datacite or Medra plugins for automatic content registration.

DOI to mEDRA xml export and registration #

Enables the export of issue, article and galley metadata in ONIX4DOI format and the registration of DOIs with mEDRA.

DRIVER #

Extends the OAI-PMH interface according to the DRIVER Guidelines 2.0, helping OJS journals to become DRIVER compliant.

Dublin Core Indexing #

Embeds Dublin Core meta tags in article views for indexing purposes.

Email Issue Table of Contents #

Embeds the table of contents within the default notification email sent when publishing an issue.

EPUB viewer #

Embeds EPUB files on the article galley view pages using epub.js.

Forthcoming articles (unvetted) #

Allows journals to preview single articles on their website before an entire issue is published.Hides the Forthcoming issue from the regular issue archive and redirect all traffic from the issue table of contents page to the custom Forthcoming listing page.

Funding #

Adds submission funding data using the Crossref funders registry, considers the data in the Crossref and DataCite XML export and displays them on the submission view page.

Google Analytics #

Integrates OJS with Google Analytics, Google’s web site traffic analysis application. Requires that you have already setup a Google Analytics account. See Google Analytics site for more information.

Google Scholar Indexing #

Enables indexing of published content in Google Scholar.

Health Sciences Theme #

An official theme for OJS 3 that applies designed to maximize legibility and content clarity, built with a focus on health sciences journals.

Honeypot #

Verifies new user registrations by creating a honeypot on the User Registration form. This plugin operates at the site level and requires Site Administrator privileges to configure.

HTML Article Galley #

Provides browser-based HTML Viewer for HTML Article Galleys.

Hypothes.is #

Adds Hypothes.is integration to the public article view, permitting annotation and commenting. It currently supports commenting on HTML galleys; see README for instructions on extending the functionality to PDF galleys.

Immersion Theme #

An official theme for OJS 3 that emphasizes the reading experience and offers bold design options such as a full-width header image and per-section color choices.

Information Block #

Provides sidebar information block with 3 sections: For Readers, For Authors, For Librarians. Standard text for these sections can be edited in Website > Setup > Information

iThenticate #

Permits automatic submission of all uploaded files to the iThenticate service for plagiarism checking. This plugin will require an iThenticate account to be set up.

JATS Template #

Permits OJS to use a basic JATS XML document generated from the OJS metadata and full-text extraction in cases where a better JATS XML document is not available. It is intended to be used in concert with the OAI JATS plugin to deliver JATS via OAI for journals that do not have better JATS XML available.

Keyword Cloud Plugin #

Provide a tag cloud of article keywords that can be added to a journals sidebar.

Language Toggle Block #

Provides the sidebar language toggler. More than one language needs to be enabled for it to work, in Website > Setup > Languages

Lens Viewer for Monographs and Journal Articles #

Provides browser-based HTML Viewer for Journal Articles and Monographs based on JATS-standard XML files.

Lucene/Solr Plugin #

Integrates the solr/search for OJS journals. Integration requires additional configuration and it is recommended to test on a test installation, before using on a production server.

Make a Submission Block #

Provides a sidebar block with a “Make a Submission” link.

Manual Fee Payment #

Allows the manager to manually record receipt of a user’s payment (outside of this software).

Manuscript (Default child theme) #

Applies a clean, simple theme with a boxed layout that mimics a paper document.

MARC Metadata Format #

Structures metadata in a way that is consistent with the MARC format.

MARC21 Metadata Format #

Structures metadata in a way that is consistent with the MARC21 format.

Material Theme #

Applies Material Theme (MDBootstrap based) theme for the reader frontend.

Matomo #

Permits usage statistics tracking using Matomo (formerly Piwik).

Most read #

Creates a “most read articles” section in the journal’s sidebar with the 5 most viewed articles (with links) in the last week, along with the number of views per article.

Native XML #

Allows import and export of articles and issues in OJS’s native XML format between the same OJS versions.

OAI JATS #

Exposes JATS XML via the OAI-PMH interface. Note that it DOES NOT generate JATS XML itself – it assumes that this will already be available.

Open Graph #

Open Graph Plugin presents published content using the Open Graph protocol. Open Graph tags are used when you content is shared in Facebook.

OpenAIRE #

Adds the ProjectID element to the article metadata and extends the OAI-PMH interface according to the OpenAIRE Guidelines 1.1, helping OJS journals to become OpenAIRE compliant.

OpenID Authentication #

Enables users to log in to PKP applications using OpenID Connect providers. It currently supports Google, Apple ID, Microsoft Azure AD and Orchid. It is also possible to configure a custom OpenID Connect provider such as Keycloak.

ORCID Profile #

Allows users to automatically import user profile data from the ORCID profile into OJS with their ORCID ID.

Paperbuzz #

Displays free altmetrics (an alternative to traditional citation-based metrics) based on open Crossref Event data. To use this plugin, your journal must have DOIs assigned to articles and properly deposited with Crossref.

PayPal Fee Payment #

Supports the processing of payments the PayPal service. Payment types include author processing charges (single fee), reader fees (articles and issues), general fees.

PDF.JS PDF Viewer #

Provides browser-based viewer for article and issue galleys in PDF.

PKP Usage Statistics Report #

Generates a CSV spreadsheet containing monthly views for the journal homepage; issue TOCs; article abstract/landing pages; and file downloads. It can provides country information (if configured).

PKP|PN #

Enables the automatic preservation of published journal content in the PKP Preservation Network (PKP PN). This plugin requires ZipArchive support.

Plugins update notification #

Generates a notification in the Website Settings informing which plugins have an upgrade available at the plugin gallery.

Plum Analytics #

Provides display of PlumX Metrics from Plum Analytics on the article level for PKP Open Journal Systems.

Portico #

Provides an import/export plugin to generate metadata information for articles and issues for indexing in Portico FTP deposit. Details on the XML format and data requirements is available at: https://www.portico.org. This plugin requires ZipArchive support.

Pragma Theme #

An official theme for OJS 3 that applies a minimalist OJS theme inspired by early periodicals’ tables of contents featuring a bold use of a monochromatic colour palette.

Public Identifier Resolver #

Resolves individual articles, issues and galleys in the current OJS installation using the supplied public identifier register in OJS. It can obtain the element metadata using the format ERC adding question marks at the end of the persistent identifier. ERC format includes the metadata who, what, when, where, how and target.

Publons Reviewer Recognition #

Enables integration with Publons Reviewer Recognition Service. This plugin will require the Reviewer Recognition Service to account to be set up.

PubMed XML Export #

Export article metadata in PubMed XML format for journals indexed in MEDLINE.

PURL #

Enables the assignation and management of persistent uniform resource locator (PURL) ID to issue, article and galley.

QuickSubmit #

Permits Journal Managers/Editors to quickly enter submissions through the OJS website, bypassing the editorial workflow.

Recommend Articles by Author #

Inserts a list of articles by the same author on the article abstract/landing page.

Recommend Similar Articles #

Adds a list of similar articles to the bottom of the articles abstract/landing page.

Registration Notification #

Sends an email notification to a configurable list of emails, configurable per journal/press, whenever a new user is registered. The email content is configurable through the email template named Registration Notification. The following variables are provided by the plugin: $date, $userFullName, $userName, $userEmail

Research Organization Registry(ROR) #

Integrates support for ROR. Organizations maintained by ROR.org are automatically fetched using an auto suggesting function. For multilingual journals, additionally supported languages will be pre-filled given, ROR.org has the corresponding names in the OJS supported languages.

Returning Author Screening #

Permits authors using who already have at least one published submission to self-publish subsequent submissions on OPS.

ReviewerCredits #

Enables integration with ReviewerCredits. ReviewerCredits Journal credentials will be required to configure the plugin.

RFC1807 Metadata Format #

Structures metadata in a way that is consistent with the RFC1807 format.

SciELO Submissions Report #

Generates a CSV spreadsheet with submissions information for OJS and OPS that is usually requested by SciELO.

Scopus/Crossref Citations #

Uses an articles DOI to get all citations from Scopus and/or Crossref. Google Scholar and PubMed are also supported. The count and list of citations is displayed in the sidebar of the article details. It is possible to choose between the different providers and display only the amount of results if the list is not desired.

Shariff #

Adds social media buttons to your web site (to the footer of each page or the sidebar) without compromising the privacy of website users.

Shibboleth #

Adds an ability to use shibboleth single sign-on service to register and authenticate users. You must have set up and configured the local service provider (SP).

Sitesearch #

Allows searches done in one journal (within a multi-journal installation) to be performed at the site level and returns results from all journals.

Subscription Block #

Provides sidebar subscription information in journals with enabled subscriptions.

Subscription SSO #

Permits delegation of OJS subscription checks to a third-party web service.

Subscriptions Report #

Generates a CSV spreadsheet containing a list of subscriptions and their information. This report provides subscription status, type, format, dates, and subscriber information.

Suggested Reviewers Plugin by Ubiquity Press (unvetted) #

Allows journals to enable Recommended and Excluded Reviewers into the Author Submission form. This information will be displayed on top of the reviewer list when Editors select reviewers for a manuscript.

SushiLite #

Provides the NISO SUSHI-Lite standard (2015 draft release) for PKP software.

SWORD Deposit #

Permits the use of the SWORD protocol to deposit documents from OJS into other systems.

Sword Server #

Permits the use of the SWORDv2 protocol to allow OJS to receive deposit documents from other systems.

Text Editor Extras #

Provides additional rich text editor control (upload images, manipulate the HTML code, and add tables) to various text fields.

Texture #

Integrates the Texture JATS XML editor with OJS.

TinyMCE #

Converts select textareas to WYSIWYG XHTML editors using the TinyMCE cross-browser Javascript editor. This allows authors, editors, etc. to easily enter valid HTML into the various forms for more control over the appearance of their content.

Title Page (unvetted) #

OPS plugin that creates a title page on PDF files submitted to preprint servers. The title page is a page added to the beginning of the PDF file, containing a series of information about the preprint when it is posted. After the preprint is posted, the title page is also updated if the preprint relations are changed.

Twitter Block #

Integrates Twitter feeds in a multi-journal instance without the need to create several custom blocks. This plugin requires Administrator access to configure and enable/disable.

URN #

Enables the assignment of the Uniform Resource Names to the issues, articles and galleys.

Usage Statistics #

Displays the number of article downloads on the article page, in bar or line graph format. Requires Administrator access to be enabled or disabled.

Users XML #

Allows import and export of users and their roles between the same OJS versions.

View Report #

Generates a CSV spreadsheet describing readership for each article, including article title, issue, date published, and view counts (for abstracts, individual galleys, total galleys).

Web Feed Plugin #

Produces RSS/Atom web syndication feeds for the current issue.


Copyright: Simon Fraser University holds the copyright for work produced by the Public Knowledge Project and has placed its documentation under a Creative Commons Attribution 4.0 International License.

Creative Commons Attribution 4.0 International