Licensing info

JatsParserPlugin.inc.php

@@ -2,7 +2,7 @@
 /**
  * @file plugins/generic/jatsParser/JatsParserPlugin.inc.php
  *
- * Copyright (c) 2017 Vitalii Bezsheiko
+ * Copyright (c) 2017-2018 Vitalii Bezsheiko
  * Distributed under the GNU GPL v3.
  *
  * @class JatsParserSettingsForm
@@ -143,8 +143,8 @@ function articleViewCallback($hookName, $args) {
 		$generatePdfUrl = $request->getCompleteUrl() . "?" . CREATE_PDF_QUERY;
 
 		$templateMgr->addStyleSheet('styles', $baseUrl . '/app/app.min.css');
-		$templateMgr->addStyleSheet('fontawesome', 'https://use.fontawesome.com/releases/v5.1.0/css/all.css');
 		$templateMgr->addStyleSheet('googleFonts', 'https://fonts.googleapis.com/css?family=PT+Serif:400,700&subset=cyrillic');
+		$templateMgr->addJavaScript('fontawesome', 'https://use.fontawesome.com/releases/v5.2.0/js/all.js');
 		$templateMgr->addJavaScript('javascript', $baseUrl . '/app/app.min.js');
 
 		$orcidImage = $this->getPluginPath() . '/templates/images/orcid.png';

JatsParserSettingsForm.inc.php

@@ -4,7 +4,7 @@
 /**
 * @file plugins/generic/jatsParser/JatsParserSettingsForm.inc.php
 *
- * Copyright (c) 2017 Vitaliy Bezsheiko, MD, Department of Psychosomatic Medicine and Psychotherapy, Bogomolets National Medical University, Kyiv, Ukraine
+ * Copyright (c) 2017-2018 Vitaliy Bezsheiko, MD, Department of Psychosomatic Medicine and Psychotherapy, Bogomolets National Medical University, Kyiv, Ukraine
 * Distributed under the GNU GPL v3.
  *
  * @class JatsParserSettingsForm

README.md

@@ -1,9 +1,22 @@
 # JATSParserPlugin
-OJS3 Plugin for parsing JATS XML and displaying it on article detail page. For correct displaying should be used in conjunction with modified [default Manuscript theme](https://github.com/Vitaliy-1/defaultManuscript) or user's theme should be changed accordingly.  
+OJS3 Plugin for parsing JATS XML and displaying it on article detail page.
+## Features 
+* JATS XML to HTML automatic conversion.
+* JATS XML to PDF automatic conversion.
+* Article's metadata now is taken directly from OJS (no need to populate JATS XML meta nodes).
+* Article's reference list can be taken from JATS XML or OJS (option in the plugin settings).
+* Support for figures attached to the XML through OJS dashboard.
 ## How to use?
-1. Clone or download from the branch jatsParser-1.0.0 (not master)
-2. Rename to `jatsParser`
-3. Copy to OJS `plugins/generic` directory
-4. Activate from dashboard.
-5. Make necessary changes in OJS theme
-6. Example of JATS XML: https://github.com/Vitaliy-1/JATS2LaTeX/blob/jats2latex-0.5/example/article_english.xml
+1. Download the [latest release](https://github.com/Vitaliy-1/JATSParserPlugin/releases) 
+2. Upload the plugin from the admin dashboard `Website Settings -> Plugins -> Upload a New Plugin` (make sure php.ini variables `upload_max_filesize` and `post_max_size` a set to equal or more than 16M) or unpack the archive into the `plugins/generic/` folder.
+3. Activate the plugin from the dashboard.
+## Requirements
+* PHP 7.1 or higher
+* OJS theme with Bootstrap 4. If the theme doesn't utilize this library, it must be added alongside with jQuery from the plugin main class (it is [quite straightforward](https://github.com/Vitaliy-1/JATSParserPlugin/blob/master/JatsParserPlugin.inc.php#L145-L148)). JATS Parser Plugin is tested with [HealthSciences](https://github.com/pkp/healthSciences), [Classic](https://github.com/Vitaliy-1/classic), and [oldGregg](https://github.com/Vitaliy-1/oldGregg) themes
+* OJS 3.1+
+* Lens Galley Plugin must be turned off
+## Examples
+* Example of the JATS XML: https://github.com/Vitaliy-1/JATSParserPlugin/blob/master/example.xml
+* HTML example: http://ojsdemo.e-medjournal.com/index.php/jatsparser/article/view/8/8
+* PDF example: http://ojsdemo.e-medjournal.com/index.php/jatsparser/article/view/8/8?download=pdf
+