Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revamp Plugin Inventory to Plugin Guide + Inventory #1284

Merged
merged 9 commits into from
Mar 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _includes/cards/ojs3/plugin-guides.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@

### Plugin Guides

These guides explain how to use OJS plugins. Plugins integrate OJS with services offered by PKP partner organizations.
Plugins add new functionality to OJS, OMP, and OPS, and integrate additional services offered by PKP partner organizations. Check out the Plugin Guide and Inventory first to learn how to install and enable plugins, as well as view a list of currently available plugins.

- [Plugin Inventory](/plugin-inventory/en/)
- [Plugin Guide and Inventory](/plugin-inventory/en/)
- [DOI Plugin Guide](/doi-plugin//)
- [Crossref Plugin Guide](/crossref-ojs-manual/en/)
- [ORCID Plugin Guide](/orcid/)
Expand Down
84 changes: 68 additions & 16 deletions plugin-inventory/en/README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,91 @@
---
title: "About Plugins"
description: 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.
title: "OJS/OMP/OPS Plugin Guide and Inventory"
description: The plugin guide and inventory explains how to install, enable, and configure plugins in OJS, OMP, and OPS. The inventory lists links to existing plugin documentation for OJS/OMP/OPS.
generateHeadingToc: true
---

# About Plugins
# OJS/OMP/OPS Plugin Guide and Inventory

## Introduction
## Introduction {#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](https://github.com/pkp/plugin-gallery/blob/main/plugins.xml), a list of compatible plugins for possible installation with version listing.
A plugin is a software component that extends the base functionality of an existing software. Plugins can add fields to forms, change templates, save new information, modify authentication procedures, create new pages or change existing screens in the application, or add integration with external services.

### Plugin gallery vs external plugins
This guide contains information on how to install and enable plugins, as well as a list with links to documentation for OJS/OMP/OPS.

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](https://github.com/pkp/plugin-gallery/blob/main/plugins.xml).
### Where to Find Plugins: The Plugin Gallery and External Plugins {#find-plugins}

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](https://docs.pkp.sfu.ca/learning-ojs/en/settings-website#external-plugins).
OJS/OMP/OPS include a built-in Plugin Gallery with supported plugins created by PKP and third-party contributors. Many of these are not included by default, but can be installed by a Site Administrator and activated by any roles with access to OJS/OMP/OPS site settings.

### Find a plugin compatible with your software version
In addition to those available in the Plugin Gallery, Site Administrators can also install custom or third-party external plugins available through other providers. If you are interested in developing your own plugins, please consult [Developer Documentation: Plugin Guide](https://docs.pkp.sfu.ca/dev/plugin-guide/en/) for details.

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](https://github.com/pkp/plugin-gallery/blob/main/plugins.xml).
## Install, Enable, and Configure Plugins {#install}

Another useful tool for checking plugin version compatibility at a glance is the [PKP Plugin Compatibility utility](https://pkp.github.io/plugin-compatibility/index.html).
In this section, you'll learn how to install, enable, and manage plugins in OJS/OMP/OPS.

For external plugins that do not appear in the [live plugin gallery list](https://github.com/pkp/plugin-gallery/blob/main/plugins.xml), consult the plugin developer’s GitHub page to determine compatibility. These plugins will need to be installed manually.
In the Plugins section of Settings: Website > Setup, you will find two tabs: Installed Plugins and Plugin Gallery. The Installed Plugins tab is where you can manage your current plugins, and the Plugin Gallery is where Site Administrators can add new plugins.

> **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.
This PKP School video explains how to configure Plugins in OJS, but the process is the same for OMP and OPS. To watch other videos in this series, visit [PKP’s YouTube channel](https://www.youtube.com/playlist?list=PLg358gdRUrDVTXpuGXiMgETgnIouWoWaY).
{% include video.html id="PMAsXY_tLMU" provider="youtube" title="Video of how to configure plugins in OJS"%}

### Add a Plugin from the Plugin Gallery

> Only Site Administrators are permitted to install new plugins. Please contact your Site Administrator to request installation.
{:.warning}

## Contribute a plugin
The "Plugin Gallery" tab shows all plugins that can be installed for your site, as well as information about whether plugins can be upgraded

![The Plugin Gallery screen in OJS with a list of possible plugins.](./assets/plugin-gallery-3.5.png)

To add a plugin, click the name of the plugin you wish to install. Read the information and click the Install button.

![The plugin information window that opens after a plugin is clicked in the Plugin Gallery, showing the name of the plugin, developer, and important information.](./assets/install-plugin-3.5.png)

The plugin will now be available from the Installed Plugins tab. Newly installed plugins are **not** enabled by default and must be enabled in the Installed Plugins tab.

### Manage Installed Plugins

The "Installed Plugins" tab shows all plugins currently installed for your site. Site Administrators, Journal Managers, and Journal Editors with access to journal settings can freely enable, disable, and configure the plugins on this tab. The Plugin Gallery will only show plugins compatible with the version of the software you are using, and will refresh automatically to reflect changes to the [live plugin gallery list on GitHub](https://github.com/pkp/plugin-gallery/blob/main/plugins.xml).

![The Installed Plugins Screen in OJS, with a list of various plugins that are enabled and disabled.](./assets/installed-plugins-3.5.png)

To enable or disable a plugin, check or uncheck the box next to the plugin name. Note that some plugins are required for the system and cannot be disabled.

Use the Search button to locate a specific plugin from the list.

Plugins may have additional settings, or require configuration before they can be used. Click the blue arrow next to the plugin name to reveal additional options, including Settings, Delete, or Upgrade.

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](https://github.com/pkp/plugin-gallery).
![The expanded menu below a plugin showing options for Settings, Delete, and Upgrade.](./assets/plugin-options-3.5.png)

**Settings**: Appears to Journal Managers, Journal Editors with access to settings, and Site Administrators. Access the custom settings menu for the plugin. These settings will differ with each plugin.
**Delete**: Only appears to Site Administrators. Remove the plugin from your site. The plugin can be reinstalled at any time from the Plugin Gallery.
**Upgrade**: Only appears to Site Administrators. Automatically installs the newest version of the plugin if it is not already installed.


### Install an External Plugin {#external-plugins}

Plugins found from sources outside of the Plugin Gallery will require manual installation. Only **Site Administrators** can upload these plugins.

> **IMPORTANT:** Be sure to confirm that the plugin you are installing is compatible with the version of the software you are using by carefully reading the documentation provided by the developer. Installing a plugin that is not compatible with your OJS/OMP/OPS version can seriously impact software functionality.
{:.warning}

1. Download the plugin's tar.gz file from its repository under the Releases tab.
2. Go to the Installed Plugins tab of the journal.
3. At the top right, click ‘Upload a New Plugin’.
4. Upload the plugin file.
5. When it has finished uploading, click Save. It may take some time for the plugin to finish installing and become available in the Installed Plugins list.

> If your upload fails and you see an error message that reads "The uploaded plugin archive does not contain a folder that corresponds to the plugin name.”, this means you must simplify the name of the plugin folder inside the zipped file. Try renaming complex folder names such as “translator-ojs-3_0_0-0” to something simpler, such as “translator.”
{:.notice}

## Contribute a Plugin {#contribute}

If you have developed a plugin and wish to make it available to all OJS/OMP/OPS users, we recommend contributing it to the Plugin Gallery. Please view the [Plugin Gallery readme page](https://github.com/pkp/plugin-gallery) on our GitHub repository for details.

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](https://github.com/pkp/pkp-docs/tree/plugin-inventory/plugin-inventory) or send this information via [Documentation Feedback](https://pkp.sfu.ca/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
## Plugin Inventory {#inventory}

The inventory below contains plugins available in the Plugin Gallery for OJS/OMP/OPS and links to related documentation written by the plugin creator or PKP. The list is not exhaustive and will continue to be updated as more plugins and documentation becomes available. For compatibility details, see the [live plugin gallery list on GitHub](https://github.com/pkp/plugin-gallery/blob/main/plugins.xml), a list of compatible plugins for possible installation with version listing.

### Acron

Expand Down
Binary file added plugin-inventory/en/assets/install-plugin-3.5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added plugin-inventory/en/assets/plugin-gallery-3.5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added plugin-inventory/en/assets/plugin-options-3.5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions plugin-inventory/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
isBookIndex: true
---

# Plugin Inventory
# OJS/OMP/OPS Plugin Guide and Inventory

* [English](./en)

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.
The plugin guide and inventory explains how to install, enable, and configure plugins in OJS, OMP, and OPS. The inventory lists links to existing plugin documentation for OJS/OMP/OPS.