Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme converted to Markdown format #41

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
=============================================================
=== Custom Block Manager Plugin
=== Version: 1.2
=== Author: Juan Pablo Alperin <[email protected]>
=== Co-Author: Bozana Bokan <[email protected]>
=============================================================

## About

This plugin is intended to enable users to create customizable HTML blocks for
the sidebars.

## License

This plugin is licensed under the GNU General Public License v2. See the file
LICENSE for the complete terms of this license.

## System Requirements

This plugin is compatible with...
- OJS 3.0.x
- OMP 1.2.x
- OMP 1.1.x

## Installation

To install the plugin:
- Unpack the plugin tar.gz file to your `plugins/generic` directory
- From your application's installation directory, run the upgrade script:
```
$ php tools/upgrade.php upgrade
```
(NOTE: It is recommended to back up your database first.)
- Enable the plugin by going to:
`Management` > `Website Settings` > `Plugins` > `Generic Plugins`
...and selecting the Enable checkbox beside `Custom Block Manager Plugin`


## Management

The Plugin management interface can be found at:
`Management` > `Website Settings` > `Plugins` > `Generic Plugins` > `Custom Block Manager`

Once the plugin is enabled, blocks can be added, edited and deleted through this
interface, using the "Manage Custom Blocks" function.

The added custom blocks will per default appear in the right sidebar, but this
can be changed in:
`Management` > `Website Settings` > `Appearance` > `Layout` > `Sidebar Management`.


## Contact/Support

Documentation, bug listings, and updates can be found on this plugin's homepage
at https://github.com/pkp/customBlockManager.