Skip to content

installation.md

Latest commit

 

History

History
174 lines (131 loc) · 4.2 KB

installation.md

File metadata and controls

174 lines (131 loc) · 4.2 KB

Installation Guide

Prerequisites

Before installing the Premium Theme, ensure you have:

  • Open Journal Systems (OJS) version 3.5.0 or later
  • PHP 8.2 or later
  • Access to the OJS filesystem
  • Administrative access to your OJS installation

Installation Steps

Method 1: Manual Installation

  1. Download the theme package

    • Download the latest release from the distribution source
    • Extract the ZIP file

  2. Upload to OJS

    # Copy the premium directory to your OJS themes folder
cp -r premium /path/to/ojs/plugins/themes/

  3. Set proper permissions

    # Ensure OJS can read the theme files
chmod -R 755 /path/to/ojs/plugins/themes/premium
chown -R www-data:www-data /path/to/ojs/plugins/themes/premium

  4. Activate the theme

    • Login to OJS as Administrator
    • Navigate to Settings → Website → Appearance
    • Locate "Premium Theme" in the theme list
    • Click Enable or Activate

  5. Configure theme options

    • Click on Theme Settings or the settings icon
    • Choose your preferred:
      • Layout (1-column, 2-column, or 3-column)
      • Color scheme
      • Typography (fonts)
      • Dark mode preference
    • Click Save

  6. Verify installation

    • Visit your journal's homepage
    • Check that the theme is applied correctly
    • Test dark mode toggle
    • Test mobile responsiveness

Method 2: Git Clone (for developers)

# Clone the repository
cd /path/to/ojs/plugins/themes/
git clone https://github.com/your-repo/premium-theme.git premium

# Install dependencies
cd premium
composer install
npm install

# Build assets
npm run build

# Set permissions
chmod -R 755 .

Post-Installation

Recommended Settings

  1. Upload a logo

    • Go to Settings → Website → Appearance
    • Upload a high-resolution logo (PNG or SVG recommended)
    • Recommended dimensions: 200x60 pixels

  2. Configure homepage image

    • Upload a hero image for the homepage
    • Recommended dimensions: 1920x820 pixels
    • Use high-quality, web-optimized images (WebP format recommended)

  3. Set up custom fonts (optional)

    • Choose Google Fonts for headings and body text
    • Preview changes before saving
    • Popular combinations:
      • Inter + Inter
      • Playfair Display + Source Sans Pro
      • Roboto Slab + Open Sans

Troubleshooting

Theme doesn't appear in the theme list

Solution:

# Clear OJS cache
php tools/upgrade.php check
php lib/pkp/tools/installPluginVersion.php plugins/themes/premium/version.xml

CSS/JS files not loading (404 errors)

Solution:

  1. Verify the dist/ directory exists and contains compiled assets
  2. Run npm run build if missing
  3. Check file permissions
  4. Clear browser cache

PHP errors after activation

Solution:

  1. Check PHP version: php -v (must be 8.2+)
  2. Enable error reporting in OJS: config.inc.php → show_stacktrace = On
  3. Check error logs: files/logs/

Styles not applying correctly

Solution:

  1. Hard refresh browser (Ctrl+Shift+R / Cmd+Shift+R)
  2. Clear OJS cache: Delete cache/ directory contents
  3. Verify CSS file exists: /plugins/themes/premium/dist/styles/main.css

Upgrading

From previous version

  1. Backup current installation

    cp -r /path/to/ojs/plugins/themes/premium /path/to/backup/premium-backup

  2. Download new version

    • Extract the new version

  3. Replace files

    rm -rf /path/to/ojs/plugins/themes/premium/*
cp -r new-premium/* /path/to/ojs/plugins/themes/premium/

  4. Clear cache

    rm -rf cache/*

  5. Verify

    • Login to admin dashboard
    • Check theme version in Appearance settings
    • Test functionality

Uninstallation

  1. Switch to another theme first

    • Activate a different theme (e.g., Default Theme)

  2. Disable Premium Theme

    • Go to Settings → Website → Appearance
    • Click Disable on Premium Theme

  3. Remove files (optional)

    rm -rf /path/to/ojs/plugins/themes/premium

Need Help?