Skip to content

Latest commit

 

History

History
executable file
·
145 lines (104 loc) · 5.04 KB

README.md

File metadata and controls

executable file
·
145 lines (104 loc) · 5.04 KB
Raw

PID Manager Plugin

PID Manager for OJS

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Contributor Covenant

Features

IGSN

  • Manual adding sample PIDs and labels
  • Allows suggesting PIDs and Labels from DataCite
  • Marks samples already added with text strike through

Screenshot(s) / screen recording(s)

igsn-screenrecording.gif

Install and configure the plugin

Requirements

  • PHP 8.0+

Install with Git

Get the correct version for your OJS version:

  • branch main: development version, don't use for production
  • branch stable-3_4_0: use this version for OJS version 3.4.0.x
  • branch stable-3_5_0: use this version for OJS version 3.5.0.x

Install via direct download

  • Download release for your OJS version from here. Note the correct version for you OJS version.
  • Alternatively, download the code with the option 'Download ZIP'. Note the correct branch for your OJS version.
  • Extract the downloaded file to /plugins/generic/pidManager.

Configuration of the plugin

  • Login in your OJS instance as an Administrator or Manager
  • Navigate to Website > Plugins > Installed Plugins > Generic Plugins > PID Manager Plugin
  • Activate the plugin by clicking the checkbox

Development

Structure

.
├─ .github                       # Github specific
├─ .project                      # Project related files
├─ assets                        # Styles, images, javascript files
├─ Classes                       # Main folder with models / logic
│  ├─ Helpers                    # Helper classes
│  ├─ Igsn                       # Classes for IGSN
│  └─ Settings                   # Classes for Plugin Settings
├─ docs                          # Documentation, examples
├─ locale                        # Language files
├─ templates                     # Templates folder
├─ .gitignore                    # Git ignore file
├─ composer.json                 # Composer configuration file
├─ LICENSE                       # License file
├─ PidManagerPlugin.php          # Main class of plugin
├─ README.md                     # This file
└─ version.xml                   # Version information of the plugin

Notes

  • Autoload of the classes in the folder classes/ is done according to the PSR-4 specification.
  • All classes have namespaces and are structured according to PSR-4 standard.

Debugging

There is a debug mode possibility in this plugin. This constant puts the plugin in debugging mode. Extra debug information will be written to the log file (see LogHelper class) such as API calls. Debug information is written to the log file in the files_dir directory of your OJS instance. You can find the files_dir constant in your config.inc.php file.

Please put the following in the file config.inc.php to enable this:

[PidManagerPlugin]
isDebugMode=true

Careful with sensitive information, (passwords, tokens) will be written in plain text.

Data models

IGSN

De IGSNs are saved in the publication_settings as an array of IGSN data models.

name description
doi Persistent identifier of the sample
label Label of the sample 
[
  { 'doi': '10.58031/kiel0188gczz101', 'label': 'Sediment core SO257_1-5' },
  { 'doi': '10.58031/kiel0188gczi201', 'label': 'Sediment core SO257_6-2' },
]

Contribute

All help is welcome: asking questions, providing documentation, testing, or even development.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

How to contribute

  • Fork the repository
  • Create a feature branch in your fork
  • Make your changes
  • Open a PR with your changes

License

This project is published under GNU General Public License, Version 3.