From cb489e9d7d59918b9bf4f836fce313c12612de39 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dar=C3=ADo=20Here=C3=B1=C3=BA?= Date: Fri, 7 Sep 2018 16:04:39 -0300 Subject: [PATCH] Readme converted to Markdown format --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c7d9302 --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ + ============================================================= + === Custom Block Manager Plugin + === Version: 1.2 + === Author: Juan Pablo Alperin + === Co-Author: Bozana Bokan + ============================================================= + +## 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.