pkp/pkp-lib#5169 Various cleanup/release prep

pkp · Jan 25, 2020 · 53a0801 · 53a0801
1 parent ffb7f59
commit 53a0801
Show file tree

Hide file tree

Showing 15 changed files with 71 additions and 60 deletions.
diff --git a/CustomLocaleHandler.inc.php b/CustomLocaleHandler.inc.php
@@ -1,9 +1,9 @@
 <?php
 
 /**
- * @file plugins/generic/customLocale/CustomLocaleHandler.inc.php
+ * @file CustomLocaleHandler.inc.php
  *
- * Copyright (c) 2016 Language Science Press
+ * Copyright (c) 2016-2020 Language Science Press
  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  *
  * @class CustomLocaleHandler

diff --git a/CustomLocalePlugin.inc.php b/CustomLocalePlugin.inc.php
@@ -1,9 +1,9 @@
 <?php
 
 /**
- * @file plugins/generic/customLocale/CustomLocalePlugin.inc.php
+ * @file CustomLocalePlugin.inc.php
  *
- * Copyright (c) 2016 Language Science Press
+ * Copyright (c) 2016-2020 Language Science Press
  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  *
  * @class CustomLocalePlugin

diff --git a/README.md b/README.md
@@ -1,21 +1,34 @@
 - Custom Locale Plugin
-- Version: 1.0
-- Author: Carola Fanselow
+- Version: 1.0.1
+- Author: Carola Fanselow (updates by Alec Smecher)
 
 About
 -----
-This plugin allows to customize locales via the OMP GUI. The default locales are replaced but not overwritten and can easily be restored. A simple documentation can be printed that lists all changes made to the locales. The locales can be customized in the tab 'locale' in management > settings > website. There is a search function for files and for locale keys within the files. The documentation can be printed in the plugin's settings section.
+This plugin allows to customize locales via the OMP GUI. The default locales
+are replaced but not overwritten and can easily be restored. A simple
+documentation can be printed that lists all changes made to the locales. The
+locales can be customized in the tab 'locale' in management > settings >
+website. There is a search function for files and for locale keys within the
+files. The documentation can be printed in the plugin's settings section.
 
 License
 -------
-Copyright (c) 2016 Language Science Press
+Copyright (c) 2016-2020 Language Science Press
 
 This plugin is licensed under the GNU General Public License v2. 
 
+Upgrading From A Previous Version
+---------------------------------
+Starting with OJS/OMP 3.2, the locale file format has changed from XML to PO.
+Existing users of this plugin MUST convert their files when migrating from
+a release older than OJS/OMP 3.2 that uses this plugin.
+
+This process is described at:
+https://github.com/pkp/pkp-lib/issues/5169
+
 System Requirements
 -------------------
-This plugin is compatible with...
- - (TBD)
+This plugin is compatible with OJS 3.2 and OMP 3.2.
 
 Installation
 ------------

diff --git a/classes/CustomLocale.inc.php b/classes/CustomLocale.inc.php
@@ -1,9 +1,9 @@
 <?php
 
 /**
- * @file plugins/generic/customLocale/classes/CustomLocale.inc.php
+ * @file classes/CustomLocale.inc.php
  *
- * Copyright (c) 2016 Language Science Press
+ * Copyright (c) 2016-2020 Language Science Press
  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  *
  * @class CustomLocale
@@ -13,40 +13,40 @@ class CustomLocale extends DataObject {
 	//
 	// Get/set methods
 	//
-	function getKey(){
+	function getKey() {
 		return $this->getData('key');
 	}
 
 	function setKey($key) {
-		return $this->setData('key', $key);
+		$this->setData('key', $key);
 	}
 
-	function getLocale(){
+	function getLocale() {
 		return $this->getData('locale');
 	}
 
 	function setLocale($locale) {
-		return $this->setData('locale', $locale);
+		$this->setData('locale', $locale);
 	}
 
-	function getContextId(){
+	function getContextId() {
 		return $this->getData('contextId');
 	}
 
 	function setContextId($contextId) {
-		return $this->setData('contextId', $contextId);
+		$this->setData('contextId', $contextId);
 	}
 
 	function setFileTitle($title) {
-		return $this->setData('filetitle', $title);
+		$this->setData('filetitle', $title);
 	}
 
 	function getFileTitle() {
 		return $this->getData('filetitle');
 	}
 
 	function setTitle($title, $locale) {
-		return $this->setData('title', $title, $locale);
+		$this->setData('title', $title, $locale);
 	}
 
 	function getTitle($locale) {
@@ -62,15 +62,15 @@ function getPath() {
 	}
 
 	function setPath($path) {
-		return $this->setData('path', $path);
+		$this->setData('path', $path);
 	}
 
 	function getFilePath() {
 		return $this->getData('filepath');
 	}
 
 	function setFilePath($filepath) {
-		return $this->setData('filepath', $filepath);
+		$this->setData('filepath', $filepath);
 	}
 }
 
diff --git a/controllers/grid/CustomLocaleAction.inc.php b/controllers/grid/CustomLocaleAction.inc.php
@@ -1,15 +1,14 @@
 <?php
 
 /**
- * @file plugins/generic/customLocale/controllers/grid/CustomLocaleAction.inc.php
+ * @file controllers/grid/CustomLocaleAction.inc.php
  *
- * Copyright (c) 2016 Language Science Press
+ * Copyright (c) 2016-2020 Language Science Press
  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  *
  * @class CustomLocaleAction
  */
 
-
 class CustomLocaleAction {
 	/**
 	 * Get a list of locale files.

diff --git a/controllers/grid/CustomLocaleGridCellProvider.inc.php b/controllers/grid/CustomLocaleGridCellProvider.inc.php
@@ -1,9 +1,9 @@
 <?php
 
 /**
- * @file plugins/generic/customLocale/controllers/grid/CustomLocaleGridCellProvider.inc.php
+ * @file controllers/grid/CustomLocaleGridCellProvider.inc.php
  *
- * Copyright (c) 2016 Language Science Press
+ * Copyright (c) 2016-2020 Language Science Press
  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  *
  * @class CustomLocaleGridCellProvider

diff --git a/controllers/grid/CustomLocaleGridHandler.inc.php b/controllers/grid/CustomLocaleGridHandler.inc.php
@@ -1,9 +1,9 @@
 <?php
 
 /**
- * @file plugins/generic/customLocale/controllers/grid/CustomLocaleGridHandler.inc.php
+ * @file controllers/grid/CustomLocaleGridHandler.inc.php
  *
- * Copyright (c) 2016 Language Science Press
+ * Copyright (c) 2016-2020 Language Science Press
  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  *
  * @class CustomLocaleGridHandler

diff --git a/controllers/grid/form/CustomLocaleForm.inc.php b/controllers/grid/form/CustomLocaleForm.inc.php
@@ -1,9 +1,9 @@
 <?php
 
 /**
- * @file plugins/generic/customLocale/controllers/grid/form/CustomLocaleForm.inc.php
+ * @file controllers/grid/form/CustomLocaleForm.inc.php
  *
- * Copyright (c) 2016 Language Science Press
+ * Copyright (c) 2016-2020 Language Science Press
  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  *
  * @class CustomLocaleForm

diff --git a/controllers/grid/form/LocaleFileForm.inc.php b/controllers/grid/form/LocaleFileForm.inc.php
@@ -1,9 +1,9 @@
 <?php
 
 /**
- * @file plugins/generic/customLocale/controllers/grid/form/LocaleFileForm.inc.php
+ * @file controllers/grid/form/LocaleFileForm.inc.php
  *
- * Copyright (c) 2016 Language Science Press
+ * Copyright (c) 2016-2020 Language Science Press
  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  *
  * @class LocaleFileForm

diff --git a/css/customLocale.css b/css/customLocale.css
@@ -1,11 +1,10 @@
-
-/*
-  * plugins/generic/customLocale/css/customLocale.css
-  *
-  * Copyright (c) 2016 Language Science Press
-  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
-  *
-*/
+/**
+ * css/customLocale.css
+ *
+ * Copyright (c) 2016-2020 Language Science Press
+ * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
+ *
+ */
 
 .highlight {
 	background-color: #A9E2F3; 

diff --git a/index.php b/index.php
@@ -1,9 +1,9 @@
 <?php
 
 /**
- * @file plugins/generic/customLocale/index.php
+ * @file index.php
  *
- * Copyright (c) 2016 Language Science Press
+ * Copyright (c) 2016-2020 Language Science Press
  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  *
  * @brief Wrapper for custom locale plugin.

diff --git a/pluginDocumentation_customLocale.md b/pluginDocumentation_customLocale.md
@@ -2,12 +2,12 @@ Key data
 ============
 
 - name of the plugin: Custom Locale Plugin
-- author: Carola Fanselow
-- current version: 1.0.0.0
-- tested on OMP version: 1.2.0
-- github link: https://github.com/langsci/customLocale.git
+- author: Carola Fanselow (updates by Alec Smecher)
+- current version: 1.0.1.0
+- see .travis.yml for compatibility information
+- github link: https://github.com/asmecher/customLocale.git
 - community plugin: yes
-- date: 2016/05/21
+- date: 2020/01/24
 
 Description
 ============
@@ -24,7 +24,7 @@ Hooks
 
 		PKPLocale::registerLocaleFile
 		LoadComponentHandler
-		Templates::Management::Settings::website
+		Template::Settings::website
 		LoadHandler
 
 New pages
@@ -50,7 +50,7 @@ Database access, server access
 - nonrecurring server access: no
 - recurring server access: yes
 
-		creating, reading from and writing to files in public/contexts/%contextId%
+		creating, reading from and writing to files in [files_dir]/[presses|journals]/%contextId%/customLocale
 
 Classes, plugins, external software
 -----------------------
@@ -89,7 +89,7 @@ Classes, plugins, external software
 Metrics
 --------
 - number of files: 19
-- lines of code: 1668
+- lines of code: 1k LOC
 
 Settings
 --------

diff --git a/templates/customLocaleGridFilter.tpl b/templates/customLocaleGridFilter.tpl
@@ -1,7 +1,7 @@
 {**
- * plugins/generic/customLocale/templates/customLocaleGridFilter.tpl
+ * templates/customLocaleGridFilter.tpl
  *
- * Copyright (c) 2016 Language Science Press
+ * Copyright (c) 2016-2020 Language Science Press
  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  *
  *}

diff --git a/templates/localeFile.tpl b/templates/localeFile.tpl
@@ -1,7 +1,7 @@
 {**
- * plugins/generic/customLocale/templates/localeFile.tpl
+ * templates/localeFile.tpl
  *
- * Copyright (c) 2016 Language Science Press
+ * Copyright (c) 2016-2020 Language Science Press
  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  *
  *}

diff --git a/version.xml b/version.xml
@@ -2,18 +2,18 @@
 <!DOCTYPE version SYSTEM "../../../lib/pkp/dtd/pluginVersion.dtd">
 
 <!--
- * plugins/generic/customLocale/version.xml
+ * version.xml
  *
- * Copyright (c) 2016 Language Science Press
+ * Copyright (c) 2016-2020 Language Science Press
  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  *
  * Plugin version information.
-  -->
+ -->
 <version>
 	<application>customLocale</application>
 	<type>plugins.generic</type>
-	<release>1.0.0.0</release>
-	<date>2015-09-25</date>
+	<release>1.0.1.0</release>
+	<date>2020-01-24</date>
 	<lazy-load>1</lazy-load>
 	<class>CustomLocalePlugin</class>
 </version>