Skip to content

Commit ce81f5b

Browse files
authored
Update README with Bootstrap refactor.
1 parent 9f2d676 commit ce81f5b

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# Inline HTML Galley plugin for PKP
22

3-
This plugin provides inline display of article galleys for PKP Open Journal Systems, replacing the default HTML Article Galley plugin's use of an iframe to deliver the HTML Galleys. Also consider the [Alternate HTML Galley plugin](https://github.com/ajnyga/embedHtmlArticleGalley). This plugin will present the galley content within your website's theme. The Alternate HTML Galley plugin will present the galley in the same manner as the HTML Article Galley plugin (with just a simple header), but without requiring an iframe.
3+
This plugin provides inline display of article galleys for PKP Open Journal Systems, replacing the default HTML Article Galley plugin's use of an iframe to deliver the HTML Galleys. Also consider the [Alternate HTML Galley plugin](https://github.com/ajnyga/embedHtmlArticleGalley). This plugin will present the galley content within your website's Bootstrap3 theme. The Alternate HTML Galley plugin will present the galley in the same manner as the HTML Article Galley plugin (with just a simple header), but without requiring an iframe.
44

55
## Requirements
66

77
* OJS 3.x
88
* The PKP plugin htmlArticleGalley (which ships by default with OJS)
9+
* [Bootstrap3 theme](https://github.com/NateWr/bootstrap3)
10+
* The plugin will function with other themes, but the structure of the blocks conforms to bootstrap3 expectations
911
* PHP modules
1012
* [libxml](https://www.php.net/manual/en/book.libxml.php)
1113
* [dom](https://www.php.net/manual/en/book.dom.php)
@@ -28,12 +30,14 @@ php lib/pkp/tools/installPluginVersion.php plugins/generic/inlineHtmlGalley/vers
2830

2931
Login as a Journal Manger and navigate to the Journal for which you wish to use inline display of HTML Galleys. Enable the plugin via Login -> Settings -> Website -> Plugins -> Inline HTML Galley -> Enable.
3032

31-
There are no settings to configure for this plugin. Once enabled, the view of an HTML Galley will extract the HTML `body` from the Galley and will place it inline in the Galley view. You will need to replicate any CSS or Javascript directives used in the `head` of the Galley in your website configuration. (Hint: see the Custom Headers plugin.)
33+
Once enabled, the default view of an HTML Galley will extract the HTML `body` from the Galley and will place it inline in the Galley view. You will need to replicate any CSS or Javascript directives used in the `head` of the Galley in your website configuration. (Hint: see the Custom Headers plugin.)
3234

33-
The template will provide a link to the "download" handler for the galley above the extracted text of the Galley. The plugin also provides a sidebar block to link to the download, which may be enabled and positioned via the Website Settings.
35+
The Settings Form allows you to target another arbitrary HTML element from which to extract the HTML, via xpath. For example, since you likely have the article's title in an `h1` in the `body`, and Bootstrap3 will render the article title independently, you might want to target a content `div` within the body.
36+
37+
The plugin provides article metadata as sidebar blocks, which may be enabled and positioned via the Website Settings.
3438

3539
## Author / License
3640

37-
Written by Clinton Graham for the [University of Pittsburgh](http://www.pitt.edu). Copyright (c) University of Pittsburgh.
41+
Written by Clinton Graham and Chrysanthemum Lovelace for the [University of Pittsburgh](http://www.pitt.edu). Copyright (c) University of Pittsburgh.
3842

3943
Released under a license of GPL v2 or later.

0 commit comments

Comments
 (0)