An OJS Plugin to streamline codechecking of submissions and display of CODECHECK certificates.
This plugin integrates the CODECHECK process into the submission and review workflows within Open Journal Systems (OJS), allowing journals to streamline code and computational reproducibility checking of scholarly submissions. The plugin provides tools for metadata creation and certificate deposition, displaying certificates, ensuring computational transparency in published research, as well as certificate and metadata publication. Therefore the plugin connects seamlessly with the CODECHECK infrastructure.
The ojs-codecheck plugin development was started as part of the CHECK-PUB project with support from TU Delft Library.
- Submission integration: Seamless integration with the OJS submission and review workflow
- CODECHECK metadata: Built-in tools for creation and publication of CODECHECK metadata
- Certificate display: Automatically display CODECHECK certificates for verified submissions
- Customizable settings: Configure CODECHECK workflow and display preferences
- Download the plugin from the releases page
- Extract the plugin to your OJS
plugins/generic/directory - Navigate to Settings → Website → Plugins in your OJS admin panel
- Find "CODECHECK" and click Enable
- Configure the plugin settings as needed
If you are interested in the changes made to this project and the different versions, feel free to view the projects Changelog.
The 1.y.z versions of this plugin are compatible with OJS 3.5.x.
For the full features of each version, feel free to look into the Changelog.
| Plugin Version | OJS Version | Status |
|---|---|---|
Unreleased |
3.5.0+ |
Active Development |
1.y.z |
3.5.0+ |
Active Development |
This plugin follows the CODECHECK brand guidelines and integrates with OJS design patterns.
| Color | Hex Code | Usage | Source |
|---|---|---|---|
| CODECHECK Main Green | #008033 |
Primary brand color, certificates, badges | CODECHECK brand |
| CODECHECK Dark Green | #006629 |
Hover states, borders, emphasis | Derived from main green (80% brightness) |
| CODECHECK Light Green | #e8f5e8 |
Certificate backgrounds, success states | Derived from main green (95% lightness) |
| Color | Hex Code | Usage | Source |
|---|---|---|---|
| Info Background | #d1ecf1 |
Information boxes, notices | Bootstrap info (OJS compatibility) |
| Info Border | #d4edda |
Information box borders | Bootstrap info (OJS compatibility) |
| Info Text | #0c5460 |
Information text, labels | Bootstrap info (OJS compatibility) |
| Details Text | #495057 |
Secondary text, descriptions | Bootstrap neutral (OJS compatibility) |
| Form Borders | #ced4da |
Input borders, form elements | Bootstrap neutral (OJS compatibility) |
| Background Light | #f8fff9 to #e8f5e8 |
Light backgrounds, certificate gradients | Custom light green variants |
- Primary Green (
#008033): Use for all CODECHECK-specific elements (certificates, badges, primary actions) - Secondary Colors: Use for supporting UI elements that need to integrate with OJS design
- Gradients: Combine primary green variants for certificate backgrounds and special elements
- Accessibility: All color combinations meet WCAG 2.1 AA contrast requirements
- Metadata creation: Assistance for creating a CODECHECK metadata file
codecheck.yml - Metadata import: If
codecheck.ymlalready exists, you can also use it instead - Manage CODECHECKs: The plugin enables you to manage your different ongoing CODECHECK tasks
- Manage the plugin: Activate through the plugin management interface and set up display preferences and workflow options
- Workflow integration: The plugin automatically integrates with your submission workflow
- Monitor certificates: View and manage CODECHECK certificates through the admin interface
- CODECHECK Process: Work with codecheckers to verify your computational work
- Certificate Integration: Certificates are automatically displayed once verification is complete
- View certificates: Explore CODECHECK certificates on published articles
- Access materials: Links to computational materials and repositories
- OJS 3.5.0 or later
- PHP 8.2.0 or later
codecheck/
├── classes/ # Plugin classes
│ ├── Constants.php # Plugin constants and definitions
│ ├── FrontEnd/ # Frontend display components
│ │ └── ArticleDetails.php # Article page integration
│ └── Settings/ # Settings management
│ ├── Actions.php # Settings actions and handlers
│ ├── Manage.php # Settings management logic
│ └── SettingsForm.php # Settings form handling
├── CodecheckPlugin.php # Main plugin class
├── cypress/ # End-to-end testing
│ └── tests/
│ └── functional/
│ └── CodecheckPlugin.cy.js # Cypress test suite
├── LICENSE # License file
├── locale/ # Internationalization
│ └── en/
│ └── locale.po # English localization strings
├── README.md # This documentation
├── CONTRIBUTING.md # Contibution guidelines for this repo
├── CHANGELOG.md # The projects Changelog with details for each version
├── templates/ # Template files
│ ├── codecheck-assets.tpl # CSS/JS assets and styling
│ └── settings.tpl # Plugin settings form template
└── version.xml # Plugin metadata and version info
If you want to contribute to this project, we kindly ask you to follow our contribution guidelines.
Copyright (c) 2025 CODECHECK Initiative
This program is free software; you can redistribute it and/or modify it under the terms of the Apache License Version 2.0, see file LICENSE.
- Documentation: CODECHECK Guide
- Issues: GitHub Issues
- Community: CODECHECK Community
- Email: For sensitive issues, contact the CODECHECK team directly at [email protected]
The CHECK-PUB project (2025-2026) is empored by TU Delft Library.
