OJS Documentation

For any available translations of the documentation, please see the Language pages of our web site.

Official Guides and Documentation

These documents have been prepared by the PKP team and are generally updated for every major OJS release.

  • README
    For installation and upgrade instructions, see the README document from the most recent release of OJS.
  • OJS Userguide:
    OJS 2.3.3: HTML (multiple pages) | PDF (21MB)
    OJS 2.3.1: HTML (multiple pages) | PDF (20MB)
    The definitive illustrated guide to online scholarly publishing using Open Journal Systems. This guide introduces OJS; explains every facet of the interface; provides comprehensive documentation for Journal Managers, Authors, Editors, Reviewers and more; and also instructs on administrative tasks such as installation, migration, upgrading, and troubleshooting. The userguide has also been translated into Spanish.
  • OJS Technical Reference: HTML (multiple pages) | PDF (.5MB)
    This comprehensive resource describes the design of OJS. It is recommended reading for users who intend to modify OJS, either by altering the codebase or by developing plugins to extend it.
  • OJS API Reference
    The OJS API Reference is automatically generated from the OJS source code using Doxygen, and is a valuable reference for developers looking to understand the codebase.
  • OxS Quick Reference
    This reference document covers common system tasks for both OCS and OJS. It includes instructions on: installing and configuring the software on a server; publishing content; and practicing necessary server administration tasks (making backups, upgrading, troubleshooting, etc.). It also includes additional material useful for developers who are looking to make additions and modifications to the code. This document will no longer be maintained in favour of the OJS Userguide.
  • OJS in an Hour
    This PDF booklet is an introductory guide to the various features and roles in OJS, including many illustrative screenshots. This document will no longer be maintained in favour of the OJS Userguide.

Community Documentation

The following are a sampling of the documents have been written by and for the PKP community on our wiki. We welcome any and all contributions to the wiki: how-to's, development guides, usage reports, and so on.

  • PKP Frequently Asked Questions
    This document answers the most frequently asked questions about all of our software.
  • Translating OJS and OCS
    This document will give you a solid understanding on how languages work with OJS and OCS, and the knowledge to undertake and maintain your own translations or translations of others.
  • Customizing OJS
    This illustated booklet describes real-world customizations that can easily be accomplished by the Journal Manager without resorting to additional coding. (You can also find a list of several screenshots highlighting attractive design modifications or innovative features here.)
  • Importing and Exporting Data with OJS
    This document details the five import/export plugins available with OJS: the CrossRef, Erudit and PubMed export plugins; the Users import and export plugin; and the Articles & Issues import and export plugin. Special consideration is also given to the web-based expedited article submission process available to journal editors.
  • LDAP and Shibboleth Setup Guide for OJS and OCS
    This guide illustrates how to set up LDAP or Shibboleth authentication with OJS or OCS. Please note that it is not a guide on installing and configuring either service on its own, and only deals with integrating our software with each service.
  • Using PayPal for OJS and OCS Payments
    This document outlines the steps to create a PayPal account and configure OJS and OCS to collect secure online payments.
  • Embedding Multimedia into OJS/OCS
    Using Web 2.0 tools like Blip, Slideshare, and Houndbite, you can embed videos, slide shows, or audio directly into an OJS or OCS page.
  • Recursos OJS en Español
    Una página de recursos OJS en español, así como enlaces a PKP acontecimientos en América Latina.

Articles and Presentations

Below are a sampling of OJS-related articles and presentations published by the PKP team. You can find more on our PKP Publications page.

Publications about OJS

Devakos, Rea and Karen Turko. (2007). Synergies: Building National Infrastructure for Canadian Scholarly Publishing, ARL Bimonthly Report, 252/253 (Special Double Issue on University Publishing).

Case, Mary M. and Nancy R. John. (2007). Publishing Journals@UIC, ARL Bimonthly Report, 252/253 (Special Double Issue on University Publishing).

Graham, Bobby. (2007). Open Publish: Open access to scholarly research. National Library of Australia: Canberra, Australia

Willinsky, John and Ranjini Mendis. (2007). Open Access on a zero budget: A case study of Postcolonial Text. Information Research 12 (3).

Willinsky, John. (2005). Open Journal Systems: An example of Open Source Software for journal management and publishing. Library Hi-Tech 23 (4), 504-519.

da Fonseca, Ramon M.S. (2004, June). Open Journal Systems. Paper presented at the ICCC 8th International Conference on Electronic Publishing, Brasilia, Brazil.