Skip to content

saddamalsalfi/ojs-pkp-plugins-and-themes

unversioned · 06274ec1afedMIT

Develop, review, and release Open Journal Systems (OJS) plugins and themes. Use for PKP plugin categories, version.xml, hooks, Smarty overrides, and editorial confidentiality. Extend to OMP or OPS only when explicitly targeted and verified.

OJS / PKP Plugins and Themes

العربية · Skill · Examples · MIT License

An independent Agent Skill for OJS / PKP extension development. Uses the actual Open Journal Systems application and matching PKP library; treats Open Monograph Press and Open Preprint Systems as separate compatibility targets. This is instruction and reference content for coding agents, not an installable OJS / PKP extension. The skill name is not the runtime identifier of any extension you build.

What it covers

  • Map category, product directory, loader and identity to the target branch; keep descriptor and Gallery metadata distinct.
  • Protect journal context, unpublished files, scholarly identifiers, and reviewer confidentiality.
  • Verify Smarty/theme overrides, locales, and clean install or upgrade from the actual release archive.

Install

Copy the whole skills/ojs-pkp-plugins-and-themes/ folder into a discovery directory in the target application. Keep its name, references, and examples intact.

AgentProject directory
Codex.agents/skills/
Claude Code.claude/skills/
Cursor.agents/skills/ or .cursor/skills/
GitHub Copilot.github/skills/ or .agents/skills/ where supported
Google Antigravity.agents/skills/

A single copy in .agents/skills/ works for clients that share that project path. Use the client-specific path when required; avoid duplicate copies for the same client.

For example, from the target project root (PowerShell; point $skill to the checked-out skill directory, and use a fresh destination):

$skill = 'C:/path/to/ojs-pkp-plugins-and-themes/skills/ojs-pkp-plugins-and-themes'
New-Item -ItemType Directory -Path '.agents/skills' -Force | Out-Null
Copy-Item -LiteralPath $skill -Destination '.agents/skills/' -Recurse

Optional installer: From the target project, use a local checkout with the skills CLI:

npx skills add "/path/to/ojs-pkp-plugins-and-themes" --list
npx skills add "/path/to/ojs-pkp-plugins-and-themes" --skill ojs-pkp-plugins-and-themes

After publishing to GitHub, pass the repository's OWNER/REPO instead of the local path. This works independently of the optional Agent Plugins manifest. Installing the native skill does not start or require the optional MCP server or Docker. See the client's documentation for hosted or organization-managed installations.

Optional Cursor rule: After installing the skill, copy the manual rule to the target project's .cursor/rules/ and mention @ojs-pkp-plugins-and-themes as a rule in chat. Prefer the native skill when available; this shortcut does not replace it. Cursor rules docs

MCP and Docker

Use the read-only MCP server if your client needs MCP instead of direct skill discovery. It serves the same bundled references over stdio or Streamable HTTP. See the setup and publishing guide for Python, Docker, Glama, and the official MCP Registry.

Try it

Use the ojs-pkp-plugins-and-themes skill. Review this OJS child theme for the installed OJS release. Verify the registered parent key, preserve metadata and access-controlled galley links, and test public article and issue views in Arabic RTL.

In Codex you can also start with $ojs-pkp-plugins-and-themes; in Claude Code, use /ojs-pkp-plugins-and-themes. The skill reports in the user's language unless they request another.

Maintainer checks

Run from this repository root with Python 3.10+:

python -B -m unittest discover -s tests -v

The standard-library checks cover installation, metadata, and local links. To exercise MCP, install the locked dependencies as described in the setup guide and rerun the suite. The GitHub Actions workflow runs these checks on Windows and Linux. They do not exercise OJS / PKP runtime code or certify that a resulting package is compatible or accepted upstream.

This repository is independent and not endorsed by OJS / PKP. The MIT license applies to this skill; check the applicable license and directory requirements for any extension it helps you build.

Source

Adapted from the project guide ojs-pkp-plugin-and-theme-best-practices.md. Topic-specific documentation is bundled under skills/ojs-pkp-plugins-and-themes/references/.