Developer Documentation

From PKP Wiki
Revision as of 11:20, 8 May 2014 by Alec (Talk | contribs) (Usability/Web Design)

Jump to: navigation, search

Getting Started

Information for Developers -- For community contributors. Includes how to identify existing bugs, contribute code, and set up your development environment.

Installation: Multiple OJS & mOJO -- For sysadmins or developers. How to install an independent OJS for each magazine and manage all of them from your command shell.

Development Roadmap and Strategy

General Software Milestones -- a rough guide to upcoming PKP software releases for all products

Development Cycle -- description of the pattern PKP follows in terms of releases and branches

PKP WAL Roadmap -- roadmap for the PKP Web Application Library, a shared codebase common to all PKP applications

Working with Git

HOW-TO check out PKP applications from git

Frequent git use cases

Git sub-module tutorial

Differences between CVS and git for PKP devs

Github Documentation for PKP Contributors

Code Design

JavaScript coding conventions -- the JS coding conventions that PKP uses.

JavaScript widget controllers -- description and explanation of the standard PKP javascript widget controllers that are implemented throughout the codebase.

Router Architecture

AJAX framework

Authorization Framework

Metadata and Filter Framework

Data Access Objects (DAO)

Third Party Library Integration Policy


Front-end Cookbook


Unit Tests are developer-centric code tests.

Integration Testing is automated testing of the web interface.

User Tests are tests performed by live humans.

Integration Testing Use Cases lists and describes the specific tests run in Integration Testing.

Usability/Web Design

OJS UI/UX OMP UI/UX PKP Library Widgets Open Monograph Press

Current Development

Migration issues -- notes on how to backport the new features that were introduced in OMP into other PKP applications