Immersion Theme

An official theme for OJS 3.1.1+

Current version 1.0.3

This theme was developed and is maintained by the Public Knowledge Project.

Description

The Immersive theme emphasizes the reading experience and offers bold design options such as a full-width header image and per-section color choices.

The serif typeface, Spectral, conveys a strong artistic personality and is paired with the crisp functionality of Roboto, a sans-serif typeface.

This theme allows you to display a full-width image in the header. When used appropriately, the image and color options can provide a striking aesthetic that will stand out from other journals. This effect may work best for arts and culture journals which want to present a more ambitious visual profile.

Installation

The theme can be installed through Plugin Gallery in Open Journal Systems website.

Manual installation:

1. Download the latest release.
2. Upload through the admin dashboard (Upload a New Plugin button on the Plugins page) or unpack the archives content inside plugins/themes directory starting from OJS web root.
3. Login into the OJS admin dashboard and activate the plugin on the Plugins page.
4. Enable the theme in Website Settings -> Appearance menu.

Installation from the master branch (should be used only for development):

1. git clone https://github.com/pkp/immersion.git.
2. Move to the theme's root folder: cd immersion.
3. Make sure that npm and Gulp are installed.
4. Resolve dependencies: npm install. Gulp config file is inside a theme root folder gulpfile.js.
5. To compile external SCSS, concatenate styles and minify: gulp sass. The result CSS path is resources/dist/app.min.css. The theme's own styles are compiled automatically by OJS's theme API.
6. To concatenate and minify javascript: gulp scripts and gulp compress. The result Javascript file path is resources/dist/app.min.js. Run gulp watch to view javascript changes inside resources/js folder in real time.
7. To compile and minify all at once: gulp compileAll.
8. Copy the plugin's folder to plugins/themes directory starting from the OJS installation root folder.
9. Login into the OJS admin dashboard, activate the plugin and enable the theme.

Note that the master branch can contain a code that will not be shipped to the stable release.

Version Compatibility

• Immersion theme version 1.0.0 and 1.0.1 were tested and compatible with OJS 3.1.1-4.
• Immersion theme version 1.0.2 is compatible with OJS 3.1.2.
• Immersion theme version 1.0.3 is compatible with OJS 3.1.2-1.

Contributors

Immersion theme was designed and developed by Sophy Ouch (@sssoz), Vitalii Bezsheiko (@Vitaliy-1), John Willinsky, and Kevin Stranack.

Troubleshooting

For technical question regarding the theme (bugs, enhancements, etc.), please open an issue on the plugin's GitHub page. For non-technical question or if you are uncertain about the question's category please visit the PKP Forum. Before opening and issue or posting a question on forum please make sure that it wasn't solved before.

Settings

Homepage Image | This theme allows the personalisation of the header background image. By default no image is present but we strongly recommend to use one for the best visual experience. It can be downloaded through Settings -> Website -> Homepage Image.

Sections' Background Color | Immersion theme adds an option for changing background color of issue sections. It is available under issue menu (for each issue). Picked colors will be displayed prominently on the journal landing page and issue page. The default background color for all sections is white and can be set differently for each section.

Section description | If Browse By Section plugin is activated and configured, the theme allows to display a description for each section on the index journal and issue page which is added through the section form.

Announcement Section Background Color | Announcements can be displayed prominently on journal's home page. It can be set in Settings -> Website -> Announcements. Immersion theme adds an option to change the background color for announcements section enabled through this menu.

Galleys | If there isn’t any CSS file attached to the HTML galley, the default theme’s style will be used.

License

This theme is released under the GPL license.